139 lines
3.8 KiB
C#
139 lines
3.8 KiB
C#
using Ghost.Graphics.Data;
|
|
|
|
namespace Ghost.Graphics.RHI;
|
|
|
|
/// <summary>
|
|
/// D3D12-style command buffer interface for recording rendering commands
|
|
/// </summary>
|
|
public interface ICommandBuffer : IDisposable
|
|
{
|
|
/// <summary>
|
|
/// Begins recording commands into this command buffer
|
|
/// </summary>
|
|
public void Begin();
|
|
|
|
/// <summary>
|
|
/// Ends recording commands and prepares for submission
|
|
/// </summary>
|
|
public void End();
|
|
|
|
/// <summary>
|
|
/// Begins a render pass with the specified render target
|
|
/// </summary>
|
|
/// <param name="renderTarget">Render target to render into</param>
|
|
/// <param name="clearColor">Color to clear the render target with</param>
|
|
public void BeginRenderPass(IRenderTarget renderTarget, Color16 clearColor);
|
|
|
|
/// <summary>
|
|
/// Ends the current render pass
|
|
/// </summary>
|
|
public void EndRenderPass();
|
|
|
|
/// <summary>
|
|
/// Sets the viewport for rendering
|
|
/// </summary>
|
|
/// <param name="viewport">Viewport to set</param>
|
|
public void SetViewport(ViewportDesc viewport);
|
|
|
|
/// <summary>
|
|
/// Sets the scissor rectangle
|
|
/// </summary>
|
|
/// <param name="rect">Scissor rectangle to set</param>
|
|
public void SetScissorRect(RectDesc rect);
|
|
|
|
/// <summary>
|
|
/// Inserts a resource barrier for state transitions
|
|
/// </summary>
|
|
/// <param name="resource">Resource to transition</param>
|
|
/// <param name="before">Current resource state</param>
|
|
/// <param name="after">Target resource state</param>
|
|
public void ResourceBarrier(IResource resource, ResourceState before, ResourceState after);
|
|
|
|
/// <summary>
|
|
/// Sets the graphics root signature
|
|
/// </summary>
|
|
/// <param name="rootSignature">Root signature to set</param>
|
|
public void SetGraphicsRootSignature(IRootSignature rootSignature);
|
|
|
|
/// <summary>
|
|
/// Sets the pipeline state object
|
|
/// </summary>
|
|
/// <param name="pipelineState">Pipeline state to set</param>
|
|
public void SetPipelineState(IPipelineStateController pipelineState);
|
|
|
|
/// <summary>
|
|
/// Renders the specified mesh using the provided material.
|
|
/// </summary>
|
|
/// <param name="mesh">The mesh to be drawn. Must not be null.</param>
|
|
/// <param name="material">The material to use for rendering the mesh. Must not be null.</param>
|
|
public void DrawMesh(Mesh mesh, Material material);
|
|
|
|
/// <summary>
|
|
/// Dispatches compute threads
|
|
/// </summary>
|
|
/// <param name="threadGroupCountX">Thread groups in X dimension</param>
|
|
/// <param name="threadGroupCountY">Thread groups in Y dimension</param>
|
|
/// <param name="threadGroupCountZ">Thread groups in Z dimension</param>
|
|
public void Dispatch(uint threadGroupCountX, uint threadGroupCountY = 1, uint threadGroupCountZ = 1);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Viewport description
|
|
/// </summary>
|
|
public struct ViewportDesc
|
|
{
|
|
public float X;
|
|
public float Y;
|
|
public float Width;
|
|
public float Height;
|
|
public float MinDepth;
|
|
public float MaxDepth;
|
|
|
|
public ViewportDesc(float width, float height)
|
|
{
|
|
X = 0;
|
|
Y = 0;
|
|
Width = width;
|
|
Height = height;
|
|
MinDepth = 0.0f;
|
|
MaxDepth = 1.0f;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Rectangle description
|
|
/// </summary>
|
|
public struct RectDesc
|
|
{
|
|
public int Left;
|
|
public int Top;
|
|
public int Right;
|
|
public int Bottom;
|
|
|
|
public RectDesc(int left, int top, int right, int bottom)
|
|
{
|
|
Left = left;
|
|
Top = top;
|
|
Right = right;
|
|
Bottom = bottom;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Resource states
|
|
/// </summary>
|
|
public enum ResourceState
|
|
{
|
|
Common = 0,
|
|
VertexAndConstantBuffer = 0x1,
|
|
IndexBuffer = 0x2,
|
|
RenderTarget = 0x4,
|
|
UnorderedAccess = 0x8,
|
|
DepthWrite = 0x10,
|
|
DepthRead = 0x20,
|
|
PixelShaderResource = 0x80,
|
|
CopyDest = 0x400,
|
|
CopySource = 0x800,
|
|
Present = 0,
|
|
}
|