Beatmup::GL::ProgramBank Class Reference

Stores linked GLSL programs and their associated fragment shader codes. More...

#include <program_bank.h>

Inheritance diagram for Beatmup::GL::ProgramBank:

Classes
struct	ProgramHolder

Public Member Functions
	ProgramBank (Context &context)
	~ProgramBank ()
GL::RenderingProgram *	operator() (GraphicPipeline &gpu, const std::string &code, bool enableExternalTextures=false)
	Provides a program given a fragment shader source code. More...
void	release (GraphicPipeline &gpu, GL::RenderingProgram *program)
	Marks a program as unused any more. More...
Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Protected Attributes
Context &	context

Private Member Functions
bool	releaseProgram (GL::RenderingProgram *program, std::map< std::string, ProgramHolder > &cache)

Private Attributes
std::map< std::string, ProgramHolder >	programs
	map of source code to programs without external texture extension More...
std::map< std::string, ProgramHolder >	programsWithExtTex
	map of source code to programs with external texture extension More...

Detailed Description

Stores linked GLSL programs and their associated fragment shader codes.

Definition at line 31 of file program_bank.h.

Constructor & Destructor Documentation

ProgramBank()

Beatmup::GL::ProgramBank::ProgramBank ( Context &  context )

inline

Definition at line 46 of file program_bank.h.

: context(context) {}

~ProgramBank()

GL::ProgramBank::~ProgramBank

(

)

Definition at line 26 of file program_bank.cpp.

                            {
    for (auto& it : this->programs)
        context.getGpuRecycleBin()->put(it.second.program);
}

Member Function Documentation

releaseProgram()

bool GL::ProgramBank::releaseProgram ( GL::RenderingProgram *  program, std::map< std::string, ProgramHolder > &  cache  )

private

Definition at line 52 of file program_bank.cpp.

                                                                                                       {
    for (auto it = cache.begin(); it != cache.end(); ++it) {
        auto& holder = it->second;
        if (holder.program == program) {
            holder.userCount--;
            if (holder.userCount == 0) {
                delete program;
                cache.erase(it);
            }
            return true;
        }
    }
    return false;
}

operator()()

GL::RenderingProgram * GL::ProgramBank::operator()	(	GraphicPipeline &	gpu,
		const std::string &	code,
		bool	enableExternalTextures = false
	)

Provides a program given a fragment shader source code.

Creates a new program or returns an available one increasing its user count (do not call this too often).

Parameters

[in]	gpu	A graphic pipeline instance
[in]	code	The fragment shader code of the program
[in]	enableExternalTextures	If true, external texture extension is enabled in the program, for example, to access camera image in Android

Returns

Linked program.

Definition at line 32 of file program_bank.cpp.

                                                                                                                      {
    auto& cache = enableExternalTextures ? programsWithExtTex : programs;
 
    auto search = cache.find(code);
    if (search != cache.end()) {
        auto& holder = search->second;
        holder.userCount++;
        holder.program->enable(gpu);
        return holder.program;
    }
 
    // not found; create
    GL::Extensions ext = enableExternalTextures ? GL::Extensions::EXTERNAL_TEXTURE : GL::Extensions::NONE;
    GL::FragmentShader fragmentShader(gpu, code, Extensions::BEATMUP_DIALECT + ext);
    GL::RenderingProgram* program = new GL::RenderingProgram(gpu, fragmentShader);
    cache.emplace(std::make_pair(code, ProgramHolder{ program, 1 }));
    return program;
}

release()

void GL::ProgramBank::release	(	GraphicPipeline &	gpu,
		GL::RenderingProgram *	program
	)

Marks a program as unused any more.

If the program has no other users, its is destroyed.

Parameters

[in]	gpu	A graphic pipeline instance
[in]	program	The program

Definition at line 68 of file program_bank.cpp.

                                                                             {
    if (!releaseProgram(program, programs) && !releaseProgram(program, programsWithExtTex))
        throw RuntimeError("No program found in a program bank");
}

Member Data Documentation

programs

std::map<std::string, ProgramHolder> Beatmup::GL::ProgramBank::programs

private

map of source code to programs without external texture extension

Definition at line 38 of file program_bank.h.

programsWithExtTex

std::map<std::string, ProgramHolder> Beatmup::GL::ProgramBank::programsWithExtTex

private

map of source code to programs with external texture extension

Definition at line 39 of file program_bank.h.

context

Context& Beatmup::GL::ProgramBank::context

protected

Definition at line 44 of file program_bank.h.

---

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

• core/gpu/program_bank.h
• core/gpu/program_bank.cpp