DirectX

Description

static class Tinman.Engine.API.DirectX

Provides some common helper methods for using DirectX libraries.

Public / Methods

Compute​Video​Memory

[Pure]
public static method ComputeVideoMemory → (4)

availableVideoMemoryBytes in : int64

The number of bytes that have been specified via IGraphicsContextFactory.AvailableVideoMemory.

dedicatedVideoMemory in : int64

The number of bytes of dedicated video memory that are not shared with the CPU.

dedicatedSystemMemory in : int64

The number of bytes of dedicated system memory that are not shared with the CPU.

sharedSystemMemory in : int64

The number of bytes of shared system memory.

returns → int64

The estimate for the amount of video memory.

Computes the amount of video memory for ITextureFactory.AvailableVideoMemory, based on the values found in the DXGI_ADAPTER_DESC structure.

Failure

[Pure]
public static method Failure → (1)

hResult in : int32

The HRESULT value to check.

returns → bool

true for failure, false for success.

Checks if the given HRESULT value indicates a failed operation.

Four​CC

[Pure]
public static method FourCC → (1)

code in : string

A string with four characters.

returns → int32

The four-character code.

Generates a four-character code (see MAKEFOURCC macro).

Semantic​Name​For

[Constant]
public static method SemanticNameFor → (1)

usage in : VertexElementUsage

The vertex element usage.

returns → IntPtr

The null-terminated ASCII name.

Returns the null-terminated ASCII name for the given usage in.

This is the name mapping:

Success

[Pure]
public static method Success → (1)

hResult in : int32

The HRESULT value to check.

returns → bool

true for success, false for failure.

Checks if the given HRESULT value indicates a successful operation.

Warn

public static method Warn → (3)

source in : string @ Tag

The error source tag.

function in : string

The function name.

hResult in : int32

The failure result code.

Output a warning message for a failed, non-critical render API call.

Logging

Logger

public static readonly attribute Logger → (ILogger)

The logger object of this class.