ImageDesc¶

class PyOpenColorIO.ImageDesc¶

ImageDesc() → None¶

getBitDepth() → PyOpenColorIO.PyOpenColorIO.BitDepth¶

getHeight() → int¶

getWidth() → int¶

getXStrideBytes() → int¶

getYStrideBytes() → int¶

isFloat() → bool¶

isRGBAPacked() → bool¶

PyOpenColorIO.AutoStride: int¶

PackedImageDesc¶

class PyOpenColorIO.PackedImageDesc¶

PackedImageDesc(*args, **kwargs)¶

Overloaded function.

__init__(self: PyOpenColorIO.PyOpenColorIO.PackedImageDesc, data: collections.abc.Buffer, width: typing.SupportsInt, height: typing.SupportsInt, numChannels: typing.SupportsInt) -> None
__init__(self: PyOpenColorIO.PyOpenColorIO.PackedImageDesc, data: collections.abc.Buffer, width: typing.SupportsInt, height: typing.SupportsInt, numChannels: typing.SupportsInt, bitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, chanStrideBytes: typing.SupportsInt, xStrideBytes: typing.SupportsInt, yStrideBytes: typing.SupportsInt) -> None
__init__(self: PyOpenColorIO.PyOpenColorIO.PackedImageDesc, data: collections.abc.Buffer, width: typing.SupportsInt, height: typing.SupportsInt, chanOrder: PyOpenColorIO.PyOpenColorIO.ChannelOrdering) -> None
__init__(self: PyOpenColorIO.PyOpenColorIO.PackedImageDesc, data: collections.abc.Buffer, width: typing.SupportsInt, height: typing.SupportsInt, chanOrder: PyOpenColorIO.PyOpenColorIO.ChannelOrdering, bitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, chanStrideBytes: typing.SupportsInt, xStrideBytes: typing.SupportsInt, yStrideBytes: typing.SupportsInt) -> None

getBitDepth() → PyOpenColorIO.PyOpenColorIO.BitDepth¶

getChanStrideBytes() → int¶

getChannelOrder() → PyOpenColorIO.PyOpenColorIO.ChannelOrdering¶

getData() → numpy.ndarray¶

getHeight() → int¶

getNumChannels() → int¶

getWidth() → int¶

getXStrideBytes() → int¶

getYStrideBytes() → int¶

isFloat() → bool¶

isRGBAPacked() → bool¶

class PackedImageDesc : public ImageDesc ¶

All the constructors expect a pointer to packed image data (such as rgbrgbrgb or rgbargbargba) starting at the first color channel of the first pixel to process (which does not need to be the first pixel of the image). The number of channels must be greater than or equal to 3. If a 4th channel is specified, it is assumed to be alpha information. Channels > 4 will be ignored.

Note

The methods assume the CPUProcessor bit-depth type for the data pointer.

Public Functions

PackedImageDesc(void *data, long width, long height, long numChannels)¶: Note

numChannels must be 3 (RGB) or 4 (RGBA).

PackedImageDesc(void *data, long width, long height, long numChannels, BitDepth bitDepth, ptrdiff_t chanStrideBytes, ptrdiff_t xStrideBytes, ptrdiff_t yStrideBytes)¶: Note

numChannels must be 3 (RGB) or 4 (RGBA).

PackedImageDesc(void *data, long width, long height, ChannelOrdering chanOrder)¶

PackedImageDesc(void *data, long width, long height, ChannelOrdering chanOrder, BitDepth bitDepth, ptrdiff_t chanStrideBytes, ptrdiff_t xStrideBytes, ptrdiff_t yStrideBytes)¶

virtual ~PackedImageDesc()¶

ChannelOrdering getChannelOrder() const¶: Get the channel ordering of all the pixels.

virtual BitDepth getBitDepth() const override¶: Get the bit-depth.

void *getData() const¶: Get a pointer to the first color channel of the first pixel.

virtual void *getRData() const override¶: Get a pointer to the red channel of the first pixel.

virtual void *getGData() const override¶: Get a pointer to the green channel of the first pixel.

virtual void *getBData() const override¶: Get a pointer to the blue channel of the first pixel.

virtual void *getAData() const override¶: Get a pointer to the alpha channel of the first pixel or null as alpha channel is optional.

virtual long getWidth() const override¶: Get the width to process (where x position starts at 0 and ends at width-1).

virtual long getHeight() const override¶: Get the height to process (where y position starts at 0 and ends at height-1).

long getNumChannels() const¶

ptrdiff_t getChanStrideBytes() const¶

virtual ptrdiff_t getXStrideBytes() const override¶: Get the step in bytes to find the same color channel of the next pixel.

virtual ptrdiff_t getYStrideBytes() const override¶: Get the step in bytes to find the same color channel of the pixel at the same position in the next line.

virtual bool isRGBAPacked() const override¶: 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.)

virtual bool isFloat() const override¶: Is the image buffer 32-bit float?

PlanarImageDesc¶

class PyOpenColorIO.PlanarImageDesc¶

PlanarImageDesc(*args, **kwargs)¶

Overloaded function.

__init__(self: PyOpenColorIO.PyOpenColorIO.PlanarImageDesc, rData: collections.abc.Buffer, gData: collections.abc.Buffer, bData: collections.abc.Buffer, width: typing.SupportsInt, height: typing.SupportsInt) -> None
__init__(self: PyOpenColorIO.PyOpenColorIO.PlanarImageDesc, rData: collections.abc.Buffer, gData: collections.abc.Buffer, bData: collections.abc.Buffer, aData: collections.abc.Buffer, width: typing.SupportsInt, height: typing.SupportsInt) -> None
__init__(self: PyOpenColorIO.PyOpenColorIO.PlanarImageDesc, rData: collections.abc.Buffer, gData: collections.abc.Buffer, bData: collections.abc.Buffer, width: typing.SupportsInt, height: typing.SupportsInt, bitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, xStrideBytes: typing.SupportsInt, yStrideBytes: typing.SupportsInt) -> None
__init__(self: PyOpenColorIO.PyOpenColorIO.PlanarImageDesc, rData: collections.abc.Buffer, gData: collections.abc.Buffer, bData: collections.abc.Buffer, aData: collections.abc.Buffer, width: typing.SupportsInt, height: typing.SupportsInt, bitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, xStrideBytes: typing.SupportsInt, yStrideBytes: typing.SupportsInt) -> None

getAData() → numpy.ndarray¶

getBData() → numpy.ndarray¶

getBitDepth() → PyOpenColorIO.PyOpenColorIO.BitDepth¶

getGData() → numpy.ndarray¶

getHeight() → int¶

getRData() → numpy.ndarray¶

getWidth() → int¶

getXStrideBytes() → int¶

getYStrideBytes() → int¶

isFloat() → bool¶

isRGBAPacked() → bool¶

class PlanarImageDesc : public ImageDesc ¶

All the constructors expect pointers to the specified image planes (i.e. rrrr gggg bbbb) starting at the first color channel of the first pixel to process (which need not be the first pixel of the image). Pass NULL for aData if no alpha exists (r/g/bData must not be NULL).

Note

The methods assume the CPUProcessor bit-depth type for the R/G/B/A data pointers.

Public Functions

PlanarImageDesc(void *rData, void *gData, void *bData, void *aData, long width, long height)¶

PlanarImageDesc(void *rData, void *gData, void *bData, void *aData, long width, long height, BitDepth bitDepth, ptrdiff_t xStrideBytes, ptrdiff_t yStrideBytes)¶: Note that although PlanarImageDesc is powerful enough to also describe all PackedImageDesc scenarios, it is recommended to use a PackedImageDesc where possible since that allows for additional optimizations.

virtual ~PlanarImageDesc()¶

virtual void *getRData() const override¶: Get a pointer to the red channel of the first pixel.

virtual void *getGData() const override¶: Get a pointer to the green channel of the first pixel.

virtual void *getBData() const override¶: Get a pointer to the blue channel of the first pixel.

virtual void *getAData() const override¶: Get a pointer to the alpha channel of the first pixel or null as alpha channel is optional.

virtual BitDepth getBitDepth() const override¶: Get the bit-depth.

virtual long getWidth() const override¶: Get the width to process (where x position starts at 0 and ends at width-1).

virtual long getHeight() const override¶: Get the height to process (where y position starts at 0 and ends at height-1).

virtual ptrdiff_t getXStrideBytes() const override¶: Get the step in bytes to find the same color channel of the next pixel.

virtual ptrdiff_t getYStrideBytes() const override¶: Get the step in bytes to find the same color channel of the pixel at the same position in the next line.

virtual bool isRGBAPacked() const override¶: 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.)

virtual bool isFloat() const override¶: Is the image buffer 32-bit float?