Handles a collection of common rendering programs of predefined types and shared operations among these programs. More...

#include <rendering_programs.h>

Classes
class	Backend

Public Types
enum class	Operation { BLEND , MASKED_BLEND , MASKED_8BIT_BLEND , SHAPED_BLEND , BLEND_EXT , MASKED_BLEND_EXT , MASKED_8BIT_BLEND_EXT , SHAPED_BLEND_EXT }
	Standard rendering operations. More...

Public Member Functions
void	enableProgram (GraphicPipeline *gpu, Operation program)
	Select and enable a common program. More...

Program &	getCurrentProgram ()

void	bindMask (GraphicPipeline *gpu, AbstractBitmap &mask)
	Binds a mask to a masked rendering program. More...

void	blend (bool onScreen)
	Performs the blending operation. More...

void	paveBackground (GraphicPipeline gpu, TextureHandler &content, GL::TextureHandler output)
	Fills background with a repeated texture taking 1 pixel of this texture per 1 pixel of the output. More...

const VertexShader &	getDefaultVertexShader (const GraphicPipeline *gpu) const

	RenderingPrograms (GraphicPipeline *gpu)

	~RenderingPrograms ()

Static Public Attributes
static const char *	VERTEX_COORD_ATTRIB_NAME = "inVertex"
	vertex coordinate attribute name in vertex shaders More...

static const char *	TEXTURE_COORD_ATTRIB_NAME = "inTexCoord"
	texture coordinate attribute name in vertex shaders More...

static const char *	VERTICAL_FLIP_ID = "flipVertically"
	Vertical flipping variable name in vertex shader. More...

static const char *	MODELVIEW_MATRIX_ID = "modelview"
	Modelview matrix (mapping input geometry to output) shader variable name in vertex shader. More...

static const char *	TEXTURE_COORDINATES_ID = "texCoord"
	Texture coordinates shader variable name in vertex shader. More...

static const char *	DECLARE_TEXTURE_COORDINATES_IN_FRAG = "varying highp vec2 texCoord;\n"
	Declaring texture coordinates in fragment shader. More...

Private Member Functions
Program &	getProgram (const GraphicPipeline *gpu, Operation program)

Private Attributes
Backend *	backend

Program *	currentGlProgram

Operation	currentProgram

bool	maskSetUp

VertexShader	defaultVertexShader

std::map< Operation, RenderingProgram >	programs

Detailed Description

Handles a collection of common rendering programs of predefined types and shared operations among these programs.

Programs compilation and linking is done in a deferred fashion, so that the first rendering pass would usually take much more time, but no time is spent on initializing programs that will never be used.

Definition at line 33 of file rendering_programs.h.

Member Enumeration Documentation

◆ Operation

enum Beatmup::GL::RenderingPrograms::Operation

strong

Standard rendering operations.

Enumerator
BLEND	default blending of a single image
MASKED_BLEND	blending an image through a pixelwise mask
MASKED_8BIT_BLEND	blending an image through a 8 bit pixelwise mask
SHAPED_BLEND	shaping an image
BLEND_EXT	default blending using a texture extension
MASKED_BLEND_EXT	blending an image through a pixelwise mask (texture extension)
MASKED_8BIT_BLEND_EXT	blending an image through a 8 bit pixelwise mask (texture extension)
SHAPED_BLEND_EXT	shaping an image (texture extension)

Definition at line 38 of file rendering_programs.h.

                                  {
                 BLEND,                  //!< default blending of a single image
                 MASKED_BLEND,           //!< blending an image through a pixelwise mask
                 MASKED_8BIT_BLEND,      //!< blending an image through a 8 bit pixelwise mask
                 SHAPED_BLEND,           //!< shaping an image
                 BLEND_EXT,              //!< default blending using a texture extension
                 MASKED_BLEND_EXT,       //!< blending an image through a pixelwise mask (texture extension)
                 MASKED_8BIT_BLEND_EXT,  //!< blending an image through a 8 bit pixelwise mask (texture extension)
                 SHAPED_BLEND_EXT,       //!< shaping an image (texture extension)
             };

Constructor & Destructor Documentation

◆ RenderingPrograms()

RenderingPrograms::RenderingPrograms ( GraphicPipeline * gpu )

Definition at line 249 of file rendering_programs.cpp.

                                                         :
     backend(new Backend()), currentGlProgram(nullptr), defaultVertexShader(*gpu, VERTEX_SHADER_BLEND, Extensions::BEATMUP_DIALECT)
 {}

◆ ~RenderingPrograms()

RenderingPrograms::~RenderingPrograms ( )

Definition at line 254 of file rendering_programs.cpp.

                                       {
     delete backend;
 }

Member Function Documentation

◆ enableProgram()

void RenderingPrograms::enableProgram	(	GraphicPipeline *	gpu,
		Operation	program
	)

Select and enable a common program.

If the selected program is not yet ready, it is linked and complied.

Parameters

[in,out]	gpu	A graphic pipeline instance
[in,out]	program	The selected common program to use

Definition at line 314 of file rendering_programs.cpp.

                                                                                {
     Program& glProgram = getProgram(gpu, operation);
     currentProgram = operation;
     currentGlProgram = &glProgram;
     glProgram.enable(*gpu);
     gpu->setTextureCoordinates(Rectangle::UNIT_SQUARE);
     glProgram.setInteger("image", TextureUnits::IMAGE);
     switch (operation) {
     case Operation::MASKED_BLEND:
     case Operation::MASKED_BLEND_EXT:
         glProgram.setInteger("maskLookup", TextureUnits::MASK_LOOKUP);
     case Operation::MASKED_8BIT_BLEND:
     case Operation::MASKED_8BIT_BLEND_EXT:
         glProgram.setInteger("mask", TextureUnits::MASK);
     default: break;
     }
     maskSetUp = false;
 }

◆ getCurrentProgram()

Program & RenderingPrograms::getCurrentProgram ( )

Returns: the currently used rendering program.

Definition at line 334 of file rendering_programs.cpp.

                                               {
     if (!currentGlProgram)
         RuntimeError("No current program");
     return *currentGlProgram;
 }

◆ bindMask()

void RenderingPrograms::bindMask	(	GraphicPipeline *	gpu,
		AbstractBitmap &	mask
	)

Binds a mask to a masked rendering program.

Throws an exception when a mask is about to be bound to a non-masked rendering program.

Parameters

[in,out]	gpu	A graphic pipeline instance
[in,out]	mask	The mask bitmap

Definition at line 341 of file rendering_programs.cpp.

                                                                            {
     Program& program = getCurrentProgram();
     gpu->bind(mask, TextureUnits::MASK, TextureParam::INTERP_NEAREST);
     if (mask.getBitsPerPixel() < 8) {
         backend->bindMaskLookup(mask.getPixelFormat());
         program.setFloat("blockSize", 8.0f / mask.getBitsPerPixel() / mask.getWidth());
         program.setFloat("pixOffset", 0.5f / mask.getWidth());
     }
     maskSetUp = true;
 }

◆ blend()

void RenderingPrograms::blend ( bool onScreen )

Performs the blending operation.

Parameters

[in] onScreen If true, the rendering is performed on a screen, not into a bitmap.

Definition at line 353 of file rendering_programs.cpp.

                                            {
 #ifdef BEATMUP_DEBUG
     if (currentProgram == Operation::MASKED_BLEND || currentProgram == Operation::MASKED_BLEND_EXT)
         DebugAssertion::check(maskSetUp, "Mask was not set up in masked blending");
 #endif
  
     getCurrentProgram().setInteger(VERTICAL_FLIP_ID, onScreen ? 0 : 1);
     glDrawArrays(GL_TRIANGLE_STRIP, 0, 4);
  
 #ifdef BEATMUP_DEBUG
     GLException::check("blending");
 #endif
 }

◆ paveBackground()

void RenderingPrograms::paveBackground	(	GraphicPipeline *	gpu,
		TextureHandler &	content,
		GL::TextureHandler *	output
	)

Fills background with a repeated texture taking 1 pixel of this texture per 1 pixel of the output.

Parameters

[in,out]	gpu	A graphic pipeline instance
[in]	content	The texture
[in]	output	Target texture handler or null if onscreen rendering

Definition at line 368 of file rendering_programs.cpp.

                                                                                                               {
     // choose program
     switch (content.getTextureFormat()) {
     case TextureHandler::TextureFormat::OES_Ext:
         enableProgram(gpu, GL::RenderingPrograms::Operation::BLEND_EXT);
         break;
     default:
         enableProgram(gpu, GL::RenderingPrograms::Operation::BLEND);
         break;
     }
  
     // setting texture coords, bitmap size and updating buffer data in GPU
     gpu->setTextureCoordinates(Rectangle(0, 0,
         (float)(output ? output->getWidth()  : gpu->getDisplayResolution().getWidth() ) / content.getWidth(),
         (float)(output ? output->getHeight() : gpu->getDisplayResolution().getHeight()) / content.getHeight()
     ));
  
     currentGlProgram->setMatrix3(MODELVIEW_MATRIX_ID, AffineMapping::IDENTITY);
     currentGlProgram->setVector4("modulationColor", 1.0f, 1.0f, 1.0f, 1.0f);
     gpu->bind(content, 0, TextureParam::REPEAT);
     blend(output == nullptr);
 }

◆ getDefaultVertexShader()

const VertexShader & RenderingPrograms::getDefaultVertexShader ( const GraphicPipeline * gpu ) const

Returns: default blending vertex shader to be used in a user-defined single-image blending program.

Definition at line 392 of file rendering_programs.cpp.

                                                                                               {
     return defaultVertexShader;
 }

◆ getProgram()

Program & RenderingPrograms::getProgram	(	const GraphicPipeline *	gpu,
		Operation	program
	)

private

Definition at line 259 of file rendering_programs.cpp.

                                                                                       {
     auto& map = programs;
     auto it = map.find(operation);
     if (it != map.end())
         return it->second;
  
     // maps shader types to internally handled shaders
     std::string fragmentCode;
     Extensions ext = Extensions::BEATMUP_DIALECT;
     switch (operation) {
     case Operation::BLEND_EXT:
         ext = ext + Extensions::EXTERNAL_TEXTURE;
     case Operation::BLEND:
         fragmentCode = FRAGMENT_SHADER_BLEND;
         break;
  
     case Operation::MASKED_BLEND_EXT:
         ext = ext + Extensions::EXTERNAL_TEXTURE;
     case Operation::MASKED_BLEND:
         fragmentCode = FRAGMENT_SHADER_BLENDMASK;
         break;
  
     case Operation::MASKED_8BIT_BLEND_EXT:
         ext = ext + Extensions::EXTERNAL_TEXTURE;
     case Operation::MASKED_8BIT_BLEND:
         fragmentCode = FRAGMENT_SHADER_BLENDMASK_8BIT;
         break;
  
     case Operation::SHAPED_BLEND_EXT:
         ext = ext + Extensions::EXTERNAL_TEXTURE;
     case Operation::SHAPED_BLEND:
         fragmentCode = FRAGMENT_SHADER_BLENDSHAPE;
         break;
  
     default:
         Insanity::insanity("Invalid rendering operation");
     }
  
     // instantiate shaders
     const bool useDefaultVertexShader = operation ==  Operation::BLEND || operation ==  Operation::BLEND_EXT;
     VertexShader* vertexShader = useDefaultVertexShader ? &defaultVertexShader : new VertexShader(*gpu, VERTEX_SHADER_BLENDMASK, ext);
     FragmentShader fragmentShader(*gpu, fragmentCode, ext);
  
     // link program
     Program& glProgram = programs.emplace(
         std::piecewise_construct,
         std::forward_as_tuple(operation),
         std::forward_as_tuple(*gpu, *vertexShader, fragmentShader)
     ).first->second;
     if (!useDefaultVertexShader)
         delete vertexShader;
     return glProgram;
 }

Member Data Documentation

◆ VERTEX_COORD_ATTRIB_NAME

const char * Beatmup::GL::RenderingPrograms::VERTEX_COORD_ATTRIB_NAME = "inVertex"

static

vertex coordinate attribute name in vertex shaders

Definition at line 50 of file rendering_programs.h.

◆ TEXTURE_COORD_ATTRIB_NAME

const char * Beatmup::GL::RenderingPrograms::TEXTURE_COORD_ATTRIB_NAME = "inTexCoord"

static

texture coordinate attribute name in vertex shaders

Definition at line 51 of file rendering_programs.h.

◆ VERTICAL_FLIP_ID

const char * Beatmup::GL::RenderingPrograms::VERTICAL_FLIP_ID = "flipVertically"

static

Vertical flipping variable name in vertex shader.

Definition at line 53 of file rendering_programs.h.

◆ MODELVIEW_MATRIX_ID

const char * Beatmup::GL::RenderingPrograms::MODELVIEW_MATRIX_ID = "modelview"

static

Modelview matrix (mapping input geometry to output) shader variable name in vertex shader.

Definition at line 54 of file rendering_programs.h.

◆ TEXTURE_COORDINATES_ID

const char * Beatmup::GL::RenderingPrograms::TEXTURE_COORDINATES_ID = "texCoord"

static

Texture coordinates shader variable name in vertex shader.

Definition at line 55 of file rendering_programs.h.

◆ DECLARE_TEXTURE_COORDINATES_IN_FRAG

const char * Beatmup::GL::RenderingPrograms::DECLARE_TEXTURE_COORDINATES_IN_FRAG = "varying highp vec2 texCoord;\n"

static

Declaring texture coordinates in fragment shader.

Definition at line 57 of file rendering_programs.h.

◆ backend

Backend* Beatmup::GL::RenderingPrograms::backend

private

Definition at line 110 of file rendering_programs.h.

◆ currentGlProgram

Program* Beatmup::GL::RenderingPrograms::currentGlProgram

private

Definition at line 111 of file rendering_programs.h.

◆ currentProgram

Operation Beatmup::GL::RenderingPrograms::currentProgram

private

Definition at line 112 of file rendering_programs.h.

◆ maskSetUp

bool Beatmup::GL::RenderingPrograms::maskSetUp

private

Definition at line 113 of file rendering_programs.h.

◆ defaultVertexShader

VertexShader Beatmup::GL::RenderingPrograms::defaultVertexShader

private

Definition at line 115 of file rendering_programs.h.

◆ programs

std::map<Operation, RenderingProgram> Beatmup::GL::RenderingPrograms::programs

private

Definition at line 116 of file rendering_programs.h.

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

core/gpu/rendering_programs.h
core/gpu/rendering_programs.cpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Operation

Constructor & Destructor Documentation

◆ RenderingPrograms()

◆ ~RenderingPrograms()

Member Function Documentation

◆ enableProgram()

◆ getCurrentProgram()

◆ bindMask()

◆ blend()

◆ paveBackground()

◆ getDefaultVertexShader()

◆ getProgram()

Member Data Documentation

◆ VERTEX_COORD_ATTRIB_NAME

◆ TEXTURE_COORD_ATTRIB_NAME

◆ VERTICAL_FLIP_ID

◆ MODELVIEW_MATRIX_ID

◆ TEXTURE_COORDINATES_ID

◆ DECLARE_TEXTURE_COORDINATES_IN_FRAG

◆ backend

◆ currentGlProgram

◆ currentProgram

◆ maskSetUp

◆ defaultVertexShader

◆ programs