Descriptor of an LCD drawing surface or hardware framebuffer. More...

#include <common.h>

Data Fields
char	magic [2]
	Header magic.

short	width
	Width of the framebuffer.

short	height
	Height of the framebuffer.

short	depth
	Depth of the color in bits.

short	xsize
	Pixel row size in bytes (aka. pitch if you know SDL).

short	encoding
	Pixel buffer encoding.

int *	palette
	Palette used to pack RGBA color into pixels.

void *	buffer
	The actual framebuffer/surface pixel buffer region.

Detailed Description

Descriptor of an LCD drawing surface or hardware framebuffer.

This contains format description of the pixel/framebuffer and a pointer to the actual buffer.

Field Documentation

void* lcd_surface_s::buffer

The actual framebuffer/surface pixel buffer region.

The actual format varies and depends on the parameters provided above.

short lcd_surface_s::depth

Depth of the color in bits.

short lcd_surface_s::encoding

Pixel buffer encoding.

char lcd_surface_s::magic[2]

Header magic.

Always "PX" without NUL.

int* lcd_surface_s::palette

Palette used to pack RGBA color into pixels.

Only make sense when using indexed color. It should be NULL otherwise.

short lcd_surface_s::xsize

Pixel row size in bytes (aka. pitch if you know SDL).

This is usually 4-bytes aligned.

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