TSpriteMember Struct Reference

Sprite member. More...

#include <w32std.h>

Public Attributes
CFbsBitmap *	iBitmap
	The bitmap to be displayed in the sprite or pointer cursor during the time interval specified by iInterval.
CFbsBitmap *	iMaskBitmap
	The bitmap mask.
TBool	iInvertMask
	EFalse if the mask bitmap is not to be inverted (the default) or ETrue if it is to be inverted.
CGraphicsContext::TDrawMode	iDrawMode
	Specifies the drawing mode to use when drawing iBitmap if the mask is NULL.
TPoint	iOffset
	Offset from the sprite's central position.
TTimeIntervalMicroSeconds32	iInterval
	Time interval for which iBitmap is displayed.

Detailed Description

Sprite member.

This structure is used to define the parameters of a sprite member, which can be added to a sprite or pointer cursor.

API status

Published to all clients. Released API.

Definition at line 731 of file w32std.h.

Member Data Documentation

iBitmap

CFbsBitmap* TSpriteMember::iBitmap

The bitmap to be displayed in the sprite or pointer cursor during the time interval specified by iInterval.

If NULL, the sprite or pointer cursor will be invisible for the time specified by iInterval.

Definition at line 747 of file w32std.h.

iDrawMode

CGraphicsContext::TDrawMode TSpriteMember::iDrawMode

Specifies the drawing mode to use when drawing iBitmap if the mask is NULL.

Definition at line 768 of file w32std.h.

iInterval

TTimeIntervalMicroSeconds32 TSpriteMember::iInterval

Time interval for which iBitmap is displayed.

Note that if only one sprite member is added to a sprite or pointer cursor, it will be displayed continuously, regardless of the value of iInterval.

Definition at line 778 of file w32std.h.

iInvertMask

TBool TSpriteMember::iInvertMask

EFalse if the mask bitmap is not to be inverted (the default) or ETrue if it is to be inverted.

Definition at line 766 of file w32std.h.

iMaskBitmap

CFbsBitmap* TSpriteMember::iMaskBitmap

The bitmap mask.

This defines which areas of iBitmap are drawn to the screen. It enables the bitmap to have a non-rectangular shape on the screen. Areas which are not drawn to, retain the appearance of the window underneath the sprite or cursor.

The bits in iBitmap are AND'ed with those in iMaskBitmap before being drawn to the screen. In practice, the mask bitmap is normally white in those areas drawn to by iBitmap, and black in all other areas.

Note:

This bitmap should be in the same mode as iBitmap, otherwise the masking out operation becomes inefficient.

Definition at line 763 of file w32std.h.

iOffset

TPoint TSpriteMember::iOffset

Offset from the sprite's central position.

Specifies an offset between the origin of iBitmap and the sprite or pointer cursor's origin. (The origin is the top left corner of the bitmap.)

Definition at line 773 of file w32std.h.

---

The documentation for this struct was generated from the following file:

• w32std.h