Main Page | Modules | Related Pages

Object Functions

Functions


Function Documentation

void hel_ObjBringToFront u8  ObjNo  ) 
 

Bring an object to front.

This function brings the object specified by ObjNo infront of all other objects.

Parameters:
ObjNo : Object number in HAM object management system

u8 hel_ObjCreate void *  pSrc,
u16  ObjShape,
u16  ObjSize,
u16  ObjMode,
u16  ColMode,
u16  PalNo,
u16  Mosaic,
u16  HFlip,
u16  VFlip,
u16  Prio,
u16  DblSize,
s16  X,
s16  Y
 

Create a new object.

This function creates a new object in HAM.

It is more or less only a wrapper function for ham_CreateObj, because you cannot specify negative values in ham_CreateObj (HAM 2.8 and lower). Check your local HAM documentation to learn more about ham_CreateObj parameters.

Returns:
Handle to the new object.

u8 hel_ObjCreate16 void *  pSrc,
u16  ObjShape,
u16  ObjSize,
u16  ObjMode,
u16  PalNo,
s16  X,
s16  Y
 

Create a new object using 16 colors.

This function is a simplified version of hel_ObjCreate() for 16 color objects.
It creates a new object in HAM, using a 16 color palette and it automatically sets several properties by default, those are:

  • ColMode = 0
  • Mosaic = FALSE
  • HFlip = FALSE
  • VFlip = FALSE
  • Prio = 0
  • DblSize = FALSE

Check your local HAM documentation to learn more about ham_CreateObj parameters.

Returns:
Handle to the new object.

u8 hel_ObjCreate256 void *  pSrc,
u16  ObjShape,
u16  ObjSize,
u16  ObjMode,
s16  X,
s16  Y
 

Create a new object using 256 colors.

This function is a simplified version of hel_ObjCreate() for 256 color objects.
It creates a new object in HAM, using a 256 color palette and it automatically sets several properties by default, those are:

  • ColMode = 1
  • PalNo = 0
  • Mosaic = FALSE
  • HFlip = FALSE
  • VFlip = FALSE
  • Prio = 0
  • DblSize = FALSE

Check your local HAM documentation to learn more about ham_CreateObj parameters.

Returns:
Handle to the new object.

u8 hel_ObjExists u8  ObjNo  ) 
 

Check if an object exist.

This function checks if the object specified by ObjNo exists in HAM

Parameters:
ObjNo : Object number in HAM object management system
Returns:
Returns true if object exists, otherwise false

u8 hel_ObjGetColorMode u8  ObjNo  ) 
 

Check if an object uses 256 or 16 colors.

Use this function to figure out if the object specified by ObjNo uses 256 colors or 16 colors.

Parameters:
ObjNo : Object number in HAM object management system
Returns:
Returns 1 if it uses 256 colors, otherwise 0

u8 hel_ObjGetFirst void   ) 
 

Get the first object number.

This function returns the number (index) of the first object in HAM's object management system.

u8 hel_ObjGetMode u8  ObjNo  ) 
 

Get the mode of an object.

This function will return what mode an object uses.

Parameters:
ObjNo : Object number in HAM object management system
Returns:
  • OBJ_MODE_NORMAL (0x00)
  • OBJ_MODE_SEMITRANSPARENT (0x01)
  • OBJ_MODE_OBJWINDOW (0x02)

u8 hel_ObjIsHFlip u8  ObjNo  ) 
 

Check if an object is horizontal flipped.

Use this function to figure out if the object specified by ObjNo is H flipped.

Parameters:
ObjNo : Object number in HAM object management system
Returns:
Returns true if it is horizontal flipped, otherwise false
See also:
hel_ObjIsVFlip()

u8 hel_ObjIsMosaic u8  ObjNo  ) 
 

Check if an object has mosaic attribute set.

Use this function to figure out if the object specified by ObjNo has the Mosaic attribute set.

Parameters:
ObjNo : Object number in HAM object management system
Returns:
Returns true if uses mosaic, otherwise false

u8 hel_ObjIsRotScale u8  ObjNo  ) 
 

Check if an object has rotation/scaling attribute set.

Use this function to figure out if the object specified by ObjNo has the Rotation/Scaling attribute set.

Parameters:
ObjNo : Object number in HAM object management system
Returns:
Returns true if uses rotation/scaling, otherwise false

u8 hel_ObjIsVFlip u8  ObjNo  ) 
 

Check if an object is vertical flipped.

Use this function to figure out if the object specified by ObjNo is V flipped.

Parameters:
ObjNo : Object number in HAM object management system
Returns:
Returns true if it is vertical flipped, otherwise false
See also:
hel_ObjIsHFlip()

u8 hel_ObjIsVisible u8  ObjNo  ) 
 

Check if an object is visible.

This function checks if the object specified by ObjNo is visible.

Parameters:
ObjNo : Object number in HAM object management system
Returns:
Returns true if visible, otherwise false

void hel_ObjUpdateInOAM u8  ObjNo  )  [inline]
 

Update object in OAM immediately.

This function updates the objects specified by ObjNo immediately in OAM.

Parameters:
ObjNo : Object number in HAM object management system
Note:
This function can be very handy if you want, for example, change visibility (ham_SetObjVisible) immediatly, instead of waiting until ham_CopyObjToOAM is called. See your local HAM documentation for more info about ham_CopyObjToOAM and ham_SetObjVisible.


Generated on Sun May 2 17:57:33 2004 by DoxyGen 1.3.6