Base APIs

Files

file umbra_defs.h

Classes

struct UmbraAllocator

User provided memory management interface.

struct UmbraLogger

User provided logging interface.

struct UmbraInputStream

User provided input stream interface.

struct UmbraOutputStream

User provided output stream interface.

struct UmbraHttp

User provided HTTP implementation.

struct UmbraConfig

Opaque Umbra configuration struct.

struct UmbraFloat2

Two floats.

struct UmbraFloat3

Three floats.

struct UmbraFloat3_3

A 3x3 matrix of floats.

struct UmbraFloat3MinMax

A single precision, min-max representation of an axis-aligned bounding box.

struct UmbraFloat4

Four floats.

struct UmbraFloat4_4

A 4x4 matrix of floats.

struct UmbraDouble2

Two doubles.

struct UmbraDouble3

Three doubles.

struct UmbraDouble3_3

A 3x3 matrix of doubles.

struct UmbraDouble3MinMax

A double precision, min-max representation of an axis-aligned bounding box.

struct UmbraDouble4

Four doubles.

struct UmbraDouble4_4

A 4x4 matrix of doubles.

struct UmbraInt2

Two 32-bit integers.

struct UmbraInt3

Three 32-bit integers.

struct UmbraRGBA

Four 8-bit unsigned integer color values.

Enums

enum UmbraLogLevel { UmbraLogLevel_Debug = 0, UmbraLogLevel_Info, UmbraLogLevel_Warning, UmbraLogLevel_Error }

Log levels.

enum UmbraMatrixFormat { UmbraMatrixFormat_ColumnMajor = 0, UmbraMatrixFormat_RowMajor = 1 }

Row or column major matrix format.

enum UmbraTextureType { UmbraTextureType_Diffuse = 0, UmbraTextureType_Normal, UmbraTextureType_Specular, UmbraTextureType_MetaIndex }

Texture type.

enum UmbraTextureFormat { UmbraTextureFormat_RGBA32 = 0, UmbraTextureFormat_RGB24 = 1, UmbraTextureFormat_BC1 = 2, UmbraTextureFormat_BC3 = 3, UmbraTextureFormat_BC4 = 4, UmbraTextureFormat_BC5 = 5, UmbraTextureFormat_ETC1_RGB = 6, UmbraTextureFormat_RGBA_FLOAT32 = 7, UmbraTextureFormat_UNC1 = 8 deprecated, UmbraTextureFormat_JPEG = 9, UmbraTextureFormat_PNG = 10, UmbraTextureFormat_BMP = 11, UmbraTextureFormat_PSD = 12, UmbraTextureFormat_TGA = 13, UmbraTextureFormat_GIF = 14, UmbraTextureFormat_HDR = 15, UmbraTextureFormat_PIC = 16, UmbraTextureFormat_PNM = 17, UmbraTextureFormat_ASTC_4X4 = 18, UmbraTextureFormat_ASTC_5X4 = 19, UmbraTextureFormat_ASTC_5X5 = 20, UmbraTextureFormat_ASTC_6X5 = 21, UmbraTextureFormat_ASTC_6X6 = 22, UmbraTextureFormat_ASTC_8X5 = 23, UmbraTextureFormat_ASTC_8X6 = 24, UmbraTextureFormat_ASTC_10X5 = 25, UmbraTextureFormat_ASTC_10X6 = 26, UmbraTextureFormat_ASTC_8X8 = 27, UmbraTextureFormat_ASTC_10X8 = 28, UmbraTextureFormat_ASTC_10X10 = 29, UmbraTextureFormat_ASTC_12X10 = 30, UmbraTextureFormat_ASTC_12X12 = 31, UmbraTextureFormat_ARGB32 = 32, UmbraTextureFormat_R8 = 33, UmbraTextureFormat_PVRTC1_RGB4 = 34, UmbraTextureFormat_PVRTC1_RGBA4 = 35, UmbraTextureFormat_UINT8 = 36, UmbraTextureFormat_UINT16 = 37, UmbraTextureFormat_UINT32 = 38, UmbraTextureFormat_RGB565 = 39, UmbraTextureFormat_RG8 = 40, UmbraTextureFormat_RG16F = 41, UmbraTextureFormat_OPENEXR = 42, UmbraTextureFormat_RGBA_FLOAT16 = 43, UmbraTextureFormat_RGB_FLOAT16 = 44, UmbraTextureFormat_RGB_FLOAT32 = 45, UmbraTextureFormat_BC6H = 46, UmbraTextureFormat_BC7 = 47 }

Texture format.

enum UmbraColorSpace { UmbraColorSpace_Linear = 0, UmbraColorSpace_SRGB }

Color space enum.

Typedefs

typedef void*(* UmbraAllocateFunc )(void*userData, size_t size, const char*info)

The function pointer type for allocating memory.

typedef void(* UmbraDeallocateFunc )(void*userData, void*ptr)

The function pointer type for deallocating memory.

typedef void(* UmbraLogFunc )(void*userData, UmbraLogLevel level, const char*str)

The function pointer type for logging messages.

typedef uint32_t(* UmbraReadFunc )(void*userData, void*buf, uint32_t numBytes)

The function pointer type for reading streams.

typedef uint32_t(* UmbraWriteFunc )(void*userData, const void*ptr, uint32_t numBytes)

The function pointer type for writing streams.

typedef UmbraHttpRequest(* UmbraHttpCreateRequestFunc )(void*userData, const char*url, UmbraHttpMethod method)

The function pointer type for creating UmbraHttpRequest objects.

typedef void(* UmbraHttpDestroyRequestFunc )(void*userData, UmbraHttpRequest req)

The function pointer type for destroying UmbraHttpRequest objects.

typedef void(* UmbraHttpSetUploadDataFunc )(void*userData, UmbraHttpRequest req, const char data[], uint32_t numBytes)

The function pointer type for setting the request body.

typedef void(* UmbraHttpSetUploadStreamFunc )(void*userData, UmbraHttpRequest req, UmbraInputStream*stream)

The function pointer type for setting the request body stream.

typedef void(* UmbraHttpSetDownloadStreamFunc )(void*userData, UmbraHttpRequest req, UmbraOutputStream*stream)

The function pointer type for setting the response output stream.

typedef void(* UmbraHttpSetHeaderFunc )(void*userData, UmbraHttpRequest req, const char*name, const char*value)

The function pointer type for setting HTTP request headers.

typedef void(* UmbraHttpSetAuthorizationFunc )(void*userData, UmbraHttpRequest req, const char*auth)

The function pointer type for setting HTTP request credentials.

typedef void(* UmbraHttpStartTransferFunc )(void*userData, UmbraHttpRequest req)

The function pointer type for starting an HTTP request.

typedef UmbraTransferStatus(* UmbraHttpReadStatusFunc )(void*userData, UmbraHttpRequest req, UmbraHttpTransferInfo*info)

The function pointer type for querying the status of an HTTP request.

typedef struct UmbraClient UmbraClient

Opaque client object.

typedef int32_t UmbraBool

A boolean type.

Functions

void UmbraConfigInit(UmbraConfig*)

Initialize an UmbraConfig struct with default values.

void UmbraSetAllocator(UmbraConfig* config, const UmbraAllocator* allocator)

Replace the default allocator.

void UmbraSetLogger(UmbraConfig* config, const UmbraLogger* logger, UmbraLogLevel minLevel)

Replace the default logger.

void UmbraSetHttp(UmbraConfig* config, const UmbraHttp* http)

Replace the default HTTP implementation.

UmbraClient* UmbraClientCreate(const char* appName, const UmbraConfig* config)

Create a client object.

void UmbraClientDestroy(UmbraClient* client)

Destroy a client object.

const char* UmbraGetLibraryInfo(UmbraLibraryInfo field)

Get information about Umbra's compile-time configuration.

Enum details

Typedef details

Function details