IFrameBufferRequest::RequestAsync method

  • Article

Requests framebuffer output of the specified render target, event, and frame.

Syntax

HRESULT RequestAsync(
   DWORD                  frameNumber,
   EventID                eventID,
   DWORD                  renderTargetIndex,
   IFrameBufferCallback * requestCallback,
   DWORD                  requestCookie,
   DWORD                  progressIntervalMsecs
);

Parameters

frameNumber
The specified frame.

eventID
The specified event.

renderTargetIndex
The index of the specified render target.

requestCallback
The address of a callback used to notify the host of results.

requestCookie
A cookie that uniquely identifies the request, and can be used to signal for it to be cancelled.

progressIntervalMsecs
Not used.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Header

Vspixengine.h

See also

IFrameBufferRequest