diff options
Diffstat (limited to 'doc/pycairo_c_api.rst')
| -rw-r--r-- | doc/pycairo_c_api.rst | 44 |
1 files changed, 25 insertions, 19 deletions
diff --git a/doc/pycairo_c_api.rst b/doc/pycairo_c_api.rst index bf0e9e4..9e0b58f 100644 --- a/doc/pycairo_c_api.rst +++ b/doc/pycairo_c_api.rst @@ -15,18 +15,24 @@ extension modules that use pycairo. To access the Pycairo C API =========================== -Edit the client module file to add the following lines:: +Example showing how to import the pycairo API:: - /* All function, type and macro definitions needed to use the Pycairo/C API - * are included in your code by the following line - */ - #include "Pycairo.h" + #include "py3cairo.h" - /* define a variable for the C API */ - static Pycairo_CAPI_t *Pycairo_CAPI; + PyMODINIT_FUNC + PyInit_client(void) + { + PyObject *m; + + m = PyModule_Create(&clientmodule); + if (m == NULL) + return NULL; + if (import_cairo() < 0) + return NULL; + /* additional initialization can happen here */ + return m; + } - /* import pycairo - add to the init<module> function */ - Pycairo_IMPORT; Pycairo Objects @@ -86,33 +92,33 @@ Types:: Functions ========= -.. cfunction:: cairo_t * PycairoContext_GET(obj) +.. c:function:: cairo_t * PycairoContext_GET(obj) get the C cairo_t \* object out of the PycairoContext \*obj -.. cfunction:: PyObject * PycairoContext_FromContext(cairo_t *ctx, PyTypeObject *type, PyObject *base) +.. c:function:: PyObject * PycairoContext_FromContext(cairo_t *ctx, PyTypeObject *type, PyObject *base) -.. cfunction:: PyObject * PycairoFontFace_FromFontFace(cairo_font_face_t *font_face) +.. c:function:: PyObject * PycairoFontFace_FromFontFace(cairo_font_face_t *font_face) -.. cfunction:: PyObject * PycairoFontOptions_FromFontOptions(cairo_font_options_t *font_options) +.. c:function:: PyObject * PycairoFontOptions_FromFontOptions(cairo_font_options_t *font_options) -.. cfunction:: PyObject * PycairoMatrix_FromMatrix(const cairo_matrix_t *matrix) +.. c:function:: PyObject * PycairoMatrix_FromMatrix(const cairo_matrix_t *matrix) -.. cfunction:: PyObject * PycairoPath_FromPath(cairo_path_t *path) +.. c:function:: PyObject * PycairoPath_FromPath(cairo_path_t *path) -.. cfunction:: PyObject * PycairoPattern_FromPattern(cairo_pattern_t *pattern, PyObject *base) +.. c:function:: PyObject * PycairoPattern_FromPattern(cairo_pattern_t *pattern, PyObject *base) -.. cfunction:: PyObject * PycairoScaledFont_FromScaledFont(cairo_scaled_font_t *scaled_font) +.. c:function:: PyObject * PycairoScaledFont_FromScaledFont(cairo_scaled_font_t *scaled_font) -.. cfunction:: PyObject * PycairoSurface_FromSurface(cairo_surface_t *surface, PyObject *base) +.. c:function:: PyObject * PycairoSurface_FromSurface(cairo_surface_t *surface, PyObject *base) -.. cfunction:: int PycairoCheck_Status(cairo_status_t status) +.. c:function:: int PycairoCheck_Status(cairo_status_t status) |