fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2026-05-05 14:38:13 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

device: Fix documentation of device types

Browse source 
The documentation of device types incorrectly talks about surfaces and
lacks the new INVALID type.
This commit is contained in:
Andrea Canciani 2011-07-08 11:24:16 +02:00
parent 02a331de13
commit 05a0b24ecb
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/cairo.h
View file

@ -1952,26 +1952,27 @@ cairo_device_reference (cairo_device_t *device);
/**
* cairo_device_type_t:
* @CAIRO_DEVICE_TYPE_DRM: The surface is of type Direct Render Manager
* @CAIRO_DEVICE_TYPE_GL: The surface is of type OpenGL
* @CAIRO_DEVICE_TYPE_SCRIPT: The surface is of type script
* @CAIRO_DEVICE_TYPE_XCB: The surface is of type xcb
* @CAIRO_DEVICE_TYPE_XLIB: The surface is of type xlib
* @CAIRO_DEVICE_TYPE_XML: The surface is of type XML
* @CAIRO_DEVICE_TYPE_INVALID: The device is not valid
* @CAIRO_DEVICE_TYPE_DRM: The device is of type Direct Render Manager
* @CAIRO_DEVICE_TYPE_GL: The device is of type OpenGL
* @CAIRO_DEVICE_TYPE_SCRIPT: The device is of type script
* @CAIRO_DEVICE_TYPE_XCB: The device is of type xcb
* @CAIRO_DEVICE_TYPE_XLIB: The device is of type xlib
* @CAIRO_DEVICE_TYPE_XML: The device is of type XML
*
* #cairo_device_type_t is used to describe the type of a given
* device. The devices types are also known as "backends" within cairo.
*
* The device type can be queried with cairo_device_get_type()
*
* The various #cairo_device_t functions can be used with surfaces of
* The various #cairo_device_t functions can be used with devices of
* any type, but some backends also provide type-specific functions
* that must only be called with a device of the appropriate
* type. These functions have names that begin with
* <literal>cairo_<emphasis>type</emphasis>_device</literal> such as
* cairo_xcb_device_debug_cap_xrender_version().
*
* The behavior of calling a type-specific function with a surface of
* The behavior of calling a type-specific function with a device of
* the wrong type is undefined.
*
* New entries may be added in future versions.