Show / Hide Table of Contents

    Class GPUDevice

    Graphics device object for rendering on GPU.

    Inheritance
    System.Object
    Object
    GPUDevice
    Inherited Members
    Object.__unmanagedPtr
    Object.__internalId
    Object.As<T>()
    Object.NewValue(Type)
    Object.New(String)
    Object.New<T>()
    Object.New(Type)
    Object.Find<T>(Guid)
    Object.Find(Guid, Type)
    Object.TryFind<T>(Guid)
    Object.Destroy(Object, Single)
    Object.Destroy<T>(T, Single)
    Object.GetUnmanagedPtr(Object)
    Object.GetHashCode()
    Object.ID
    Object.TypeName
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: FlaxEngine
    Assembly: FlaxEngine.CSharp.dll
    Syntax
    [Unmanaged]
    [Tooltip("Graphics device object for rendering on GPU.")]
    public sealed class GPUDevice : Object

    Constructors

    GPUDevice()

    Initializes a new instance of the GPUDevice.

    Declaration
    public GPUDevice()

    Properties

    Adapter

    Gets the adapter device.

    Declaration
    [Unmanaged]
    [Tooltip("The adapter device.")]
    public GPUAdapter Adapter { get; }
    Property Value
    GPUAdapter

    DefaultBlackTexture

    Gets the default solid black texture.

    Declaration
    [Unmanaged]
    [Tooltip("The default solid black texture.")]
    public GPUTexture DefaultBlackTexture { get; }
    Property Value
    GPUTexture

    DefaultWhiteTexture

    Gets the default solid white texture.

    Declaration
    [Unmanaged]
    [Tooltip("The default solid white texture.")]
    public GPUTexture DefaultWhiteTexture { get; }
    Property Value
    GPUTexture

    FeatureLevel

    Gets device feature level type.

    Declaration
    [Unmanaged]
    [Tooltip("Gets device feature level type.")]
    public FeatureLevel FeatureLevel { get; }
    Property Value
    FeatureLevel

    Instance

    The singleton instance of the graphics device.

    Declaration
    [Unmanaged]
    [Tooltip("The singleton instance of the graphics device.")]
    public static GPUDevice Instance { get; }
    Property Value
    GPUDevice

    IsRendering

    Returns true if device is during rendering state, otherwise false.

    Declaration
    [Unmanaged]
    [Tooltip("Returns true if device is during rendering state, otherwise false.")]
    public bool IsRendering { get; }
    Property Value
    System.Boolean

    Limits

    The GPU limits.

    Declaration
    [Unmanaged]
    [Tooltip("The GPU limits.")]
    public GPULimits Limits { get; }
    Property Value
    GPULimits

    MainContext

    Gets the main GPU context.

    Declaration
    [Unmanaged]
    [Tooltip("The main GPU context.")]
    public GPUContext MainContext { get; }
    Property Value
    GPUContext

    MemoryUsage

    Gets the amount of memory usage by all the GPU resources (in bytes).

    Declaration
    [Unmanaged]
    [Tooltip("The amount of memory usage by all the GPU resources (in bytes).")]
    public ulong MemoryUsage { get; }
    Property Value
    System.UInt64

    NativePtr

    Gets the native pointer to the underlying graphics device. It's a low-level platform-specific handle.

    Declaration
    [Unmanaged]
    [Tooltip("The native pointer to the underlying graphics device. It's a low-level platform-specific handle.")]
    public IntPtr NativePtr { get; }
    Property Value
    System.IntPtr

    RendererType

    Gets the device renderer type.

    Declaration
    [Unmanaged]
    [Tooltip("The device renderer type.")]
    public RendererType RendererType { get; }
    Property Value
    RendererType

    ShaderProfile

    Gets device shader profile type.

    Declaration
    [Unmanaged]
    [Tooltip("Gets device shader profile type.")]
    public ShaderProfile ShaderProfile { get; }
    Property Value
    ShaderProfile

    TotalGraphicsMemory

    The total amount of graphics memory in bytes.

    Declaration
    [Unmanaged]
    [Tooltip("The total amount of graphics memory in bytes.")]
    public ulong TotalGraphicsMemory { get; }
    Property Value
    System.UInt64

    VideoOutputModes

    The available video output modes.

    Declaration
    [Unmanaged]
    [Tooltip("The available video output modes.")]
    public GPUDevice.VideoOutputMode[] VideoOutputModes { get; }
    Property Value
    GPUDevice.VideoOutputMode[]

    Methods

    CreateBuffer(String)

    Creates the buffer.

    Declaration
    [Unmanaged]
    [Tooltip("Creates the buffer.")]
    public GPUBuffer CreateBuffer(string name = null)
    Parameters
    System.String name

    The resource name.

    Returns
    GPUBuffer

    The buffer.

    CreateTexture(String)

    Creates the texture.

    Declaration
    [Unmanaged]
    [Tooltip("Creates the texture.")]
    public GPUTexture CreateTexture(string name = null)
    Parameters
    System.String name

    The resource name.

    Returns
    GPUTexture

    The texture.

    GetFormatFeatures(PixelFormat)

    Gets the supported features for the specified format (index is the pixel format value).

    Declaration
    [Unmanaged]
    [Tooltip("The supported features for the specified format (index is the pixel format value).")]
    public FormatFeatures GetFormatFeatures(PixelFormat format)
    Parameters
    PixelFormat format

    The format.

    Returns
    FormatFeatures

    The format features flags.

    Extension Methods

    Extensions.ReflectiveCompare<T>(T, T)
    Extensions.DeepClone<T>(T)
    Extensions.RawClone<T>(T)
    Back to top Copyright © 2012-2021 Wojciech Figat