caiyu/gmio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor doc fixes

Browse Source
This commit is contained in:
Hugues Delorme 2017-04-05 12:27:30 +02:00
parent 18e81ea27a
commit 62a9ec97c8
4 changed files with 33 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
src/gmio_amf/amf_document.h
View File

@ -263,6 +263,28 @@ struct gmio_amf_document {
uint32_t element_index,
void* ptr_element);
/*! Optional function that retrieves the i-th metadata assigned to a
* document sub-element
*
* \p element is the type of the sub-element of interest.\n
* \p element_index is the index of the sub-element within the AMF
* document.\n
* The domain of this index depends on \p element :
* Element type | Domain of index | gmio type
* --------------|---------------------------------------|----------------
* MATERIAL | <tt> [0 .. material_count[ </tt> | gmio_amf_material
* OBJECT | <tt> [0 .. object_count[ </tt> | gmio_amf_object
* CONSTELLATION | <tt> [0 .. constellation_count[ </tt> | gmio_amf_constellation
*
* Function not required(can be set to \c NULL) if there is no metadata in
* the document */
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);
/*! Function that retrieves the i-th \c mesh within an \c object element */
void (*func_get_object_mesh)(
const void* cookie,
@ -286,6 +308,17 @@ struct gmio_amf_document {
const struct gmio_amf_object_mesh_element_index* element_index,
void* ptr_element);
/*! Optional function that retrieves the i-th metadata attached to a mesh
* element(only vertex or volume)
*
* Function not required(can be set to \c NULL) if there is no metadata
* for all mesh elements */
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);
/*! Function that retrieves the i-th \c triangle within a mesh \c volume */
void (*func_get_object_mesh_volume_triangle)(
const void* cookie,
@ -314,41 +347,6 @@ struct gmio_amf_document {
uint32_t constellation_index,
uint32_t instance_index,
struct gmio_amf_instance* ptr_instance);
/* Optional function pointers to retrieve metadata */
/*! Optional function that retrieves the i-th metadata assigned to a
* document sub-element
*
* \p element is the type of the sub-element of interest.\n
* \p element_index is the index of the sub-element within the AMF
* document.\n
* The domain of this index depends on \p element :
* Element type | Domain of index | gmio type
* --------------|---------------------------------------|----------------
* MATERIAL | <tt> [0 .. material_count[ </tt> | gmio_amf_material
* OBJECT | <tt> [0 .. object_count[ </tt> | gmio_amf_object
* CONSTELLATION | <tt> [0 .. constellation_count[ </tt> | gmio_amf_constellation
*
* Function not required(can be set to \c NULL) if there is no metadata in
* the document */
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 attached to a mesh
* element(only vertex or volume)
*
* Function not required(can be set to \c NULL) if there is no metadata
* for all mesh elements */
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);
};
/*! @} */

5
src/gmio_amf/amf_global.h
View File

@ -52,13 +52,8 @@
* gmio_amf_write_options</td>
* </tr>
* </table>
*
* \addtogroup gmio_amf
* @{
*/
#pragma once
#include "../gmio_core/global.h"
/*! @} */

5
src/gmio_stl/stl_global.h
View File

@ -100,13 +100,8 @@
* <td>gmio_stl_triangle</td>
* </tr>
* </table>
*
* \addtogroup gmio_stl
* @{
*/
#pragma once
#include "../gmio_core/global.h"
/*! @} */

4
src/gmio_support/support_global.h
View File

@ -99,8 +99,6 @@
* All \c gmio_support source files are copied with install target (ie by doing
* <tt>(n)make install</tt>) to <tt>PREFIX/src/gmio_support</tt>
*
* \addtogroup gmio_support
* @{
*/
/*
@ -125,5 +123,3 @@
#pragma once
#include "../gmio_core/global.h"
/*! @} */