Search Results for

    Show / Hide Table of Contents

    Class ValidationLayer

    The graphics validation layer.

    Inheritance
    object
    ValidationLayer
    Namespace: Evergine.Common.Graphics
    Assembly: Evergine.Common.dll
    Syntax
    public class ValidationLayer

    Constructors

    ValidationLayer(NotifyAction)

    Initializes a new instance of the ValidationLayer class.

    Declaration
    public ValidationLayer(ValidationLayer.NotifyAction function)
    Parameters
    Type Name Description
    ValidationLayer.NotifyAction function

    The callback function called for every detected error.

    ValidationLayer(NotifyMethod)

    Initializes a new instance of the ValidationLayer class.

    Declaration
    public ValidationLayer(ValidationLayer.NotifyMethod method = NotifyMethod.Exceptions)
    Parameters
    Type Name Description
    ValidationLayer.NotifyMethod method

    The notification method ValidationLayer.NotifyMethod, exception by default.

    Fields

    Notify

    Pointer to the Notify function.

    Declaration
    public ValidationLayer.NotifyAction Notify
    Field Value
    Type Description
    ValidationLayer.NotifyAction

    Methods

    CopyBufferDataTo(bool, uint)

    Validates the copy buffer operation.

    Declaration
    public void CopyBufferDataTo(bool inRenderPass, uint sizeInBytes)
    Parameters
    Type Name Description
    bool inRenderPass

    Indicates whether the operation is made inside a render pass.

    uint sizeInBytes

    The size of the buffer in bytes.

    CopyTextureDataTo(bool)

    Validates the copy texture data operation.

    Declaration
    public void CopyTextureDataTo(bool inRenderPass)
    Parameters
    Type Name Description
    bool inRenderPass

    Indicates if the operation is made inside a render pass.

    CreateBufferValidation(nint, ref BufferDescription)

    Creates the buffer validation layer.

    Declaration
    public void CreateBufferValidation(nint data, ref BufferDescription description)
    Parameters
    Type Name Description
    nint data

    The buffer's data.

    BufferDescription description

    The buffer's description.

    CreateCommandQueueValidation(CommandQueueType)

    Creates a command queue validation layer.

    Declaration
    public void CreateCommandQueueValidation(CommandQueueType queueType)
    Parameters
    Type Name Description
    CommandQueueType queueType

    The type of queue.

    CreateComputePipelineValidation(ref ComputePipelineDescription)

    Creates a compute pipeline validation layer.

    Declaration
    public void CreateComputePipelineValidation(ref ComputePipelineDescription description)
    Parameters
    Type Name Description
    ComputePipelineDescription description

    The compute pipeline's description.

    CreateFrameBufferValidation(FrameBufferAttachment?, FrameBufferAttachment[], bool)

    Creates a frame buffer validation.

    Declaration
    public void CreateFrameBufferValidation(FrameBufferAttachment? depthTarget, FrameBufferAttachment[] colorTargets, bool disposeAttachments)
    Parameters
    Type Name Description
    FrameBufferAttachment? depthTarget

    The depth frame buffer.

    FrameBufferAttachment[] colorTargets

    The color frame buffers.

    bool disposeAttachments

    Whether the attachments should be disposed.

    CreateGraphicsPipelineValidation(ref GraphicsPipelineDescription)

    Creates a graphics pipeline validation.

    Declaration
    public void CreateGraphicsPipelineValidation(ref GraphicsPipelineDescription description)
    Parameters
    Type Name Description
    GraphicsPipelineDescription description

    The graphics pipeline description.

    CreateRaytracingPipelineValidation(ref RaytracingPipelineDescription)

    Creates a ray tracing pipeline validation layer.

    Declaration
    public void CreateRaytracingPipelineValidation(ref RaytracingPipelineDescription description)
    Parameters
    Type Name Description
    RaytracingPipelineDescription description

    The ray tracing pipeline description.

    CreateResourceLayoutValidation(ref ResourceLayoutDescription)

    Creates a resource layout validation.

    Declaration
    public void CreateResourceLayoutValidation(ref ResourceLayoutDescription description)
    Parameters
    Type Name Description
    ResourceLayoutDescription description

    The resource layout description.

    CreateResourceSetValidation(ref ResourceSetDescription)

    Creates the resource set validation.

    Declaration
    public void CreateResourceSetValidation(ref ResourceSetDescription description)
    Parameters
    Type Name Description
    ResourceSetDescription description

    The resource set description.

    CreateSamplerStateValidation(ref SamplerStateDescription)

    Creates the sampler state validation layer.

    Declaration
    public void CreateSamplerStateValidation(ref SamplerStateDescription description)
    Parameters
    Type Name Description
    SamplerStateDescription description

    The description of the sampler state.

    CreateShaderValidation(ref ShaderDescription)

    Creates a shader validation layer.

    Declaration
    public void CreateShaderValidation(ref ShaderDescription description)
    Parameters
    Type Name Description
    ShaderDescription description

    The shader's description.

    CreateTextureValidation(DataBox[], ref TextureDescription, ref SamplerStateDescription)

    Creates a texture validation layer.

    Declaration
    public void CreateTextureValidation(DataBox[] data, ref TextureDescription description, ref SamplerStateDescription samplerState)
    Parameters
    Type Name Description
    DataBox[] data

    The texture data.

    TextureDescription description

    The texture description.

    SamplerStateDescription samplerState

    The texture sampler state.

    SetGraphicsPipelineState(bool)

    Validates CommandBuffer.SetGraphicsPipelineState.

    Declaration
    public void SetGraphicsPipelineState(bool inRenderPass)
    Parameters
    Type Name Description
    bool inRenderPass

    Indicates if the operation is performed inside a render pass.

    UpdateBufferData(bool, uint)

    Updates the buffer data.

    Declaration
    public void UpdateBufferData(bool inRenderPass, uint sourceSizeInBytes)
    Parameters
    Type Name Description
    bool inRenderPass

    Indicates if the operation is made inside a render pass.

    uint sourceSizeInBytes

    The source buffer size in bytes.

    Events

    Error

    Event that allows obtaining error messages if ValidationLayer.NotifyMethod is set to Events.

    Declaration
    public event EventHandler<string> Error
    Event Type
    Type Description
    EventHandler<string>

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)
    In this article
    Back to top
    Generated by DocFX