QuesaStyle.h

Discussion

Functions

( TQ3Status ) Q3AntiAliasStyle_GetData (
    TQ3StyleObject styleObject,
    TQ3AntiAliasStyleData *data
);

Discussion

Get the data from an anti-alias style.

Parameter Descriptions

styleObject

The style to query.

data

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3AntiAliasStyle_New (
    const TQ3AntiAliasStyleData *data
);

Discussion

Create an anti-alias style.

Parameter Descriptions

data

The anti-alias style data.

function result

The new anti-alias style.

( TQ3Status ) Q3AntiAliasStyle_SetData (
    TQ3StyleObject styleObject,
    const TQ3AntiAliasStyleData *data
);

Discussion

Set the data for an anti-alias style.

Parameter Descriptions

styleObject

The style to update.

data

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3AntiAliasStyle_Submit (
    const TQ3AntiAliasStyleData *data,
    TQ3ViewObject view
);

Discussion

Submit an anti-alias style to a view.

Parameter Descriptions

data

The anti-alias style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3BackfacingStyle_Get (
    TQ3StyleObject backfacingObject,
    TQ3BackfacingStyle *backfacingStyle
);

Discussion

Get the data from a backfacing style.

Parameter Descriptions

backfacingObject

The style to query.

backfacingStyle

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3BackfacingStyle_New (
    TQ3BackfacingStyle backfacingStyle
);

Discussion

Create a backfacing style.

Parameter Descriptions

backfacingStyle

The backfacing style data.

function result

The new backfacing style.

( TQ3Status ) Q3BackfacingStyle_Set (
    TQ3StyleObject backfacingObject,
    TQ3BackfacingStyle backfacingStyle
);

Discussion

Set the data for a backfacing style.

Parameter Descriptions

backfacingObject

The style to update.

backfacingStyle

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3BackfacingStyle_Submit (
    TQ3BackfacingStyle backfacingStyle,
    TQ3ViewObject view
);

Discussion

Submit a backfacing style to a view.

Parameter Descriptions

backfacingStyle

The backfacing style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3CastShadowsStyle_Get (
    TQ3StyleObject styleObject,
    TQ3Boolean *castShadows
);

Discussion

Get the data from a cast shadows style.

This function is not available in QD3D.

Parameter Descriptions

styleObject

The style to query.

castShadows

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3CastShadowsStyle_New (
    TQ3Boolean castsShadows
);

Discussion

Create a cast shadows style.

This function is not available in QD3D.

Parameter Descriptions

castShadows

The cast shadows style data.

function result

The new cast shadows style.

( TQ3Status ) Q3CastShadowsStyle_Set (
    TQ3StyleObject styleObject,
    TQ3Boolean castShadows
);

Discussion

Set the data for a cast shadows style.

This function is not available in QD3D.

Parameter Descriptions

styleObject

The style to update.

castShadows

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3CastShadowsStyle_Submit (
    TQ3Boolean castShadows,
    TQ3ViewObject view
);

Discussion

Submit a cast shadows style to a view.

This function is not available in QD3D.

Parameter Descriptions

castShadows

The cast shadows style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3FillStyle_Get (
    TQ3StyleObject styleObject,
    TQ3FillStyle *fillStyle
);

Discussion

Get the data from a fill style.

Parameter Descriptions

styleObject

The style to query.

filLStyle

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3FillStyle_New (
    TQ3FillStyle fillStyle
);

Discussion

Create a fill style.

Parameter Descriptions

fillStyle

The fill style data.

function result

The new fill style.

( TQ3Status ) Q3FillStyle_Set (
    TQ3StyleObject styleObject,
    TQ3FillStyle fillStyle
);

Discussion

Set the data for a fill style.

Parameter Descriptions

styleObject

The style to update.

fillStyle

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3FillStyle_Submit (
    TQ3FillStyle fillStyle,
    TQ3ViewObject view
);

Discussion

Submit a fill style to a view.

Parameter Descriptions

fillStyle

The fill style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3FogStyle_GetData (
    TQ3StyleObject styleObject,
    TQ3FogStyleData *data
);

Discussion

Get the data from a fog style.

Parameter Descriptions

styleObject

The style to query.

data

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3FogStyle_New (
    const TQ3FogStyleData *data
);

Discussion

Create a fog style.

Parameter Descriptions

data

The fog style data.

function result

The new fog style.

( TQ3Status ) Q3FogStyle_SetData (
    TQ3StyleObject styleObject,
    const TQ3FogStyleData *data
);

Discussion

Set the data for a fog style.

Parameter Descriptions

styleObject

The style to update.

data

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3FogStyle_Submit (
    const TQ3FogStyleData *data,
    TQ3ViewObject view
);

Discussion

Submit a fog style to a view.

Parameter Descriptions

data

The fog style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3HighlightStyle_Get (
    TQ3StyleObject highlight,
    TQ3AttributeSet *highlightAttribute
);

Discussion

Get the data from a highlight style.

Parameter Descriptions

highlight

The style to query.

highlightAttribute

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3HighlightStyle_New (
    TQ3AttributeSet highlightAttribute
);

Discussion

Create a highlight style.

Parameter Descriptions

highlightAttribute

The highlight style set.

function result

The new highlight style.

( TQ3Status ) Q3HighlightStyle_Set (
    TQ3StyleObject highlight,
    TQ3AttributeSet highlightAttribute
);

Discussion

Set the data for a highlight style.

Parameter Descriptions

highlight

The style to update.

highlightAttribute

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3HighlightStyle_Submit (
    TQ3AttributeSet highlightAttribute,
    TQ3ViewObject view
);

Discussion

Submit a highlight style to a view.

Parameter Descriptions

highlightAttribute

The highlight style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3InterpolationStyle_Get (
    TQ3StyleObject interpolationObject,
    TQ3InterpolationStyle *interpolationStyle
);

Discussion

Get the data from an interpolation style.

Parameter Descriptions

interpolationObject

The style to query.

interpolationStyle

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3InterpolationStyle_New (
    TQ3InterpolationStyle interpolationStyle
);

Discussion

Create an interpolation style.

Parameter Descriptions

interpolationStyle

The interpolation style data.

function result

The new interpolation style.

( TQ3Status ) Q3InterpolationStyle_Set (
    TQ3StyleObject interpolationObject,
    TQ3InterpolationStyle interpolationStyle
);

Discussion

Set the data for an interpolation style.

Parameter Descriptions

interpolationObject

The style to update.

interpolationStyle

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3InterpolationStyle_Submit (
    TQ3InterpolationStyle interpolationStyle,
    TQ3ViewObject view
);

Discussion

Submit an interpolation style to a view.

Parameter Descriptions

interpolationStyle

The interpolation style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3LineWidthStyle_GetData (
    TQ3StyleObject styleObject,
    float *outWidth
);

Discussion

Get width from a line width style.

This function is not available in QD3D.

Parameter Descriptions

styleObject

The style to query.

outWidth

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3LineWidthStyle_New (
    float inWidth
);

Discussion

Create a line width style.

This function is not available in QD3D.

Parameter Descriptions

inWidth

New line width in pixels.

function result

The new fog style.

( TQ3Status ) Q3LineWidthStyle_SetData (
    TQ3StyleObject styleObject,
    float inWidth
);

Discussion

Set the width for a line width style.

This function is not available in QD3D.

Parameter Descriptions

styleObject

The style to update.

inWidth

The new line width for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3LineWidthStyle_Submit (
    float inWidth,
    TQ3ViewObject view
);

Discussion

Submit a line width style to a view.

This function is not available in QD3D.

Parameter Descriptions

inWidth

New line width in pixels.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3OrientationStyle_Get (
    TQ3StyleObject frontFacingDirectionObject,
    TQ3OrientationStyle *frontFacingDirection
);

Discussion

Get the data from an orientation style.

Parameter Descriptions

frontFacingDirectionObject

The style to query.

frontFacingDirection

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3OrientationStyle_New (
    TQ3OrientationStyle frontFacingDirection
);

Discussion

Create an orientation style.

Parameter Descriptions

frontFacingDirection

The orientation style data.

function result

The new orientation style.

( TQ3Status ) Q3OrientationStyle_Set (
    TQ3StyleObject frontFacingDirectionObject,
    TQ3OrientationStyle frontFacingDirection
);

Discussion

Set the data for an orientation style.

Parameter Descriptions

frontFacingDirectionObject

The style to update.

frontFacingDirection

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3OrientationStyle_Submit (
    TQ3OrientationStyle frontFacingDirection,
    TQ3ViewObject view
);

Discussion

Submit an orientation style to a view.

Parameter Descriptions

frontFacingDirection

The orientation style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3PickIDStyle_Get (
    TQ3StyleObject pickIDObject,
    TQ3Uns32 *id
);

Discussion

Get the data from a pick ID style.

Parameter Descriptions

styleObject

The style to query.

id

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3PickIDStyle_New (
    TQ3Uns32 id
);

Discussion

Create a pick ID style.

Parameter Descriptions

id

The pick ID.

function result

The new pick ID style.

( TQ3Status ) Q3PickIDStyle_Set (
    TQ3StyleObject pickIDObject,
    TQ3Uns32 id
);

Discussion

Set the data for a pick ID style.

Parameter Descriptions

pickIDObject

The style to update.

id

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3PickIDStyle_Submit (
    TQ3Uns32 id,
    TQ3ViewObject view
);

Discussion

Submit a pick ID style to a view.

Parameter Descriptions

id

The pick ID.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3PickPartsStyle_Get (
    TQ3StyleObject pickPartsObject,
    TQ3PickParts *parts
);

Discussion

Get the data from a pick parts style.

Parameter Descriptions

pickPartsObject

The style to query.

parts

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3PickPartsStyle_New (
    TQ3PickParts parts
);

Discussion

Create a pick parts style.

Parameter Descriptions

parts

The pick parts.

function result

The new pick parts style.

( TQ3Status ) Q3PickPartsStyle_Set (
    TQ3StyleObject pickPartsObject,
    TQ3PickParts parts
);

Discussion

Set the data for a pick parts style.

Parameter Descriptions

pickPartsObject

The style to update.

parts

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3PickPartsStyle_Submit (
    TQ3PickParts parts,
    TQ3ViewObject view
);

Discussion

Submit a pick parts style to a view.

Parameter Descriptions

parts

The pick parts style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3ReceiveShadowsStyle_Get (
    TQ3StyleObject styleObject,
    TQ3Boolean *receiveShadows
);

Discussion

Get the data from a receive shadows style.

Parameter Descriptions

styleObject

The style to query.

receiveShadows

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3ReceiveShadowsStyle_New (
    TQ3Boolean receiveShadows
);

Discussion

Create a receive shadows style.

Parameter Descriptions

receiveShadows

The receive shadows style data.

function result

The new receive shadows style.

( TQ3Status ) Q3ReceiveShadowsStyle_Set (
    TQ3StyleObject styleObject,
    TQ3Boolean receiveShadows
);

Discussion

Set the data for a receive shadows style.

Parameter Descriptions

styleObject

The style to update.

receiveShadows

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3ReceiveShadowsStyle_Submit (
    TQ3Boolean receiveShadows,
    TQ3ViewObject view
);

Discussion

Submit a receive shadows style to a view.

Parameter Descriptions

receiveShadows

The receive shadows style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3ObjectType ) Q3Style_GetType (
    TQ3StyleObject style
);

Discussion

Get the type of a style object.

Parameter Descriptions

style

The style to query.

function result

The type of the style.

( TQ3Status ) Q3Style_Submit (
    TQ3StyleObject style,
    TQ3ViewObject view
);

Discussion

Submit a style to a view.

Parameter Descriptions

style

The style to submit.

view

The view to submit the style to.

function result

Success or failure of the operation.

( TQ3Status ) Q3SubdivisionStyle_GetData (
    TQ3StyleObject subdiv,
    TQ3SubdivisionStyleData *data
);

Discussion

Get the data from a subdivision style.

Parameter Descriptions

subdiv

The style to query.

data

Receives the data from the style.

function result

Success or failure of the operation.

( TQ3StyleObject ) Q3SubdivisionStyle_New (
    const TQ3SubdivisionStyleData *data
);

Discussion

Create a subdivision style.

Parameter Descriptions

data

The subdivision style data.

function result

The new subdivision style.

( TQ3Status ) Q3SubdivisionStyle_SetData (
    TQ3StyleObject subdiv,
    const TQ3SubdivisionStyleData *data
);

Discussion

Set the data for a subdivision style.

Parameter Descriptions

subdiv

The style to update.

data

The new data for the style.

function result

Success or failure of the operation.

( TQ3Status ) Q3SubdivisionStyle_Submit (
    const TQ3SubdivisionStyleData *data,
    TQ3ViewObject view
);

Discussion

Submit a subdivision style to a view.

Parameter Descriptions

data

The subdivision style data.

view

The view to submit the style to.

function result

Success or failure of the operation.

Typedefs

typedef TQ3Uns32                                TQ3AntiAliasMode;

Discussion

Holds one or more TQ3AntiAliasModeMasks values.

typedef TQ3Uns32                                TQ3PickParts;

Discussion

Holds TQ3PickPartsMasks values.

Structs

typedef struct TQ3AntiAliasStyleData {
    TQ3Switch                                   state;
    TQ3AntiAliasMode                            mode;
    float                                       quality;
} TQ3AntiAliasStyleData;

Discussion

Anti-alias style data.

Anti-aliasing may be toggled on and off using the state switch. To guarantee that no anti-aliasing is performed, the state must be set to kQ3Off.

The type of anti-aliasing performed is controlled by the mode switch.

The quality of anti-aliasing performed is controlled by the quality field, which can range from 0.0 (minimum) to 1.0 (maximum). Values outside this range are undefined.

Field Descriptions

state

Is anti-aliasing active?

mode

The anti-aliasing mode.

quality

The anti-aliasing quality.

typedef struct TQ3FogStyleData {
    TQ3Switch                                   state;
    TQ3FogMode                                  mode;
    float                                       fogStart;
    float                                       fogEnd;
    float                                       density;
    TQ3ColorARGB                                color;
} TQ3FogStyleData;

Discussion

Fog style data.

Fog may be toggled on and off using the state switch. To guarantee that no fogging is performed, the state must be set to kQ3Off.

The type of fogging performed is controlled by the mode switch.

Field Descriptions

state

Is fog active?

mode

The fog mode.

fogStart

The start point for fog (only used for linear fog).

fogEnd

The end point for fog (only used for linear fog).

density

The maximum density for fog (ignored in linear fog).

color

The fog color.

typedef struct TQ3SubdivisionStyleData {
    TQ3SubdivisionMethod                        method;
    float                                       c1;
    float                                       c2;
} TQ3SubdivisionStyleData;

Discussion

Subdivision style data.

The c1 parameter is used as the "size" for all subdivision methods. Its meaning and units depends on the subdivision method.

The c2 parameter is used as an additional parameter for surfaces by the kQ3SubdivisionMethodConstant method, to allow control over subdivision in both horizontal and vertical dimensions.

Field Descriptions

method

The subdivision method.

c1

The first parameter for the subdivision method.

c2

The second parameter for the subdivision method.

Enumerations

typedef enum TQ3AntiAliasModeMasks {
    kQ3AntiAliasModeMaskEdges                   = (1 << 0),
    kQ3AntiAliasModeMaskFilled                  = (1 << 1),
    kQ3AntiAliasModeMaskFullScreen              = (1 << 2),
#endif // QUESA_ALLOW_QD3D_EXTENSIONS
    kQ3AntiAliasModeSize32                      = 0xFFFFFFFF
} TQ3AntiAliasModeMasks;

Discussion

Anti-alias style selectors.

Constants

kQ3AntiAliasModeMaskEdges

Apply anti-aliasing to wireframe objects.

kQ3AntiAliasModeMaskFilled

Apply anti-aliasing to filled objects.

kQ3AntiAliasModeMaskFullScreen

Apply global anti-aliasing (e.g., FSAA). This feature is not available in QD3D.

typedef enum TQ3BackfacingStyle {
    kQ3BackfacingStyleBoth                      = 0,
    kQ3BackfacingStyleRemove                    = 1,
    kQ3BackfacingStyleFlip                      = 2,
    kQ3BackfacingStyleSize32                    = 0xFFFFFFFF
} TQ3BackfacingStyle;

Discussion

Backfacing styles.

Constants

kQ3BackfacingStyleBoth

Both backfacing and front facing surfaces are rendered.

kQ3BackfacingStyleRemove

Backfacing surfaces are removed before rendering.

kQ3BackfacingStyleFlip

Both backfacing and front facing surfaces are rendered, and the surface normals of backfacing surfaces are inverted before rendering.

typedef enum TQ3FillStyle {
    kQ3FillStyleFilled                          = 0,
    kQ3FillStyleEdges                           = 1,
    kQ3FillStylePoints                          = 2,
    kQ3FillStyleSize32                          = 0xFFFFFFFF
} TQ3FillStyle;

Discussion

Fill styles.

Constants

kQ3FillStyleFilled

Shapes are rendered as filled surfaces.

kQ3FillStyleEdges

Shapes are rendered as sets of lines.

kQ3FillStylePoints

Shapes are rendered as sets of points.

typedef enum TQ3FogMode {
    kQ3FogModeLinear                            = 0,
    kQ3FogModeExponential                       = 1,
    kQ3FogModeExponentialSquared                = 2,
    kQ3FogModeAlpha                             = 3,
    kQ3FogModeSize32                            = 0xFFFFFFFF
} TQ3FogMode;

Discussion

Indicates how fog increases in density with distance.

Quesa's interactive renderer does not currently implement alpha fog.

Constants

kQ3FogModeLinear

Fog == (End - z) / (End - Start)

kQ3FogModeExponential

Fog == exp(-Density * z)

kQ3FogModeExponentialSquared

Fog == exp(-Density * z * Density * z).

kQ3FogModeAlpha

Fog == Vertex Alpha

typedef enum TQ3InterpolationStyle {
    kQ3InterpolationStyleNone                   = 0,
    kQ3InterpolationStyleVertex                 = 1,
    kQ3InterpolationStylePixel                  = 2,
    kQ3InterpolationSize32                      = 0xFFFFFFFF
} TQ3InterpolationStyle;

Discussion

Interpolation styles.

Constants

kQ3InterpolationStyleNone

Faces are rendered with a uniform illumination.

kQ3InterpolationStyleVertex

Individual vertices are shaded, and their values are interpolated across each face.

kQ3InterpolationStylePixel

Individual pixels are shaded. Is not typically supported by interactive renderers.

typedef enum TQ3OrientationStyle {
    kQ3OrientationStyleCounterClockwise         = 0,
    kQ3OrientationStyleClockwise                = 1,
    kQ3OrientationStyleSize32                   = 0xFFFFFFFF
} TQ3OrientationStyle;

Discussion

Defines the "front facing" side of polygons.

Constants

kQ3OrientationStyleCounterClockwise

The front face is defined as CCW order.

kQ3OrientationStyleClockwise

The front face is defined as CW order.

typedef enum TQ3PickPartsMasks {
    kQ3PickPartsObject                          = 0,
    kQ3PickPartsMaskFace                        = (1 << 0),
    kQ3PickPartsMaskEdge                        = (1 << 1),
    kQ3PickPartsMaskVertex                      = (1 << 2),
    kQ3PickPartsMaskSize32                      = 0xFFFFFFFF
} TQ3PickPartsMasks;

Discussion

Indicates the kind of objects placed in a hit list.

Constants

kQ3PickPartsObject

The hit list contains whole objects.

kQ3PickPartsMaskFace

The hit list contains faces.

kQ3PickPartsMaskEdge

The hit list contains edges.

kQ3PickPartsMaskVertex

The hit list contains vertices.

typedef enum TQ3SubdivisionMethod {
    kQ3SubdivisionMethodConstant                = 0,
    kQ3SubdivisionMethodWorldSpace              = 1,
    kQ3SubdivisionMethodScreenSpace             = 2,
    kQ3SubdivisionMethodSize32                  = 0xFFFFFFFF
} TQ3SubdivisionMethod;

Discussion

Subdivision methods.

Constants

kQ3SubdivisionMethodConstant

Surfaces are divided into the specified number of segments.

kQ3SubdivisionMethodWorldSpace

Surfaces are divided into segments smaller than the specified size in world-space.

kQ3SubdivisionMethodScreenSpace

Surfaces are divided into segments smaller than the specified size in pixels.

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