#include "kate/kate_config.h"
Go to the source code of this file.
The libkate public API.
#define KATE_BITSTREAM_VERSION_MAJOR 0 |
major version number of the highest bitstream version this version of libkate supports
Referenced by kate_get_bitstream_version(), kate_get_bitstream_version_string(), and kate_info_init().
#define KATE_BITSTREAM_VERSION_MINOR 5 |
minor version number of the highest bitstream version this version of libkate supports
Referenced by kate_get_bitstream_version(), kate_get_bitstream_version_string(), and kate_info_init().
#define KATE_E_BAD_GRANULE (-4) |
decreasing granule
Referenced by kate_duration_granule(), kate_encode_finish_raw_times(), kate_encode_keepalive_raw_times(), kate_encode_repeat_raw_times(), kate_encode_text_raw_times(), and kate_info_set_granule_encoding().
#define KATE_E_BAD_PACKET (-6) |
packet contains invalid data
Referenced by kate_decode_headerin().
#define KATE_E_BAD_TAG (-11) |
a tag does not comply with the Vorbis comment rules
Referenced by kate_comment_add_length().
#define KATE_E_IMPL (-12) |
the requested feature is not implemented
Referenced by kate_encode_set_id().
#define KATE_E_INIT (-5) |
initializing twice, using an uninitialized state, etc
Referenced by kate_curve_get_point(), kate_decode_eventout(), kate_decode_packetin(), kate_decode_seek(), kate_encode_add_bitmap(), kate_encode_add_bitmap_index(), kate_encode_add_motion(), kate_encode_add_motion_index(), kate_encode_finish_raw_times(), kate_encode_get_granule(), kate_encode_headers(), kate_encode_keepalive_raw_times(), kate_encode_repeat_raw_times(), kate_encode_set_bitmap(), kate_encode_set_bitmap_index(), kate_encode_set_font_mapping_index(), kate_encode_set_id(), kate_encode_set_language(), kate_encode_set_markup_type(), kate_encode_set_palette(), kate_encode_set_palette_index(), kate_encode_set_region(), kate_encode_set_region_index(), kate_encode_set_secondary_style(), kate_encode_set_secondary_style_index(), kate_encode_set_style(), kate_encode_set_style_index(), kate_encode_set_text_directionality(), kate_encode_set_text_encoding(), kate_encode_text_raw_times(), kate_high_decode_clear(), kate_high_decode_packetin(), kate_tracker_clear(), and kate_tracker_update().
#define KATE_E_INVALID_PARAMETER (-2) |
a bogus parameter was passed (usually NULL)
Referenced by kate_bitmap_init(), kate_clear(), kate_comment_add(), kate_comment_add_length(), kate_comment_add_tag(), kate_comment_clear(), kate_comment_init(), kate_comment_query_count(), kate_curve_get_point(), kate_curve_init(), kate_decode_eventout(), kate_decode_headerin(), kate_decode_init(), kate_decode_packetin(), kate_decode_seek(), kate_duration_granule(), kate_encode_add_bitmap(), kate_encode_add_bitmap_index(), kate_encode_add_motion(), kate_encode_add_motion_index(), kate_encode_finish(), kate_encode_finish_raw_times(), kate_encode_get_granule(), kate_encode_headers(), kate_encode_init(), kate_encode_keepalive(), kate_encode_keepalive_raw_times(), kate_encode_repeat(), kate_encode_repeat_raw_times(), kate_encode_set_bitmap(), kate_encode_set_bitmap_index(), kate_encode_set_font_mapping_index(), kate_encode_set_id(), kate_encode_set_language(), kate_encode_set_markup_type(), kate_encode_set_palette(), kate_encode_set_palette_index(), kate_encode_set_region(), kate_encode_set_region_index(), kate_encode_set_secondary_style(), kate_encode_set_secondary_style_index(), kate_encode_set_style(), kate_encode_set_style_index(), kate_encode_set_text_directionality(), kate_encode_set_text_encoding(), kate_encode_text(), kate_encode_text_raw_times(), kate_font_get_index_from_code_point(), kate_granule_duration(), kate_granule_shift(), kate_granule_split_time(), kate_high_decode_clear(), kate_high_decode_init(), kate_high_decode_packetin(), kate_info_clear(), kate_info_init(), kate_info_matches_language(), kate_info_no_limits(), kate_info_remove_markup(), kate_info_set_category(), kate_info_set_granule_encoding(), kate_info_set_language(), kate_info_set_markup_type(), kate_info_set_original_canvas_size(), kate_info_set_text_directionality(), kate_motion_get_point(), kate_motion_init(), kate_ogg_decode_headerin(), kate_ogg_decode_packetin(), kate_packet_clear(), kate_packet_init(), kate_packet_wrap(), kate_palette_init(), kate_region_init(), kate_style_init(), kate_text_get_character(), kate_text_remove_markup(), kate_text_set_character(), kate_text_validate(), kate_time_granule(), kate_tracker_clear(), kate_tracker_get_text_path_position(), kate_tracker_init(), kate_tracker_morph_styles(), kate_tracker_remap(), kate_tracker_update(), and kate_tracker_update_property_at_duration().
#define KATE_E_LIMIT (-8) |
a limit was exceeded (eg, string too long, pixel value above bpp, etc)
Referenced by kate_info_set_category(), and kate_time_granule().
#define KATE_E_NOT_FOUND (-1) |
whatever was requested was not found
Referenced by kate_encode_finish_raw_times(), kate_encode_keepalive_raw_times(), kate_encode_repeat_raw_times(), and kate_font_get_index_from_code_point().
#define KATE_E_NOT_KATE (-10) |
the packet is not a Kate packet
#define KATE_E_OUT_OF_MEMORY (-3) |
we're running out of cheese, bring some more
Referenced by kate_comment_add_length(), kate_comment_add_tag(), kate_decode_init(), kate_encode_init(), kate_encode_set_language(), kate_high_decode_init(), kate_packet_init(), and kate_tracker_init().
#define KATE_E_TEXT (-7) |
invalid/truncated character/sequence, etc
Referenced by kate_font_get_index_from_code_point(), kate_text_get_character(), kate_text_set_character(), and kate_text_validate().
#define KATE_E_VERSION (-9) |
we do not understand that bitstream version
#define KATE_VERSION_MAJOR 0 |
major version number of the libkate API
Referenced by kate_get_version(), and kate_get_version_string().
#define KATE_VERSION_MINOR 3 |
minor version number of the libkate API
Referenced by kate_get_version(), and kate_get_version_string().
#define KATE_VERSION_PATCH 8 |
patch version number of the libkate API
Referenced by kate_get_version(), and kate_get_version_string().
typedef struct kate_bitmap kate_bitmap |
defines a paletted image
typedef enum kate_bitmap_type kate_bitmap_type |
defines a particular type of bitmap
typedef struct kate_color kate_color |
defines an RGBA color
typedef struct kate_comment kate_comment |
Vorbis comments - this is the same as Vorbis and Theora comments
typedef struct kate_curve kate_curve |
defines a curve
typedef enum kate_curve_type kate_curve_type |
defines a type of curve
typedef struct kate_event kate_event |
This is an event passed to the user. A kate_tracker may be used to track animation changes to this event.
typedef struct kate_font_mapping kate_font_mapping |
defines a set of ranges to define a font mapping
typedef struct kate_font_range kate_font_range |
defines a set of images to map to a range of Unicode code points
Information about a Kate bitstream. On encoding, this information will be filled by the encoder. On decoding, it will be extracted from the stream headers.
typedef struct kate_motion kate_motion |
defines a motion - well, try to find a better explanation
typedef enum kate_motion_mapping kate_motion_mapping |
defines a way to transform a curve point
typedef enum kate_motion_semantics kate_motion_semantics |
defines what uses a motion can have
typedef struct kate_packet kate_packet |
a kate packet raw data
typedef struct kate_palette kate_palette |
defines colors to correspond to a bitmap's pixels
typedef struct kate_region kate_region |
defines an area where to draw
typedef struct kate_state kate_state |
top level information about a Kate bitstream
typedef struct kate_style kate_style |
defines a style to display text
typedef enum kate_text_directionality kate_text_directionality |
defines the direction in which glyphs within a text are drawn
typedef struct kate_tracker kate_tracker |
this keeps track of changes during an event's lifetime
enum kate_bitmap_type |
enum kate_curve_type |
defines a type of curve
enum kate_markup_type |
enum kate_motion_mapping |
defines a way to transform a curve point
defines what uses a motion can have
enum kate_space_metric |
defines the direction in which glyphs within a text are drawn
enum kate_text_encoding |
enum kate_wrap_mode |
int kate_clear | ( | kate_state * | k | ) |
Destroys a kate_state structure. The kate_state structure should have been initialized with kate_decode_init or kate_encode_init.
k | the kate_state structure to clear |
References kate_clear(), and KATE_E_INVALID_PARAMETER.
Referenced by kate_clear(), and kate_high_decode_clear().
int kate_curve_get_point | ( | const kate_curve * | kc, | |
kate_float | t, | |||
kate_float * | x, | |||
kate_float * | y | |||
) |
Returns the point defined by the given curve at the given time. t will be between 0 and 1
kc | the curve to get the point from | |
t | the time at which the point should be taken (between 0 and motion duration) | |
x | a pointer to the first coordinate of the computed point (may be NULL) | |
y | a pointer to the second coordinate of the computed point (may be NULL) |
References kate_curve_bezier_cubic_spline, kate_curve_bspline, kate_curve_catmull_rom_spline, kate_curve_get_point(), kate_curve_linear, kate_curve_none, kate_curve_static, KATE_E_INIT, KATE_E_INVALID_PARAMETER, kate_curve::npts, kate_curve::pts, and kate_curve::type.
Referenced by kate_curve_get_point(), and kate_motion_get_point().
int kate_motion_get_point | ( | const kate_motion * | km, | |
kate_float | duration, | |||
kate_float | t, | |||
kate_float * | x, | |||
kate_float * | y | |||
) |
Returns the point defined by the given motion at the given time. t will be between 0 and the duration of the motion
km | the motion to get the point from | |
duration | the duration the motion spans | |
t | the time at which the point should be taken (between 0 and motion duration) | |
x | a pointer to the first coordinate of the computed point (may be NULL) | |
y | a pointer to the second coordinate of the computed point (may be NULL) |
References kate_motion::curves, kate_motion::durations, kate_curve_get_point(), KATE_E_INVALID_PARAMETER, kate_motion_get_point(), kate_motion::ncurves, and kate_motion::periodic.
Referenced by kate_motion_get_point(), kate_tracker_update(), and kate_tracker_update_property_at_duration().