VisuTwin Canvas
C++ 3D Engine — Metal Backend
Loading...
Searching...
No Matches
visutwin::canvas::RenderTarget Class Referenceabstract

#include <platform/graphics/renderTarget.h>

Inheritance diagram for visutwin::canvas::RenderTarget:
[legend]

Public Member Functions

bool autoResolve () const
Texture * colorBuffer () const
int colorBufferCount () const
Texture * depthBuffer () const
int face () const
Texture * getColorBuffer (size_t index) const
bool hasDepth () const
bool hasDepthBuffer () const
bool hasMipmaps () const
bool hasStencil () const
int height () const
int key () const
int mipLevel () const
const std::string & name () const
 RenderTarget (const RenderTargetOptions &options={})
void resize (int width, int height)
int samples () const
int width () const
virtual ~RenderTarget ()

Protected Member Functions

virtual void createFrameBuffers ()=0
virtual void destroyFrameBuffers ()=0
GraphicsDevice * device () const
void validateMrt ()

Detailed Description

Definition at line 44 of file renderTarget.h.

Constructor & Destructor Documentation

◆ RenderTarget()

visutwin::canvas::RenderTarget::RenderTarget ( const RenderTargetOptions & options = {})
explicit

Definition at line 17 of file renderTarget.cpp.

References visutwin::canvas::RenderTargetOptions::autoResolve, visutwin::canvas::RenderTargetOptions::colorBuffer, visutwin::canvas::RenderTargetOptions::colorBuffers, visutwin::canvas::RenderTargetOptions::depth, visutwin::canvas::RenderTargetOptions::depthBuffer, visutwin::canvas::Texture::device(), visutwin::canvas::RenderTargetOptions::face, visutwin::canvas::RenderTargetOptions::flipY, visutwin::canvas::RenderTargetOptions::graphicsDevice, height(), visutwin::canvas::RenderTargetOptions::mipLevel, visutwin::canvas::RenderTargetOptions::name, visutwin::canvas::PIXELFORMAT_DEPTH, visutwin::canvas::PIXELFORMAT_DEPTH16, visutwin::canvas::PIXELFORMAT_DEPTHSTENCIL, visutwin::canvas::PIXELFORMAT_R32F, visutwin::canvas::RenderTargetOptions::samples, visutwin::canvas::RenderTargetOptions::stencil, validateMrt(), and width().

Referenced by visutwin::canvas::metal::MetalBackBufferRenderTarget::MetalBackBufferRenderTarget(), and visutwin::canvas::MetalRenderTarget::MetalRenderTarget().

◆ ~RenderTarget()

visutwin::canvas::RenderTarget::~RenderTarget ( )
virtual

Definition at line 117 of file renderTarget.cpp.

Member Function Documentation

◆ autoResolve()

bool visutwin::canvas::RenderTarget::autoResolve ( ) const
inline

Definition at line 78 of file renderTarget.h.

◆ colorBuffer()

Texture * visutwin::canvas::RenderTarget::colorBuffer ( ) const
inline

Definition at line 58 of file renderTarget.h.

Referenced by visutwin::canvas::MetalRenderTarget::ensureAttachments(), resize(), and validateMrt().

◆ colorBufferCount()

int visutwin::canvas::RenderTarget::colorBufferCount ( ) const
inline

Definition at line 65 of file renderTarget.h.

Referenced by visutwin::canvas::MetalRenderTarget::ensureAttachments().

◆ createFrameBuffers()

virtual void visutwin::canvas::RenderTarget::createFrameBuffers ( )
protectedpure virtual

Referenced by visutwin::canvas::MetalRenderTarget::ensureAttachments(), visutwin::canvas::MetalRenderTarget::MetalRenderTarget(), and resize().

◆ depthBuffer()

Texture * visutwin::canvas::RenderTarget::depthBuffer ( ) const
inline

Definition at line 77 of file renderTarget.h.

◆ destroyFrameBuffers()

virtual void visutwin::canvas::RenderTarget::destroyFrameBuffers ( )
protectedpure virtual

Referenced by resize(), and visutwin::canvas::MetalRenderTarget::~MetalRenderTarget().

◆ device()

GraphicsDevice * visutwin::canvas::RenderTarget::device ( ) const
inlineprotected

Definition at line 86 of file renderTarget.h.

◆ face()

int visutwin::canvas::RenderTarget::face ( ) const
inline

Definition at line 81 of file renderTarget.h.

◆ getColorBuffer()

Texture * visutwin::canvas::RenderTarget::getColorBuffer ( size_t index) const

Definition at line 178 of file renderTarget.cpp.

Referenced by visutwin::canvas::MetalRenderTarget::ensureAttachments().

◆ hasDepth()

bool visutwin::canvas::RenderTarget::hasDepth ( ) const
inline

Definition at line 63 of file renderTarget.h.

Referenced by visutwin::canvas::MetalRenderTarget::ensureAttachments().

◆ hasDepthBuffer()

bool visutwin::canvas::RenderTarget::hasDepthBuffer ( ) const
inline

Definition at line 62 of file renderTarget.h.

◆ hasMipmaps()

bool visutwin::canvas::RenderTarget::hasMipmaps ( ) const
inline

Definition at line 67 of file renderTarget.h.

◆ hasStencil()

bool visutwin::canvas::RenderTarget::hasStencil ( ) const
inline

Definition at line 71 of file renderTarget.h.

◆ height()

int visutwin::canvas::RenderTarget::height ( ) const

Definition at line 139 of file renderTarget.cpp.

References visutwin::canvas::TextureUtils::calcLevelDimension(), and height().

Referenced by height(), RenderTarget(), resize(), and validateMrt().

◆ key()

int visutwin::canvas::RenderTarget::key ( ) const
inline

Definition at line 83 of file renderTarget.h.

◆ mipLevel()

int visutwin::canvas::RenderTarget::mipLevel ( ) const
inline

Definition at line 73 of file renderTarget.h.

◆ name()

const std::string & visutwin::canvas::RenderTarget::name ( ) const
inline

Definition at line 75 of file renderTarget.h.

◆ resize()

void visutwin::canvas::RenderTarget::resize ( int width,
int height )

Definition at line 148 of file renderTarget.cpp.

References colorBuffer(), createFrameBuffers(), destroyFrameBuffers(), height(), validateMrt(), and width().

◆ samples()

int visutwin::canvas::RenderTarget::samples ( ) const
inline

Definition at line 60 of file renderTarget.h.

◆ validateMrt()

void visutwin::canvas::RenderTarget::validateMrt ( )
protected

Definition at line 186 of file renderTarget.cpp.

References colorBuffer(), height(), and width().

Referenced by RenderTarget(), and resize().

◆ width()

int visutwin::canvas::RenderTarget::width ( ) const

Definition at line 130 of file renderTarget.cpp.

References visutwin::canvas::TextureUtils::calcLevelDimension(), and width().

Referenced by RenderTarget(), resize(), validateMrt(), and width().

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