Edit

PartyAllocateMemoryCallback

  • Article

A callback invoked every time a new memory buffer must be dynamically allocated by the Party library.

Syntax

typedef
void* (*PartyAllocateMemoryCallback)(  
    size_t size,  
    uint32_t memoryTypeId  
)

Parameters

size   size_t

The size of the allocation to be made. This value will never be zero.

memoryTypeId   uint32_t

An opaque identifier representing the Party library internal category of memory being allocated. This value should be ignored.

Return value

Type: void*

A pointer to an allocated block of memory of the specified size, or nullptr if the allocation failed.

Remarks

This callback is optionally installed using the PartyManager::SetMemoryCallbacks() method.

The callback must allocate and return a pointer to a contiguous block of memory of the specified size that will remain valid until the title's corresponding PartyFreeMemoryCallback is invoked to release it. If this is not possible, the callback must return nullptr to fail the allocation. Memory allocation failures are sometimes considered benign but will usually cause current Party library operation(s) to fail.

Every non-nullptr returned by this method will be subsequently passed to the corresponding PartyFreeMemoryCallback once the memory is no longer needed.

Requirements

Header: Party.h

See also

Party members
PartyFreeMemoryCallback
PartyManager::SetMemoryCallbacks
PartyManager::GetMemoryCallbacks