Layer Functions
Functions:
MTK_Layer_AppendObject
int MTK_Layer_AppendObject(MTK_Layer* layer, MTK_Object* obj);
Description
Add an object to a layer.
Parameters
layer
pointer to an MTK_Layer struct
obj
pointer to an MTK_Object struct
Return Value
0
success
other
failure
MTK_Layer_Close
int MTK_Layer_Close(MTK_Layer* layer);
Description
Clean up the layer.
Parameters
layer
pointer to an MTK_Layer struct
Return Value
0
success
other
failure
MTK_Layer_DeleteObject
int MTK_Layer_DeleteObject(MTK_Layer* layer, const int& index);
Description
Delete an object from a layer.
Parameters
layer
pointer to an MTK_Layer struct
index
index of the object (int)
Return Value
0
success
other
failure
MTK_Layer_GetDescription
int MTK_Layer_GetDescription(MTK_Layer* layer, char* desc);
Description
Get the description of a layer.
Parameters
layer
pointer to an MTK_Layer struct
desc
buffer of length MTK_BUFFER_SIZE to receive the layer description (char*)
Return Value
0
success
other
failure
MTK_Layer_GetName
int MTK_Layer_GetName(MTK_Layer* layer, char* name);
Description
Get the name of a layer.
Parameters
layer
pointer to an MTK_Layer struct
name
buffer of length MTK_BUFFER_SIZE to receive the layer name (char*)
Return Value
0
success
other
failure
MTK_Layer_GetObject
MTK_Object* MTK_Layer_GetObject(MTK_Layer* layer, const int& index);
Description
Get an object from a layer. Allocates a new object which will needs to be freed with MTK_Object_Close .
Parameters
layer
pointer to an MTK_Layer struct
index
index of the object (int)
Return Value
A pointer to an MTK_Object
success
NULL
failure
MTK_Layer_IsEdited
int MTK_Layer_IsEdited(MTK_Layer* layer);
Description
Checks if a layer has been edited.
Parameters
layer
pointer to an MTK_Layer struct
Return Value
1
edited
0
not edited
other
failure
MTK_Layer_New
MTK_Layer* MTK_Layer_New();
Description
Start with a blank MTK_Layer that values can be set to.
Parameters
None
Return Value
Pointer to an empty MTK_Layer struct
success
Null pointer
failure
MTK_Layer_NObjects
int MTK_Layer_NObjects(MTK_Layer* layer);
Description
Get the number of objects in a layer.
Parameters
layer
pointer to an MTK_Layer struct
Return Value
int
number of objects in the layer
-1
failed
MTK_Layer_SetDescription
int MTK_Layer_SetDescription(MTK_Layer* layer, const char* desc);
Description
Set the description of a layer.
Parameters
layer
pointer to an MTK_Layer struct
desc
layer description (const char*)
Return Value
0
success
other
failure
MTK_Layer_SetName
int MTK_Layer_SetName(MTK_Layer* layer, const char* name);
Description
Set the name of a layer.
Parameters
layer
pointer to an MTK_Layer struct
name
layer name (const char*)
Return Value
0
success
other
failure
MTK_Layer_SetObject
int MTK_Layer_SetObject(MTK_Layer* layer, MTK_Object* obj, const int& index);
Description
Set an object in a layer.
Parameters
layer
pointer to an MTK_Layer struct
obj
pointer to an MTK_Object struct
index
index of the object (int)
Return Value
0
success
other
failure
