Ultibo API
C/C++ API for Ultibo Core
Loading...
Searching...
No Matches
_FRAMEBUFFER_DEVICE Struct Reference

#include <framebuffer.h>

Data Fields

DEVICE device
 The Device entry for this Framebuffer device.
uint32_t framebufferid
 Unique Id of this Framebuffer device in the Framebuffer device table.
uint32_t framebufferstate
 Framebuffer device state (eg FRAMEBUFFER_STATE_ENABLED).
framebuffer_device_allocate_proc deviceallocate
 A device specific DeviceAllocate method implementing a standard framebuffer device interface (Mandatory).
framebuffer_device_release_proc devicerelease
 A device specific DeviceRelease method implementing a standard framebuffer device interface (Mandatory).
framebuffer_device_blank_proc deviceblank
 A device specific DeviceBlank method implementing a standard framebuffer device interface (Optional).
framebuffer_device_read_proc deviceread
 A device specific DeviceRead method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_write_proc devicewrite
 A device specific DeviceWrite method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_mark_proc devicemark
 A device specific DeviceMark method implementing a standard framebuffer device interface (Optional).
framebuffer_device_commit_proc devicecommit
 A device specific DeviceCommit method implementing a standard framebuffer device interface (Optional).
framebuffer_device_get_rect_proc devicegetrect
 A device specific DeviceGetRect method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_put_rect_proc deviceputrect
 A device specific DevicePutRect method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_copy_rect_proc devicecopyrect
 A device specific DeviceCopyRect method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_fill_rect_proc devicefillrect
 A device specific DeviceFillRect method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_get_line_proc devicegetline
 A device specific DeviceGetLine method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_get_point_proc devicegetpoint
 A device specific DeviceGetPoint method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_wait_sync_proc devicewaitsync
 A device specific DeviceWaitSync method implementing a standard framebuffer device interface (Optional).
framebuffer_device_get_offset_proc devicegetoffset
 A device specific DeviceGetOffset method implementing a standard framebuffer device interface (Optional).
framebuffer_device_set_offset_proc devicesetoffset
 A device specific DeviceSetOffset method implementing a standard framebuffer device interface (Optional).
framebuffer_device_set_offset_ex_proc devicesetoffsetex
 A device specific DeviceSetOffsetEx method implementing a standard framebuffer device interface (Optional).
framebuffer_device_get_palette_proc devicegetpalette
 A device specific DeviceGetPalette method implementing a standard framebuffer device interface (Optional).
framebuffer_device_set_palette_proc devicesetpalette
 A device specific DeviceSetPalette method implementing a standard framebuffer device interface (Optional).
framebuffer_device_set_backlight_proc devicesetbacklight
 A device specific DeviceSetBacklight method implementing a standard framebuffer device interface (Optional).
framebuffer_device_set_cursor_proc devicesetcursor
 A device specific DeviceSetCursor method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_update_cursor_proc deviceupdatecursor
 A device specific DeviceUpdateCursor method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_get_properties_proc devicegetproperties
 A device specific DeviceGetProperties method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
framebuffer_device_set_properties_proc devicesetproperties
 A device specific DeviceSetProperties method implementing a standard framebuffer device interface (Or nil if the default method is suitable).
uint32_t allocatecount
uint32_t releasecount
uint32_t readcount
uint32_t writecount
uint32_t getcount
uint32_t putcount
uint32_t copycount
uint32_t fillcount
MUTEX_HANDLE lock
 Device lock.
size_t address
 Framebuffer address.
uint32_t size
 Framebuffer size (Bytes).
uint32_t pitch
 Framebuffer pitch (Bytes per Line).
uint32_t depth
 Framebuffer depth (Bits per Pixel)(8/16/24/32).
uint32_t order
 Framebuffer pixel order (BGR/RGB).
uint32_t mode
 Framebuffer alpha mode (Enabled/Reversed/Ignored).
uint32_t format
 Framebuffer color format (eg COLOR_FORMAT_ARGB32).
uint32_t physicalwidth
 Framebuffer Physical Width (Pixels).
uint32_t physicalheight
 Framebuffer Physical Height (Pixels).
uint32_t virtualwidth
 Framebuffer Virtual Width (Pixels).
uint32_t virtualheight
 Framebuffer Virtual Height (Pixels).
uint32_t offsetx
 Framebuffer Virtual Offset X (Pixels).
uint32_t offsety
 Framebuffer Virtual Offset Y (Pixels).
uint32_t overscantop
 Framebuffer Overscan Top (Pixels).
uint32_t overscanbottom
 Framebuffer Overscan Bottom (Pixels).
uint32_t overscanleft
 Framebuffer Overscan Left (Pixels).
uint32_t overscanright
 Framebuffer Overscan Right (Pixels).
uint32_t rotation
 Framebuffer Rotation (eg FRAMEBUFFER_ROTATION_180).
uint32_t cursorx
 Framebuffer Cursor X (Pixels).
uint32_t cursory
 Framebuffer Cursor Y (Pixels).
uint32_t cursorstate
 Framebuffer Cursor State (eg FRAMEBUFFER_CURSOR_ENABLED).
void * linebuffer
 Buffer for line fills.
void * copybuffer
 Buffer for overlapped copy.
LONGBOOL cursorupdate
 Flag to indicate if cursor update (Show/Hide) is in progress.
void * cursorimage
 Buffer for cursor image pixels (COLOR_FORMAT_DEFAULT).
void * cursorinput
 Buffer for cursor image pixels (Native color format).
void * cursorbuffer
 Buffer for pixels currently under cursor (Native color format).
void * cursoroutput
 Buffer for cursor pixels currently displayed (Native color format).
uint32_t cursorwidth
 Framebuffer Cursor Width (Pixels).
uint32_t cursorheight
 Framebuffer Cursor Height (Pixels).
uint32_t cursorhotspotx
 Framebuffer Cursor Hotspot X (Pixels).
uint32_t cursorhotspoty
 Framebuffer Cursor Hotspot Y (Pixels).
FRAMEBUFFER_DEVICEprev
 Previous entry in Framebuffer device table.
FRAMEBUFFER_DEVICEnext
 Next entry in Framebuffer device table.

Detailed Description

Framebuffer Device

Field Documentation

◆ device

DEVICE device

The Device entry for this Framebuffer device.

◆ framebufferid

uint32_t framebufferid

Unique Id of this Framebuffer device in the Framebuffer device table.

◆ framebufferstate

uint32_t framebufferstate

Framebuffer device state (eg FRAMEBUFFER_STATE_ENABLED).

◆ deviceallocate

A device specific DeviceAllocate method implementing a standard framebuffer device interface (Mandatory).

◆ devicerelease

A device specific DeviceRelease method implementing a standard framebuffer device interface (Mandatory).

◆ deviceblank

A device specific DeviceBlank method implementing a standard framebuffer device interface (Optional).

◆ deviceread

A device specific DeviceRead method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ devicewrite

A device specific DeviceWrite method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ devicemark

A device specific DeviceMark method implementing a standard framebuffer device interface (Optional).

◆ devicecommit

A device specific DeviceCommit method implementing a standard framebuffer device interface (Optional).

◆ devicegetrect

A device specific DeviceGetRect method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ deviceputrect

A device specific DevicePutRect method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ devicecopyrect

A device specific DeviceCopyRect method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ devicefillrect

A device specific DeviceFillRect method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ devicegetline

A device specific DeviceGetLine method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ devicegetpoint

A device specific DeviceGetPoint method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ devicewaitsync

A device specific DeviceWaitSync method implementing a standard framebuffer device interface (Optional).

◆ devicegetoffset

A device specific DeviceGetOffset method implementing a standard framebuffer device interface (Optional).

◆ devicesetoffset

A device specific DeviceSetOffset method implementing a standard framebuffer device interface (Optional).

◆ devicesetoffsetex

A device specific DeviceSetOffsetEx method implementing a standard framebuffer device interface (Optional).

◆ devicegetpalette

A device specific DeviceGetPalette method implementing a standard framebuffer device interface (Optional).

◆ devicesetpalette

A device specific DeviceSetPalette method implementing a standard framebuffer device interface (Optional).

◆ devicesetbacklight

A device specific DeviceSetBacklight method implementing a standard framebuffer device interface (Optional).

◆ devicesetcursor

A device specific DeviceSetCursor method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ deviceupdatecursor

A device specific DeviceUpdateCursor method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ devicegetproperties

A device specific DeviceGetProperties method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ devicesetproperties

A device specific DeviceSetProperties method implementing a standard framebuffer device interface (Or nil if the default method is suitable).

◆ allocatecount

uint32_t allocatecount

◆ releasecount

uint32_t releasecount

◆ readcount

uint32_t readcount

◆ writecount

uint32_t writecount

◆ getcount

uint32_t getcount

◆ putcount

uint32_t putcount

◆ copycount

uint32_t copycount

◆ fillcount

uint32_t fillcount

◆ lock

Device lock.

◆ address

size_t address

Framebuffer address.

◆ size

uint32_t size

Framebuffer size (Bytes).

◆ pitch

uint32_t pitch

Framebuffer pitch (Bytes per Line).

◆ depth

uint32_t depth

Framebuffer depth (Bits per Pixel)(8/16/24/32).

◆ order

uint32_t order

Framebuffer pixel order (BGR/RGB).

◆ mode

uint32_t mode

Framebuffer alpha mode (Enabled/Reversed/Ignored).

◆ format

uint32_t format

Framebuffer color format (eg COLOR_FORMAT_ARGB32).

◆ physicalwidth

uint32_t physicalwidth

Framebuffer Physical Width (Pixels).

◆ physicalheight

uint32_t physicalheight

Framebuffer Physical Height (Pixels).

◆ virtualwidth

uint32_t virtualwidth

Framebuffer Virtual Width (Pixels).

◆ virtualheight

uint32_t virtualheight

Framebuffer Virtual Height (Pixels).

◆ offsetx

uint32_t offsetx

Framebuffer Virtual Offset X (Pixels).

◆ offsety

uint32_t offsety

Framebuffer Virtual Offset Y (Pixels).

◆ overscantop

uint32_t overscantop

Framebuffer Overscan Top (Pixels).

◆ overscanbottom

uint32_t overscanbottom

Framebuffer Overscan Bottom (Pixels).

◆ overscanleft

uint32_t overscanleft

Framebuffer Overscan Left (Pixels).

◆ overscanright

uint32_t overscanright

Framebuffer Overscan Right (Pixels).

◆ rotation

uint32_t rotation

Framebuffer Rotation (eg FRAMEBUFFER_ROTATION_180).

◆ cursorx

uint32_t cursorx

Framebuffer Cursor X (Pixels).

◆ cursory

uint32_t cursory

Framebuffer Cursor Y (Pixels).

◆ cursorstate

uint32_t cursorstate

Framebuffer Cursor State (eg FRAMEBUFFER_CURSOR_ENABLED).

◆ linebuffer

void* linebuffer

Buffer for line fills.

◆ copybuffer

void* copybuffer

Buffer for overlapped copy.

◆ cursorupdate

LONGBOOL cursorupdate

Flag to indicate if cursor update (Show/Hide) is in progress.

◆ cursorimage

void* cursorimage

Buffer for cursor image pixels (COLOR_FORMAT_DEFAULT).

◆ cursorinput

void* cursorinput

Buffer for cursor image pixels (Native color format).

◆ cursorbuffer

void* cursorbuffer

Buffer for pixels currently under cursor (Native color format).

◆ cursoroutput

void* cursoroutput

Buffer for cursor pixels currently displayed (Native color format).

◆ cursorwidth

uint32_t cursorwidth

Framebuffer Cursor Width (Pixels).

◆ cursorheight

uint32_t cursorheight

Framebuffer Cursor Height (Pixels).

◆ cursorhotspotx

uint32_t cursorhotspotx

Framebuffer Cursor Hotspot X (Pixels).

◆ cursorhotspoty

uint32_t cursorhotspoty

Framebuffer Cursor Hotspot Y (Pixels).

◆ prev

Previous entry in Framebuffer device table.

◆ next

Next entry in Framebuffer device table.


The documentation for this struct was generated from the following file: