Generic image interface for GenDC parts.
More...
#include <PvGenDCInterfaces.h>
|
| virtual const uint8_t * | GetDataPointer () const =0 |
| | Get the image's data pointer.
|
| |
| virtual uint8_t * | GetDataPointer ()=0 |
| | Get the image's data pointer.
|
| |
| virtual uint32_t | GetImageSize () const =0 |
| | Actual image size within the payload or buffer.
|
| |
| virtual uint32_t | GetWidth () const =0 |
| | Get the image's width.
|
| |
| virtual uint32_t | GetHeight () const =0 |
| | Get the image's height.
|
| |
| virtual PvPixelType | GetPixelType () const =0 |
| | The buffer's pixel type.
|
| |
| virtual uint32_t | GetBitsPerPixel () const =0 |
| | Returns how many bits are required to hold a pixel using the current buffer's pixel type.
|
| |
| virtual uint32_t | GetOffsetX () const =0 |
| | Get the image's horizontal offset.
|
| |
| virtual uint32_t | GetOffsetY () const =0 |
| | Get the image's vertical offset.
|
| |
| virtual uint16_t | GetPaddingX () const =0 |
| | Get the horizontal image padding.
|
| |
| virtual uint16_t | GetPaddingY () const =0 |
| | Get the vertical image padding.
|
| |
| virtual uint64_t | GetBlockID () const =0 |
| | Return the block ID.
|
| |
Generic image interface for GenDC parts.
This interface provides access to image data within a GenDC part
◆ GetBitsPerPixel()
| virtual uint32_t IPvGenDCImage::GetBitsPerPixel |
( |
| ) |
const |
|
pure virtual |
Returns how many bits are required to hold a pixel using the current buffer's pixel type.
- Returns
- Bits per pixel for the current buffer's pixel type.
◆ GetBlockID()
| virtual uint64_t IPvGenDCImage::GetBlockID |
( |
| ) |
const |
|
pure virtual |
Return the block ID.
- Returns
- The block ID
◆ GetDataPointer() [1/2]
| virtual const uint8_t * IPvGenDCImage::GetDataPointer |
( |
| ) |
const |
|
pure virtual |
Get the image's data pointer.
- Returns
- A const pointer to the memory pointer.
◆ GetDataPointer() [2/2]
| virtual uint8_t * IPvGenDCImage::GetDataPointer |
( |
| ) |
|
|
pure virtual |
Get the image's data pointer.
- Returns
- A pointer to the memory pointer.
◆ GetHeight()
| virtual uint32_t IPvGenDCImage::GetHeight |
( |
| ) |
const |
|
pure virtual |
Get the image's height.
- Returns
- The image's height, in pixels.
◆ GetImageSize()
| virtual uint32_t IPvGenDCImage::GetImageSize |
( |
| ) |
const |
|
pure virtual |
Actual image size within the payload or buffer.
- Returns
- The actual image size within the payload or buffer
◆ GetOffsetX()
| virtual uint32_t IPvGenDCImage::GetOffsetX |
( |
| ) |
const |
|
pure virtual |
Get the image's horizontal offset.
- Returns
- The image's horizontal offset, in pixels.
◆ GetOffsetY()
| virtual uint32_t IPvGenDCImage::GetOffsetY |
( |
| ) |
const |
|
pure virtual |
Get the image's vertical offset.
- Returns
- The image's vertical offset, in pixels.
◆ GetPaddingX()
| virtual uint16_t IPvGenDCImage::GetPaddingX |
( |
| ) |
const |
|
pure virtual |
Get the horizontal image padding.
- Returns
- The horizontal image padding, in bytes.
◆ GetPaddingY()
| virtual uint16_t IPvGenDCImage::GetPaddingY |
( |
| ) |
const |
|
pure virtual |
Get the vertical image padding.
- Returns
- The vertical image padding, in bytes.
◆ GetPixelType()
| virtual PvPixelType IPvGenDCImage::GetPixelType |
( |
| ) |
const |
|
pure virtual |
The buffer's pixel type.
- Returns
- The pixel type. The pixel depth, colorspace, and other information are coded into the value.
◆ GetWidth()
| virtual uint32_t IPvGenDCImage::GetWidth |
( |
| ) |
const |
|
pure virtual |
Get the image's width.
- Returns
- The image's width in pixels.
The documentation for this class was generated from the following file:
eBUS SDK v7.0.1.7536 API