Class DxgiSurface

The IDXGISurface interface implements methods for image-data objects.

Inheritance

object

DxgiObject

DxgiDeviceSubObject

DxgiSurface

Implements

IDisposable

IDxgiReleasable

Inherited Members

DxgiObject.ToBoolean()

DxgiObject.Dispose()

DxgiObject.Release()

DxgiObject.SetPrivateDataText(Guid, string)

DxgiObject.GetPrivateDataText(Guid)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JeremyAnsel.DirectX.Dxgi

Assembly: JeremyAnsel.DirectX.Dxgi.dll

Syntax

public sealed class DxgiSurface : DxgiDeviceSubObject, IDisposable, IDxgiReleasable

Constructors

DxgiSurface(object)

Initializes a new instance of the DxgiSurface class.

Declaration

public DxgiSurface(object resource)

Parameters

Type	Name	Description
object	resource	A resource interface which implements the IDXGISurface interface.

Fields

InterfaceGuid

The interface GUID.

Declaration

public static readonly Guid InterfaceGuid

Field Value

Type	Description
Guid

Properties

Description

Gets a description of the surface.

Declaration

public DxgiSurfaceDesc Description { get; }

Property Value

Type	Description
DxgiSurfaceDesc

Handle

Gets an handle representing the DXGI object interface.

Declaration

public override object Handle { get; }

Property Value

Type	Description
object

Overrides

DxgiObject.Handle

Methods

Map(DxgiMapOptions)

Get a pointer to the data contained in the surface, and deny GPU access to the surface.

Declaration

public DxgiMappedRect Map(DxgiMapOptions options)

Parameters

Type	Name	Description
DxgiMapOptions	options	CPU read-write flags. These flags can be combined with a logical OR.

Returns

Type	Description
DxgiMappedRect	The surface data.

Unmap()

Invalidate the pointer to the surface retrieved by IDXGISurface::Map and re-enable GPU access to the resource.

Declaration

public void Unmap()

Implements

IDisposable

IDxgiReleasable