EQUINOX-3D

[Introduction] [Overview] [Core reference] [3D reference] [GUI]

Index

 EMemDbg_ObjectsPrint
 EClass_CheckAllResources
 EObject_NumOfReferences
 EObject_SetName
 ELst_ObjectRemoveA
 ELst_ObjectsSort_s
 EScriptFunction_Call

EMemDbg_ObjectsPrint

Print unfreed Objects

Syntax
void EMemDbg_ObjectsPrint(const EBool PPrintFullCallStack, const EBool PCollapseCascades)

Arguments
None.

Description
Prints information about currently created Objects, when:
- EObjectMEMORY_DEBUG is defined
- the code has debug information (debug build)

This function shows what Objects are created from where (source file + line number) and where those Objects are being referenced (source files + line numbers).

Return value
None.

See also
E_Assign

EClass_CheckAllResources

Collect all Resources of a Class

Syntax
void EClass_CheckAllResources(ECoreClass* PClass)

Arguments
PClass The class
Description
Collect all Resources of a Class, including those in its superclasses into a single array and store them in PClass->AllResources.

Return value
None.

EObject_NumOfReferences

Get true number of references to an Object from the garbage-collector

Syntax
int EObject_NumOfReferences(void* PObject)

Argument
PObject Pointer to the Object
Description
If the garbage-collector is not enabled, it returns -1.

Return value
None.

See also
E_Assign, E_Delete

EObject_SetName

Set the name of an Object

Syntax
void EObject_SetName(void* PObject, char* PName, const EBool PStatic)

Arguments
PObject Pointer to the Object PName The new name PStatic The name is a statically allocated string
Description
This function will update the name of the Object and update the reference-tracking system as well (when enabled). PName must be a copy created by EStrDup etc., as it is not copied here.

Return value
None.

ELst_ObjectRemoveA

Remove a Object pointer from a dynamically allocated array

Syntax
EBool ELst_ObjectRemoveA(void* PListPtr, EIndex* PPointers_CountP, EIndex* PPointers_CountAllocatedP, void* PObject)

Arguments
PListPtr Pointer to the list PPointers_CountP The number of pointers in use PPointers_CountAllocatedP The number of pointers allocated PObject Pointer to the Object to insert
Description
This function looks for the given pointer in the array. If it finds that, it removes it by possibly reallocating the memory for the array and updating PPointers_CountP and PPointers_CountAllocatedP. The number of pointers allocated may be different from the number of pointers in use (to minimize reallocation and copying).

Return value
Pointer to the new array and PPointers_CountP PPointers_CountAllocatedP

ELst_ObjectsSort_s

Sort a list of Objects with qsort, taking care of reference tracking

Syntax
void ELst_ObjectsSort_s(void* PListStruct, int (*PCompareFunc)(const void* P0, const void* P1))

Arguments
PListStruct Pointer to a EListObjectsA-like struct for the list (the pointer type of Items may vary) PCompareFunc Comparison function to be passed to qsort
Description
Sorts the items in a list (.Items member) with qsort. If Object reference tracking is enabled, it also updates reference addresses.

Return value
None.

See also
ELst_ObjectAddA, ELst_ObjectAddAChk, etc.

EScriptFunction_Call

Call an EScriptFunction with a vararg parameter list.

Syntax
int EScriptFunction_Call(EScriptFunction* PScriptFunction, ...)

Arguments
PScriptFunction Handle returned by E3dScriptFunction_Register() ... List of parameter name / value pairs
Description
Calls a ScriptFunction's implementation (C/C++ etc.) function with a variable-length parameter list, made of name / value pairs and terminated with a NULL.

Return value
The value returned by the implementation, or E_NOT_IMPLEMENTED if PScriptFunction->Func is NULL