kos_img Struct Reference

Platform-indpendent image type. More...

#include <kos/img.h>

Data Fields
void *	data
	Image data in the specified format. More...
uint32	w
	Width of the image. More...
uint32	h
	Height of the image. More...
uint32	fmt
	Format of the image data. More...
uint32	byte_count
	Length of the image data, in bytes. More...

Detailed Description

Platform-indpendent image type.

You can use this type for textures or whatever you feel it's appropriate for. "width" and "height" are as you would expect. "format" has a lower-half which is platform-independent and used to basically describe the contained data; the upper-half is platform-dependent and can hold anything (so AND it off if you only want the bottom part).

Note that in some of the more obscure formats (like the paletted formats) the data interpretation may be platform dependent. Thus we also provide a data length field.

Field Documentation

uint32 kos_img::byte_count

Length of the image data, in bytes.

void* kos_img::data

Image data in the specified format.

uint32 kos_img::fmt

Format of the image data.

See also

Image format types

Macros for accessing the format of an image

uint32 kos_img::h

Height of the image.

uint32 kos_img::w

Width of the image.

---

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

• addons/include/kos/img.h