Video::OpenGLRenderPass Class Reference
OpenGL implementation of RenderPass. More...
#include <OpenGLRenderPass.hpp>
Inheritance diagram for Video::OpenGLRenderPass:
Public Member Functions | |
| OpenGLRenderPass (Texture *colorAttachment, RenderPass::LoadOperation colorLoadOperation, Texture *depthAttachment, RenderPass::LoadOperation depthLoadOperation) | |
| Create new OpenGL render pass. More... | |
| OpenGLRenderPass (const glm::uvec2 &size, uint32_t msaaSamples) | |
| Create new attachmentless OpenGL render pass. More... | |
| ~OpenGLRenderPass () final | |
| Destructor. More... | |
| const glm::uvec2 & | GetSize () const final |
| Get the size of the frame buffer. More... | |
| GLuint | GetFrameBuffer () const |
| Get the render pass' frame buffer. More... | |
| GLbitfield | GetClearMask () const |
| Get the clear mask for use when beginning the render pass. More... | |
 Public Member Functions inherited from Video::RenderPass | |
| RenderPass () | |
| Create new render pass. More... | |
| virtual | ~RenderPass () |
| Destructor. More... | |
Additional Inherited Members | |
| Public Types inherited from Video::RenderPass | |
| enum class | LoadOperation { LOAD , CLEAR , DONT_CARE } |
| What to do with an image being rendered to before rendering to it. More... | |
Detailed Description
OpenGL implementation of RenderPass.
Constructor & Destructor Documentation
◆ OpenGLRenderPass() [1/2]
| Video::OpenGLRenderPass::OpenGLRenderPass | ( | Texture * | colorAttachment, |
| RenderPass::LoadOperation | colorLoadOperation, | ||
| Texture * | depthAttachment, | ||
| RenderPass::LoadOperation | depthLoadOperation | ||
| ) |
Create new OpenGL render pass.
- Parameters
-
colorAttachment The color attachment to render to. colorLoadOperation What to do with the previous contents of the color attachment. depthAttachment The depth attachment to render to. depthLoadOperation What to do with the previous contents of the depth attachment.
◆ OpenGLRenderPass() [2/2]
| Video::OpenGLRenderPass::OpenGLRenderPass | ( | const glm::uvec2 & | size, |
| uint32_t | msaaSamples | ||
| ) |
Create new attachmentless OpenGL render pass.
- Parameters
-
size The size of the framebuffer. msaaSamples The number of MSAA samples.
◆ ~OpenGLRenderPass()
|
final |
Destructor.
Member Function Documentation
◆ GetClearMask()
| GLbitfield Video::OpenGLRenderPass::GetClearMask | ( | ) | const |
Get the clear mask for use when beginning the render pass.
- Returns
- The clear mask.
◆ GetFrameBuffer()
| GLuint Video::OpenGLRenderPass::GetFrameBuffer | ( | ) | const |
Get the render pass' frame buffer.
- Returns
- The frame buffer.
◆ GetSize()
|
finalvirtual |
Get the size of the frame buffer.
- Returns
- The size of the frame buffer in pixels.
Implements Video::RenderPass.
The documentation for this class was generated from the following files:
- src/Video/LowLevelRenderer/OpenGL/OpenGLRenderPass.hpp
- src/Video/LowLevelRenderer/OpenGL/OpenGLRenderPass.cpp
