CommandEncoderPlatformInterface.h

 
#pragma once
 
#include <Foundation/Math/Color.h>
#include <Foundation/Math/Rect.h>
#include <RendererFoundation/Descriptors/Enumerations.h>
#include <RendererFoundation/RendererFoundationDLL.h>
 
struct plShaderResourceBinding;
struct plGALRenderingSetup;
 
class PL_RENDERERFOUNDATION_DLL plGALCommandEncoderCommonPlatformInterface
{
public:
  // State setting functions
 
  virtual void SetShaderPlatform(const plGALShader* pShader) = 0;
 
  virtual void SetConstantBufferPlatform(const plShaderResourceBinding& binding, const plGALBuffer* pBuffer) = 0;
  virtual void SetSamplerStatePlatform(const plShaderResourceBinding& binding, const plGALSamplerState* pSamplerState) = 0;
  virtual void SetResourceViewPlatform(const plShaderResourceBinding& binding, const plGALTextureResourceView* pResourceView) = 0;
  virtual void SetResourceViewPlatform(const plShaderResourceBinding& binding, const plGALBufferResourceView* pResourceView) = 0;
  virtual void SetUnorderedAccessViewPlatform(const plShaderResourceBinding& binding, const plGALTextureUnorderedAccessView* pUnorderedAccessView) = 0;
  virtual void SetUnorderedAccessViewPlatform(const plShaderResourceBinding& binding, const plGALBufferUnorderedAccessView* pUnorderedAccessView) = 0;
  virtual void SetPushConstantsPlatform(plArrayPtr<const plUInt8> data) = 0;
 
  // GPU -> CPU query functions
 
  virtual plGALTimestampHandle InsertTimestampPlatform() = 0;
  virtual plGALOcclusionHandle BeginOcclusionQueryPlatform(plEnum<plGALQueryType> type) = 0;
  virtual void EndOcclusionQueryPlatform(plGALOcclusionHandle hOcclusion) = 0;
  virtual plGALFenceHandle InsertFencePlatform() = 0;
 
  // Resource update functions
 
  virtual void ClearUnorderedAccessViewPlatform(const plGALTextureUnorderedAccessView* pUnorderedAccessView, plVec4 vClearValues) = 0;
  virtual void ClearUnorderedAccessViewPlatform(const plGALTextureUnorderedAccessView* pUnorderedAccessView, plVec4U32 vClearValues) = 0;
 
  virtual void ClearUnorderedAccessViewPlatform(const plGALBufferUnorderedAccessView* pUnorderedAccessView, plVec4 vClearValues) = 0;
  virtual void ClearUnorderedAccessViewPlatform(const plGALBufferUnorderedAccessView* pUnorderedAccessView, plVec4U32 vClearValues) = 0;
 
  virtual void CopyBufferPlatform(const plGALBuffer* pDestination, const plGALBuffer* pSource) = 0;
  virtual void CopyBufferRegionPlatform(const plGALBuffer* pDestination, plUInt32 uiDestOffset, const plGALBuffer* pSource, plUInt32 uiSourceOffset, plUInt32 uiByteCount) = 0;
 
  virtual void UpdateBufferPlatform(const plGALBuffer* pDestination, plUInt32 uiDestOffset, plArrayPtr<const plUInt8> sourceData, plGALUpdateMode::Enum updateMode) = 0;
 
  virtual void CopyTexturePlatform(const plGALTexture* pDestination, const plGALTexture* pSource) = 0;
  virtual void CopyTextureRegionPlatform(const plGALTexture* pDestination, const plGALTextureSubresource& destinationSubResource, const plVec3U32& vDestinationPoint, const plGALTexture* pSource, const plGALTextureSubresource& sourceSubResource, const plBoundingBoxu32& box) = 0;
 
  virtual void UpdateTexturePlatform(const plGALTexture* pDestination, const plGALTextureSubresource& destinationSubResource, const plBoundingBoxu32& destinationBox, const plGALSystemMemoryDescription& sourceData) = 0;
 
  virtual void ResolveTexturePlatform(const plGALTexture* pDestination, const plGALTextureSubresource& destinationSubResource, const plGALTexture* pSource, const plGALTextureSubresource& sourceSubResource) = 0;
 
  virtual void ReadbackTexturePlatform(const plGALTexture* pTexture) = 0;
 
  virtual void CopyTextureReadbackResultPlatform(const plGALTexture* pTexture, plArrayPtr<plGALTextureSubresource> sourceSubResource, plArrayPtr<plGALSystemMemoryDescription> targetData) = 0;
 
  virtual void GenerateMipMapsPlatform(const plGALTextureResourceView* pResourceView) = 0;
 
  // Misc
 
  virtual void FlushPlatform() = 0;
 
  // Debug helper functions
 
  virtual void PushMarkerPlatform(const char* szMarker) = 0;
  virtual void PopMarkerPlatform() = 0;
  virtual void InsertEventMarkerPlatform(const char* szMarker) = 0;
 
  // Compute Dispatch
 
  virtual void BeginComputePlatform() = 0;
  virtual void EndComputePlatform() = 0;
 
  virtual plResult DispatchPlatform(plUInt32 uiThreadGroupCountX, plUInt32 uiThreadGroupCountY, plUInt32 uiThreadGroupCountZ) = 0;
  virtual plResult DispatchIndirectPlatform(const plGALBuffer* pIndirectArgumentBuffer, plUInt32 uiArgumentOffsetInBytes) = 0;
 
  // Draw functions
 
  virtual void BeginRenderingPlatform(const plGALRenderingSetup& renderingSetup) = 0;
  virtual void EndRenderingPlatform() = 0;
 
  virtual void ClearPlatform(const plColor& clearColor, plUInt32 uiRenderTargetClearMask, bool bClearDepth, bool bClearStencil, float fDepthClear, plUInt8 uiStencilClear) = 0;
 
  virtual plResult DrawPlatform(plUInt32 uiVertexCount, plUInt32 uiStartVertex) = 0;
  virtual plResult DrawIndexedPlatform(plUInt32 uiIndexCount, plUInt32 uiStartIndex) = 0;
  virtual plResult DrawIndexedInstancedPlatform(plUInt32 uiIndexCountPerInstance, plUInt32 uiInstanceCount, plUInt32 uiStartIndex) = 0;
  virtual plResult DrawIndexedInstancedIndirectPlatform(const plGALBuffer* pIndirectArgumentBuffer, plUInt32 uiArgumentOffsetInBytes) = 0;
  virtual plResult DrawInstancedPlatform(plUInt32 uiVertexCountPerInstance, plUInt32 uiInstanceCount, plUInt32 uiStartVertex) = 0;
  virtual plResult DrawInstancedIndirectPlatform(const plGALBuffer* pIndirectArgumentBuffer, plUInt32 uiArgumentOffsetInBytes) = 0;
 
  // State functions
 
  virtual void SetIndexBufferPlatform(const plGALBuffer* pIndexBuffer) = 0;
  virtual void SetVertexBufferPlatform(plUInt32 uiSlot, const plGALBuffer* pVertexBuffer) = 0;
  virtual void SetVertexDeclarationPlatform(const plGALVertexDeclaration* pVertexDeclaration) = 0;
  virtual void SetPrimitiveTopologyPlatform(plGALPrimitiveTopology::Enum topology) = 0;
 
  virtual void SetBlendStatePlatform(const plGALBlendState* pBlendState, const plColor& blendFactor, plUInt32 uiSampleMask) = 0;
  virtual void SetDepthStencilStatePlatform(const plGALDepthStencilState* pDepthStencilState, plUInt8 uiStencilRefValue) = 0;
  virtual void SetRasterizerStatePlatform(const plGALRasterizerState* pRasterizerState) = 0;
 
  virtual void SetViewportPlatform(const plRectFloat& rect, float fMinDepth, float fMaxDepth) = 0;
  virtual void SetScissorRectPlatform(const plRectU32& rect) = 0;
 
};