xcb_image_t Struct Reference
[XCB Image Functions]

A structure that describes an xcb_image_t. More...

Data Fields
uint16_t	width
	Width in pixels, excluding pads etc.
uint16_t	height
	Height in pixels.
xcb_image_format_t	format
	Format.
uint8_t	scanline_pad
	Right pad in bits.
uint8_t	depth
	Depth in bits.
uint8_t	bpp
	Storage per pixel in bits.
uint8_t	unit
	Scanline unit in bits for xy formats and for bpp == 1, in which case valid scanline units are 8, 16, 32.
uint32_t	plane_mask
	When format is xy-pixmap and depth > 1, this says which planes are "valid" in some vague sense.
xcb_image_order_t	byte_order
	Component byte order for z-pixmap, byte order of scanline unit for xy-bitmap and xy-pixmap.
xcb_image_order_t	bit_order
	Bit order of scanline unit for xy-bitmap and xy-pixmap.
uint32_t	stride
	Bytes per image row.
uint32_t	size
	Size of image data in bytes.
void *	base
	Malloced block of storage that will be freed by xcb_image_destroy() if non-null.
uint8_t *	data
	The actual image.

---

Detailed Description

A structure that describes an xcb_image_t.

---

Field Documentation

uint16_t xcb_image_t::width

Width in pixels, excluding pads etc.

Referenced by xcb_image_annotate(), xcb_image_convert(), xcb_image_create(), xcb_image_native(), xcb_image_put(), xcb_image_put_pixel(), xcb_image_shm_get(), xcb_image_shm_put(), and xcb_image_subimage().

uint16_t xcb_image_t::height

Height in pixels.

Referenced by xcb_image_annotate(), xcb_image_convert(), xcb_image_create(), xcb_image_get(), xcb_image_get_pixel(), xcb_image_native(), xcb_image_put(), xcb_image_put_pixel(), xcb_image_shm_get(), xcb_image_shm_put(), and xcb_image_subimage().

xcb_image_format_t xcb_image_t::format

Format.

Referenced by xcb_create_pixmap_from_bitmap_data(), xcb_image_annotate(), xcb_image_convert(), xcb_image_create(), xcb_image_get_pixel(), xcb_image_native(), xcb_image_put(), xcb_image_put_pixel(), xcb_image_shm_get(), xcb_image_shm_put(), and xcb_image_subimage().

uint8_t xcb_image_t::scanline_pad

Right pad in bits.

Valid pads are 8, 16, 32.

Referenced by xcb_image_annotate(), xcb_image_convert(), xcb_image_create(), xcb_image_native(), and xcb_image_subimage().

uint8_t xcb_image_t::depth

Depth in bits.

Valid depths are 1, 4, 8, 16, 24 for z format, 1 for xy-bitmap-format, anything for xy-pixmap-format.

Referenced by xcb_image_annotate(), xcb_image_convert(), xcb_image_create(), xcb_image_native(), xcb_image_put(), xcb_image_shm_put(), and xcb_image_subimage().

uint8_t xcb_image_t::bpp

Storage per pixel in bits.

Must be >= depth. Valid bpp are 1, 4, 8, 16, 24, 32 for z format, 1 for xy-bitmap format, anything for xy-pixmap-format.

Referenced by xcb_image_annotate(), xcb_image_convert(), xcb_image_create(), xcb_image_get_pixel(), xcb_image_native(), xcb_image_put_pixel(), and xcb_image_subimage().

uint8_t xcb_image_t::unit

Scanline unit in bits for xy formats and for bpp == 1, in which case valid scanline units are 8, 16, 32.

Otherwise, will be max(8, bpp). Must be >= bpp.

Referenced by xcb_image_convert(), xcb_image_create(), xcb_image_native(), and xcb_image_subimage().

uint32_t xcb_image_t::plane_mask

When format is xy-pixmap and depth > 1, this says which planes are "valid" in some vague sense.

Currently used only by xcb_image_get/put_pixel(), and set only by xcb_image_get().

Referenced by xcb_image_create(), xcb_image_get(), xcb_image_get_pixel(), and xcb_image_put_pixel().

xcb_image_order_t xcb_image_t::byte_order

Component byte order for z-pixmap, byte order of scanline unit for xy-bitmap and xy-pixmap.

Nybble order for z-pixmap when bpp == 4.

Referenced by xcb_image_convert(), xcb_image_create(), xcb_image_get_pixel(), xcb_image_native(), xcb_image_put_pixel(), and xcb_image_subimage().

uint32_t xcb_image_t::stride

Bytes per image row.

Computable from other data, but cached for convenience/performance.

Referenced by xcb_image_annotate(), xcb_image_convert(), xcb_image_get(), xcb_image_get_pixel(), and xcb_image_put_pixel().

uint32_t xcb_image_t::size

Size of image data in bytes.

Computable from other data, but cached for convenience/performance.

Referenced by xcb_image_annotate(), xcb_image_convert(), xcb_image_create(), xcb_image_get(), and xcb_image_put().

uint8_t* xcb_image_t::data

The actual image.

Referenced by xcb_image_convert(), xcb_image_create(), xcb_image_get(), xcb_image_get_pixel(), xcb_image_put(), xcb_image_put_pixel(), xcb_image_shm_get(), and xcb_image_shm_put().