Zen API

- Home
- Topics
- Types
- Files

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

## 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...
void | kUserAlloc_EnableForeignMemory (kUserAlloc object, kBool enable)
| Controls whether this allocator will report that it emits foreign memory. More...
void | kUserAlloc_EnableObjectMemory (kUserAlloc object, kBool enable)
| Controls whether this allocator will report that it is capable of allocating objects. 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...
kBool | kAlloc_CanGetObject (kAlloc alloc)
| Reports whether this allocator is suitable for allocating objects. 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_GetObject (kAlloc alloc, kType type, void *mem)
| Allocates a block of memory large enough for an object of the specified type. More...
kStatus | kAlloc_GetZero (kAlloc alloc, kSize size, void *mem)
| Allocates a block of memory and zero-initializes the block. More...
kBool | kAlloc_IsForeign (kAlloc alloc)
| Reports whether memory will be allocated in a foreign address space. 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...
kBool | kObject_HasForeignData (kObject object)
| Reports whether the object, including aggregated child elements, contains any foreign memory references. 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
Protected Member Functions inherited from kAlloc
kStatus | kAlloc_Export (kAlloc alloc, void *dest, const void *src, kSize size)
| Copies memory from the allocator's address space to the host address space. More...
kStatus | kAlloc_Init (kAlloc alloc, kType type, kAlloc allocator)
| Protected method called by derived classes to initialize the kAlloc base class. More...
kStatus | kAlloc_VExport (kAlloc alloc, void *dest, const void *src, kSize size)
| Protected virtual method that copies memory from the allocator's address space to the host address space. More...
kStatus | kAlloc_VFree (kAlloc alloc, void *mem)
| Protected virtual method that frees memory. More...
kStatus | kAlloc_VGet (kAlloc alloc, kSize size, void *mem)
| Protected virtual method that allocates memory. More...
kStatus | kAlloc_VRelease (kAlloc alloc)
| Protected virtual method that deallocates any resources owned by the object. More...
Protected Member Functions inherited from kObject
kStatus | kObject_FreeMem (kObject object, void *mem)
| Protected method called by derived classes to free memory using the object's allocator. More...
kStatus | kObject_FreeMemRef (kObject object, void *mem)
| Protected method called by derived classes to free memory (and reset the provided memory pointer to kNULL) using the object's allocator. More...
kStatus | kObject_GetMem (kObject object, kSize size, void *mem)
| Protected method called by derived classes to allocate memory using the object's allocator. More...
kStatus | kObject_GetMemZero (kObject object, kSize size, void *mem)
| Protected method called by derived classes to allocate and zero memory using the object's allocator. More...
kStatus | kObject_Init (kObject object, kType type, kAlloc alloc)
| Protected method called by derived classes to initialize the kObject base class. More...
kStatus | kObject_VDisposeItems (kObject object)
| Protected virtual method that destroys any aggregated child objects associated with a collection. More...
kBool | kObject_VEquals (kObject object, kObject other)
| Protected virtual method that compares two objects for equality. More...
kBool | kObject_VHasForeignData (kObject object)
| Protected virtual method that reports whether the object, including aggregated child elements, contains any foreign memory references. More...
kSize | kObject_VHashCode (kObject object)
| Protected virtual method that calculates a hash code representing the object instance. More...
kStatus | kObject_VInitClone (kObject object, kObject source, kAlloc allocator)
| Protected virtual method that clones (makes a deep copy of) the specified source object. More...
kStatus | kObject_VRelease (kObject object)
| Protected virtual method that deallocates any resources owned by the object. More...
kSize | kObject_VSize (kObject object)
| Protected virtual method that calculates the total size (in bytes) of the object instance. More...

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

- Utils/kUserAlloc.h