diguyGraphicsState

Generated from diguyGraphicsState.h

DI-Guy API Version 12.5.1

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

Includes: diguy_constants.h | declspec_diguy.h | diguyGraphicsTexture.h

Contents:

Alphabetical Index

Link against: libdiguy_graphics_api

class diguyGraphicsState

class BDI_DECLSPEC_diguy diguyGraphicsState
{
public:
    diguyGraphicsMaterial* get_material();
    int get_num_textures();
    diguyGraphicsTexture* get_texture(int texture_index = 0);
    diguyTextureMapType get_texture_type(int index);
    int get_textures_available();
    int get_contains_alpha_component();
    int get_is_unlit();
    void free_loader_memory();
#ifdef CPLUSPLUS_ONLY
    virtual void build();
    virtual void unbuild();
    virtual void bind_now();
#endif

Accessor Functions

The functions in this section provide access to data in this object. They are designed to be called by DI-Guy programmers.

function diguyGraphicsState::get_material

Prototype:
diguyGraphicsMaterial* get_material();
Description:

This function returns the material of this state. Specific information about the material can then be accessed from the returned object.
Returns:

object of type diguyGraphicsMaterial; NULL on failure
Callable From:

C++

function diguyGraphicsState::get_num_textures

Prototype:
int get_num_textures();
Description:

This function returns the number of textures this state has.
Returns:

number of textures associated with this state
Callable From:

C++

function diguyGraphicsState::get_texture

Prototype:
diguyGraphicsTexture* get_texture(int texture_index = 0);
Description:

This function returns the nth texture of this state. Specific information about the texture can then be accessed from the returned object.
Returns:

object of type diguyGraphicsTexture; NULL on failure
Callable From:

C++

function diguyGraphicsState::get_texture_type

Prototype:
diguyTextureMapType get_texture_type(int index);
Description:

This function returns the way that a texture is used in the state. Possibilities include diffuse, specular, normal.
Returns:

diguyTextureMapType enum
Callable From:

C++

function diguyGraphicsState::get_textures_available

Prototype:
int get_textures_available();
Description:

This function returns a bit-wise or'ed mask of available textures in this state. Possibilities include DIGUY_TEXTURE_MAP_MASK_DIFFUSE, DIGUY_TEXTURE_MAP_MASK_SPECULAR, DIGUY_TEXTURE_MAP_MASK_BUMP, etc. See diguyTextureMapMasks enum for a complete list.

function diguyGraphicsState::get_contains_alpha_component

Prototype:
int get_contains_alpha_component();
Description:

This function returns whether either the material or texture of this state contains an alpha component. States that have an alpha component can make objects semi-transparent, which can affect when said objects should be drawn.
Returns:

1 if state contains an alpha component, 0 if not; -1 on failure
Callable From:

C++

function diguyGraphicsState::get_is_unlit

Prototype:
int get_is_unlit();
Description:

This function returns whether faces drawn with this state should be lit or unlit.
Returns:

1 if faces unlit, 0 if lit, -1 on failure
Callable From:

C++

function diguyGraphicsState::free_loader_memory

Prototype:
void free_loader_memory();
Description:

This function frees most memory allocated by the DI-Guy geometry loader for this object.

This function should only be called during or after the object's build() function has been called. After it has been called, calls to many accessor functions will fail.
Callable From:

C++

Virtual Functions

The functions in this section are all virtual functions that will be called by DI-Guy at various times during DI-Guy execution.

Because the functions are all virtual, DI-Guy programmers can create a subclass of this class and override them. Unless otherwise stated, the base class functions do not need to be called.

function diguyGraphicsState::build

Prototype:
virtual void build();
Description:

This function will be called by DI-Guy when it is time for a renderer-specific state object to be created. A subclass of this class isn't always necessary, particularly for immediate mode renderers in which everything might be done in a subclass of diguyGraphicsMaterial and a subclass of diguyGraphicsTexture.
Immediate Mode:

Immediate mode renderers usually do not override this function.
Scene Graph:

Scene graph renderers may override this function, to create a state object that will be associated with diguyGraphicsMesh objects.

The subclass version of this function may need to refer to material and texture objects created by the build() calls of subclasses of diguyGraphicsMaterial and diguyGraphicsTexture objects.
Callable From:

N/A (automatically called by DI-Guy Graphics API during the Build Stage)

function diguyGraphicsState::unbuild

Prototype:
virtual void unbuild();
Description:

This function will be called by DI-Guy when it is time for a renderer-specific state object to be destroyed.
Immediate Mode:

Immediate mode renderers may override this function, to destroy any object that may have been created by build().
Scene Graph:

Scene graph renderers may override this function, to destroy any object that may have been created by build().
Callable From:

N/A (automatically called by DI-Guy Graphics API during the Unbuild Stage)

function diguyGraphicsState::bind_now

Prototype:
virtual void bind_now();
Description:

This function will be called by DI-Guy when the state should be made active, or bound.
Immediate Mode:

Immediate mode renderers can override this function, but may not need to. The material and texture of the state will receive their own bind_now() calls.
Scene Graph:

Scene graph renderers usually do not override this function.
Callable From:

N/A (automatically called by DI-Guy Graphics API during Draw Stage)

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.