PresentParameters.SwapEffect Property (Microsoft.DirectX.Direct3D)

  • Article

Retrieves or sets the swap effect.

Definition

Visual Basic Public Property SwapEffect As SwapEffect
C# public SwapEffect SwapEffect { get; set; }
C++ public:
property SwapEffect SwapEffect {
        SwapEffect get();
        void set(SwapEffect value);
}
JScript public function get SwapEffect() : SwapEffect
public function set SwapEffect(SwapEffect);

Property Value

Microsoft.DirectX.Direct3D.SwapEffect
Member of the SwapEffect enumerated type that indicates how buffers are swapped.

This property is read/write. 

Remarks

The runtime guarantees the implied semantics concerning buffer swap behavior. So if Windowed is set to true and SwapEffect is set to SwapEffect.Flip, the runtime creates one extra back buffer and copies whichever becomes the front buffer at presentation time.

The SwapEffect.Copy setting requires that BackBufferCount be set to 1. This setting is enforced in the debug runtime, which fills any buffer with noise after it is presented.