Internal low-level GPU control API. More...

#include <pipeline.h>

Classes
class	Impl

Public Types
enum class	Mode { RENDERING , INFERENCE }
	Graphic pipeline working mode setting some common OpenGL switches. More...

enum class	Limit { TEXTURE_IMAGE_UNITS , FRAGMENT_UNIFORM_VECTORS , LOCAL_GROUPS_X , LOCAL_GROUPS_Y , LOCAL_GROUPS_Z , LOCAL_GROUPS_TOTAL , SHARED_MEM }
	GPU characteristics. More...

Public Member Functions
	GraphicPipeline ()

	~GraphicPipeline ()

void	switchDisplay (void *data)

void	swapBuffers ()

void	bindOutput (AbstractBitmap &bitmap)
	Binds a bitmap to the pipeline output. More...

void	bindOutput (AbstractBitmap &bitmap, const IntRectangle &viewport)
	Binds a bitmap to the pipeline output. More...

void	bindOutput (GL::TextureHandler &texture)

void	bindOutput (GL::handle_t texture)

void	unbindOutput ()
	Unbinds a bitmap from output and switches to screen. More...

const ImageResolution &	getDisplayResolution () const

void	bind (GL::TextureHandler &texture, size_t texUnit, const TextureParam param)

void	bind (GL::TextureHandler &texture, size_t imageUnit, bool read, bool write)

void	pullPixels (AbstractBitmap &bitmap)
	Transfers bitmap pixels from GPU to CPU. More...

void	pushPixels (AbstractBitmap &bitmap)
	Transfers bitmap pixels from CPU to GPU. More...

void	flush ()
	Waits until all operations submitted to GPU are finished. More...

int	getLimit (Limit limit) const

void	switchMode (Mode mode)
	Switches GPU mode. More...

GL::RenderingPrograms &	getRenderingPrograms ()

const GL::VertexShader &	getDefaultVertexShader () const

const char *	getGpuVendorString () const

const char *	getGpuRendererString () const

int	getGlslVersion () const
	Returns GLSL language version supported by the GPU context being used. More...

bool	isGlEsCompliant () const
	Returns `true` if the GPU context is OpenGL ES-compliant. More...

void	setTextureCoordinates (const Rectangle &coords)
	Specifies texture coordinates for the next rendering pass. More...

void	setTextureCoordinates (const Point &leftTop, const Point &rightTop, const Point &leftBottom, const Point &rightBottom)
	Specifies texture coordinates for the next rendering pass. More...

void	setTextureCoordinates (const Rectangle &area, const IntPoint &size, const IntPoint &sampling)
	Specifies texture coordinates for the next rendering pass. More...

Static Public Member Functions
static Rectangle	getTextureCoordinates (const Rectangle &area, const IntPoint &size, const IntPoint &sampling)
	Computes floating-point texture coordinates for pixel-accurate sampling: a texture gets sampled exactly at specified pixel locations. More...

Static Public Attributes
static const int	ATTRIB_VERTEX_COORD = 0
	vertex coordinate attribute index in the VBO More...

static const int	ATTRIB_TEXTURE_COORD = 1
	texture coordinate attribute index in the VBO More...

Private Member Functions
	GraphicPipeline (const GraphicPipeline &)=delete

Private Attributes
Impl *	impl

GL::RenderingPrograms *	renderingPrograms

Friends
class	GL::TextureHandler

Detailed Description

Internal low-level GPU control API.

Hides OpenGL stuff from intsances of AbstractTask operating with images. A GraphicPipeline instance is likely a singleton accessible from a single thread.

Definition at line 33 of file pipeline.h.

Member Enumeration Documentation

◆ Mode

enum Beatmup::GraphicPipeline::Mode

strong

Graphic pipeline working mode setting some common OpenGL switches.

Enumerator
RENDERING	Textures are images to be blended together to produce another image.
INFERENCE	Textures are feature maps computed in fragment shaders.

Definition at line 47 of file pipeline.h.

                         {
             RENDERING,    //!< Textures are images to be blended together to produce another image
             INFERENCE     //!< Textures are feature maps computed in fragment shaders
         };

◆ Limit

enum Beatmup::GraphicPipeline::Limit

strong

GPU characteristics.

Enumerator
TEXTURE_IMAGE_UNITS	maximum number of texture units per fragment shader
FRAGMENT_UNIFORM_VECTORS	maximum number of 4-dimensional uniform vectors per fragment shader
LOCAL_GROUPS_X
LOCAL_GROUPS_Y
LOCAL_GROUPS_Z
LOCAL_GROUPS_TOTAL
SHARED_MEM

Definition at line 55 of file pipeline.h.

                          {
             TEXTURE_IMAGE_UNITS,            //!< maximum number of texture units per fragment shader
             FRAGMENT_UNIFORM_VECTORS,       //!< maximum number of 4-dimensional uniform vectors per fragment shader
             LOCAL_GROUPS_X,
             LOCAL_GROUPS_Y,
             LOCAL_GROUPS_Z,
             LOCAL_GROUPS_TOTAL,
             SHARED_MEM,
         };

Constructor & Destructor Documentation

◆ GraphicPipeline() [1/2]

Beatmup::GraphicPipeline::GraphicPipeline ( const GraphicPipeline & )

privatedelete

◆ GraphicPipeline() [2/2]

GraphicPipeline::GraphicPipeline ( )

Definition at line 858 of file pipeline.cpp.

                                  {
     BEATMUP_DEBUG_I("GRAPHIC PIPELINE INITIALIZATION");
     impl = new Impl(*this);
     renderingPrograms = new GL::RenderingPrograms(this);
 }

◆ ~GraphicPipeline()

GraphicPipeline::~GraphicPipeline ( )

Definition at line 865 of file pipeline.cpp.

                                   {
     delete renderingPrograms;
     delete impl;
 }

Member Function Documentation

◆ switchDisplay()

void GraphicPipeline::switchDisplay ( void * data )

Definition at line 871 of file pipeline.cpp.

                                               {
     impl->switchDisplay(data);
 }

◆ swapBuffers()

void GraphicPipeline::swapBuffers ( )

Definition at line 876 of file pipeline.cpp.

                                   {
     impl->swapBuffers();
 }

◆ bindOutput() [1/4]

void GraphicPipeline::bindOutput ( AbstractBitmap & bitmap )

Binds a bitmap to the pipeline output.

Parameters

[in] bitmap A bitmap to be filled with pixels on the next render pass.

Definition at line 891 of file pipeline.cpp.

                                                        {
     impl->bindOutput(bitmap, bitmap.getSize().halfOpenedRectangle());
 }

◆ bindOutput() [2/4]

void GraphicPipeline::bindOutput	(	AbstractBitmap &	bitmap,
		const IntRectangle &	viewport
	)

Binds a bitmap to the pipeline output.

Parameters

[in]	bitmap	A bitmap to be filled with pixels on the next render pass.
[in]	viewport	Output viewport in pixels: only this area of the bitmap will be affected

Definition at line 896 of file pipeline.cpp.

                                                                                      {
     impl->bindOutput(bitmap, viewport);
 }

◆ bindOutput() [3/4]

void GraphicPipeline::bindOutput ( GL::TextureHandler & texture )

Definition at line 901 of file pipeline.cpp.

                                                                  {
     impl->bindOutput(textureHandler);
 }

◆ bindOutput() [4/4]

void GraphicPipeline::bindOutput ( GL::handle_t texture )

Definition at line 906 of file pipeline.cpp.

                                                    {
     impl->bindOutput(texture);
 }

◆ unbindOutput()

void GraphicPipeline::unbindOutput ( )

Unbinds a bitmap from output and switches to screen.

Definition at line 911 of file pipeline.cpp.

                                    {
     impl->unbindOutput();
 }

◆ getDisplayResolution()

const ImageResolution & GraphicPipeline::getDisplayResolution ( ) const

Definition at line 916 of file pipeline.cpp.

                                                                    {
     return impl->getDisplayResolution();
 }

◆ bind() [1/2]

void GraphicPipeline::bind	(	GL::TextureHandler &	texture,
		size_t	texUnit,
		const TextureParam	param
	)

Definition at line 881 of file pipeline.cpp.

                                                                                               {
     impl->bind(texture, texUnit, param);
 }

◆ bind() [2/2]

void GraphicPipeline::bind	(	GL::TextureHandler &	texture,
		size_t	imageUnit,
		bool	read,
		bool	write
	)

Definition at line 886 of file pipeline.cpp.

                                                                                              {
     impl->bindImage(texture, imageUnit, read, write);
 }

◆ pullPixels()

void GraphicPipeline::pullPixels ( AbstractBitmap & bitmap )

Transfers bitmap pixels from GPU to CPU.

The bitmap is assumed locked.

Definition at line 921 of file pipeline.cpp.

                                                        {
     impl->pullPixels(bitmap);
 }

◆ pushPixels()

void GraphicPipeline::pushPixels ( AbstractBitmap & bitmap )

Transfers bitmap pixels from CPU to GPU.

The bitmap is assumed locked.

Definition at line 926 of file pipeline.cpp.

                                                        {
     impl->pushPixels(bitmap);
 }

◆ flush()

void GraphicPipeline::flush ( )

Waits until all operations submitted to GPU are finished.

Definition at line 931 of file pipeline.cpp.

                             {
     glFinish();
 }

◆ getLimit()

int GraphicPipeline::getLimit ( Limit limit ) const

Definition at line 936 of file pipeline.cpp.

                                                {
     return impl->getLimit(limit);
 }

◆ switchMode()

void GraphicPipeline::switchMode ( Mode mode )

Switches GPU mode.

Definition at line 941 of file pipeline.cpp.

                                           {
     impl->switchMode(mode);
 }

◆ getRenderingPrograms()

GL::RenderingPrograms& Beatmup::GraphicPipeline::getRenderingPrograms ( )

inline

Definition at line 125 of file pipeline.h.

125 { return *renderingPrograms; }

◆ getDefaultVertexShader()

const GL::VertexShader& Beatmup::GraphicPipeline::getDefaultVertexShader ( ) const

inline

Definition at line 126 of file pipeline.h.

126 { return renderingPrograms->getDefaultVertexShader(this); }

Beatmup::GL::RenderingPrograms::getDefaultVertexShader

const VertexShader & getDefaultVertexShader(const GraphicPipeline *gpu) const

Definition: rendering_programs.cpp:392

◆ getGpuVendorString()

const char * GraphicPipeline::getGpuVendorString ( ) const

Definition at line 946 of file pipeline.cpp.

                                                       {
     return (const char*)glGetString(GL_VENDOR);
 }

◆ getGpuRendererString()

const char * GraphicPipeline::getGpuRendererString ( ) const

Definition at line 951 of file pipeline.cpp.

                                                         {
     return (const char*)glGetString(GL_RENDERER);
 }

◆ getGlslVersion()

int GraphicPipeline::getGlslVersion ( ) const

Returns GLSL language version supported by the GPU context being used.

Definition at line 956 of file pipeline.cpp.

                                           {
     return impl->getGlslVersion();
 }

◆ isGlEsCompliant()

bool GraphicPipeline::isGlEsCompliant ( ) const

Returns true if the GPU context is OpenGL ES-compliant.

Definition at line 961 of file pipeline.cpp.

                                             {
     return impl->isGlEsCompliant();
 }

◆ setTextureCoordinates() [1/3]

void GraphicPipeline::setTextureCoordinates ( const Rectangle & coords )

Specifies texture coordinates for the next rendering pass.

Parameters

[in] coords Normalized texture coordinates

Definition at line 966 of file pipeline.cpp.

                                                                           {
     impl->setTextureCoordinates(coords);
 }

◆ setTextureCoordinates() [2/3]

void GraphicPipeline::setTextureCoordinates	(	const Point &	leftTop,
		const Point &	rightTop,
		const Point &	leftBottom,
		const Point &	rightBottom
	)

Specifies texture coordinates for the next rendering pass.

Parameters

[in]	leftTop	Top left output image corner texture coordinates
[in]	rightTop	Top right output image corner texture coordinates
[in]	leftBottom	Bottom left output image corner texture coordinates
[in]	rightBottom	Bottom right output image corner texture coordinates

Definition at line 971 of file pipeline.cpp.

                                                                                                                                           {
     impl->setTextureCoordinates(leftTop, rightTop, leftBottom, rightBottom);
 }

◆ setTextureCoordinates() [3/3]

void Beatmup::GraphicPipeline::setTextureCoordinates	(	const Rectangle &	area,
		const IntPoint &	size,
		const IntPoint &	sampling
	)

inline

Specifies texture coordinates for the next rendering pass.

Parameters

[in]	area	A closed rectangle in pixels of a texture to sample; all its corners are valid sampling locations.
[in]	size	Size in pixels of the input texture
[in]	sampling	Number of resulting samples covering the area

Definition at line 163 of file pipeline.h.

                                                                                                                  {
             setTextureCoordinates(getTextureCoordinates(area, size, sampling));
         }

◆ getTextureCoordinates()

Beatmup::Rectangle GraphicPipeline::getTextureCoordinates	(	const Rectangle &	area,
		const IntPoint &	size,
		const IntPoint &	sampling
	)

static

Computes floating-point texture coordinates for pixel-accurate sampling: a texture gets sampled exactly at specified pixel locations.

Parameters

[in]	area	A closed rectangle in pixels of a texture to sample; all its corners are valid sampling locations.
[in]	size	Size in pixels of the input texture
[in]	sampling	Number of resulting samples covering the area

Definition at line 976 of file pipeline.cpp.

                                                                                                                                     {
     /* Common OpenGL texture sampling model, likely:
         . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .    <- texture pixels (`size` in number).
            |  *     *     *     *     *     *     *     *     *  |               <- sampling point locations (`area`).
            |                                                     |                  There are exactly `sampling` points.
            |_____________________________________________________|               <- texture coordinates to give to
                                                                                     the shaders to get the texture
                                                                                     sampled in the starred locations.
     */
  
     // compute offsets of texture coordinates with respect to the sampling positions
     const float
         dx = sampling.x > 1 ?  0.5f * area.width()  / (sampling.x - 1)  : 0.0f,
         dy = sampling.y > 1 ?  0.5f * area.height() / (sampling.y - 1)  : 0.0f;
  
     // compute texture coordinates: x + 0.5 is the target sampling position, dx is the offset
     return Beatmup::Rectangle(
         (area.a.x + 0.5f - dx) / size.x,
         (area.a.y + 0.5f - dy) / size.y,
         (area.b.x + 0.5f + dx) / size.x,
         (area.b.y + 0.5f + dy) / size.y
     );
 }

Friends And Related Function Documentation

◆ GL::TextureHandler

friend class GL::TextureHandler

friend

Definition at line 34 of file pipeline.h.

Member Data Documentation

◆ impl

Impl* Beatmup::GraphicPipeline::impl

private

Definition at line 37 of file pipeline.h.

◆ renderingPrograms

GL::RenderingPrograms* Beatmup::GraphicPipeline::renderingPrograms

private

Definition at line 39 of file pipeline.h.

◆ ATTRIB_VERTEX_COORD

const int Beatmup::GraphicPipeline::ATTRIB_VERTEX_COORD = 0

static

vertex coordinate attribute index in the VBO

Definition at line 66 of file pipeline.h.

◆ ATTRIB_TEXTURE_COORD

const int Beatmup::GraphicPipeline::ATTRIB_TEXTURE_COORD = 1

static

texture coordinate attribute index in the VBO

Definition at line 67 of file pipeline.h.

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

core/gpu/pipeline.h
core/gpu/pipeline.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Mode

◆ Limit

Constructor & Destructor Documentation

◆ GraphicPipeline() [1/2]

◆ GraphicPipeline() [2/2]

◆ ~GraphicPipeline()

Member Function Documentation

◆ switchDisplay()

◆ swapBuffers()

◆ bindOutput() [1/4]

◆ bindOutput() [2/4]

◆ bindOutput() [3/4]

◆ bindOutput() [4/4]

◆ unbindOutput()

◆ getDisplayResolution()

◆ bind() [1/2]

◆ bind() [2/2]

◆ pullPixels()

◆ pushPixels()

◆ flush()

◆ getLimit()

◆ switchMode()

◆ getRenderingPrograms()

◆ getDefaultVertexShader()

◆ getGpuVendorString()

◆ getGpuRendererString()

◆ getGlslVersion()

◆ isGlEsCompliant()

◆ setTextureCoordinates() [1/3]

◆ setTextureCoordinates() [2/3]

◆ setTextureCoordinates() [3/3]

◆ getTextureCoordinates()

Friends And Related Function Documentation

◆ GL::TextureHandler

Member Data Documentation

◆ impl

◆ renderingPrograms

◆ ATTRIB_VERTEX_COORD

◆ ATTRIB_TEXTURE_COORD