graphics_init_ogl.h

Go to the documentation of this file.

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


/*********************************************************************
 **
 *t  DI-Guy Graphics Init Structure, OpenGL
 **
 */

#ifndef __GRAPHICS_INIT_OGL_H
#define __GRAPHICS_INIT_OGL_H

#ifdef _WIN32
#include <windows.h>
#endif
#ifdef __APPLE__
#include <OpenGL/gl.h>
#else
#include <GL/gl.h>
#endif


/****************************************************************************/
typedef struct bdiGraphicsInitOgl
{
        /*l
         *b  Description:
         **
         **   Determines whether textures will be applied.  Default is 1.
         */
        int use_textures;

        /*l
         *b  Description:
         **
         **   Determines whether materials will be applied.  Default is 1.
         */
        int use_materials;


        /*l
         *b  Description:
         **
         **    Determines the OpenGL magnification filtering method
         **    for textures.  Should be one of:
         **
         *e     GL_NEAREST
         *e     GL_LINEAR
         **
         **    Default is GL_LINEAR
         */
        GLenum texture_mag_filter;

        /*l
         *b  Description:
         **
         **    Determines the OpenGL minification filtering method
         **    for textures.  Should be one of:
         **
         *e     GL_NEAREST
         *e     GL_LINEAR
         *e     GL_NEAREST_MIPMAP_NEAREST
         *e     GL_NEAREST_MIPMAP_LINEAR
         *e     GL_LINEAR_MIPMAP_NEAREST
         *e     GL_LINEAR_MIPMAP_LINEAR
         **
         **    Default is GL_LINEAR_MIPMAP_LINEAR
         */
        GLenum texture_min_filter;

        /*l
         *b  Description:
         **
         **    Determines the OpenGL anisotropic filtering level for textures.  
         **    Should be a power of 2 typically up to 16.
         **    Default is 0.0f
         */
        float texture_anisotropic_filter;

        /*l
         *b  Description:
         **
         **    Deprecated; Boston Dynamics no longer uses the MG-API library,
         **    so this setting is not used.  It is left here in order to not
         **    break existing code.
         */
        int call_mgInit_and_mgExit;

        /*l
         *b  Description:
         **
         **    Determines whether vertex buffer object extensions are used.
         **    In some cases using vertex buffer objects rather than display
         **    lists can improve performance.
         **
         **    Possible values are:
         **
         *a    0 - don't use vertex buffer object extensions
         *a    1 - do use vertex buffer object extensions
         **
         **    Default is 1.
         */
        int use_VBOs;

        /*l
         *b  Description:
         **
         **    Determines whether frame buffer object extensions are used.
         **    In some cases using frame buffer objects can improve performance
         **    of intersection testing.
         **
         *b    This currently only has an effect on Win32 platforms.
         **
         **    There is a known problem with some graphics cards that using
         **    frame buffer objects leads to a program crash.
         **
         **    Possible values are:
         **
         *a    0 - don't use frame buffer object extensions
         *a    1 - do use frame buffer object extensions
         **
         **    Default is 0.
         */
        int use_FBOs;

        /*l
         *b  Description:
         **
         **    Determines whether shaders should be loaded and compiled.
         **
         **    Note the DI-Guy skinned appearances depend on shaders being
         **    available and enabled.
         **
         *b    This currently only has an effect on Win32 platforms.
         **
         **    There is a known problem with some graphics cards using GLSL
         **    possibly causing a crash.
         **
         **    Possible values are:
         **
         *a    0 - don't use shaders 
         *a    1 - do use shaders 
         **
         **    Default is 1.
         */
        int use_shaders;

        /*l
         *b  Description:
         **
         **    Determines whether the multitexture extension is used.
         **
         **    Possible values are:
         **
         *a    0 - don't use multitexture extensions
         *a    1 - do use multitexture extensions
         **
         **    Default is 0.
         */
        int use_multitexture_extension;

        /*l
         *b  Description:
         **
         **    Sets which texture unit is used for applying textures.
         **    Should be set to an integer, *not* to a GL enumeration.
         **
         **    Possible values are:
         **
         *a    0 - use GL_TEXTURE0
         *a    1 - use GL_TEXTURE1
         *a    2 - use GL_TEXTURE2
         *a    3 - use GL_TEXTURE3
         **
         **    Default is 0, or texture unit GL_TEXTURE0.
         */
        int texture_unit;

        /*l
         *b  Description:
         **
         **    Sets the value passed to the factor argument of the
         **    glPolygonOffset() function.  This function is used when
         **    rendering polygon subfaces, which are commonly used for
         **    edge highlighting and decals on signs.
         **
         **    Default is -1.0.
         */
        float polygon_offset_factor;

        /*l
         *b  Description:
         **
         **    Sets the value passed to the units argument of the
         **    glPolygonOffset() function.
         **
         **    Default is -1.0.
         */
        float polygon_offset_units;

        /*l
         *b  Description:
         **
         **    Sets if a default shooting intersection function should be
         **    automatically set up. See
         **    diguyScenario::set_default_fire_weapon_intersection_function()
         **    for more details.
         **
         **    Default is 1.
         */
        int use_default_fire_weapon_intersection_function;

        /*l
         *b  Description:
         **
         **    Sets whether .flt and .dae files will be loaded as geometry
         **    files optimized for DI-Guy use.
         **
         **    Generated files will be put into a subdirectory of the DI-Guy
         **    geometry directory, and will be automatically updated as needed
         **    (doesn't exist, or original file is newer).
         **
         **    The .bdg geometry format is a smaller, more efficient version of
         **    the geometry data encoded in .flt and .dae files.  It is an
         **    internal DI-Guy format that is not directly supported by geometry
         **    editing programs.
         **
         **    There is no quality trade-off in using optimized geometry files,
         **    so it is recommended that they always be enabled.
         **
         **    Default is 1.
         */
        int use_cached_optimized_geometry;

        /*l
         *b  Description:
         **
         **    Sets whether compressed texture files should be generated from
         **    source uncompressed texture files in order to reduce texture
         **    memory usage.
         **
         **    There is a quality trade-off when using compressed textures.  If
         **    there are too many undesired artifacts in the generated textures,
         **    they should not be used.
         **
         **    Generated files will be put into a subdirectory of the DI-Guy
         **    geometry directory, and will be automatically updated as needed
         **    (doesn't exist, or original file is newer).
         **
         **    The compressed texture files will be in the .dds (DirectDraw
         **    Surface) format.
         **
         **    Default is 1.
         */
        int use_cached_compressed_textures;

        /*l
         *b  Description:
         **
         **    Sets whether SRGB textures should be used, these allow a relatively 
         **    free lookup into texture maps that have been transformed into sRBG space
         **    allowing a linear lighting pipeline to be setup.
         **
         **    Default is 1.
         */
        int use_sRGB_corrected_textures;

        /*l
         *b  Description:
         **
         **    Sets whether DI-Guy draws characters by traversing links in a
         **    recursive tree traversal, or in a flat linear traversal.  Linear
         **    drawing allows for easier culling and some additional performance
         **    on simpler characters.  Linear traversal is required for some
         **    advanced lighting shaders.
         **
         **    Versions of DI-Guy prior to version 11 always used a recursive
         **    traversal.
         **
         **    Default is 1.
         */
        int use_linear_traversal_draw;

        /*l
         *b  Description:
         **
         **    Whether matrices that will be used as transforms in shaders should 
         **    be sent as a 4x3 matrix instead of 4x4. This should only be changed
         **    if your video card is unable to use 4x4 matrices. 
         **
         **    Default is 1.
         */
        int use_4x3_shader_matrices;

        /*l
         *b  Description:
         **
         **    Whether instancing should be used for rendering.
         **
         **    Default is 0.
         */
        int use_shader_instancing;

        /*l
         *b  Description:
         **
         **    Instructs the instancing system to respect the graphics state switch
         **    of geometry when constructing instance groups.  Setting value to 0
         **        while not graphically correct results in increased performance
         **
         **    Default is 1.
         */
        int instancing_respect_graphics_state_switch;

} bdiGraphicsInitOgl;


#endif /* __GRAPHICS_INIT_OGL_H */


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