ImageDesc

Caution

API Docs are a work in progress, expect them to improve over time.

class ImageDesc

This is a light-weight wrapper around an image, that provides a context for pixel access. This does NOT claim ownership of the pixels or copy image data.

Subclassed by OpenColorIO::PackedImageDesc, OpenColorIO::PlanarImageDesc

ImageDesc()
~ImageDesc()
void *getRData() const = 0

Get a pointer to the red channel of the first pixel.

void *getGData() const = 0

Get a pointer to the green channel of the first pixel.

void *getBData() const = 0

Get a pointer to the blue channel of the first pixel.

void *getAData() const = 0

Get a pointer to the alpha channel of the first pixel or null as alpha channel is optional.

BitDepth getBitDepth() const = 0

Get the bit-depth.

long getWidth() const = 0

Get the width to process (where x position starts at 0 and ends at width-1).

long getHeight() const = 0

Get the height to process (where y position starts at 0 and ends at height-1).

ptrdiff_t getXStrideBytes() const = 0

Get the step in bytes to find the same color channel of the next pixel.

ptrdiff_t getYStrideBytes() const = 0

Get the step in bytes to find the same color channel of the pixel at the same position in the next line.

bool isRGBAPacked() const = 0

Is the image buffer in packed mode with the 4 color channels? (“Packed” here means that XStrideBytes is 4x the bytes per channel, so it is more specific than simply any PackedImageDesc.)

bool isFloat() const = 0

Is the image buffer 32-bit float?

getBitDepth(self: PyOpenColorIO.ImageDesc)PyOpenColorIO.BitDepth
getHeight(self: PyOpenColorIO.ImageDesc) → int
getWidth(self: PyOpenColorIO.ImageDesc) → int
getXStrideBytes(self: PyOpenColorIO.ImageDesc) → int
getYStrideBytes(self: PyOpenColorIO.ImageDesc) → int
isFloat(self: PyOpenColorIO.ImageDesc) → bool
isRGBAPacked(self: PyOpenColorIO.ImageDesc) → bool