D3DImage.Lock Method

Definition

Namespace:

System.Windows.Interop

Assembly:

PresentationCore.dll

Locks the D3DImage and enables operations on the back buffer.

public:
 void Lock();

public void Lock ();

member this.Lock : unit -> unit

Public Sub Lock ()

Exceptions

InvalidOperationException

The lock count equals UInt32.MaxValue.

Examples

The following code example shows how to call the Lock method to enable updates to the back buffer. For more information, see Walkthrough: Hosting Direct3D9 Content in WPF.

d3dimg.Lock();
// Repeatedly calling SetBackBuffer with the same IntPtr is 
// a no-op. There is no performance penalty.
d3dimg.SetBackBuffer(D3DResourceType.IDirect3DSurface9, pSurface);
HRESULT.Check(Render());
d3dimg.AddDirtyRect(new Int32Rect(0, 0, d3dimg.PixelWidth, d3dimg.PixelHeight));
d3dimg.Unlock();

Remarks

Call the Lock method to change the back buffer by calling the AddDirtyRect and SetBackBuffer methods. While the D3DImage is locked, your application can also render to the Direct3D surface assigned to the back buffer.

Note

The Lock method blocks when the rendering system is reading the back buffer to update the front buffer. Use the TryLock method to avoid blocking indefinitely.

See also

• TryLock(Duration)
• Unlock()