Main Page   Modules   Related Pages  

Object Functions

Functions


Function Documentation

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.71). 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:
TRUE : Object exists
FALSE : Object does not exist

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 Tue Nov 11 18:41:13 2003 by DoxyGen 1.3-rc1