[]
        
(Showing Draft Content)

GrapeCity.Documents.DX.DXGI.Surface

Class Surface

Namespace
GrapeCity.Documents.DX.DXGI
Assembly
GcDocs.DX.Windows.dll

IDXGISurface

[Guid("cafcb56c-6ac3-4889-bf47-9e23bbd260ec")]
public class Surface : DeviceChild, IDisposable, IUnknown
Inheritance
object
Surface
Implements
System.IDisposable
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()

Constructors

Surface(IntPtr)

Initializes a new instance of the Surface class.

public Surface(IntPtr nativePtr)

Parameters

nativePtr System.IntPtr

The native pointer.

Properties

Description

GetDescription

public SurfaceDescription Description { get; }

Property Value

SurfaceDescription

Methods

FromSwapChain(SwapChain, int)

Gets a swap chain back buffer.

public static Surface FromSwapChain(SwapChain swapChain, int index)

Parameters

swapChain SwapChain

The swap chain to get the buffer from.

index int

The index of the desired buffer.

Returns

Surface

The buffer interface, or null on failure.

GetDescription(out SurfaceDescription)

HRESULT IDXGISurface::GetDesc([Out] DXGI_SURFACE_DESC* pDesc)

public void GetDescription(out SurfaceDescription descRef)

Parameters

descRef SurfaceDescription

Map(MapFlags, out DataStream)

Acquires access to the surface data.

public DataRectangle Map(MapFlags flags, out DataStream dataStream)

Parameters

flags MapFlags

Flags specifying CPU access permissions.

dataStream DataStream

A data stream.

Returns

DataRectangle

A C1.Win.DX.DataRectangle for accessing the mapped data, or null on failure.

Map(MapFlags)

Acquires access to the surface data.

public DataRectangle Map(MapFlags flags)

Parameters

flags MapFlags

Flags specifying CPU access permissions.

Returns

DataRectangle

A C1.Win.DX.DataRectangle for accessing the mapped data, or null on failure.

Map(out MappedRectangle, int)

HRESULT IDXGISurface::Map([Out] DXGI_MAPPED_RECT* pLockedRect,[In] unsigned int MapFlags)

public void Map(out MappedRectangle lockedRectRef, int mapFlags)

Parameters

lockedRectRef MappedRectangle
mapFlags int

Unmap()

HRESULT IDXGISurface::Unmap()

public void Unmap()

Operators

explicit operator Surface(IntPtr)

Performs an explicit conversion from System.IntPtr to Surface.

public static explicit operator Surface(IntPtr nativePointer)

Parameters

nativePointer System.IntPtr

Returns

Surface