Functions

( TQ3Status ) Q3InteractiveRenderer_CountRAVEDrawContexts (
    TQ3RendererObject renderer,
    TQ3Uns32 *numRAVEContexts
);

Discussion

Count the RAVE contexts for the interactive renderer.

Note - this function is deprecated, and is not fully supported in Quesa.

Parameter Descriptions

renderer

The renderer to query.

numRAVEContexts

Receives the number of RAVE contexts.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_GetCSGEquation (
    TQ3RendererObject renderer,
    TQ3CSGEquation *equation
);

Discussion

Get the CSG equation from the interactive renderer.

Note - this function is deprecated, and is not fully supported in Quesa.

Parameter Descriptions

renderer

The renderer to query.

equation

Receives the CSG equation.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_GetDoubleBufferBypass (
    TQ3RendererObject renderer,
    TQ3Boolean *bypass
);

Discussion

Get the double-buffer bypass hint from the interactive renderer.

Note - this function is deprecated, and is not fully supported in Quesa.

Parameter Descriptions

renderer

The renderer to query.

bypass

Receives the double-buffer bypass hint.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_GetPreferences (
    TQ3RendererObject renderer,
    TQ3RaveVendorID *vendorID,
    TQ3RaveEngineID *engineID
);

Discussion

Get the RAVE preferences from the interactive renderer.

Note - this function is deprecated, and is not fully supported in Quesa.

Parameter Descriptions

renderer

The renderer to query.

vendorID

Receives the RAVE vendor ID.

engineID

Receives the RAVE engine ID.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_GetRAVEContextHints (
    TQ3RendererObject renderer,
    TQ3Uns32 *RAVEContextHints
);

Discussion

Get the RAVE context hints from the interactive renderer.

Note - this function is deprecated, and is not fully supported in Quesa.

Parameter Descriptions

renderer

The renderer to query.

RAVEContextHints

Receives the RAVE context hints.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_GetRAVEDrawContexts (
    TQ3RendererObject renderer,
    TQADrawContext **raveDrawContextList,
    TQAEngine **raveDrawingEnginesList,
    TQ3Uns32 *numRAVEContexts,
    TQ3RaveDestroyCallback raveDestroyCallback
);

Discussion

Get the RAVE contexts for the interactive renderer.

Note - this function is deprecated, and is not fully supported in Quesa.

Parameter Descriptions

renderer

The renderer to query.

raveDrawContextList

Receives the RAVE context list.

raveDrawingEnginesList

Receives the RAVE engine list.

numRAVEContexts

Receives the number of RAVE contexts.

raveDestroyCallback

The RAVE destroy callback.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_GetRAVETextureFilter (
    TQ3RendererObject renderer,
    TQ3TextureFilter *raveTextureFilterValue
);

Discussion

Get the RAVE texture filter from the interactive renderer.

Although Quesa does not actually use RAVE, the Interactive and OpenGL renderers do use this filter to choose OpenGL texture filtering settings.

Parameter Descriptions

renderer

The renderer to query.

raveTextureFilterValue

Receives the RAVE texture filter.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_SetCSGEquation (
    TQ3RendererObject renderer,
    TQ3CSGEquation equation
);

Discussion

Set the CSG equation for the interactive renderer.

Note - this function is deprecated, and is not fully supported in Quesa.

Parameter Descriptions

renderer

The renderer to update.

equation

The new CSG equation.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_SetDoubleBufferBypass (
    TQ3RendererObject renderer,
    TQ3Boolean bypass
);

Discussion

Set the double-buffer bypass hint for the interactive renderer.

Note - this function is deprecated, and is not fully supported in Quesa.

Parameter Descriptions

renderer

The renderer to update.

bypass

The double-buffer bypass hint.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_SetPreferences (
    TQ3RendererObject renderer,
    TQ3RaveVendorID vendorID,
    TQ3RaveEngineID engineID
);

Discussion

Set the RAVE preferences for the interactive renderer.

Note - this function is deprecated, and is not fully supported in Quesa.

Parameter Descriptions

renderer

The renderer to update.

vendorID

The new RAVE vendor ID.

engineID

The new RAVE engine ID.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_SetRAVEContextHints (
    TQ3RendererObject renderer,
    TQ3Uns32 RAVEContextHints
);

Discussion

Set the RAVE context hints for the interactive renderer.

Note - this function is deprecated, and is not fully supported in Quesa.

Parameter Descriptions

renderer

The renderer to update.

RAVEContextHints

The RAVE context hints.

function result

Success or failure of the operation.

( TQ3Status ) Q3InteractiveRenderer_SetRAVETextureFilter (
    TQ3RendererObject renderer,
    TQ3TextureFilter raveTextureFilterValue
);

Discussion

Set the RAVE texture filter for the interactive renderer.

Although Quesa does not actually use RAVE, the Interactive and OpenGL renderers do use this filter to choose OpenGL texture filtering settings.

Parameter Descriptions

renderer

The renderer to update.

raveTextureFilterValue

The RAVE texture filter.

function result

Success or failure of the operation.

( TQ3Status ) Q3RendererClass_GetNickNameString (
    TQ3ObjectType rendererClassType,
    TQ3ObjectClassNameString rendererClassString
);

Discussion

Get the "nick name" of a renderer class.

The "nick name" is the user-visible name for the renderer, and is suitable for display in a menu or window.

Parameter Descriptions

rendererClassType

The class type of the renderer to query.

rendererClassString

Receives the nick name of the renderer.

function result

Success or failure of the operation.

( TQ3Status ) Q3Renderer_GetConfigurationData (
    TQ3RendererObject renderer,
    unsigned char *dataBuffer,
    TQ3Uns32 bufferSize,
    TQ3Uns32 *actualDataSize
);

Discussion

Get the configuration data for a renderer.

Configuration data should be saved by the application in a manner appropriate for the current platform (e.g., the Registry on Windows or a .plist file on the Mac), tagging it with the renderer's type for later identification.

If dataBuffer is NULL, the size of data required to store the configuration data will be returned in actualDataSize.

Otherwise bufferSize should be set to the number of bytes pointed to by dataBuffer, and actualDataSize will receive the number of bytes written to dataBuffer.

Parameter Descriptions

renderer

The renderer to query.

dataBuffer

Receives the renderer configuration data. May be NULL.

bufferSize

The number of bytes pointed to by dataBuffer. May be 0.

actualDataSize

Receives the number of bytes required for, or written to, dataBuffer.

function result

Success or failure of the operation.

( TQ3ObjectType ) Q3Renderer_GetType (
    TQ3RendererObject renderer
);

Discussion

Get the class type of a renderer object.

Parameter Descriptions

renderer

The renderer to query.

function result

The type of the renderer.

( TQ3Boolean ) Q3Renderer_HasModalConfigure (
    TQ3RendererObject renderer
);

Discussion

Does a renderer have a modal configure dialog?

Parameter Descriptions

renderer

The renderer to query.

function result

Does the renderer have a modal configure dialog?

( TQ3Boolean ) Q3Renderer_IsInteractive (
    TQ3RendererObject renderer
);

Discussion

Is a renderer "interactive"?

An interactive renderer should be able to render frames at a more or less interactive rate, allowing the user to manipulate the renderer in real-time.

Typically, renderers using hardware-acceleration would report as interactive while software-based renderers (e.g., ray-tracers) would not.

Parameter Descriptions

renderer

The renderer to query.

function result

Is the renderer interactive?

( TQ3Status ) Q3Renderer_ModalConfigure (
    TQ3RendererObject renderer,
    TQ3DialogAnchor dialogAnchor,
    TQ3Boolean *cancelled
);

Discussion

Invoke a renderer's modal configure dialog.

If the renderer provides a user interface for adjusting its preferences, a modal configure dialog can be displayed by this function.

The cancel/accept state of the dialog is returned through the cancelled parameter.

After a configure dialog has been accepted, the current preferences should be retrieved with Q3Renderer_GetConfigurationData and stored by the application for later recall.

Parameter Descriptions

theRenderer

The renderer whose configure dialog is to be displayed.

dialogAnchor

Platform-specific dialog data.

cancelled

Receives the OK/Cancel state of the dialog.

function result

Success or failure of the operation.

( TQ3RendererObject ) Q3Renderer_NewFromType (
    TQ3ObjectType rendererObjectType
);

Discussion

Instantiate a new renderer by type.

The built-in renderer types include:

• kQ3RendererTypeOpenGL, new OpenGL
• kQ3RendererTypeInteractive, legacy OpenGL
• kQ3RendererTypeWireFrame, wire frame
• kQ3RendererTypeCartoon, cartoon style
• kQ3RendererTypeHiddenLine, hidden line removal, non photorealistic

Parameter Descriptions

rendererObjectType

The class type of the renderer to create.

function result

The new renderer object.

( TQ3Status ) Q3Renderer_SetConfigurationData (
    TQ3RendererObject renderer,
    unsigned char *dataBuffer,
    TQ3Uns32 bufferSize
);

Discussion

Set the configuration data for a renderer.

The configuration must have been obtained with a previous call to Q3Renderer_GetConfigurationData.

Parameter Descriptions

renderer

The renderer to update.

dataBuffer

The configuration data for the renderer.

bufferSize

The number of bytes pointed to by dataBuffer.

function result

Success or failure of the operation.

( TQ3Status ) Q3XDrawContext_ClearValidationFlags (
    TQ3DrawContextObject drawContext
);

Discussion

Clear the validation flags for a draw context.

This function should only be called from renderer plug-ins.

Parameter Descriptions

drawContext

The draw context to update.

function result

Success or failure of the operation.

( TQ3Status ) Q3XDrawContext_GetValidationFlags (
    TQ3DrawContextObject drawContext,
    TQ3XDrawContextValidation *validationFlags
);

Discussion

Get the validation flags for a draw context.

This function should only be called from renderer plug-ins.

Parameter Descriptions

drawContext

The draw context to query.

validationFlags

Receives the validation flags for a draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3XView_EndFrame (
    TQ3ViewObject view
);

Discussion

Indicate to a view that a frame has completed.

This function should only be called from asynchronous renderer plug-ins.

Parameter Descriptions

view

The view to notify.

function result

Success or failure of the operation.

( TQ3Status ) Q3XView_IdleProgress (
    TQ3ViewObject view,
    TQ3Uns32 current,
    TQ3Uns32 completed
);

Discussion

Update the view's idle state while rendering.

Allows non-interactive renderers to update the view with their progress. Progress should be passed as:

0% (theView, 0, maxValue); ..% (theView, 1 to maxValue-1, maxValue); 100% (theView, maxValue, maxValue);

Progress will be passed to the application callbacks registered with Q3View_SetIdleMethod or Q3View_SetIdleProgressMethod.

This function should only be called from renderer plug-ins.

Parameter Descriptions

view

The view to notify.

current

The amount of work performed so far.

completed

The total amount of work which will be performed.

function result

Success or failure of the operation.

© 1999-2008 Quesa Developers (Last Updated 5/10/2008)