All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Pylon::IImage Interface Referenceabstract

Usable to access image properties and image buffer. More...

#include <pylon/Image.h>

Inheritance diagram for Pylon::IImage:
Inheritance graph
[legend]

Public Member Functions

virtual ~IImage ()=0
 Ensure proper destruction by using a virtual destructor.
 
virtual bool IsValid () const =0
 Can be used to check whether an image is valid. More...
 
virtual EPixelType GetPixelType () const =0
 Get the current pixel type. More...
 
virtual uint32_t GetWidth () const =0
 Get the current number of columns in pixels. More...
 
virtual uint32_t GetHeight () const =0
 Get the current number of rows. More...
 
virtual size_t GetPaddingX () const =0
 Get the number of extra data bytes at the end of each row. More...
 
virtual EImageOrientation GetOrientation () const =0
 Get the vertical orientation of the image in memory. More...
 
virtual void * GetBuffer ()=0
 Get the pointer to the buffer. More...
 
virtual const void * GetBuffer () const =0
 Get the pointer to the buffer containing the image. More...
 
virtual size_t GetImageSize () const =0
 Get the size of the image in bytes. More...
 
virtual bool IsUnique () const =0
 Indicates that the referenced buffer is only referenced by this image. More...
 
virtual bool GetStride (size_t &strideBytes) const =0
 Get the stride in bytes. More...
 

Detailed Description

Usable to access image properties and image buffer.

Member Function Documentation

virtual void* Pylon::IImage::GetBuffer ( )
pure virtual

Get the pointer to the buffer.

Returns
Returns the pointer to the used buffer or NULL if the image is invalid.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.

virtual const void* Pylon::IImage::GetBuffer ( ) const
pure virtual

Get the pointer to the buffer containing the image.

The buffer is at least as large as the value returned by GetImageSize().

Returns
Returns the pointer to the used buffer or NULL if the image is invalid.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.

virtual uint32_t Pylon::IImage::GetHeight ( ) const
pure virtual

Get the current number of rows.

Returns
Returns the current number of rows or 0 if the image is invalid.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.

virtual size_t Pylon::IImage::GetImageSize ( ) const
pure virtual

Get the size of the image in bytes.

Returns
Returns the size of the image in bytes or 0 if the image is invalid.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.

virtual EImageOrientation Pylon::IImage::GetOrientation ( ) const
pure virtual

Get the vertical orientation of the image in memory.

Returns
Returns the orientation of the image or ImageOrientation_TopDown if the image is invalid.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.

virtual size_t Pylon::IImage::GetPaddingX ( ) const
pure virtual

Get the number of extra data bytes at the end of each row.

Returns
Returns the number of extra data bytes at the end of each row or 0 if the image is invalid.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.

virtual EPixelType Pylon::IImage::GetPixelType ( ) const
pure virtual

Get the current pixel type.

Returns
Returns the pixel type or PixelType_Undefined if the image is invalid.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.

virtual bool Pylon::IImage::GetStride ( size_t &  strideBytes) const
pure virtual

Get the stride in bytes.

The stride in bytes can not be computed for packed image format when the stride is not byte aligned. See also Pylon::IsPacked(). The stride in bytes can not be computed if the image is invalid.

Parameters
[out]strideBytesThe stride in byte if it can be computed.
Returns
Returns true if the stride can be computed.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.

virtual uint32_t Pylon::IImage::GetWidth ( ) const
pure virtual

Get the current number of columns in pixels.

Returns
Returns the current number of columns in pixels or 0 if the image is invalid.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.

virtual bool Pylon::IImage::IsUnique ( ) const
pure virtual

Indicates that the referenced buffer is only referenced by this image.

Returns
Returns true if the referenced buffer is only referenced by this image. Returns false if the image is invalid.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.

virtual bool Pylon::IImage::IsValid ( ) const
pure virtual

Can be used to check whether an image is valid.

Returns
Returns false if the image is invalid.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CPylonImage, and Pylon::CGrabResultImageT< GrabResultT >.


The documentation for this interface was generated from the following file:

pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)