GATE
Classes | Macros | Typedefs | Functions
framebuffers.h File Reference
GATE Graphics Library

Framebuffer interfaces. More...

#include "gate/graphics/gate_graphics_api.h"
#include "gate/graphics/colors.h"
#include "gate/graphics/images.h"
#include "gate/objects.h"
#include "gate/properties.h"
#include "gate/inputs.h"

Classes

struct  gate_framebuffer_info_class
 
struct  gate_framebuffer_key_event_class
 
struct  gate_framebuffer_pointer_event_class
 
struct  gate_framebuffer_event_class
 

Macros

#define GATE_INTERFACE_NAME_FRAMEBUFFER   GATE_INTERFACE_NAME_OBJECT GATE_INTERFACE_NAME_SEPARATOR "framebuffer"
 
#define GATE_FRAMEBUFFER_EVENT_NONE   0x00
 
#define GATE_FRAMEBUFFER_EVENT_CANCEL   0x01
 
#define GATE_FRAMEBUFFER_EVENT_QUIT   0x02
 
#define GATE_FRAMEBUFFER_EVENT_IDLE   0x03
 
#define GATE_FRAMEBUFFER_EVENT_KEY_DOWN   0x11
 
#define GATE_FRAMEBUFFER_EVENT_KEY_UP   0x12
 
#define GATE_FRAMEBUFFER_EVENT_KEY_PRESS   0x13
 
#define GATE_FRAMEBUFFER_EVENT_POINTER_BUTTON_DOWN   0x21
 
#define GATE_FRAMEBUFFER_EVENT_POINTER_BUTTON_UP   0x22
 
#define GATE_FRAMEBUFFER_EVENT_POINTER_MOVE   0x23
 
#define GATE_FRAMEBUFFER_BUTTON_1   1
 
#define GATE_FRAMEBUFFER_BUTTON_2   2
 
#define GATE_FRAMEBUFFER_BUTTON_3   3
 
#define gate_framebuffer_get_info(objptr, ptr_info)   (objptr)->vtbl->get_info((objptr), (ptr_info))
 
#define gate_framebuffer_get_property(objptr, name, ptr_prop)   (objptr)->vtbl->get_property((objptr), (name), (ptr_prop))
 
#define gate_framebuffer_set_property(objptr, name, ptr_prop)   (objptr)->vtbl->set_property((objptr), (name), (ptr_prop))
 
#define gate_framebuffer_update(objptr)   (objptr)->vtbl->update((objptr))
 
#define gate_framebuffer_get_pixel(objptr, x, y, ptr_col)   (objptr)->vtbl->get_pixel((objptr), (x), (y), (ptr_col))
 
#define gate_framebuffer_set_pixel(objptr, x, y, col)   (objptr)->vtbl->set_pixel((objptr), (x), (y), (col))
 
#define gate_framebuffer_get_image(objptr, x, y, width, height, ptr_image)   (objptr)->vtbl->get_image((objptr), (x), (y), (width), (height), (ptr_image))
 
#define gate_framebuffer_set_image(objptr, ptr_image, x, y)   (objptr)->vtbl->set_image((objptr), (ptr_image), (x), (y))
 
#define gate_framebuffer_await_event(objptr, timeout_ms, ptr_evt)   (objptr)->vtbl->await_event((objptr), (timeout_ms), (ptr_evt))
 

Typedefs

typedef struct gate_framebuffer_info_class gate_framebuffer_info_t
 
typedef struct gate_framebuffer_key_event_class gate_framebuffer_key_event_t
 
typedef struct gate_framebuffer_pointer_event_class gate_framebuffer_pointer_event_t
 
typedef struct gate_framebuffer_event_class gate_framebuffer_event_t
 

Functions

 GATE_INTERFACE (gate_framebuffer)
 
GATE_GRAPHICS_API gate_result_t gate_framebuffer_create_image (gate_uint32_t width, gate_uint32_t height, gate_framebuffer_t **ptr_framebuffer)
 
GATE_GRAPHICS_API gate_size_t gate_framebuffer_enum_displays (gate_framebuffer_info_t *ptr_infos, gate_size_t infos_capacity)
 
GATE_GRAPHICS_API gate_result_t gate_framebuffer_open_display (gate_framebuffer_info_t const *ptr_infos, gate_framebuffer_t **ptr_framebuffer)
 

Detailed Description

Framebuffer interfaces.