Edit

Share via

CXAPOParametersBase::OnSetParameters method (xapobase.h)

  • Article

Called by IXAPOParameters::SetParameters to allow for user-defined parameter validation.

Syntax

void OnSetParameters(
  const void *pParameters,
  UINT32     ParameterByteSize
);

Parameters

pParameters

Effect-specific parameter block.

ParameterByteSize

Size, in bytes, of pParameters.

Return value

None

Remarks

Users are expected to use asserts for parameter validation in OnSetParameters.

The CXAPOParametersBase class's implementation of IXAPOParameters::SetParameters validates that ParameterByteSize is equal to the m_uParameterBlockByteSize private member before calling OnSetParameters so it may be assumed that ParameterByteSize == m_uParameterBlockByteSize. m_uParameterBlockByteSize will be equal to the uParameterBlockByteSize parameter passed into the CXAPOParametersBase::CXAPOParametersBase constructor.

This method should not block as it is called from the realtime audio processing thread.

Platform Requirements

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

Requirement Value
Target Platform Windows
Header xapobase.h
Library XAPOBase.lib

See also

CXAPOParametersBase