libtiger 0.3.4
tiger.h
Go to the documentation of this file.
1/* Copyright (C) 2008 Vincent Penquerc'h.
2 This file is part of the Tiger rendering library.
3 Written by Vincent Penquerc'h.
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public
16 License along with this library; if not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA. */
19
20
21#ifndef TIGER_tiger_h_GUARD
22#define TIGER_tiger_h_GUARD
23
28#include <stddef.h>
29#include <kate/kate.h>
30#include "tiger/tiger_config.h"
31
34#define TIGER_VERSION_MAJOR 0
35#define TIGER_VERSION_MINOR 3
36#define TIGER_VERSION_PATCH 4
39typedef struct tiger_renderer tiger_renderer;
40
41typedef enum {
42 tiger_font_plain,
43 tiger_font_shadow,
44 tiger_font_outline
45} tiger_font_effect;
46
47#ifdef __cplusplus
48extern "C" {
49#endif
50
52extern int tiger_get_version(void);
53extern const char *tiger_get_version_string(void);
54
56extern int tiger_renderer_create(tiger_renderer **tr);
57extern int tiger_renderer_set_buffer(tiger_renderer *tr,unsigned char *ptr,int width,int height,int stride,int swap_rgb);
58extern int tiger_renderer_set_surface_clear_color(tiger_renderer *tr,int clear,double r,double g,double b,double a);
59extern int tiger_renderer_set_quality(tiger_renderer *tr,double quality);
60extern int tiger_renderer_add_event(tiger_renderer *tr,const kate_info *ki,const kate_event *ev);
61extern int tiger_renderer_update(tiger_renderer *tr,kate_float t,int track);
62extern int tiger_renderer_seek(tiger_renderer *tr, kate_float target);
63extern int tiger_renderer_render(tiger_renderer *tr);
64extern int tiger_renderer_destroy(tiger_renderer *tr);
65extern int tiger_renderer_is_dirty(const tiger_renderer *tr);
66extern int tiger_renderer_enable_caching(tiger_renderer *tr,int enable);
67
68extern int tiger_renderer_set_default_font_description(tiger_renderer *tr,const char *desc);
69extern int tiger_renderer_set_default_font(tiger_renderer *tr,const char *font);
70extern int tiger_renderer_set_default_font_size(tiger_renderer *tr,double size);
71extern int tiger_renderer_set_default_font_color(tiger_renderer *tr,double r,double g, double b,double a);
72
73extern int tiger_renderer_set_default_background_fill_color(tiger_renderer *tr,double r,double g,double b,double a);
74extern int tiger_renderer_set_default_font_effect(tiger_renderer *tr,tiger_font_effect effect,double strength);
75
76#ifdef DEBUG
78extern int tiger_renderer_enable_debug(tiger_renderer *tr,int debug);
79#endif
80
81#ifdef __cplusplus
82}
83#endif
84
87/* note that libkate errors may be returned by libtiger - see libkate API for more details */
88#define TIGER_E_NOT_FOUND (-1001)
89#define TIGER_E_INVALID_PARAMETER (-1002)
90#define TIGER_E_OUT_OF_MEMORY (-1003)
91#define TIGER_E_CAIRO_ERROR (-1004)
92#define TIGER_E_BAD_SURFACE_TYPE (-1005)
95#endif
96
int tiger_renderer_set_default_font_color(tiger_renderer *tr, double r, double g, double b, double a)
Definition: tiger_renderer.c:678
int tiger_renderer_set_surface_clear_color(tiger_renderer *tr, int clear, double r, double g, double b, double a)
Definition: tiger_renderer.c:320
int tiger_renderer_destroy(tiger_renderer *tr)
Definition: tiger_renderer.c:295
int tiger_renderer_set_default_font_effect(tiger_renderer *tr, tiger_font_effect effect, double strength)
Definition: tiger_renderer.c:725
int tiger_renderer_create(tiger_renderer **tr)
Definition: tiger_renderer.c:137
int tiger_renderer_set_quality(tiger_renderer *tr, double quality)
Definition: tiger_renderer.c:235
int tiger_renderer_add_event(tiger_renderer *tr, const kate_info *ki, const kate_event *ev)
Definition: tiger_renderer.c:341
int tiger_renderer_seek(tiger_renderer *tr, kate_float target)
Definition: tiger_renderer.c:442
int tiger_renderer_set_buffer(tiger_renderer *tr, unsigned char *ptr, int width, int height, int stride, int swap_rgb)
Definition: tiger_renderer.c:200
int tiger_renderer_set_default_font_size(tiger_renderer *tr, double size)
Definition: tiger_renderer.c:649
int tiger_renderer_is_dirty(const tiger_renderer *tr)
Definition: tiger_renderer.c:574
int tiger_renderer_enable_caching(tiger_renderer *tr, int enable)
Definition: tiger_renderer.c:746
int tiger_renderer_render(tiger_renderer *tr)
Definition: tiger_renderer.c:481
int tiger_renderer_set_default_font_description(tiger_renderer *tr, const char *desc)
Definition: tiger_renderer.c:588
int tiger_renderer_update(tiger_renderer *tr, kate_float t, int track)
Definition: tiger_renderer.c:393
int tiger_renderer_set_default_font(tiger_renderer *tr, const char *font)
Definition: tiger_renderer.c:618
int tiger_renderer_set_default_background_fill_color(tiger_renderer *tr, double r, double g, double b, double a)
Definition: tiger_renderer.c:704
int tiger_get_version(void)
Definition: tiger.c:36
const char * tiger_get_version_string(void)
Definition: tiger.c:46