gmio_amf_document Struct Reference

Provides an interface for accessing the underlying(hidden) user AMF data. More...

Data Fields
const void *	cookie
	Opaque pointer on the user AMF document, passed as first argument to hook functions. More...
enum gmio_amf_unit	unit
uint32_t	object_count
	Number of objects in the document, must be >= 1. More...
uint32_t	material_count
	Number of materials in the document. More...
uint32_t	texture_count
	Number of textures in the document. More...
uint32_t	constellation_count
	Number of constellations in the document. More...
uint32_t	metadata_count
	Number of direct metadata attached to the document. More...
void(*	func_get_document_element )(const void *cookie, enum gmio_amf_document_element element, uint32_t element_index, void *ptr_element)
	Function that retrieves the i-th document sub-element. More...
void(*	func_get_document_element_metadata )(const void *cookie, enum gmio_amf_document_element element, uint32_t element_index, uint32_t metadata_index, struct gmio_amf_metadata *ptr_metadata)
	Optional function that retrieves the i-th metadata assigned to a document sub-element. More...
void(*	func_get_object_mesh )(const void *cookie, uint32_t object_index, uint32_t mesh_index, struct gmio_amf_mesh *ptr_mesh)
	Function that retrieves the i-th mesh within an object element. More...
void(*	func_get_object_mesh_element )(const void *cookie, const struct gmio_amf_object_mesh_element_index *element_index, void *ptr_element)
	Function that retrieves the i-th sub-element of a mesh element. More...
void(*	func_get_object_mesh_element_metadata )(const void *cookie, const struct gmio_amf_object_mesh_element_index *mesh_element_index, uint32_t metadata_index, struct gmio_amf_metadata *ptr_metadata)
	Optional function that retrieves the i-th metadata attached to a mesh element(only vertex or volume) More...
void(*	func_get_object_mesh_volume_triangle )(const void *cookie, const struct gmio_amf_object_mesh_element_index *volume_index, uint32_t triangle_index, struct gmio_amf_triangle *ptr_triangle)
	Function that retrieves the i-th triangle within a mesh volume. More...
void(*	func_get_material_composite )(const void *cookie, uint32_t material_index, uint32_t composite_index, struct gmio_amf_composite *ptr_composite)
	Optional function that retrieves the i-th composite within a material element. More...
void(*	func_get_constellation_instance )(const void *cookie, uint32_t constellation_index, uint32_t instance_index, struct gmio_amf_instance *ptr_instance)
	Optional function that retrieves the i-th instance within a constellation element. More...

Detailed Description

Provides an interface for accessing the underlying(hidden) user AMF data.

Note

version is 1.2

Field Documentation

const void* gmio_amf_document::cookie

Opaque pointer on the user AMF document, passed as first argument to hook functions.

enum gmio_amf_unit gmio_amf_document::unit

uint32_t gmio_amf_document::object_count

Number of objects in the document, must be >= 1.

uint32_t gmio_amf_document::material_count

Number of materials in the document.

uint32_t gmio_amf_document::texture_count

Number of textures in the document.

uint32_t gmio_amf_document::constellation_count

Number of constellations in the document.

uint32_t gmio_amf_document::metadata_count

Number of direct metadata attached to the document.

void(* gmio_amf_document::func_get_document_element)(const void *cookie, enum gmio_amf_document_element element, uint32_t element_index, void *ptr_element)

Function that retrieves the i-th document sub-element.

element is the type of the sub-element of interest.
element_index is the index of the sub-element within the AMF document.
The domain of this index depends on element :

Element type	Domain of index	gmio type
OBJECT	[0 .. object_count[	gmio_amf_object
MATERIAL	[0 .. material_count[	gmio_amf_material
TEXTURE	[0 .. texture_count[	gmio_amf_texture
CONSTELLATION	[0 .. constellation_count[	gmio_amf_constellation
METADATA	[0 .. metadata_count[	gmio_amf_metadata

void(* gmio_amf_document::func_get_document_element_metadata)(const void *cookie, enum gmio_amf_document_element element, uint32_t element_index, uint32_t metadata_index, struct gmio_amf_metadata *ptr_metadata)

Optional function that retrieves the i-th metadata assigned to a document sub-element.

element is the type of the sub-element of interest.
element_index is the index of the sub-element within the AMF document.
The domain of this index depends on element :

Element type	Domain of index	gmio type
MATERIAL	[0 .. material_count[	gmio_amf_material
OBJECT	[0 .. object_count[	gmio_amf_object
CONSTELLATION	[0 .. constellation_count[	gmio_amf_constellation

Function not required(can be set to NULL) if there is no metadata in the document

void(* gmio_amf_document::func_get_object_mesh)(const void *cookie, uint32_t object_index, uint32_t mesh_index, struct gmio_amf_mesh *ptr_mesh)

Function that retrieves the i-th mesh within an object element.

void(* gmio_amf_document::func_get_object_mesh_element)(const void *cookie, const struct gmio_amf_object_mesh_element_index *element_index, void *ptr_element)

Function that retrieves the i-th sub-element of a mesh element.

element_index is the index of the sub-element within the mesh element.
The domain of this index(ie. value field) depends on element :

Element type	Domain of index	gmio type
VERTEX	[0 .. gmio_amf_mesh::vertex_count[	gmio_amf_vertex
EDGE	[0 .. gmio_amf_mesh::edge_count[	gmio_amf_edge
VOLUME	[0 .. gmio_amf_mesh::volume_count[	gmio_amf_volume

void(* gmio_amf_document::func_get_object_mesh_element_metadata)(const void *cookie, const struct gmio_amf_object_mesh_element_index *mesh_element_index, uint32_t metadata_index, struct gmio_amf_metadata *ptr_metadata)

Optional function that retrieves the i-th metadata attached to a mesh element(only vertex or volume)

Function not required(can be set to NULL) if there is no metadata for all mesh elements

void(* gmio_amf_document::func_get_object_mesh_volume_triangle)(const void *cookie, const struct gmio_amf_object_mesh_element_index *volume_index, uint32_t triangle_index, struct gmio_amf_triangle *ptr_triangle)

Function that retrieves the i-th triangle within a mesh volume.

void(* gmio_amf_document::func_get_material_composite)(const void *cookie, uint32_t material_index, uint32_t composite_index, struct gmio_amf_composite *ptr_composite)

Optional function that retrieves the i-th composite within a material element.

Function not required(can be set to NULL) if there is no material composite in the document

void(* gmio_amf_document::func_get_constellation_instance)(const void *cookie, uint32_t constellation_index, uint32_t instance_index, struct gmio_amf_instance *ptr_instance)

Optional function that retrieves the i-th instance within a constellation element.

Function not required(can be set to NULL) if there is no constellation in the document

---

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

• gmio_amf/amf_document.h