Specifies how renderTexture is to be performed. More...

#include <FrameRenderer.hpp>

Public Member Functions
	RenderTextureParams (unsigned int unit)
	Instantiates default configuration. This will simply reproduce the texture that is currently bound to texture unit on a rectangle that covers the whole viewport.

Public Attributes
unsigned int	unit
	The texture unit that renderTexture will instruct the shader to use.

bool	useDefaultSampler
	Holds whether a predefined sampler is to be bound to unit before drawing. This predefined sampler uses Sampler::FILTER_LINEAR and Sampler::WRAP_MODE_CLAMP.

bool	useDefaultShader
	The currently set shader will be used for drawing if this is `false`. If the value is `true`, the default shader will be bound, that reproduces the texture bound to unit.

std::string	textureUniformName
	Holds the name of the uniform variable defined by the shader that will be used, that will be linked with the specified texture unit.

float	alphaFactor
	If useDefaultShader is `true`, the alpha values sampled from the texture bound to the specified texture unit will be multiplied with this value. Otherwise this is ignored.

Detailed Description

Specifies how renderTexture is to be performed.

The texture unit will be linked with the specified shader uniform variable, that is set to colorMap initially.

Definition at line 185 of file FrameRenderer.hpp.

Member Data Documentation

◆ alphaFactor

float LibCarna::base::FrameRenderer::RenderTextureParams::alphaFactor

If useDefaultShader is true, the alpha values sampled from the texture bound to the specified texture unit will be multiplied with this value. Otherwise this is ignored.

The default value is 1.

Definition at line 225 of file FrameRenderer.hpp.

◆ textureUniformName

std::string LibCarna::base::FrameRenderer::RenderTextureParams::textureUniformName

Holds the name of the uniform variable defined by the shader that will be used, that will be linked with the specified texture unit.

The default value is colorMap.

Definition at line 216 of file FrameRenderer.hpp.

◆ unit

unsigned int LibCarna::base::FrameRenderer::RenderTextureParams::unit

The texture unit that renderTexture will instruct the shader to use.

Definition at line 190 of file FrameRenderer.hpp.

◆ useDefaultSampler

bool LibCarna::base::FrameRenderer::RenderTextureParams::useDefaultSampler

Holds whether a predefined sampler is to be bound to unit before drawing. This predefined sampler uses Sampler::FILTER_LINEAR and Sampler::WRAP_MODE_CLAMP.

The default value is true.

Definition at line 199 of file FrameRenderer.hpp.

◆ useDefaultShader

bool LibCarna::base::FrameRenderer::RenderTextureParams::useDefaultShader

The currently set shader will be used for drawing if this is false. If the value is true, the default shader will be bound, that reproduces the texture bound to unit.

The default value is true.

Definition at line 208 of file FrameRenderer.hpp.

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

include/LibCarna/base/FrameRenderer.hpp

Public Member Functions