Device.GetRasterStatus(Int32) Method (Microsoft.DirectX.Direct3D)

  • Article

Returns information that describes the raster of the monitor on which the swap chain is presented.

Definition

Visual Basic Public Function GetRasterStatus( _
    ByVal swapChain As Integer _
) As RasterStatus
C# public RasterStatus GetRasterStatus(
    int swapChain
);
C++ public:
RasterStatus GetRasterStatus(
    int swapChain
);
JScript public function GetRasterStatus(
    swapChain : int
) : RasterStatus;

Parameters

swapChain System.Int32
Unsigned integer that specifies the swap chain.

Return Value

Microsoft.DirectX.Direct3D.RasterStatus
A RasterStatus structure that contains information about the position or other status of the raster on the monitor driven by this adapter.

Remarks

This method does not return device state for a device created using PureDevice. To use this method, create a device with any of the other values in CreateFlags.

Exceptions

InvalidCallException

The device does not support reading the current scan line. To determine whether a device supports reading the scan line, check for the DriverCaps.ReadScanLine property in Caps.DriverCaps.