ImageSurface.createForData

Creates an image surface for the provided pixel data. The output buffer must be kept around until the cairo_surface_t is destroyed or Surface.finish is called on the surface. The initial contents of data will be used as the initial image contents; you must explicitly clear the buffer, using, for example, cairo_rectangle() and cairo_fill() if you want it cleared. Note that the stride may be larger than width*bytes_per_pixel to provide proper alignment for each pixel and row. This alignment is required to allow high-performance rendering within cairo. The correct way to obtain a legal stride value is to call cairo_format_stride_for_width() with the desired format and maximum image width value, and then use the resulting stride value to allocate the data and to create the image surface. See cairo_format_stride_for_width() for example code. Since 1.0

class ImageSurface
static
createForData

Parameters

data ubyte*

a pointer to a buffer supplied by the application in which to write contents. This pointer must be suitably aligned for any kind of variable, (for example, a pointer returned by malloc).

format cairo_format_t

the format of pixels in the buffer

width int

the width of the image to be stored in the buffer

height int

the height of the image to be stored in the buffer

stride int

the number of bytes between the start of rows in the buffer as allocated. This value should always be computed by cairo_format_stride_for_width() before allocating the data buffer.

Return Value

a pointer to the newly created surface. The caller owns the surface and should call Surface.destroy when done with it. This function always returns a valid pointer, but it will return a pointer to a "nil" surface in the case of an error such as out of memory or an invalid stride value. In case of invalid stride value the error status of the returned surface will be CAIRO_STATUS_INVALID_STRIDE. You can use Surface.status to check for this. See Surface.setUserData for a means of attaching a destroy-notification fallback to the surface if necessary.