diguy_graphics_api.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2015 VT MAK
 ** All rights reserved. 
 *********************************************************************/

/*********************************************************************
 **
 *t  DI-Guy API, Info Graphics Module
 **
 *b    Link against: libdiguy_graphics_api
 */

#ifndef __diguy_graphics_api_H
#define __diguy_graphics_api_H

#include <diguy_api.h>
#include <diguy_typedefs.h>
#include <bdigraphics/bdiGraphicsInitGraphicsAPI.h>

// these typedefs have actually been moved to diguy_typedefs.h but very few files depend on this
// header file so it's not worth breaking backwards compatibility to remove these.
#include <diguyGraphicsLink.h>     // for diguyGraphicsLinkCreateFunc
#include <diguyGraphicsShape.h>    // for diguyGraphicsShapeCreateFunc
#include <diguyGraphicsFile.h>     // for diguyGraphicsFileCreateFunc
#include <diguyGraphicsState.h>    // for diguyGraphicsStateCreateFunc
#include <diguyGraphicsMaterial.h> // for diguyGraphicsMaterialCreateFunc
#include <diguyGraphicsTexture.h>  // for diguyGraphicsTextureCreateFunc
#include <diguyGraphicsMesh.h>     // for diguyGraphicsMeshCreateFunc
#include <diguyGraphicsShaderProgram.h>  // for diguyGraphicsShaderProgramCreateFunc
#include <diguyGraphicsShaderInstance.h> // for diguyGraphicsShaderInstanceCreateFunc
#include <diguyGraphicsInstanceGroup.h>  // for diguyGraphicsInstanceGroupCreateFunc

#include <declspec_diguy_graphics.h>

#ifdef __cplusplus
extern "C" {
#endif


/*****************************************************************************/
/*l
 *b  Description:
 **
 **    This function initializes the DI-Guy Runtime API for accessing
 **    information about DI-Guy graphics and geometry.
 **
 **    Use diguy_graphics_get_defaults() to fill out the init structure
 **    before changing specific entries.
 **
 *b  Arguments:
 **
 *a    init - pointer to type bdiGraphicsInitGraphicsAPI; passing NULL
 *a           will cause defaults to be used for all values
 **
 *b  Returns:
 **
 **    0 on success, non-zero error code on failure
 **
 **    Refer to diguy_constants.h for error code values.
 **    
 ** \ingroup diguyGraphicsAPI
 */
BDI_DECLSPEC_diguy_graphics int
diguy_graphics_initialize(bdiGraphicsInitGraphicsAPI* init);

/*l
 *b  Description:
 **
 **    Fills out the init structure with default values.  Selected entries
 **    can then be changed before calling diguy_graphics_initialize().
 **
 **    The default values are:
 *-    - init->use_array_format_for_vertex_buffer_data = 0;
 *-    - init->default_vertex_type = DIGUY_GRAPHICS_INDEX_TYPE_USHORT;
 *-    - init->use_shaders = 1;
 *-    - init->shader_language = DIGUY_GRAPHICS_SHADER_LANGUAGE_GLSL;
 *-    - init->transpose_shader_matrices = 0;
 *-    - init->use_4x3_shader_matrices = 1;
 *-    - init->use_cached_optimized_geometry = 1;
 *-    - init->use_cached_compressed_textures = 1;
 *-    - init->use_sRGB_corrected_textures = 1;
 *-    - init->characters_have_world_space_triangle_query = 0;
 *-    - init->scene_objects_have_world_space_triangle_query = 0;
 *-    - init->use_linear_traversal_draw = 1;
 **
 *b  Arguments:
 **
 *a    init - pointer to type bdiGraphicsInitGraphicsAPI
 **
 *b  Returns:
 **
 **    0 on success, -1 on failure
 */
BDI_DECLSPEC_diguy_graphics int
diguy_graphics_get_defaults(bdiGraphicsInitGraphicsAPI* init);

/*l
 *b  Description:
 **
 **    Fills out the init structure with default OSG values.  Selected entries
 **    can then be changed before calling diguy_graphics_initialize().
 **
 **    The differences for the default values are:
 *-    - init->transpose_shader_matrices = 1;
 *-    - init->use_4x3_shader_matrices = 0;
 *-    - init->use_sRGB_corrected_textures = 0;
 **
 *b  Arguments:
 **
 *a    init - pointer to type bdiGraphicsInitGraphicsAPI
 **
 *b  Returns:
 **
 **    0 on success, -1 on failure
 */
BDI_DECLSPEC_diguy_graphics int
diguy_graphics_get_osg_defaults(bdiGraphicsInitGraphicsAPI* init);

/*l
 *b  Description:
 **
 **    Fills out the init structure with default values.  Selected entries
 **    can then be changed before calling diguy_graphics_initialize().
 **
 **    The differences for the default values are:
 *-    - init->transpose_shader_matrices = 1
 *-    - init->use_4x3_shader_matrices = 0
 *-    - init->shader_language = DIGUY_GRAPHICS_SHADER_LANGUAGE_HLSL
 **
 *b  Arguments:
 **
 *a    init - pointer to type bdiGraphicsInitGraphicsAPI
 **
 *b  Returns:
 **
 **    0 on success, -1 on failure
 */

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_get_dx9_defaults(bdiGraphicsInitGraphicsAPI* init);

/*l
 *b  Description:
 **
 **    This function turns far position rendering on or off.  It must be
 **    called after diguy_graphics_initialize().
 **
 *b  Arguments:
 **
 *a    flag - pass 1 to turn far positions on, 0 to turn them off
 **
 */
BDI_DECLSPEC_diguy_graphics
void diguy_graphics_set_use_far_positions(int flag);

/*l
 *b  Description:
 **
 **    This function gets the status of far position rendering.
 **    It can only be called after diguy_graphics_initialize().
 **
 *b  Returns:
 **
 **    1 if far position rendering is on, 0 if not
 **
 */
BDI_DECLSPEC_diguy_graphics
int diguy_graphics_get_use_far_positions();


/*****************************************************************************/
BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_link_create_func(diguyGraphicsLinkCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_shape_create_func(diguyGraphicsShapeCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_file_create_func(diguyGraphicsFileCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_state_create_func(diguyGraphicsStateCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_material_create_func(diguyGraphicsMaterialCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_texture_create_func(diguyGraphicsTextureCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_mesh_create_func(diguyGraphicsMeshCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_shader_program_create_func(diguyGraphicsShaderProgramCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_shader_technique_create_func(diguyGraphicsShaderTechniqueCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_shader_instance_create_func(diguyGraphicsShaderInstanceCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_instance_group_create_func(diguyGraphicsInstanceGroupCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_painter_create_func(diguyViewPainterCreateFunc* func);


BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_particle_system_create_func(diguyParticleSystemCreateFunc* func);

BDI_DECLSPEC_diguy_graphics int
diguy_graphics_set_particle_renderer_create_func(diguyParticleRendererCreateFunc* func);

#ifdef __cplusplus
}
#endif


#endif /* __diguy_graphics_api_H */


/*********************************************************************
 ** Copyright (c) 1992-2015 VT MAK
 ** All rights reserved. 
 *********************************************************************/