Libraries:Gtk:Cairo:Surface

Types

T

Constants

Nil : T

Functions

ImageSurfaceCreate(format @ Gtk.Cairo.Format.T, width @ Std.Integer.SmallT, height @ Std.Integer.SmallT) : Gtk.Cairo.Surface.T

Creates an image surface of the specified format and dimensions. Initially the surface contents are all 0. (Specifically, within each pixel, each color or alpha channel belonging to format will be 0. The contents of bits within a pixel, but not belonging to the given format are undefined).

format	format of pixels in the surface to create
width	width of the surface, in pixels
height	height of the surface, in pixels
Returns	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 cairo_surface_status() to check for this.

ImageSurfaceCreateForData(data @ Std.Address.T, format @ Gtk.Cairo.Format.T, width @ Std.Integer.SmallT, height @ Std.Integer.SmallT, stride @ Std.Integer.SmallT) : Gtk.Cairo.Surface.T

Creates an image surface for the provided pixel data. The output buffer must be kept around until the T is destroyed or cairo_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, Gtk.Cairo.Cairo.Rectangle and Gtk.Cairo.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.

data	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	the format of pixels in the buffer
width	the width of the image to be stored in the buffer
height	the height of the image to be stored in the buffer
stride	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.
Returns	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 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 Gtk.Cairo.Status.InvalidStride. You can use cairo_surface_status() to check for this. See cairo_surface_set_user_data() for a means of attaching a destroy-notification fallback to the surface if necessary.

Methods

:"="(_ @ T, _ @ T)

:"~="(_ @ T, _ @ T)

Surface