Renderings

Detailed Description

Built-in rendering functions for the frame widget.

These function may be passed to gwinSetCustomDraw() to get different frame drawing styles.

Note

In your custom frame drawing function you may optionally call these standard functions and then draw your extra details on top.

These custom drawing routines don't have to worry about setting clipping as the framework sets clipping to the object window prior to calling these routines.

Functions
void	gwinFrameDraw_Std (GWidgetObject *gw, void *param)
	The default rendering function for the frame widget. More...
void	gwinFrameDraw_Transparent (GWidgetObject *gw, void *param)
	Renders the frame widget with a transparent client area. More...
void	gwinFrameDraw_Image (GWidgetObject *gw, void *param)
	Renders the frame widget and uses the specified image for the client area. More...

Function Documentation

gwinFrameDraw_Image()

void gwinFrameDraw_Image	(	GWidgetObject *	gw,
		void *	param
	)

Renders the frame widget and uses the specified image for the client area.

The image will be tiled throghout the client area. Therefore, to archive the best looking result the supplied image needs to be of the same size as the client area size of the frame widget (inner size).

Parameters

[in]	gw	The widget object (must be a frame object).
[in]	param	A parameter passed in from the user. Must be an image handle. See note below.

Note

The image must be already opened before calling gwinSetCustomDraw(). The handle is passed as the parameter to this function.

Precondition

GDISP_NEED_IMAGE must be set to GFXON

Function Class: Normal API, this function can be invoked by regular system threads.

gwinFrameDraw_Std()

void gwinFrameDraw_Std	(	GWidgetObject *	gw,
		void *	param
	)

The default rendering function for the frame widget.

Fills the client area with the background color.

Parameters

[in]	gw	The widget object (must be a frame widget).
[in]	param	A parameter passed in from the user. Ignored by this function.

Function Class: Normal API, this function can be invoked by regular system threads.

gwinFrameDraw_Transparent()

void gwinFrameDraw_Transparent	(	GWidgetObject *	gw,
		void *	param
	)

Renders the frame widget with a transparent client area.

Will not fill the client area at all.

Parameters

[in]	gw	The widget object (must be a frame object).
[in]	param	A parameter passed in from the user. Ignored by this function.

Note

The image custom draw function gwinFrameDraw_Image() uses param to pass in the gImage pointer. The image must be already opened before calling gwinSetCustomDraw().

Function Class: Normal API, this function can be invoked by regular system threads.