Functions

( TQ3Status ) Q3CocoaDrawContext_GetNSView (
    TQ3DrawContextObject drawContext,
    void **nsView
);

Discussion

Get the NSView of a Cocoa draw context.

This function is not available in QD3D.

Parameter Descriptions

drawContext

The draw context to query.

nsView

Receives the NSView of the draw context.

function result

Success or failure of the operation.

( TQ3DrawContextObject ) Q3CocoaDrawContext_New (
    const TQ3CocoaDrawContextData *drawContextData
);

Discussion

Create a new Cocoa draw context object.

This function is not available in QD3D.

Parameter Descriptions

drawContextData

The data for the Cocoa draw context object.

function result

The new draw context object.

( TQ3Status ) Q3CocoaDrawContext_SetNSView (
    TQ3DrawContextObject drawContext,
    void *nsView
);

Discussion

Set the NSView for a Cocoa draw context.

This function is not available in QD3D.

Parameter Descriptions

drawContext

The draw context to update.

nsView

The new NSView for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3DDSurfaceDrawContext_GetDirectDrawSurface (
    TQ3DrawContextObject drawContext,
    TQ3DDSurfaceDescriptor *ddSurfaceDescriptor
);

Discussion

Get the DD surface of a Win32 DD draw context.

Parameter Descriptions

drawContext

The draw context to query.

ddSurfaceDescriptor

Receives the DD surface of the draw context.

function result

Success or failure of the operation.

( TQ3DrawContextObject ) Q3DDSurfaceDrawContext_New (
    const TQ3DDSurfaceDrawContextData *drawContextData
);

Discussion

Create a new Win32 DD draw context object.

Parameter Descriptions

drawContextData

The data for the draw context.

function result

The new Win32 DD draw context.

( TQ3Status ) Q3DDSurfaceDrawContext_SetDirectDrawSurface (
    TQ3DrawContextObject drawContext,
    const TQ3DDSurfaceDescriptor *ddSurfaceDescriptor
);

Discussion

Set the DD surface for a Win32 DD draw context.

Parameter Descriptions

drawContext

The draw context to update.

ddSurfaceDescriptor

The new DD surface for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_GetClearImageColor (
    TQ3DrawContextObject context,
    TQ3ColorARGB *color
);

Discussion

Get the clear image colour of a draw context.

Parameter Descriptions

context

The draw context to query.

color

Receives the clear image colour.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_GetClearImageMethod (
    TQ3DrawContextObject context,
    TQ3DrawContextClearImageMethod *method
);

Discussion

Get the clear image method of a draw context.

Parameter Descriptions

context

The draw context to query.

method

Receives the clear image method.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_GetData (
    TQ3DrawContextObject context,
    TQ3DrawContextData *contextData
);

Discussion

Get the common state of a draw context.

Parameter Descriptions

context

The draw context to query.

contextData

Receives the common state for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_GetDoubleBufferState (
    TQ3DrawContextObject context,
    TQ3Boolean *state
);

Discussion

Get the double-buffer state of a draw context.

Parameter Descriptions

context

The draw context to query.

state

Receives true or false as the draw context is double-buffered.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_GetMask (
    TQ3DrawContextObject context,
    TQ3Bitmap *mask
);

Discussion

Get the mask of a draw context.

Parameter Descriptions

context

The draw context to query.

mask

Receives the current draw context mask.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_GetMaskState (
    TQ3DrawContextObject context,
    TQ3Boolean *state
);

Discussion

Get the mask state of a draw context.

Parameter Descriptions

context

The draw context to query.

state

Receives true or false as the mask is active.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_GetPane (
    TQ3DrawContextObject context,
    TQ3Area *pane
);

Discussion

Get the area within the draw context which is rendered to.

Rendering within a draw context is constrained to within the active pane. If no pane is active, renderers will draw to the entire draw context (e.g., the bounds of the window).

Note that, unlike QD3D, Quesa will return the size of the entire draw context if this routine is called on a draw context which has not had an explicit pane set.

Parameter Descriptions

context

The draw context to query.

pane

Receives the dimensions of the rendered area.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_GetPaneState (
    TQ3DrawContextObject context,
    TQ3Boolean *state
);

Discussion

Get the pane state of a draw context.

Parameter Descriptions

context

The draw context to query.

state

Receives true or false as the pane is active.

function result

Success or failure of the operation.

( TQ3ObjectType ) Q3DrawContext_GetType (
    TQ3DrawContextObject drawContext
);

Discussion

Get the type of a draw context.

Returns kQ3ObjectTypeInvalid if the draw context type is unknown.

Parameter Descriptions

drawContext

The draw context to query.

function result

The type of the draw context object.

( TQ3Status ) Q3DrawContext_SetClearImageColor (
    TQ3DrawContextObject context,
    const TQ3ColorARGB *color
);

Discussion

Set the clear image colour for a draw context.

Parameter Descriptions

context

The draw context to update.

color

The new clear image colour.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_SetClearImageMethod (
    TQ3DrawContextObject context,
    TQ3DrawContextClearImageMethod method
);

Discussion

Set the clear image method for a draw context.

Parameter Descriptions

context

The draw context to update.

method

The new clear image method.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_SetData (
    TQ3DrawContextObject context,
    const TQ3DrawContextData *contextData
);

Discussion

Set the common state for a draw context.

Parameter Descriptions

context

The draw context to update.

contextData

The new common state for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_SetDoubleBufferState (
    TQ3DrawContextObject context,
    TQ3Boolean state
);

Discussion

Set the double-buffer state of a draw context.

A double-buffered draw context will draw to an off-screen buffer as objects are submited, and update the destination window/surface once at the end of the frame.

Parameter Descriptions

context

The draw context to update.

state

True or false as the draw context is to be double-buffered.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_SetMask (
    TQ3DrawContextObject context,
    const TQ3Bitmap *mask
);

Discussion

Set the mask for a draw context.

The mask field is a bitmap-level clipping mask, which clips the rendered output as it is copied to the destination.

This feature is not currently supported by Quesa's interactive renderers.

Parameter Descriptions

context

The draw context to update.

mask

The new mask for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_SetMaskState (
    TQ3DrawContextObject context,
    TQ3Boolean state
);

Discussion

Set the mask state for a draw context.

Parameter Descriptions

context

The draw context to update.

state

True or false as the mask is active.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_SetPane (
    TQ3DrawContextObject context,
    const TQ3Area *pane
);

Discussion

Set the area within the draw context which is rendered to.

Rendering within a draw context is constrained to within the active pane. If no pane is active, renderers will draw to the entire draw context (e.g., the bounds of the window).

Parameter Descriptions

context

The draw context to update.

pane

The area which rendering will be constrained to.

function result

Success or failure of the operation.

( TQ3Status ) Q3DrawContext_SetPaneState (
    TQ3DrawContextObject context,
    TQ3Boolean state
);

Discussion

Set the pane state for a draw context.

Parameter Descriptions

context

The draw context to update.

state

True or false as the pane is active.

function result

Success or failure of the operation.

( TQ3Status ) Q3MacDrawContext_Get2DLibrary (
    TQ3DrawContextObject drawContext,
    TQ3MacDrawContext2DLibrary *library
);

Discussion

Get the 2D library of a Mac draw context.

Parameter Descriptions

drawContext

The draw context to query.

library

Receives the 2D library of the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3MacDrawContext_GetGXViewPort (
    TQ3DrawContextObject drawContext,
    gxViewPort *viewPort
);

Discussion

Get the QuickDraw GX port of a Mac draw context.

Parameter Descriptions

drawContext

The draw context to query.

viewPort

Receives the QuickDraw GX port of the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3MacDrawContext_GetGrafPort (
    TQ3DrawContextObject drawContext,
    CGrafPtr *grafPort
);

Discussion

Get the Mac OS GrafPort of a Mac draw context.

Parameter Descriptions

drawContext

The draw context to query.

grafPort

Receives the Mac OS GrafPort of the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3MacDrawContext_GetWindow (
    TQ3DrawContextObject drawContext,
    CWindowPtr *window
);

Discussion

Get the window of a Mac draw context.

Parameter Descriptions

drawContext

The draw context to query.

window

Receives the window of the draw context.

function result

Success or failure of the operation.

( TQ3DrawContextObject ) Q3MacDrawContext_New (
    const TQ3MacDrawContextData *drawContextData
);

Discussion

Create a new Mac draw context object.

Parameter Descriptions

drawContextData

The data for the Mac draw context object.

function result

The new draw context object.

( TQ3Status ) Q3MacDrawContext_Set2DLibrary (
    TQ3DrawContextObject drawContext,
    TQ3MacDrawContext2DLibrary library
);

Discussion

Set the 2D library for a Mac draw context.

Parameter Descriptions

drawContext

The draw context to update.

library

The new 2D library for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3MacDrawContext_SetGXViewPort (
    TQ3DrawContextObject drawContext,
    gxViewPort viewPort
);

Discussion

Set the QuickDraw GX port for a Mac draw context.

Parameter Descriptions

drawContext

The draw context to update.

viewPort

The new QuickDraw GX port for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3MacDrawContext_SetGrafPort (
    TQ3DrawContextObject drawContext,
    CGrafPtr grafPort
);

Discussion

Set the Mac OS GrafPort for a Mac draw context.

Parameter Descriptions

drawContext

The draw context to update.

grafPort

The new Mac OS GrafPort for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3MacDrawContext_SetWindow (
    TQ3DrawContextObject drawContext,
    CWindowPtr window
);

Discussion

Set the window for a Mac draw context.

Parameter Descriptions

drawContext

The draw context to update.

window

The new window for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3PixmapDrawContext_GetPixmap (
    TQ3DrawContextObject drawContext,
    TQ3Pixmap *pixmap
);

Discussion

Get the pixmap of a pixmap draw context.

Parameter Descriptions

drawContext

The draw context to query.

pixmap

Receives the pixmap of the draw context.

function result

Success or failure of the operation.

( TQ3DrawContextObject ) Q3PixmapDrawContext_New (
    const TQ3PixmapDrawContextData *contextData
);

Discussion

Create a new Pixmap draw context object.

Parameter Descriptions

contextData

The data for the pixmap draw context object.

function result

The new draw context object.

( TQ3Status ) Q3PixmapDrawContext_SetPixmap (
    TQ3DrawContextObject drawContext,
    const TQ3Pixmap *pixmap
);

Discussion

Set the pixmap for a pixmap draw context.

Parameter Descriptions

drawContext

The draw context to update.

pixmap

The new pixmap for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3Win32DCDrawContext_GetDC (
    TQ3DrawContextObject drawContext,
    HDC *curHDC
);

Discussion

Get the DC for a Win32 DC draw context.

Parameter Descriptions

drawContext

The draw context to query.

curHDC

Receives the DC of the draw context.

function result

Success or failure of the operation.

( TQ3DrawContextObject ) Q3Win32DCDrawContext_New (
    const TQ3Win32DCDrawContextData *drawContextData
);

Discussion

Create a new Win32 DC draw context object.

Parameter Descriptions

drawContextData

The data for the Win32 DC draw context object.

function result

The new draw context object.

( TQ3Status ) Q3Win32DCDrawContext_SetDC (
    TQ3DrawContextObject drawContext,
    HDC newHDC
);

Discussion

Set the DC for a Win32 DC draw context.

Parameter Descriptions

drawContext

The draw context to update.

newHDC

The new DC for the draw context.

function result

Success or failure of the operation.

( TQ3XBufferObject ) Q3XBuffers_New (
    Display *dpy,
    TQ3Uns32 numBuffers,
    Window window
);

Discussion

Create a new X11 buffer object.

Note - no QD3D documentation could be found for this routine. The purpose of the function, and its parameters/result, have been assumed.

Parameter Descriptions

dpy

The X11 display.

numBuffers

The number of buffers to create.

window

The X11 window.

function result

The new X11 buffer object.

( void ) Q3XBuffers_Swap (
    Display *dpy,
    TQ3XBufferObject buffers
);

Discussion

Swap the front and back buffers of an X11 buffer object.

Note - no QD3D documentation could be found for this routine. The purpose of the function, and its parameters/result, have been assumed.

Parameter Descriptions

dpy

The X11 display.

buffers

The X11 buffer object.

( TQ3Status ) Q3XDrawContext_GetColormap (
    TQ3DrawContextObject drawContext,
    Colormap *colormap
);

Discussion

Get the Colormap of an X11 draw context.

Parameter Descriptions

drawContext

The draw context to query.

colormap

Receives the Colormap of the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3XDrawContext_GetColormapData (
    TQ3DrawContextObject drawContext,
    TQ3XColormapData *colormapData
);

Discussion

Get the Colormap data of an X11 draw context.

Parameter Descriptions

drawContext

The draw context to query.

colormapData

Receives the Colormap data of the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3XDrawContext_GetDisplay (
    TQ3DrawContextObject drawContext,
    Display **display
);

Discussion

Get the Display of an X11 draw context.

Parameter Descriptions

drawContext

The draw context to query.

display

Receives the Display of the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3XDrawContext_GetDrawable (
    TQ3DrawContextObject drawContext,
    Drawable *drawable
);

Discussion

Get the Drawable of an X11 draw context.

Parameter Descriptions

drawContext

The draw context to query.

drawable

Receives the Drawable of the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3XDrawContext_GetVisual (
    TQ3DrawContextObject drawContext,
    Visual **visual
);

Discussion

Get the Visual of an X11 draw context.

Parameter Descriptions

drawContext

The draw context to query.

visual

Receives the Visual of the draw context.

function result

Success or failure of the operation.

( TQ3DrawContextObject ) Q3XDrawContext_New (
    const TQ3XDrawContextData *drawContextData
);

Discussion

Create a new X11 draw context object.

Parameter Descriptions

drawContextData

The data for the X11 draw context object.

function result

The new draw context object.

( TQ3Status ) Q3XDrawContext_SetColormap (
    TQ3DrawContextObject drawContext,
    Colormap colormap
);

Discussion

Set the Colormap of an X11 draw context.

Parameter Descriptions

drawContext

The draw context to update.

colormap

The new Colormap for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3XDrawContext_SetColormapData (
    TQ3DrawContextObject drawContext,
    const TQ3XColormapData *colormapData
);

Discussion

Set the Colormap data for an X11 draw context.

Parameter Descriptions

drawContext

The draw context to update.

colormapData

The new Colormap data for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3XDrawContext_SetDisplay (
    TQ3DrawContextObject drawContext,
    const Display *display
);

Discussion

Set the Display for an X11 draw context.

Parameter Descriptions

drawContext

The draw context to update.

display

The new Display for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3XDrawContext_SetDrawable (
    TQ3DrawContextObject drawContext,
    Drawable drawable
);

Discussion

Set the Drawable for an X11 draw context.

Parameter Descriptions

drawContext

The draw context to update.

drawable

The new Drawable for the draw context.

function result

Success or failure of the operation.

( TQ3Status ) Q3XDrawContext_SetVisual (
    TQ3DrawContextObject drawContext,
    const Visual *visual
);

Discussion

Set the Visual of an X11 draw context.

Parameter Descriptions

drawContext

The draw context to update.

visual

The new Visual for the draw context.

function result

Success or failure of the operation.

( XVisualInfo * ) Q3X_GetVisualInfo (
    Display *dpy,
    Screen *screen
);

Discussion

Get an X11 visual info.

Note - no QD3D documentation could be found for this routine. The purpose of the function, and its parameters/result, have been assumed.

Parameter Descriptions

dpy

The X11 display.

screen

The X11 screen.

function result

The X11 visual info.

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