File List   File Members  

ptc.h File Reference

OpenPTC C Header file. More...

Defines

Typedefs

Functions


Detailed Description

OpenPTC C Header file.


Define Documentation

#define PTC_KEY_ENTER

#define PTC_KEY_BACKSPACE

#define PTC_KEY_TAB

#define PTC_KEY_CANCEL

#define PTC_KEY_CLEAR

#define PTC_KEY_SHIFT

#define PTC_KEY_CONTROL

#define PTC_KEY_ALT

#define PTC_KEY_PAUSE

#define PTC_KEY_CAPSLOCK

#define PTC_KEY_ESCAPE

#define PTC_KEY_SPACE

#define PTC_KEY_PAGEUP

#define PTC_KEY_PAGEDOWN

#define PTC_KEY_END

#define PTC_KEY_HOME

#define PTC_KEY_LEFT

#define PTC_KEY_UP

#define PTC_KEY_RIGHT

#define PTC_KEY_DOWN

#define PTC_KEY_COMMA

#define PTC_KEY_PERIOD

#define PTC_KEY_SLASH

#define PTC_KEY_ZERO

#define PTC_KEY_ONE

#define PTC_KEY_TWO

#define PTC_KEY_THREE

#define PTC_KEY_FOUR

#define PTC_KEY_FIVE

#define PTC_KEY_SIX

#define PTC_KEY_SEVEN

#define PTC_KEY_EIGHT

#define PTC_KEY_NINE

#define PTC_KEY_SEMICOLON

#define PTC_KEY_EQUALS

#define PTC_KEY_A

#define PTC_KEY_B

#define PTC_KEY_C

#define PTC_KEY_D

#define PTC_KEY_E

#define PTC_KEY_F

#define PTC_KEY_G

#define PTC_KEY_H

#define PTC_KEY_I

#define PTC_KEY_J

#define PTC_KEY_K

#define PTC_KEY_L

#define PTC_KEY_M

#define PTC_KEY_N

#define PTC_KEY_O

#define PTC_KEY_P

#define PTC_KEY_Q

#define PTC_KEY_R

#define PTC_KEY_S

#define PTC_KEY_T

#define PTC_KEY_U

#define PTC_KEY_V

#define PTC_KEY_W

#define PTC_KEY_X

#define PTC_KEY_Y

#define PTC_KEY_Z

#define PTC_KEY_OPENBRACKET

#define PTC_KEY_BACKSLASH

#define PTC_KEY_CLOSEBRACKET

#define PTC_KEY_NUMPAD0

#define PTC_KEY_NUMPAD1

#define PTC_KEY_NUMPAD2

#define PTC_KEY_NUMPAD3

#define PTC_KEY_NUMPAD4

#define PTC_KEY_NUMPAD5

#define PTC_KEY_NUMPAD6

#define PTC_KEY_NUMPAD7

#define PTC_KEY_NUMPAD8

#define PTC_KEY_NUMPAD9

#define PTC_KEY_MULTIPLY

#define PTC_KEY_ADD

#define PTC_KEY_SEPARATOR

#define PTC_KEY_SUBTRACT

#define PTC_KEY_DECIMAL

#define PTC_KEY_DIVIDE

#define PTC_KEY_F1

#define PTC_KEY_F2

#define PTC_KEY_F3

#define PTC_KEY_F4

#define PTC_KEY_F5

#define PTC_KEY_F6

#define PTC_KEY_F7

#define PTC_KEY_F8

#define PTC_KEY_F9

#define PTC_KEY_F10

#define PTC_KEY_F11

#define PTC_KEY_F12

#define PTC_KEY_DELETE

#define PTC_KEY_NUMLOCK

#define PTC_KEY_SCROLLLOCK

#define PTC_KEY_PRINTSCREEN

#define PTC_KEY_INSERT

#define PTC_KEY_HELP

#define PTC_KEY_META

#define PTC_KEY_BACKQUOTE

#define PTC_KEY_QUOTE

#define PTC_KEY_FINAL

#define PTC_KEY_CONVERT

#define PTC_KEY_NONCONVERT

#define PTC_KEY_ACCEPT

#define PTC_KEY_MODECHANGE

#define PTC_KEY_KANA

#define PTC_KEY_KANJI

#define PTC_KEY_UNDEFINED


Typedef Documentation

PTC_KEY

Opaque key object handle.

PTC_AREA

Opaque area object handle.

PTC_MODE

Opaque mode object handle.

PTC_COPY

Opaque key object handle.

PTC_CLEAR

Opaque clear object handle.

PTC_TIMER

Opaque timer object handle.

PTC_ERROR

Opaque error object handle.

PTC_COLOR

Opaque color object handle.

PTC_FORMAT

Opaque format object handle.

PTC_PALETTE

Opaque palette object handle.

PTC_SURFACE

Opaque surface object handle.

PTC_CONSOLE

Opaque console object handle.

ptc_char8

An unsigned 8 bit value.

ptc_short16

An unsigned 16 bit value.

ptc_int32

An unsigned 32 bit value.


Function Documentation

PTC_KEY ptc_key_create (int code, int alt, int shift, int control)

void ptc_key_destroy (PTC_KEY object)

int ptc_key_code (PTC_KEY object)

int ptc_key_alt (PTC_KEY object)

int ptc_key_shift (PTC_KEY object)

int ptc_key_control (PTC_KEY object)

void ptc_key_assign (PTC_KEY object, PTC_KEY key)

int ptc_key_equals (PTC_KEY object, PTC_KEY key)

PTC_AREA ptc_area_create (int left, int top, int right, int bottom)

void ptc_area_destroy (PTC_AREA object)

int ptc_area_left (PTC_AREA object)

int ptc_area_right (PTC_AREA object)

int ptc_area_top (PTC_AREA object)

int ptc_area_bottom (PTC_AREA object)

int ptc_area_width (PTC_AREA object)

int ptc_area_height (PTC_AREA object)

void ptc_area_assign (PTC_AREA object, PTC_AREA area)

int ptc_area_equals (PTC_AREA object, PTC_AREA area)

PTC_COPY ptc_copy_create ()

void ptc_copy_destroy (PTC_COPY object)

void ptc_copy_request (PTC_COPY object, PTC_FORMAT source, PTC_FORMAT destination)

void ptc_copy_palette (PTC_COPY object, PTC_PALETTE source, PTC_PALETTE destination)

void ptc_copy_copy (PTC_COPY object, void * source_pixels, int source_x, int source_y, int source_width, int source_height, int source_pitch, void * destination_pixels, int destination_x, int destination_y, int destination_width, int destination_height, int destination_pitch)

int ptc_copy_option (PTC_COPY object, char * option)

PTC_MODE ptc_mode_create (int width, int height, PTC_FORMAT format)

PTC_MODE ptc_mode_create_invalid ()

void ptc_mode_destroy (PTC_MODE object)

int ptc_mode_valid (PTC_MODE object)

int ptc_mode_width (PTC_MODE object)

int ptc_mode_height (PTC_MODE object)

PTC_FORMAT ptc_mode_format (PTC_MODE object)

void ptc_mode_assign (PTC_MODE object, PTC_MODE mode)

int ptc_mode_equals (PTC_MODE object, PTC_MODE mode)

PTC_CLEAR ptc_clear_create ()

void ptc_clear_destroy (PTC_CLEAR object)

void ptc_clear_request (PTC_CLEAR object, PTC_FORMAT format)

void ptc_clear_clear (PTC_CLEAR object, void * pixels, int x, int y, int width, int height, int pitch, PTC_COLOR color)

PTC_COLOR ptc_color_create ()

PTC_COLOR ptc_color_create_indexed (int index)

PTC_COLOR ptc_color_create_direct (float r, float g, float b, float a)

void ptc_color_destroy (PTC_COLOR object)

int ptc_color_index (PTC_COLOR object)

float ptc_color_r (PTC_COLOR object)

float ptc_color_g (PTC_COLOR object)

float ptc_color_b (PTC_COLOR object)

float ptc_color_a (PTC_COLOR object)

int ptc_color_direct (PTC_COLOR object)

int ptc_color_indexed (PTC_COLOR object)

void ptc_color_assign (PTC_COLOR object, PTC_COLOR color)

int ptc_color_equals (PTC_COLOR object, PTC_COLOR color)

PTC_ERROR ptc_error_create (char * message)

PTC_ERROR ptc_error_create_composite (char * message, PTC_ERROR error)

void ptc_error_destroy (PTC_ERROR object)

void ptc_error_report (PTC_ERROR object)

char * ptc_error_message (PTC_ERROR object)

void ptc_error_assign (PTC_ERROR object, PTC_ERROR error)

int ptc_error_equals (PTC_ERROR object, PTC_ERROR error)

typedef void (PTC_CALLBACK * PTC_ERROR_HANDLER)

void ptc_error_handler (PTC_ERROR_HANDLER handler)

PTC_TIMER ptc_timer_create ()

void ptc_timer_destroy (PTC_TIMER object)

void ptc_timer_set (PTC_TIMER object, double time)

void ptc_timer_start (PTC_TIMER object)

void ptc_timer_stop (PTC_TIMER object)

double ptc_timer_time (PTC_TIMER object)

double ptc_timer_delta (PTC_TIMER object)

double ptc_timer_resolution (PTC_TIMER object)

void ptc_timer_assign (PTC_TIMER object, PTC_TIMER timer)

int ptc_timer_equals (PTC_TIMER object, PTC_TIMER timer)

PTC_FORMAT ptc_format_create ()

PTC_FORMAT ptc_format_create_indexed (int bits)

PTC_FORMAT ptc_format_create_direct (int bits, int32 r, int32 g, int32 b, int32 a)

void ptc_format_destroy (PTC_FORMAT object)

int32 ptc_format_r (PTC_FORMAT object)

int32 ptc_format_g (PTC_FORMAT object)

int32 ptc_format_b (PTC_FORMAT object)

int32 ptc_format_a (PTC_FORMAT object)

int ptc_format_bits (PTC_FORMAT object)

int ptc_format_bytes (PTC_FORMAT object)

int ptc_format_direct (PTC_FORMAT object)

int ptc_format_indexed (PTC_FORMAT object)

void ptc_format_assign (PTC_FORMAT object, PTC_FORMAT format)

int ptc_format_equals (PTC_FORMAT object, PTC_FORMAT format)

void ptc_clipper_clip (PTC_AREA area, PTC_AREA clip, PTC_AREA clipped)

void ptc_clipper_clip_complex (PTC_AREA source, PTC_AREA clip_source, PTC_AREA clipped_source, PTC_AREA destination, PTC_AREA clip_destination, PTC_AREA clipped_destination)

PTC_PALETTE ptc_palette_create ()

PTC_PALETTE ptc_palette_create_data (int32 * data)

void ptc_palette_destroy (PTC_PALETTE object)

int32 * ptc_palette_lock (PTC_PALETTE object)

void ptc_palette_unlock (PTC_PALETTE object)

void ptc_palette_load (PTC_PALETTE object, int32 * data)

void ptc_palette_save (PTC_PALETTE object, int32 * data)

int32 * ptc_palette_data (PTC_PALETTE object)

void ptc_palette_assign (PTC_PALETTE object, PTC_PALETTE palette)

int ptc_palette_equals (PTC_PALETTE object, PTC_PALETTE palette)

PTC_SURFACE ptc_surface_create (int width, int height, PTC_FORMAT format)

void ptc_surface_destroy (PTC_SURFACE object)

void ptc_surface_copy (PTC_SURFACE object, PTC_SURFACE surface)

void ptc_surface_copy_area (PTC_SURFACE object, PTC_SURFACE surface, PTC_AREA source, PTC_AREA destination)

void * ptc_surface_lock (PTC_SURFACE object)

void ptc_surface_unlock (PTC_SURFACE object)

void ptc_surface_load (PTC_SURFACE object, void * pixels, int width, int height, int pitch, PTC_FORMAT format, PTC_PALETTE palette)

void ptc_surface_load_area (PTC_SURFACE object, void * pixels, int width, int height, int pitch, PTC_FORMAT format, PTC_PALETTE palette, PTC_AREA source, PTC_AREA destination)

void ptc_surface_save (PTC_SURFACE object, void * pixels, int width, int height, int pitch, PTC_FORMAT format, PTC_PALETTE palette)

void ptc_surface_save_area (PTC_SURFACE object, void * pixels, int width, int height, int pitch, PTC_FORMAT format, PTC_PALETTE palette, PTC_AREA source, PTC_AREA destination)

void ptc_surface_clear (PTC_SURFACE object)

void ptc_surface_clear_color (PTC_SURFACE object, PTC_COLOR color)

void ptc_surface_clear_color_area (PTC_SURFACE object, PTC_COLOR color, PTC_AREA area)

void ptc_surface_palette_set (PTC_SURFACE object, PTC_PALETTE palette)

PTC_PALETTE ptc_surface_palette_get (PTC_SURFACE object)

void ptc_surface_clip_set (PTC_SURFACE object, PTC_AREA area)

int ptc_surface_width (PTC_SURFACE object)

int ptc_surface_height (PTC_SURFACE object)

int ptc_surface_pitch (PTC_SURFACE object)

PTC_AREA ptc_surface_area (PTC_SURFACE object)

PTC_AREA ptc_surface_clip (PTC_SURFACE object)

PTC_FORMAT ptc_surface_format (PTC_SURFACE object)

int ptc_surface_option (PTC_SURFACE object, char * option)

PTC_CONSOLE ptc_console_create ()

void ptc_console_destroy (PTC_CONSOLE object)

void ptc_console_configure (PTC_CONSOLE object, char * file)

int ptc_console_option (PTC_CONSOLE object, char * option)

PTC_MODE ptc_console_mode (PTC_CONSOLE object, int index)

void ptc_console_open (PTC_CONSOLE object, char * title, int pages)

void ptc_console_open_format (PTC_CONSOLE object, char * title, PTC_FORMAT format, int pages)

void ptc_console_open_resolution (PTC_CONSOLE object, char * title, int width, int height, PTC_FORMAT format, int pages)

void ptc_console_open_mode (PTC_CONSOLE object, char * title, PTC_MODE mode, int pages)

void ptc_console_close (PTC_CONSOLE object)

void ptc_console_flush (PTC_CONSOLE object)

void ptc_console_finish (PTC_CONSOLE object)

void ptc_console_update (PTC_CONSOLE object)

void ptc_console_update_area (PTC_CONSOLE object, PTC_AREA area)

int ptc_console_key (PTC_CONSOLE object)

void ptc_console_read (PTC_CONSOLE object, PTC_KEY key)

void ptc_console_copy (PTC_CONSOLE object, PTC_SURFACE surface)

void ptc_console_copy_area (PTC_CONSOLE object, PTC_SURFACE surface, PTC_AREA source, PTC_AREA destination)

void * ptc_console_lock (PTC_CONSOLE object)

void ptc_console_unlock (PTC_CONSOLE object)

void ptc_console_load (PTC_CONSOLE object, void * pixels, int width, int height, int pitch, PTC_FORMAT format, PTC_PALETTE palette)

void ptc_console_load_area (PTC_CONSOLE object, void * pixels, int width, int height, int pitch, PTC_FORMAT format, PTC_PALETTE palette, PTC_AREA source, PTC_AREA destination)

void ptc_console_save (PTC_CONSOLE object, void * pixels, int width, int height, int pitch, PTC_FORMAT format, PTC_PALETTE palette)

void ptc_console_save_area (PTC_CONSOLE object, void * pixels, int width, int height, int pitch, PTC_FORMAT format, PTC_PALETTE palette, PTC_AREA source, PTC_AREA destination)

void ptc_console_clear (PTC_CONSOLE object)

void ptc_console_clear_color (PTC_CONSOLE object, PTC_COLOR color)

void ptc_console_clear_color_area (PTC_CONSOLE object, PTC_COLOR color, PTC_AREA area)

void ptc_console_palette_set (PTC_CONSOLE object, PTC_PALETTE palette)

PTC_PALETTE ptc_console_palette_get (PTC_CONSOLE object)

void ptc_console_clip_set (PTC_CONSOLE object, PTC_AREA area)

int ptc_console_width (PTC_CONSOLE object)

int ptc_console_height (PTC_CONSOLE object)

int ptc_console_pages (PTC_CONSOLE object)

int ptc_console_pitch (PTC_CONSOLE object)

PTC_AREA ptc_console_area (PTC_CONSOLE object)

PTC_AREA ptc_console_clip (PTC_CONSOLE object)

PTC_FORMAT ptc_console_format (PTC_CONSOLE object)

char * ptc_console_name (PTC_CONSOLE object)

char * ptc_console_title (PTC_CONSOLE object)

char * ptc_console_information (PTC_CONSOLE object)