This documentation is archived and is not being maintained.

D3DImage.Lock Method

Updated: July 2008

Locks the D3DImage and enables operations on the back buffer.

Namespace:  System.Windows.Interop
Assembly:  PresentationCore (in PresentationCore.dll)

public void Lock()
You cannot use methods in XAML.

ExceptionCondition
InvalidOperationException

The lock count equals MaxValue.

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.

NoteNote:

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.

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();

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5 SP1, 3.0 SP2

Date

History

Reason

July 2008

Added topic for new class.

SP1 feature change.

Show: