Skip to main content

ApuCreateHeap

Creates the APU heap.

Syntax

Parameters

cachedSizeInBytes   _In_
Type: UINT32
Size of a cached memory allocation, in bytes. nonCachedSizeInBytes   _In_opt_
Type: UINT32
Size of a non-cached allocation, in bytes. If 0, use the default allocation of ~1 MB.

Return value

Type: HRESULT In addition to other error codes, this method can return the following values:

Remarks

Only a single APU heap can be created; it persists for the lifetime of the process. The heap is released only when the process terminates. To ensure that a heap is allocated to your specific requirements, call this method before any other ACP HAL and APU method. If any ACP HAL (AcpHal.h) or APU methods are called before this method, a cached heap of 64 MB and a non-cached heap of ~1 MB are allocated; subsequent calls to this method will fail with APU_E_HEAP_ALREADY_ALLOCATED. Cached memory is used for all Waves assets and command and message queues. Non-cached memory is used for SHAPE contexts and notifications.

Requirements

Header: apu.h Library: acphal.lib Supported platforms: XBOX One family consoles and XBOX Series consoles

Conceptual documentation

See also

APU
Last modified on August 20, 2026