Divide Framework 0.1
A free and open-source 3D Framework under heavy development
Loading...
Searching...
No Matches
Divide::RenderAPIWrapper Class Referenceabstract

Renderer Programming Interface. More...

#include <RenderAPIWrapper.h>

+ Inheritance diagram for Divide::RenderAPIWrapper:

Public Member Functions

virtual ~RenderAPIWrapper ()=default
 

Protected Member Functions

virtual bool drawToWindow (DisplayWindow &window)=0
 
virtual void onRenderThreadLoopStart ()=0
 
virtual void onRenderThreadLoopEnd ()=0
 
virtual void prepareFlushWindow (DisplayWindow &window)=0
 
virtual void flushWindow (DisplayWindow &window)=0
 
virtual bool frameStarted ()=0
 
virtual bool frameEnded ()=0
 
virtual void idle (bool fast)=0
 
virtual ErrorCode initRenderingAPI (I32 argc, char **argv, Configuration &config)=0
 
virtual void closeRenderingAPI ()=0
 
virtual void preFlushCommandBuffer (Handle< GFX::CommandBuffer > commandBuffer)=0
 
virtual void flushCommand (GFX::CommandBase *cmd)=0
 
virtual void postFlushCommandBuffer (Handle< GFX::CommandBuffer > commandBuffer)=0
 
virtual bool setViewportInternal (const Rect< I32 > &newViewport)=0
 
virtual bool setScissorInternal (const Rect< I32 > &newScissor)=0
 
virtual void onThreadCreated (const std::thread::id &threadID, bool isMainRenderThread)=0
 
virtual bool bindShaderResources (const DescriptorSetEntries &descriptorSetEntries)=0
 
virtual void initDescriptorSets ()=0
 
virtual RenderTarget_uptr newRT (const RenderTargetDescriptor &descriptor) const =0
 
virtual GenericVertexData_ptr newGVD (U32 ringBufferLength, std::string_view name) const =0
 
virtual ShaderBuffer_uptr newSB (const ShaderBufferDescriptor &descriptor) const =0
 

Friends

class GFXDevice
 

Additional Inherited Members

- Private Member Functions inherited from Divide::NonCopyable
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
 NonCopyable (NonCopyable &&)=default
 
NonCopyableoperator= (NonCopyable &&)=default
 
 NonCopyable ()=default
 
 ~NonCopyable ()=default
 

Detailed Description

Renderer Programming Interface.

Definition at line 149 of file RenderAPIWrapper.h.

Constructor & Destructor Documentation

◆ ~RenderAPIWrapper()

virtual Divide::RenderAPIWrapper::~RenderAPIWrapper ( )
virtualdefault

Member Function Documentation

◆ bindShaderResources()

virtual bool Divide::RenderAPIWrapper::bindShaderResources ( const DescriptorSetEntries descriptorSetEntries)
protectedpure virtual

◆ closeRenderingAPI()

virtual void Divide::RenderAPIWrapper::closeRenderingAPI ( )
protectedpure virtual

◆ drawToWindow()

virtual bool Divide::RenderAPIWrapper::drawToWindow ( DisplayWindow window)
protectedpure virtual

◆ flushCommand()

virtual void Divide::RenderAPIWrapper::flushCommand ( GFX::CommandBase cmd)
protectedpure virtual

◆ flushWindow()

virtual void Divide::RenderAPIWrapper::flushWindow ( DisplayWindow window)
protectedpure virtual

◆ frameEnded()

virtual bool Divide::RenderAPIWrapper::frameEnded ( )
protectedpure virtual

◆ frameStarted()

virtual bool Divide::RenderAPIWrapper::frameStarted ( )
protectedpure virtual

◆ idle()

virtual void Divide::RenderAPIWrapper::idle ( bool  fast)
protectedpure virtual

◆ initDescriptorSets()

virtual void Divide::RenderAPIWrapper::initDescriptorSets ( )
protectedpure virtual

◆ initRenderingAPI()

virtual ErrorCode Divide::RenderAPIWrapper::initRenderingAPI ( I32  argc,
char **  argv,
Configuration config 
)
protectedpure virtual

◆ newGVD()

virtual GenericVertexData_ptr Divide::RenderAPIWrapper::newGVD ( U32  ringBufferLength,
std::string_view  name 
) const
protectedpure virtual

◆ newRT()

virtual RenderTarget_uptr Divide::RenderAPIWrapper::newRT ( const RenderTargetDescriptor descriptor) const
protectedpure virtual

◆ newSB()

virtual ShaderBuffer_uptr Divide::RenderAPIWrapper::newSB ( const ShaderBufferDescriptor descriptor) const
protectedpure virtual

◆ onRenderThreadLoopEnd()

virtual void Divide::RenderAPIWrapper::onRenderThreadLoopEnd ( )
protectedpure virtual

◆ onRenderThreadLoopStart()

virtual void Divide::RenderAPIWrapper::onRenderThreadLoopStart ( )
protectedpure virtual

◆ onThreadCreated()

virtual void Divide::RenderAPIWrapper::onThreadCreated ( const std::thread::id &  threadID,
bool  isMainRenderThread 
)
protectedpure virtual

◆ postFlushCommandBuffer()

virtual void Divide::RenderAPIWrapper::postFlushCommandBuffer ( Handle< GFX::CommandBuffer commandBuffer)
protectedpure virtual

◆ preFlushCommandBuffer()

virtual void Divide::RenderAPIWrapper::preFlushCommandBuffer ( Handle< GFX::CommandBuffer commandBuffer)
protectedpure virtual

◆ prepareFlushWindow()

virtual void Divide::RenderAPIWrapper::prepareFlushWindow ( DisplayWindow window)
protectedpure virtual

◆ setScissorInternal()

virtual bool Divide::RenderAPIWrapper::setScissorInternal ( const Rect< I32 > &  newScissor)
protectedpure virtual

◆ setViewportInternal()

virtual bool Divide::RenderAPIWrapper::setViewportInternal ( const Rect< I32 > &  newViewport)
protectedpure virtual

Friends And Related Function Documentation

◆ GFXDevice

friend class GFXDevice
friend

Definition at line 154 of file RenderAPIWrapper.h.


The documentation for this class was generated from the following file: