Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
Public Member Functions
kUserAlloc Class Reference
kApi

## Description

Allocates memory from a user-defined memory source.

Inheritance diagram for kUserAlloc:

## Public Member Functions
kStatus | kUserAlloc_Construct (kUserAlloc *object, kApiMemAllocFx allocFx, kApiMemFreeFx freeFx, kPointer provider, kAlloc allocator)
| Constructs a new kUserAlloc instance. More...
kPointer | kUserAlloc_Provider (kUserAlloc object)
| Gets provider handle passed to kUserAlloc constructor. More...
Public Member Functions inherited from kAlloc
kAlloc | kAlloc_App ()
| Gets the allocator that should normally be used by applications to request memory. More...
kAlloc | kAlloc_Fallback (kAlloc alloc)
| Returns the passed allocator, or if null, the App allocator. More...
kStatus | kAlloc_Free (kAlloc alloc, void *mem)
| Frees a block of memory. More...
kStatus | kAlloc_FreeRef (kAlloc alloc, void *mem)
| Frees a block of memory and sets the memory pointer to kNULL. More...
kStatus | kAlloc_Get (kAlloc alloc, kSize size, void *mem)
| Allocates a block of memory. More...
kStatus | kAlloc_GetZero (kAlloc alloc, kSize size, void *mem)
| Allocates a block of memory and zero-initializes the block. More...
kAlloc | kAlloc_System ()
| Gets the system allocator. More...
Public Member Functions inherited from kObject
kAlloc | kObject_Alloc (kObject object)
| Gets the memory allocator associated with this object. More...
kStatus | kObject_Clone (kObject *object, kObject source, kAlloc allocator)
| Constructs a new object by copying an existing object, including any aggregated child elements. More...
kStatus | kObject_Destroy (kObject object)
| Destroys the object. More...
kStatus | kObject_Dispose (kObject object)
| Destroys the object and any aggregated child elements. More...
kBool | kObject_Equals (kObject object, kObject other)
| Determines whether the object is equal to another object. More...
kSize | kObject_HashCode (kObject object)
| Gets a hash code representing the state of this object. More...
kBool | kObject_Is (kObject object, kType type)
| Determines whether this object is an instance of the specified type. More...
kBool | kObject_IsShared (kObject object)
| Reports whether the object is currently shared (reference count greater than one). More...
kStatus | kObject_SetPool (kObject object, kObjectPool pool)
| Sets the object pool associated with this object. More...
kStatus | kObject_Share (kObject object)
| Increments the reference count associated with this object. More...
kSize | kObject_Size (kObject object)
| Estimates the memory consumed by this object, including any aggregated child elements. More...
kType | kObject_Type (kObject object)
| Returns the type of the object. More...

## Additional Inherited Members
Related inherited from kAlloc
#define | kAlloc_Get_(ALLOC, SIZE, MEM) kxAlloc_Get_(ALLOC, SIZE, MEM)
| Macro version of kAlloc_Get.
#define | kAlloc_GetZero_(ALLOC, SIZE, MEM) kxAlloc_GetZero_(ALLOC, SIZE, MEM)
| Macro version of kAlloc_GetZero.
#define | kAlloc_Free_(ALLOC, MEM) kxAlloc_Free_(ALLOC, MEM)
| Macro version of kAlloc_Free.
#define | kAlloc_FreeRef_(ALLOC, MEM) kxAlloc_FreeRef_(ALLOC, MEM)
| Macro version of kAlloc_FreeRef.
#define | kAlloc_App_() kxAlloc_App_()
| Macro version of kAlloc_App.
#define | kAlloc_System_() kxAlloc_System_()
| Macro version of kAlloc_System.
#define | kAlloc_Fallback_(ALLOC) kxAlloc_Fallback_(ALLOC)
| Macro version of kAlloc_Fallback.
Related inherited from kObject
#define | kObject_Type_(OBJ) kxObject_Type_(OBJ)
| Macro version of kObject_Type.
#define | kObject_Is_(OBJ, TYPE) kxObject_Is_(OBJ, TYPE)
| Macro version of kObject_Is.
#define | kObject_Alloc_(OBJ) kxObject_Allocator_(OBJ)
| Macro version of kObject_Alloc.

The documentation for this class was generated from the following file:

- Utils/kUserAlloc.h