IContext.h

Go to the documentation of this file.

#pragma once
 
#include "Common.h"
#include "DataFormat.h"
 
namespace Cogs
{
  class StringView;
  struct FrameStatistics;
  struct UploadStatistics;
 
  enum class LoadOp : uint32_t{
    Undefined,
    Clear,
    Load,
  };
 
  enum class StoreOp : uint32_t{
    Undefined,
    Store,
    Discard
  };
 
  struct RenderPassInfo{
    RenderTargetHandle renderTargetHandle = {};
    DepthStencilHandle depthStencilHandle = {};
    TextureViewHandle resolveHandle[8] = {};
 
    LoadOp loadOp[8] = {LoadOp::Clear, LoadOp::Clear, LoadOp::Clear, LoadOp::Clear, LoadOp::Clear, LoadOp::Clear, LoadOp::Clear, LoadOp::Clear};
    StoreOp storeOp[8] = {StoreOp::Store, StoreOp::Store, StoreOp::Store, StoreOp::Store, StoreOp::Store, StoreOp::Store, StoreOp::Store, StoreOp::Store};
    float clearValue[8][4] = {};
 
    LoadOp depthLoadOp = LoadOp::Clear;
    StoreOp depthStoreOp = StoreOp::Store;
    float depthClearValue = 1.0f;
    bool depthReadOnly = false;
  };
 
  struct IContext
  {
    virtual const Cogs::FrameStatistics& getLastFrameStatistics() = 0;
    virtual const Cogs::UploadStatistics& getLastUploadStatistics() = 0;
 
    virtual void frameStatisticsConfigure(bool enable) = 0;
 
    virtual void clearCachedState() {}
 
    virtual void pushCommandGroupAnnotation(const StringView & name) { (void)name; }
 
    virtual void popCommandGroupAnnotation() {}
 
    virtual void setAnnotationMarker(const StringView & name) { (void)name; }
 
    //
    // Render Pass
    //
    virtual void beginRenderPass(const RenderPassInfo &info) = 0;
 
    virtual void endRenderPass() = 0;
 
    //
    // Render target management
    //
    virtual void setRenderTarget(const RenderTargetHandle handle, const DepthStencilHandle depthStencilHandle) = 0;
 
    virtual void setViewport(const float x, const float y, const float width, const float height) = 0;
 
    virtual void setScissor(const int x, const int y, const int width, const int height) = 0;
 
    virtual void clearRenderTarget(const float * value) = 0;
    
    virtual void clearRenderTarget(const float ** values, const int numvalues) = 0;
 
    virtual void clearDepth(const float depth = 1.0f) = 0;
 
    //
    // Pipeline state setup
    //
 
    virtual void setDepthStencilState(const DepthStencilStateHandle handle) = 0;
 
    virtual void setBlendState(const BlendStateHandle handle, const float* constant = nullptr) = 0;
 
    virtual void setRasterizerState(const RasterizerStateHandle handle) = 0;
 
    //
    // Effect state setup
    //
 
    virtual void setEffect(EffectHandle handle) = 0;
 
    virtual void setMatrixVariable(const StringView& name, const float * value) = 0;
 
    virtual void setScalarVariable(const StringView& name, const float value) = 0;
 
    virtual void setScalarVariable(const StringView& name, int value) = 0;
 
    virtual void setVector2Variable(const StringView& name, const float * value) = 0;
    
    virtual void setVector3Variable(const StringView& name, const float * value) = 0;
    
    virtual void setVector4Variable(const StringView& name, const float * value) = 0;
 
    virtual void setVariable(const EffectVariableHandle index, const uint8_t * data, size_t size) = 0;
 
    virtual void setMatrixVariable(const EffectVariableHandle variableHandle, const float * value) = 0;
 
    virtual void setMatrixVariable(const EffectVariableHandle variableHandle, const float * value, size_t count) = 0;
 
    virtual void setScalarVariable(const EffectVariableHandle variableHandle, const float value) = 0;
 
    virtual void setScalarVariable(const EffectVariableHandle variableHandle, const float* value, size_t count) = 0;
 
    virtual void setScalarVariable(const EffectVariableHandle variableHandle, int value) = 0;
 
    virtual void setScalarVariable(const EffectVariableHandle variableHandle, const int* value, size_t count) = 0;
 
    virtual void setVector2Variable(const EffectVariableHandle variableHandle, const float * value, size_t count = 1) = 0;
    
    virtual void setVector3Variable(const EffectVariableHandle variableHandle, const float * value, size_t count = 1) = 0;
    
    virtual void setVector4Variable(const EffectVariableHandle variableHandle, const float * value, size_t count = 1) = 0;
 
    virtual void setVector4Variable(const EffectVariableHandle variableHandle, const int * value, size_t count = 1) = 0;
 
    //
    // Texture state setup
    //
 
    virtual void setTexture(const StringView& name, unsigned int unit, TextureHandle textureHandle) = 0;
 
    virtual void setTexture(const TextureBindingHandle textureBindingHandle, const TextureHandle textureHandle) = 0;
 
    virtual void setTexture(const StringView& name, TextureViewHandle textureViewHandle) = 0;
    virtual void setTexture(const TextureBindingHandle textureBindingHandle, TextureViewHandle textureViewHandle) = 0;
 
    virtual void setSamplerState(const StringView& name, unsigned int unit, SamplerStateHandle samplerStateHandle) = 0;
 
    virtual void setSamplerState(const SamplerStateBindingHandle samplerStateBindingHandle, const SamplerStateHandle samplerStateHandle) = 0;
 
    //
    // Draw state setup
    //
 
    virtual void setInputLayout(const InputLayoutHandle inputLayoutHandle) = 0;
 
    virtual void setVertexBuffers(const VertexBufferHandle * vertexBufferHandles, const size_t count, const uint32_t * strides, const uint32_t * offsets) = 0;
 
    virtual void setVertexBuffers(const VertexBufferHandle * vertexBufferHandles, const size_t count) = 0;
 
    virtual void setIndexBuffer(IndexBufferHandle bufferHandle, uint32_t stride = 4, uint32_t offset = 0) = 0;
 
 
    virtual void setVertexArrayObject(VertexArrayObjectHandle vertexArrayObject) = 0;
 
 
    virtual void setConstantBuffer(const StringView& name, const BufferHandle bufferHandle, const uint32_t offset = 0, const uint32_t size = ~0u) = 0;
 
    virtual void setConstantBuffer(const ConstantBufferBindingHandle bufferBindingHandle, const BufferHandle bufferHandle, const uint32_t offset = 0, const uint32_t size = ~0u) = 0;
 
    virtual void setBuffer(const StringView& name, BufferHandle bufferHandle) = 0;
 
    virtual void setBuffer(const BufferBindingHandle bufferBindingHandle, BufferHandle bufferHandle) = 0;
 
    virtual void setBufferCounter(BufferHandle bufferHandle, uint32_t value) = 0;
 
    virtual void setBufferCounter(BufferHandle bufferHandle, BufferHandle sourceBufferHandle) = 0;
 
    virtual void getBufferCounter(BufferHandle bufferHandle, BufferHandle destinationBufferHandle) = 0;
 
    virtual uint32_t getBufferCounter(BufferHandle bufferHandle) = 0;
 
    //
    // Draw calls
    //
 
    virtual void draw(PrimitiveType::EPrimitiveType primitiveType, const size_t startVertex, const size_t numVertexes) = 0;
 
    virtual void drawIndexed(PrimitiveType::EPrimitiveType primitiveType, const size_t startIndex, const size_t numIndexes, const size_t startVertex = 0) = 0;
 
    virtual void drawInstanced(PrimitiveType::EPrimitiveType primitiveType, const size_t startVertex, const size_t numVertexes, const size_t startInstance, const size_t numInstances) = 0;
 
    virtual void drawInstancedIndexed(PrimitiveType::EPrimitiveType primitiveType, const size_t startInstance, const size_t numInstances, const size_t startIndex, const size_t numIndexes) = 0;
 
    virtual void dispatchCompute(const unsigned int threadGroupsX, const unsigned int threadGroupsY, const unsigned int threadGroupsZ) = 0;
    
    //
    // Render target, texture and buffer manipulation.
    //
 
    virtual void resolveResource(TextureHandle source, TextureHandle destination) = 0;
 
    virtual void readDepthBuffer(BufferHandle bufferHandle, int x, int y, int width, int height, Framebuffer::EFrameBuffer framebuffer) = 0;
    
    virtual void readColorBuffer(BufferHandle bufferHandle, int x, int y, int width, int height, Framebuffer::EFrameBuffer framebuffer) = 0;
 
 
    virtual void * map(BufferHandle bufferHandle, MapMode::EMapMode mapMode, uint32_t * stride = nullptr) = 0;
 
    virtual void unmap(BufferHandle bufferHandle) = 0;
 
    virtual void updateBuffer(BufferHandle bufferHandle, const void* data, size_t size) = 0;
 
    virtual void * map(TextureHandle textureHandle, MapMode::EMapMode accessMode, uint32_t * rowPitch, uint32_t * depthPitch) = 0;
 
    virtual void unmap(TextureHandle textureHandle) = 0;
 
    virtual void signal(FenceHandle fenceHandle) = 0;
 
    virtual void updateSubTexture(TextureHandle textureHandle, const size_t level, const void * data) = 0;
 
    virtual void updateSubBuffer(BufferHandle bufferHandle, const size_t offset, const size_t size, const void* data) = 0;
 
    virtual void copyResource(BufferHandle destinationHandle, BufferHandle sourceHandle) = 0;
    virtual void copyResource(TextureHandle destinationHandle, TextureHandle sourceHandle) = 0;
 
    virtual void copyTexture(TextureHandle dstHandle, unsigned dstSub, unsigned dstX, unsigned dstY, unsigned dstZ, TextureHandle sourceHandle, unsigned srcSub) = 0;
 
    virtual void clearResource(BufferHandle destinationHandle, uint32_t *Values) = 0;
    virtual void clearResource(BufferHandle destinationHandle, float *Values) = 0;
 
    //
    // Context management.
    //
 
    virtual void reset() {};
  };
}