Main Page | Modules | Related Pages

Object Rotation/Scaling Functions

Functions


Detailed Description

The Object Rotation/Scaling SubSystem can be used to create Rotation/Scaling Sets, which can be assigned to Objects, to perform rotation and scaling in hardware. The Rotation/Scaling Parameter-Attributes are shadowed internally and should be transmitted to hardware during VBL to avoid shearing.

Please see "demos/ObjRotation" for an example program.


Function Documentation

THandle hel_ObjRotScaleClone THandle  Handle  ) 
 

Clone a Rotation/Scaling Set.

The hel_ObjRotScaleClone function clones an existing Rotation/Scaling Set.

Parameters:
Handle Handle of Rotation/Scaling Set you want to clone
Returns:
Returns the Handle of the cloned Rotation/Scaling Set.

THandle hel_ObjRotScaleCreate u32  Angle,
s32  ZoomX,
s32  ZoomY
 

Create a new Rotation/Scaling Set.

The hel_ObjRotScaleCreate creates a new Rotation/Scaling Set and returns a Handle to it.

Parameters:
Angle Rotation-angle in degree (0..359)
ZoomX Horizontal scaling
ZoomY Vertical scaling
Returns:
Returns a Handle to the created Rotation/Scaling Set.
ZoomX and ZoomY are in fixed point format, where 256 equals 1 and means no zoom at all. Bigger numbers enlarge, smaller reduce the size.

See also:
hel_ObjRotScaleClone

void hel_ObjRotScaleDeInit void   ) 
 

Deinitialize Object Rotation/Scaling SubSystem.

Call hel_ObjRotScaleInit to deinitialize the Rotation/Scaling Parameter SubSystem.

void hel_ObjRotScaleDelete THandle  Handle  ) 
 

Delete a Rotation/Scaling Set.

The hel_ObjRotScaleDelete deletes the Rotation/Scaling Set specified by Handle when it's not referenced anymore.

Parameters:
Handle Handle of Rotation/Scaling Set you want to delete
In case the Rotation/Scaling Set has been cloned, it will not be delete until all clones have been deleted too.

u32 hel_ObjRotScaleGetFreeSlots void   ) 
 

Get amount of free Rotation/Scaling Sets.

The hel_ObjRotScaleGetFreeSlots returns the amount of free/unused Rotation/Scaling Sets.

void hel_ObjRotScaleInit void   ) 
 

Initialize Object Rotation/Scaling SubSystem.

Call hel_ObjRotScaleInit once to initialize the Rotation/Scaling Parameter SubSystem. This function must be called before using any other Object Rotation/Scaling function.

void hel_ObjRotScaleReset void   ) 
 

Reset Object Rotation/Scaling SubSystem.

The hel_ObjRotScaleReset resets the Object Rotation/Scaling SubSystem.

void hel_ObjRotScaleTransmit void   ) 
 

Transmit Rotation/Scaling Parameters to hardware.

The hel_ObjRotScaleTransmit forces the Rotation/Scaling SubSystem to copy its shadowed parameters to hardware (Vram). This function should be called during Vertical Blank.

void hel_ObjRotScaleUpdate THandle  Handle,
u32  Angle,
s32  ZoomX,
s32  ZoomY
 

Update Rotation/Scaling Parameters.

hel_ObjRotScaleUpdate can be used to update the parameters of an existing Rotation/Scaling Set. This includes the rotation-angle and zoom.

Parameters:
Handle Handle of Rotation/Scaling Set
Angle Rotation-angle in degree
ZoomX Horizontal zoom
ZoomY Vertical zoom
See also:
hel_ObjRotScaleCreate


Generated on Sun Oct 9 20:21:01 2005 by DoxyGen 1.4.4