![]() |
MHEG5
22.11.0
|
Module Description: Implement the MHEG5 Bitmap Class. 32 Bitmap Class Defines the behaviour of a two-dimensional array of pixels.$ Base class: Visible Subclasses: None Status: Concrete class. More...
#include "mh5application.h"
#include "mh5bitmap.h"
#include "mh5object.h"
#include "mh5variable.h"
#include "mh5display.h"
#include "mh5memory.h"
#include "mh5debug.h"
#include "mh5misc.h"
#include "mh5profile.h"
#include "mg_api.h"
Functions | |
void | MHEG5bitmapInit (MHEG5Bitmap *bitmap) |
Initialise a bitmap object with default values. More... | |
void | MHEG5bitmapFree (MHEG5Bitmap *bitmap) |
Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed. More... | |
MHEG5Bitmap * | MHEG5bitmapClone (MHEG5Bitmap *source) |
Copy a bitmap object with original values. More... | |
void | MHEG5bitmapPrepare (MHEG5Bitmap *bitmap) |
Apply the preparation behaviour of the bitmap class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class. More... | |
void | MHEG5bitmapActivate (MHEG5Bitmap *bitmap) |
Apply the activation behaviour of the bitmap class. As this class has no own activation behaviour this function just invokes the activation behaviour from the base class. More... | |
void | MHEG5bitmapDeactivate (MHEG5Bitmap *bitmap) |
Apply the deactivation behaviour of the bitmap class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class. More... | |
void | MHEG5bitmapDestruct (MHEG5Bitmap *bitmap) |
Destruct a bitmap object. More... | |
MHEG5ErrorCode | MHEG5scaleBitmap (MHEG5Root *target, MHEG5GList *params) |
The effect of this action is to scale the contents of the Bitmap to the size (XScale, YScale). Implementation of the ScaleBitmap (XScale, YScale) action of the bitmap class. More... | |
MHEG5ErrorCode | MHEG5setTransparency (MHEG5Root *target, MHEG5GList *params) |
Change the value of the Transparency attribute. Implementation of the SetTransparency (NewTransparency) action of the bitmap class. More... | |
MHEG5ErrorCode | MHEG5setBitmapDecodeOffset (MHEG5Root *target, MHEG5GList *params) |
Implementation of the SetBitmapDecodeOffset (NewXOffset, NewYOffset) action of the bitmap class. SetBitmapDecodeOffset (NewXOffset, NewYOffset) Change the location of the decoded and scaled bitmap with respect to the target Bitmap object. The offset parameters may be negative. Execute the following sequence of actions: More... | |
MHEG5ErrorCode | MHEG5getBitmapDecodeOffset (MHEG5Root *target, MHEG5GList *params) |
Implementation of the GetBitmapDecodeOffset (XOffset, YOffset) action of the bitmap class GetBitmapDecodeOffset (XOffsetVar, YOffsetVar) Return the location of the decoded and scaled bitmap with respect to the target Bitmap object. The offset values may be negative. Set the Variables referenced by XPositionVar and YPositionVar to the value of the X and Y decode offset of the target Bitmap object respectively. Provisions of use: The Target object shall be an available Bitmap object. XOffsetVar and YOffsetVar shall refer to active IntegerVariable objects. GetBitmapDecodeOffset –> Target, XOffsetVar, YOffsetVar Target –> GenericObjectReference XOffsetVar, YOffsetVar –> ObjectReference. More... | |
Module Description: Implement the MHEG5 Bitmap Class. 32 Bitmap Class Defines the behaviour of a two-dimensional array of pixels.$ Base class: Visible Subclasses: None Status: Concrete class.
void MHEG5bitmapActivate | ( | MHEG5Bitmap * | bitmap | ) |
Apply the activation behaviour of the bitmap class. As this class has no own activation behaviour this function just invokes the activation behaviour from the base class.
bitmap | Pointer to a bitmap. |
MHEG5Bitmap* MHEG5bitmapClone | ( | MHEG5Bitmap * | source | ) |
Copy a bitmap object with original values.
source | Source bitmap. |
void MHEG5bitmapDeactivate | ( | MHEG5Bitmap * | bitmap | ) |
Apply the deactivation behaviour of the bitmap class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class.
bitmap | Pointer to a bitmap. |
void MHEG5bitmapDestruct | ( | MHEG5Bitmap * | bitmap | ) |
Destruct a bitmap object.
bitmap | Pointer to a bitmap. |
void MHEG5bitmapFree | ( | MHEG5Bitmap * | bitmap | ) |
Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
bitmap | Pointer to object to free. |
void MHEG5bitmapInit | ( | MHEG5Bitmap * | bitmap | ) |
Initialise a bitmap object with default values.
<Function description>="">
bitmap | Pointer to object to initialise |
void MHEG5bitmapPrepare | ( | MHEG5Bitmap * | bitmap | ) |
Apply the preparation behaviour of the bitmap class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class.
bitmap | Pointer to a bitmap. |
MHEG5ErrorCode MHEG5getBitmapDecodeOffset | ( | MHEG5Root * | target, |
MHEG5GList * | params | ||
) |
Implementation of the GetBitmapDecodeOffset (XOffset, YOffset) action of the bitmap class GetBitmapDecodeOffset (XOffsetVar, YOffsetVar) Return the location of the decoded and scaled bitmap with respect to the target Bitmap object. The offset values may be negative. Set the Variables referenced by XPositionVar and YPositionVar to the value of the X and Y decode offset of the target Bitmap object respectively. Provisions of use: The Target object shall be an available Bitmap object. XOffsetVar and YOffsetVar shall refer to active IntegerVariable objects. GetBitmapDecodeOffset –> Target, XOffsetVar, YOffsetVar Target –> GenericObjectReference XOffsetVar, YOffsetVar –> ObjectReference.
target | target object for this action |
params | Action parameters |
MHEG5ErrorCode MHEG5scaleBitmap | ( | MHEG5Root * | target, |
MHEG5GList * | params | ||
) |
The effect of this action is to scale the contents of the Bitmap to the size (XScale, YScale). Implementation of the ScaleBitmap (XScale, YScale) action of the bitmap class.
target | target object for this action |
params | ?? |
MHEG5ErrorCode MHEG5setBitmapDecodeOffset | ( | MHEG5Root * | target, |
MHEG5GList * | params | ||
) |
Implementation of the SetBitmapDecodeOffset (NewXOffset, NewYOffset) action of the bitmap class. SetBitmapDecodeOffset (NewXOffset, NewYOffset) Change the location of the decoded and scaled bitmap with respect to the target Bitmap object. The offset parameters may be negative. Execute the following sequence of actions:
target | target object for this action |
params | Action parameters |
MHEG5ErrorCode MHEG5setTransparency | ( | MHEG5Root * | target, |
MHEG5GList * | params | ||
) |
Change the value of the Transparency attribute. Implementation of the SetTransparency (NewTransparency) action of the bitmap class.
target | target object for this action |
params | ?? |