A task applying an image shader to a bitmap. More...

#include <shader_applicator.h>

Inheritance diagram for Beatmup::ShaderApplicator:

Public Member Functions
	ShaderApplicator ()

void	addSampler (AbstractBitmap *bitmap, const std::string uniformName=ImageShader::INPUT_IMAGE_ID)
	Connects a bitmap to a shader uniform variable. More...

bool	removeSampler (const std::string uniformName)
	Removes a sampler with a uniform variable name. More...

void	clearSamplers ()
	Clears all connections of bitmaps to samplers. More...

void	setOutputBitmap (AbstractBitmap *bitmap)

void	setShader (ImageShader *shader)

AbstractBitmap *	getOutputBitmap () const

ImageShader *	getShader () const

const size_t	getSamplersCount () const

Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Private Member Functions
bool	processOnGPU (GraphicPipeline &gpu, TaskThread &thread)
	Executes the task on GPU. More...

void	beforeProcessing (ThreadIndex threadCount, ProcessingTarget target, GraphicPipeline *gpu)
	Instruction called before the task is executed. More...

void	afterProcessing (ThreadIndex threadCount, GraphicPipeline *gpu, bool aborted)
	Instruction called after the task is executed. More...

Private Member Functions inherited from Beatmup::BitmapContentLock
	BitmapContentLock ()

	~BitmapContentLock ()

void	readLock (GraphicPipeline gpu, AbstractBitmap bitmap, ProcessingTarget target)
	Locks content of a bitmap for reading using a specific processing target device. More...

void	writeLock (GraphicPipeline gpu, AbstractBitmap bitmap, ProcessingTarget target)
	Locks content of a bitmap for writing using a specific processing target device. More...

void	unlock (AbstractBitmap *bitmap)
	Drops a lock to the bitmap. More...

void	unlockAll ()
	Unlocks all the locked bitmaps unconditionally. More...

template<const ProcessingTarget target>
void	lock (GraphicPipeline gpu, AbstractBitmap input, AbstractBitmap *output)

void	lock (GraphicPipeline gpu, ProcessingTarget target, AbstractBitmap input, AbstractBitmap *output)

template<const ProcessingTarget target>
void	lock (GraphicPipeline gpu, std::initializer_list< AbstractBitmap > read, std::initializer_list< AbstractBitmap * > write)

template<typename ... Args>
void	unlock (AbstractBitmap *first, Args ... others)

Private Attributes
std::map< std::string, AbstractBitmap * >	samplers

ImageShader *	shader

AbstractBitmap *	mainInput

AbstractBitmap *	output

AffineMapping	mapping

Additional Inherited Members
Public Types inherited from Beatmup::AbstractTask
enum class	TaskDeviceRequirement { CPU_ONLY , GPU_OR_CPU , GPU_ONLY }
	Specifies which device (CPU and/or GPU) is used to run the task. More...

Static Public Member Functions inherited from Beatmup::AbstractTask
static ThreadIndex	validThreadCount (int number)
	Valid thread count from a given integer value. More...

Detailed Description

A task applying an image shader to a bitmap.

Definition at line 31 of file shader_applicator.h.

Constructor & Destructor Documentation

◆ ShaderApplicator()

ShaderApplicator::ShaderApplicator ( )

Definition at line 77 of file shader_applicator.cpp.

                                   :
     shader(nullptr), mainInput(nullptr), output(nullptr)
 {}

Member Function Documentation

◆ processOnGPU()

bool ShaderApplicator::processOnGPU	(	GraphicPipeline &	gpu,
		TaskThread &	thread
	)

privatevirtual

Executes the task on GPU.

Parameters

gpu	graphic pipeline instance
thread	associated task execution context

Returns: true if the execution is finished correctly, false otherwise

Reimplemented from Beatmup::AbstractTask.

Definition at line 25 of file shader_applicator.cpp.

                                                                             {
     // distribute texture units over samplers
     {
         int unit = mainInput ? 1 : 0;
         for (auto input : samplers)
             if (input.first != ImageShader::INPUT_IMAGE_ID) {
                 RuntimeError::check(input.second->getTextureFormat() != GL::TextureHandler::TextureFormat::OES_Ext,
                     "OES_EXT samplers are only supported when bound to '" + ImageShader::INPUT_IMAGE_ID + "' sampler variable of type " + ImageShader::INPUT_IMAGE_DECL_TYPE);
                 shader->setInteger(input.first, unit);
                 unit++;
             }
     }
  
     // prepare shader
     shader->prepare(gpu, mainInput, output);
  
     // bind textures
     {
         size_t unit = mainInput ? 1 : 0;
         for (auto input : samplers)
             if (input.first != ImageShader::INPUT_IMAGE_ID) {
                 gpu.bind(*input.second, unit, TextureParam::INTERP_LINEAR);
                 unit++;
             }
     }
  
     // process
     shader->process(gpu);
     return true;
 }

◆ beforeProcessing()

void ShaderApplicator::beforeProcessing	(	ThreadIndex	threadCount,
		ProcessingTarget	target,
		GraphicPipeline *	gpu
	)

privatevirtual

Instruction called before the task is executed.

Parameters

threadCount	Number of threads used to perform the task
target	Device used to perform the task
gpu	A graphic pipeline instance; may be null.

Reimplemented from Beatmup::AbstractTask.

Definition at line 57 of file shader_applicator.cpp.

                                                                                                               {
     NullTaskInput::check(output, "output bitmap");
     NullTaskInput::check(shader, "image shader");
     if (mainInput)
         readLock(gpu, mainInput, ProcessingTarget::GPU);
     for (auto _ : samplers)
         readLock(gpu, _.second, ProcessingTarget::GPU);
     writeLock(gpu, output, ProcessingTarget::GPU);
 }

◆ afterProcessing()

void ShaderApplicator::afterProcessing	(	ThreadIndex	threadCount,
		GraphicPipeline *	gpu,
		bool	aborted
	)

privatevirtual

Instruction called after the task is executed.

Parameters

threadCount	Number of threads used to perform the task
gpu	GPU to be used to execute the task; may be null.
aborted	`true` if the task was aborted

Reimplemented from Beatmup::AbstractTask.

Definition at line 68 of file shader_applicator.cpp.

                                                                                                   {
     if (mainInput)
         unlock(mainInput);
     for (auto _ : samplers)
         unlock(_.second);
     unlock(output);
 }

◆ addSampler()

void ShaderApplicator::addSampler	(	AbstractBitmap *	bitmap,
		const std::string	uniformName = `ImageShader::INPUT_IMAGE_ID`
	)

Connects a bitmap to a shader uniform variable.

The bitmap connected to ImageShader::INPUT_IMAGE_ID is used to resolve the sampler type (ImageShader::INPUT_IMAGE_DECL_TYPE).

Definition at line 82 of file shader_applicator.cpp.

                                                                                      {
     if (uniformName == ImageShader::INPUT_IMAGE_ID)
         mainInput = bitmap;
     else
         samplers[uniformName] = bitmap;
 }

◆ removeSampler()

bool ShaderApplicator::removeSampler ( const std::string uniformName )

Removes a sampler with a uniform variable name.

Parameters

[in] uniformName The uniform variable

Returns: true if a sampler associated to the given variable existed and was removed, false otherwise.

Definition at line 90 of file shader_applicator.cpp.

                                                                 {
     if (uniformName == ImageShader::INPUT_IMAGE_ID) {
         if (mainInput) {
             mainInput = nullptr;
             return true;
         }
         else
             return false;
     }
  
     auto sampler = samplers.find(uniformName);
     if (sampler == samplers.end()) {
         return false;
     }
     else {
         samplers.erase(sampler);
         return true;
     }
 }

◆ clearSamplers()

void ShaderApplicator::clearSamplers ( )

Clears all connections of bitmaps to samplers.

Definition at line 111 of file shader_applicator.cpp.

                                      {
     mainInput = nullptr;
     samplers.clear();
 }

◆ setOutputBitmap()

void ShaderApplicator::setOutputBitmap ( AbstractBitmap * bitmap )

Definition at line 117 of file shader_applicator.cpp.

                                                              {
     this->output = bitmap;
 }

◆ setShader()

void ShaderApplicator::setShader ( ImageShader * shader )

Definition at line 122 of file shader_applicator.cpp.

                                                     {
     this->shader = shader;
 }

◆ getOutputBitmap()

AbstractBitmap* Beatmup::ShaderApplicator::getOutputBitmap ( ) const

inline

Definition at line 66 of file shader_applicator.h.

66 { return output; }

◆ getShader()

ImageShader* Beatmup::ShaderApplicator::getShader ( ) const

inline

Definition at line 67 of file shader_applicator.h.

67 { return shader; }

◆ getSamplersCount()

const size_t Beatmup::ShaderApplicator::getSamplersCount ( ) const

inline

Definition at line 68 of file shader_applicator.h.

68 { return samplers.size(); }

Member Data Documentation

◆ samplers

std::map<std::string, AbstractBitmap*> Beatmup::ShaderApplicator::samplers

private

Definition at line 33 of file shader_applicator.h.

◆ shader

ImageShader* Beatmup::ShaderApplicator::shader

private

Definition at line 34 of file shader_applicator.h.

◆ mainInput

AbstractBitmap* Beatmup::ShaderApplicator::mainInput

private

Definition at line 35 of file shader_applicator.h.

◆ output

AbstractBitmap * Beatmup::ShaderApplicator::output

private

Definition at line 35 of file shader_applicator.h.

◆ mapping

AffineMapping Beatmup::ShaderApplicator::mapping

private

Definition at line 36 of file shader_applicator.h.

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

core/shading/shader_applicator.h
core/shading/shader_applicator.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShaderApplicator()

Member Function Documentation

◆ processOnGPU()

◆ beforeProcessing()

◆ afterProcessing()

◆ addSampler()

◆ removeSampler()

◆ clearSamplers()

◆ setOutputBitmap()

◆ setShader()

◆ getOutputBitmap()

◆ getShader()

◆ getSamplersCount()

Member Data Documentation

◆ samplers

◆ shader

◆ mainInput

◆ output

◆ mapping