DI-Guy API, Performer Graphics Module

diguy_graphics_pf.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguy_graphics_pf.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com

Alphabetical Index

Includes: pf.h | pf.h | diguy_api.h | graphics_init_pf.h

Link against: libdiguy_graphics_[graphics] (e.g., libdiguy_graphics_pf22_ogl)

Functions

function diguy_pf_initialize

Prototype:

diguy_pf_initialize(bdiGraphicsInitPf* init);
Description:

This function initializes the DI-Guy Runtime API for the Performer environment.

This function should only be called once per program execution.

Do not call this function again, even after calling

diguy_deinitialize().

Use diguy_pf_get_defaults() to fill out the init structure before changing specific entries.

You must call diguy_pf_set_channel() before calling this function.

Arguments:

initpointer to type bdiGraphicsInitPf; 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.

function diguy_pf_get_defaults

Prototype:

diguy_pf_get_defaults(bdiGraphicsInitPf* init);
Description:

Fills out the init structure with default values. Selected entries can then be changed before calling diguy_pf_initialize().

Arguments:

initpointer to type bdiGraphicsInitPf
The Performer 2.x init structure doesn't currently contain any usable entries.

Returns:

0 on success, -1 on failure

function diguy_pf_set_channel

Prototype:

diguy_pf_set_channel(pfChannel* channel);
Description:

This function sets the default channel that cameras, overlays, and other graphics objects will be attached to.

NOTE: This function must be called before diguy_pf_initialize().

Arguments:

channelpointer to a valid pfChannel
Returns:

0 on success, -1 on failure


Alphabetical Index


Copyright (C) 1992-2003

Boston Dynamics

ALL RIGHTS RESERVED.

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/515 Massachusetts Avenue/Cambridge MA 02139.