IRES TILEDMEMORY Protocol (Beta)

Defines
#define	IRES_TILEDMEMORY_PROTOCOLNAME   "ti.sdo.fc.ires.tiledmemory"
	Name used to describe this protocol.
#define	TILEDMEMORY_MODNAME   "ti.sdo.fc.ires.tiledmemory"
	Name to pass to Diags_setMask() to enable logging for TILEDMEMORY functions. For example, Diags_setMask(TILEDMEMORY_MODNAME"+EX1234567"); turns on all Log statements in this module. Diags_setMask() must be called after initialization to take effect.
Data Structures
struct	IRES_TILEDMEMORY_ProtocolArgs
	TILEDMEMORY Protocol Arguments definition. More...
struct	IRES_TILEDMEMORY_Obj
	IRES_TILEDMEMORY_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource. More...
struct	IRES_TILEDMEMORY_RegisterLayer
	TILEDMEMORY Register Layout. More...
struct	IRES_TILEDMEMORY_Properties
	Static Resource Properties. More...
Typedefs
typedef struct IRES_TILEDMEMORY_Obj *	IRES_TILEDMEMORY_Handle
	Handle to "logical" resource.
typedef enum IRES_TILEDMEMORY_AccessDimension	IRES_TILEDMEMORY_AccessDimension
	Indicates whether requested/granted memory is of type 1D or 2D.
typedef enum IRES_TILEDMEMORY_AccessUnit	IRES_TILEDMEMORY_AccessUnit
	Indicates the size of the Tiler elements requested by the codec.
typedef struct IRES_TILEDMEMORY_ProtocolArgs	IRES_TILEDMEMORY_ProtocolArgs
	TILEDMEMORY Protocol Arguments definition.
typedef struct IRES_TILEDMEMORY_Obj	IRES_TILEDMEMORY_Obj
	IRES_TILEDMEMORY_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource.
typedef struct IRES_TILEDMEMORY_RegisterLayer	IRES_TILEDMEMORY_RegisterLayer
	TILEDMEMORY Register Layout.
typedef struct IRES_TILEDMEMORY_Properties	IRES_TILEDMEMORY_Properties
	Static Resource Properties.
Enumerations
enum	IRES_TILEDMEMORY_AccessDimension {   IRES_TILEDMEMORY_1D = 0,   IRES_TILEDMEMORY_2D = 1 }
	Indicates whether requested/granted memory is of type 1D or 2D. More...
enum	IRES_TILEDMEMORY_AccessUnit {   IRES_TILEDMEMORY_RAW = 0,   IRES_TILEDMEMORY_PAGE = 1,   IRES_TILEDMEMORY_8BIT = 2,   IRES_TILEDMEMORY_16BIT = 3,   IRES_TILEDMEMORY_32BIT = 4 }
	Indicates the size of the Tiler elements requested by the codec. More...

---

Detailed Description

Allows algorithms to request and receive handles representing TILEDMEMORY resources.

---

Define Documentation

#define IRES_TILEDMEMORY_PROTOCOLNAME   "ti.sdo.fc.ires.tiledmemory"

Name used to describe this protocol.

#define TILEDMEMORY_MODNAME   "ti.sdo.fc.ires.tiledmemory"

Name to pass to Diags_setMask() to enable logging for TILEDMEMORY functions. For example, Diags_setMask(TILEDMEMORY_MODNAME"+EX1234567"); turns on all Log statements in this module. Diags_setMask() must be called after initialization to take effect.

---

Typedef Documentation

typedef struct IRES_TILEDMEMORY_Obj* IRES_TILEDMEMORY_Handle

Handle to "logical" resource.

typedef enum IRES_TILEDMEMORY_AccessDimension IRES_TILEDMEMORY_AccessDimension

Indicates whether requested/granted memory is of type 1D or 2D.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

typedef enum IRES_TILEDMEMORY_AccessUnit IRES_TILEDMEMORY_AccessUnit

Indicates the size of the Tiler elements requested by the codec.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

typedef struct IRES_TILEDMEMORY_ProtocolArgs IRES_TILEDMEMORY_ProtocolArgs

TILEDMEMORY Protocol Arguments definition.

typedef struct IRES_TILEDMEMORY_Obj IRES_TILEDMEMORY_Obj

IRES_TILEDMEMORY_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource.

typedef struct IRES_TILEDMEMORY_RegisterLayer IRES_TILEDMEMORY_RegisterLayer

TILEDMEMORY Register Layout.

typedef struct IRES_TILEDMEMORY_Properties IRES_TILEDMEMORY_Properties

Static Resource Properties.

---

Enumeration Type Documentation

enum IRES_TILEDMEMORY_AccessDimension

Indicates whether requested/granted memory is of type 1D or 2D.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

Enumerator:

IRES_TILEDMEMORY_1D
IRES_TILEDMEMORY_2D

enum IRES_TILEDMEMORY_AccessUnit

Indicates the size of the Tiler elements requested by the codec.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

Enumerator:

IRES_TILEDMEMORY_RAW	Contiguously allocated non-TILED memory
IRES_TILEDMEMORY_PAGE	PAGE TILED memory
IRES_TILEDMEMORY_8BIT	8BIT TILED memory
IRES_TILEDMEMORY_16BIT	16BIT TILED memory
IRES_TILEDMEMORY_32BIT	32BIT TILED memory