RGtk2 (version 2.8.8)

cairoImageSurfaceCreateForData: cairoImageSurfaceCreateForData

Description

Creates an image surface for the provided pixel data. The output buffer must be kept around until the CairoSurface is destroyed or cairoSurfaceFinish is called on the surface. The initial contents of buffer will be used as the inital image contents; you must explicitely clear the buffer, using, for example, cairoRectangle and cairoFill if you want it cleared.

Usage

cairoImageSurfaceCreateForData(data, format, width, height, stride)

Arguments

data

[char] a pointer to a buffer supplied by the application in which to write contents.

format

[CairoFormat] the format of pixels in the buffer

width

[integer] the width of the image to be stored in the buffer

height

[integer] the height of the image to be stored in the buffer

stride

[integer] the number of bytes between the start of rows in the buffer. Having this be specified separate from width allows for padding at the end of rows, or for writing to a subportion of a larger image.

Value

• [CairoSurface] a pointer to the newly created surface. The caller owns the surface and should call cairo_surface_destroy when done with it.

  This function always returns a valid pointer, but it will return a pointer to a "nil" surface if an error such as out of memory occurs. You can use cairoSurfaceStatus to check for this.