Deki::Texture2D Class Reference

#include <deki/assets/Texture2D.h>

Classes
struct	Header
	Header of a texture file. The file is [Header][pixel data][metadata]. More...

Public Types
enum class	TextureFormat : uint32_t {   RGB888 = 0 , RGBA8888 = 1 , RGB565 = 2 , RGB565A8 = 3 ,   ALPHA8 = 4 }

Public Member Functions
	Texture2D ()
virtual	~Texture2D ()

Static Public Member Functions
static Texture2D *	Load (const char *filePath)
	Loads a compiled texture file (.tex), or returns nullptr.
static uint32_t	GetBytesPerPixel (TextureFormat format)
static const char *	GetFormatName (TextureFormat format)
	The format's name, for logs.
static bool	ValidateHeader (const Texture2D::Header &header)
	True when the header is well formed.
static uint8_t *	LoadAsRGBA (const char *filePath, int32_t &outWidth, int32_t &outHeight, bool &outHasAlpha)
	Loads a .tex file as RGBA8888 pixels (editor).
static uint8_t *	ConvertToRGBA (const uint8_t *srcData, int32_t width, int32_t height, TextureFormat format)
	Converts pixels in format to RGBA8888.

Public Attributes
uint8_t *	data
int32_t	width
int32_t	height
TextureFormat	format
bool	hasTransparency
bool	hasAlpha
Deki::Buffer< int16_t >	alphaRowSpans
bool	allocatedWithBackend

Protected Member Functions
virtual bool	LoadFromMemory (const Texture2D::Header &header, const uint8_t *data)
	Fills the texture from data, the file's bytes after header.

Member Enumeration Documentation

TextureFormat

enum class Deki::Texture2D::TextureFormat : uint32_t

strong

Enumerator
RGB888
RGBA8888
RGB565
RGB565A8
ALPHA8

Constructor & Destructor Documentation

Texture2D()

Deki::Texture2D::Texture2D

(

)

~Texture2D()

virtual Deki::Texture2D::~Texture2D ( )

virtual

Member Function Documentation

Load()

Texture2D * Deki::Texture2D::Load ( const char * filePath )

static

Loads a compiled texture file (.tex), or returns nullptr.

GetBytesPerPixel()

uint32_t Deki::Texture2D::GetBytesPerPixel ( TextureFormat format )

static

GetFormatName()

const char * Deki::Texture2D::GetFormatName ( TextureFormat format )

static

The format's name, for logs.

ValidateHeader()

bool Deki::Texture2D::ValidateHeader ( const Texture2D::Header & header )

static

True when the header is well formed.

LoadAsRGBA()

uint8_t * Deki::Texture2D::LoadAsRGBA ( const char * filePath, int32_t & outWidth, int32_t & outHeight, bool & outHasAlpha )

static

Loads a .tex file as RGBA8888 pixels (editor).

The caller owns the result and frees it with delete[]; nullptr on failure.

ConvertToRGBA()

uint8_t * Deki::Texture2D::ConvertToRGBA ( const uint8_t * srcData, int32_t width, int32_t height, TextureFormat format )

static

Converts pixels in format to RGBA8888.

The caller owns the result and frees it with delete[]; nullptr on failure.

LoadFromMemory()

virtual bool Deki::Texture2D::LoadFromMemory ( const Texture2D::Header & header, const uint8_t * data )

protectedvirtual

Fills the texture from data, the file's bytes after header.

Returns false on failure.

Member Data Documentation

data

uint8_t* Deki::Texture2D::data

width

int32_t Deki::Texture2D::width

height

int32_t Deki::Texture2D::height

format

TextureFormat Deki::Texture2D::format

hasTransparency

bool Deki::Texture2D::hasTransparency

hasAlpha

bool Deki::Texture2D::hasAlpha

alphaRowSpans

Deki::Buffer<int16_t> Deki::Texture2D::alphaRowSpans

allocatedWithBackend

bool Deki::Texture2D::allocatedWithBackend

---

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

• deki-engine/include/deki/assets/Texture2D.h