DI-Guy API, Info Graphics Module

Generated from diguy_graphics_api.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguy_graphics_api.h. Do not edit this file directly; the changes will be lost.

Includes: diguy_api.h | diguy_typedefs.h | bdiGraphicsInitGraphicsAPI.h | declspec_diguy_graphics.h

Contents:

Alphabetical Index

Link against: libdiguy_graphics_api

Graphics API Initialization Functions

\ingroup diguyGraphicsAPI

function diguy_graphics_initialize

Prototype:
diguy_graphics_initialize(bdiGraphicsInitGraphicsAPI* init);
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.
Arguments:

init pointer to type bdiGraphicsInitGraphicsAPI; passing NULL will cause defaults to be used for all values
Returns:

0 on success, non-zero error code on failure

Refer to diguy_constants.h for error code values.
\ingroup diguyGraphicsAPI

function diguy_graphics_get_defaults

Prototype:
diguy_graphics_get_defaults(bdiGraphicsInitGraphicsAPI* init);
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;
Arguments:

init pointer to type bdiGraphicsInitGraphicsAPI
Returns:

0 on success, -1 on failure

function diguy_graphics_get_osg_defaults

Prototype:
diguy_graphics_get_osg_defaults(bdiGraphicsInitGraphicsAPI* init);
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;
Arguments:

init pointer to type bdiGraphicsInitGraphicsAPI
Returns:

0 on success, -1 on failure

function diguy_graphics_get_dx9_defaults

Prototype:
diguy_graphics_get_dx9_defaults(bdiGraphicsInitGraphicsAPI* init);
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
Arguments:

init pointer to type bdiGraphicsInitGraphicsAPI
Returns:

0 on success, -1 on failure

function diguy_graphics_set_use_far_positions

Prototype:
void diguy_graphics_set_use_far_positions(int flag);
Description:

This function turns far position rendering on or off. It must be called after diguy_graphics_initialize().
Arguments:

flag pass 1 to turn far positions on, 0 to turn them off

function diguy_graphics_get_use_far_positions

Prototype:
int diguy_graphics_get_use_far_positions();
Description:

This function gets the status of far position rendering. It can only be called after diguy_graphics_initialize().
Returns:

1 if far position rendering is on, 0 if not

DI-Guy Graphics Object Create Functions

\ingroup diguyGraphicsAPI

Function responsible for allowing end users to subclass from a diguyGraphicsLink \ingroup diguyGraphicsAPI

function diguy_graphics_set_link_create_func

Prototype:

diguy_graphics_set_link_create_func(diguyGraphicsLinkCreateFunc* func);

Function responsible for allowing end users to subclass from a diguyGraphicsShape

function diguy_graphics_set_shape_create_func

Prototype:

diguy_graphics_set_shape_create_func(diguyGraphicsShapeCreateFunc* func);

Function responsible for allowing end users to subclass from a diguyGraphicsFile

function diguy_graphics_set_file_create_func

Prototype:

diguy_graphics_set_file_create_func(diguyGraphicsFileCreateFunc* func);

Function responsible for allowing end users to subclass from a diguyGraphicsState

function diguy_graphics_set_state_create_func

Prototype:

diguy_graphics_set_state_create_func(diguyGraphicsStateCreateFunc* func);

Function responsible for allowing end users to subclass from a diguyGraphicsMaterial

function diguy_graphics_set_material_create_func

Prototype:

diguy_graphics_set_material_create_func(diguyGraphicsMaterialCreateFunc* func);

Function responsible for allowing end users to subclass from a diguyGraphicsTexture

function diguy_graphics_set_texture_create_func

Prototype:

diguy_graphics_set_texture_create_func(diguyGraphicsTextureCreateFunc* func);

Function responsible for allowing end users to subclass from a diguyGraphicsMesh

function diguy_graphics_set_mesh_create_func

Prototype:

diguy_graphics_set_mesh_create_func(diguyGraphicsMeshCreateFunc* func);

Function responsible for allowing end users to subclass from a diguyGraphicsShaderProgram

function diguy_graphics_set_shader_program_create_func

Prototype:

diguy_graphics_set_shader_program_create_func(diguyGraphicsShaderProgramCreateFunc* func);

Function responsible for allowing end users to subclass from a diguyGraphicsShaderTechnique

function diguy_graphics_set_shader_technique_create_func

Prototype:

diguy_graphics_set_shader_technique_create_func(diguyGraphicsShaderTechniqueCreateFunc* func);

Function responsible for allowing end users to subclass from a diguyGraphicsShaderInstance

function diguy_graphics_set_shader_instance_create_func

Prototype:

diguy_graphics_set_shader_instance_create_func(diguyGraphicsShaderInstanceCreateFunc* func);

Function responsible for allowing end users to subclass from a diguyViewPainter

function diguy_graphics_set_painter_create_func

Prototype:

diguy_graphics_set_painter_create_func(diguyViewPainterCreateFunc* func);

Alphabetical Index

These coded instructions, statements, and computer programs contain unpublished proprietary information of Boston Dynamics and are protected by Copyright Laws of the United States. They may not be used, duplicated, or disclosed in any form, in whole or in part, without the prior written consent from Boston Dynamics.

RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Sofware clause at DFARS 252.227-7013 and/or in similar or successor clauses in the FAR, or the DOD or NASA FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished-rights reserved under the Copyright Laws of the United States.

Contractor/Manufacturer is:

Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.