Class DxgiObject

An IDXGIObject interface is a base interface for all DXGI objects. IDXGIObject supports associating caller-defined (private data) with an object and retrieval of an interface to the parent object.

Inheritance

DxgiObject

Implements

IDisposable

Inherited Members

DXComObject.Handle

DXComObject.Dispose()

DXComObject.AddRef()

DXComObject.Release()

DXComObject.QueryInterface(in Guid)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JeremyAnsel.DirectX.Dxgi

Assembly: JeremyAnsel.DirectX.Dxgi.dll

Syntax

[SecurityCritical]
public class DxgiObject : DXComObject, IDisposable

Constructors

| Edit this page View Source

DxgiObject(nint)

Initializes a new instance of the DxgiObject class.

Declaration

public DxgiObject(nint comPtr)

Parameters

Type	Name	Description
nint	comPtr

Fields

| Edit this page View Source

DxgiObjectGuid

The interface GUID.

Declaration

public static readonly Guid DxgiObjectGuid

Field Value

Type	Description
Guid

Methods

| Edit this page View Source

GetParent(in Guid)

Gets the parent of the object.

Declaration

public nint GetParent(in Guid riid)

Parameters

Type	Name	Description
Guid	riid	The ID of the requested interface.

Returns

Type	Description
nint	The address of a pointer to the parent object.

| Edit this page View Source

GetPrivateDataText(in Guid)

Gets an application-defined data from the object that is associated with a GUID.

Declaration

public string GetPrivateDataText(in Guid name)

Parameters

Type	Name	Description
Guid	name	A GUID identifying the data.

Returns

Type	Description
string	The object's text.

| Edit this page View Source

GetPrivateDataTextCharCount(in Guid)

Gets an application-defined data from the object that is associated with a GUID.

Declaration

public int GetPrivateDataTextCharCount(in Guid name)

Parameters

Type	Name	Description
Guid	name	A GUID identifying the data.

Returns

Type	Description
int	The count.

| Edit this page View Source

GetPrivateDataTextChars(in Guid, Span<char>)

Gets an application-defined data from the object that is associated with a GUID.

Declaration

public int GetPrivateDataTextChars(in Guid name, Span<char> text)

Parameters

Type	Name	Description
Guid	name	A GUID identifying the data.
Span<char>	text	A char buffer.

Returns

Type	Description
int	The object's text.

| Edit this page View Source

SetPrivateDataText(in Guid, ReadOnlySpan<char>)

Sets an application-defined data to the object and associates that data with a GUID.

Declaration

public void SetPrivateDataText(in Guid name, ReadOnlySpan<char> text)

Parameters

Type	Name	Description
Guid	name	A GUID that identifies the data.
ReadOnlySpan<char>	text	The object's text.

| Edit this page View Source

SetPrivateDataText(in Guid, string?)

Sets an application-defined data to the object and associates that data with a GUID.

Declaration

public void SetPrivateDataText(in Guid name, string? text)

Parameters

Type	Name	Description
Guid	name	A GUID that identifies the data.
string	text	The object's text.

Implements

IDisposable