Skip to main content

XDspCommand

XDSP command.

Syntax

Members

beginScale
Type: float
Default value is 1.0. This parameter is only used for XDspProcessType::Convolution processing. endScale
Type: float
Default value is 1.0. This parameter is only used for XDspProcessType::Convolution processing. If neither beginScale nor endScale are 1.0, then all the input or output frames will be scaled according to the following formula:
outputBlockBuffer[i] = outputBlockBuffer[i] * (XDspCommand::beginScale + (i * step)) where step = (XDspCommand::endScale - XDspCommand::beginScale) / XDspActivationParameters::blockFrameCount
Please see the samples in the GDK download portal https://aka.ms/gdkdl for an example of using these parameters to ramp up/down. inputBlockBuffer
Type: float*
Input buffer to hold one input block of frames of XDspActivationParameters::blockFrameCount that will be passed to XDspSubmitCommand. This buffer must be part of the memory registered by XDspConnect. It must also be 16-byte aligned. outputBlockBuffer
Type: float*
Output buffer to hold one output block of frames of XDspActivationParameters::blockFrameCount that the processing engine will write to this buffer must be part of the memory registered by XDspConnect. It must also be 16-byte aligned. blockBufferMultiplier
Type: float*
A buffer to hold one block of XDspActivationParameters::blockFrameCount frames that will be passed to XDspSubmitCommand. If this parameter is not NULL, then frame in this buffer will be multiplied by the corresponding frame in inputBlockBuffer. This parameter must be used with XDspProcessType::ForwardFourierTransform only. This buffer must be part of the memory registered by XDspConnect. It must also be 16-byte aligned.

Requirements

Header: XDspAudio.h Supported platforms: XBOX Series X|S

Conceptual documentation

See also

XDSP
XDspProcessType
XDspActivationParameters
XDspSubmitCommand
XDspConnect
Overview of a single stream Convolution using the XDSP API
Overview of a single stream FFT/IFFT using the XDSP API
Last modified on August 20, 2026