Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

#define kImage_AttachT | ( |  | kImage_image,
|  |  | TPtr_pixels,
|  |  | kType_pixelType,
|  |  | kSize_width,
|  |  | kSize_height,
|  |  | kSize_stride
| ) |  |
| related

Attaches the image to an external pixel buffer.

Attached pixel buffers are not freed when the image is destroyed.

A debug assertion will be raised if the size of the specified pixel type is not equal to the size of the image pixel type.

Parameters

  kImage_image | Image object.
  TPtr_pixels | Strongly-typed pointer to external pixel buffer.
  kType_pixelType | Type of pixel (values types only).
  kSize_width | Image width, in pixels.
  kSize_height | Image height, in pixels.
  kSize_stride | Image stride (row size), in bytes.

Returns
  Operation status.