diguyGraphicsVertexFormats.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2024 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/

/*********************************************************************/
#ifndef __diguyGraphicsVertexFormats_H
#define __diguyGraphicsVertexFormats_H

#ifdef SWIG
%module diguyGraphicsVertexFormats
#else
#define CPLUSPLUS_ONLY
#include <diguy_constants.h>
#include <declspec_diguy.h>
#endif


/****************************************************************************/
/*l
 *b  Description:
 **
 **    This enumeration lists types of vertex data formats DI-Guy may use.
 **    In general the same vertex format meshes will use cannot be
 **    the same for all meshes, as static meshes don't use indices and
 **    weights, but dynamic meshes (e.g., skinned meshes) do.
 **
 **    The data member use_array_format_for_vertex_buffer_data of the
 **    bdiGraphicsInitGraphicsAPI structure can be used to specify
 **    whether interleaved or array format is to be used.
 **
 **    See diguyGraphicsMesh::get_vertex_format().
 **
 *i    DIGUY_GRAPHICS_VERTEX_FORMAT_V3_N3_T2
 **
 **      The most basic vertex format DI-Guy supports:  One vertex position,
 **      one normal, and one UV texture coordinate.  These values are
 **      interleaved like so:
 *>
 **          vnt vnt vnt vnt ...
 *<
 **      Where 'v' represents three floats specifying vertex position, 'n'
 **      represents three floats specifying normal direction, and 't'
 **      represents two floats specifying texture indices.
 **
 **      This format is commonly used by static meshes.  It cannot be used
 **      by skinned meshes.
 **
 *<
 *i    DIGUY_GRAPHICS_VERTEX_FORMAT_V3_N3_T2_I4F_W4
 **
 **      Vertices for skinned meshes require more info; specifically, they
 **      need the indices of the links/bones that influence them and the
 **      weights of said influences.  DI-Guy supports at most 4 link
 **      influences per vertex.
 **
 **      Indices are stored as floats instead of an int or unsigned int
 **      because data passed to shaders in attribute variables (at least for
 **      glsl shaders) needs to be in float form, not int.
 **
 **      These values are interleaved like so:
 *>
 *-      vntiw vntiw vntiw vntiw ...
 *<
 **      Where 'i' and 'w' each represent four floats specifying indices
 **      and weights, respectively.
 **
 **      This format is commonly used by skinned meshes.  It could be used
 **      by static meshes, but doing so would waste memory.
 **
 ** DIGUY_GRAPHICS_VERTEX_FORMAT_V4_N4_T4
 **
 **  padded data for use in SSBOs for blend shapes.
 *<
 ** \ingroup diguyGraphicsAPI
 */
typedef enum
{
   DIGUY_GRAPHICS_VERTEX_FORMAT_UNKNOWN                = -1,
   DIGUY_GRAPHICS_VERTEX_FORMAT_V3_N3_T2               = 0,
   DIGUY_GRAPHICS_VERTEX_FORMAT_V3_N3_T2_I4F_W4        = 1,
   DIGUY_GRAPHICS_VERTEX_FORMAT_V3_N3_T2_T4_I4F_W4     = 2,
   DIGUY_GRAPHICS_VERTEX_FORMAT_V3_N3_T2_T4            = 3,
   // blend shape format
   DIGUY_GRAPHICS_VERTEX_FORMAT_V4_N4_T4               = 4
} diguyGraphicsVertexFormat;

/****************************************************************************/
/*l
 *b  Description:
 **
 **    This enumeration lists the type that indices stored in index buffer
 **    data might have.
 **
 **    Also see diguyGraphicsMesh::get_index_type().
 **
 **    Note that indices in index buffer data are different than the indices
 **    contained in vertex buffer data.  Index buffer indices specify which
 **    *vertices* in vertex buffer data are used to create polygons in a mesh
 **    (e.g., for the first triangle, use vertices 0, 1, and 2), while indices
 **    stored in vertex buffer data specify which *links* affect the final
 **    position of the vertex.
 **
 *i    DIGUY_GRAPHICS_INDEX_TYPE_UINT
 **
 **      Index buffer data is stored as unsigned integers (4 bytes).
 **
 *i    DIGUY_GRAPHICS_INDEX_TYPE_USHORT
 **
 **      Index buffer data is stored as unsigned short integers (2 bytes).
 **
 **    Unless the mesh has more then 65k verts the data will be unsigned shorts.
 **
 ** \ingroup diguyGraphicsAPI
 */
typedef enum
{
   DIGUY_GRAPHICS_INDEX_TYPE_UNKNOWN  = -1,
   DIGUY_GRAPHICS_INDEX_TYPE_UINT     = 0,
   DIGUY_GRAPHICS_INDEX_TYPE_USHORT   = 1,

} diguyGraphicsIndexType;


#endif /* __diguyGraphicsVertexFormats_H */