Glip::CorePipeline::AbstractFilterLayout Class Reference

Filter layout (Read Only). More...

#include <Filter.hpp>

Inheritance diagram for Glip::CorePipeline::AbstractFilterLayout:

Public Member Functions
	AbstractFilterLayout (const AbstractFilterLayout &)
	AbstractFilterLayout constructor. More...
const ShaderSource *	getShaderSource (GLenum shaderType) const
	Access the shader source of a particular type of shader. More...
GeometryModel &	getGeometryModel (void) const
	Get the GeometryModel used by the filter. More...
bool	isStandardGeometryModel (void) const
int	getNumUniformVars (void) const
bool	isClearingEnabled (void) const
void	enableClearing (void)
	Enables clearing operation (the destination buffer is cleared before each operation).
void	disableClearing (void)
	Disables clearing operation.
bool	isBlendingEnabled (void) const
const GLenum &	getSFactor (void) const
const GLenum &	getDFactor (void) const
const GLenum &	getBlendingEquation (void) const
void	enableBlending (const GLenum &_sFactor=GL_ONE, const GLenum &_dFactor=GL_ONE, const GLenum &_blendingEquation=GL_FUNC_ADD)
	Enables blending operation (the alpha channel is used). More...
void	disableBlending (void)
	Disables blending operation.
bool	isDepthTestingEnabled (void) const
const GLenum &	getDepthTestingFunction (void) const
void	enableDepthTesting (const GLenum &_depthTestingFunction=GL_LESS)
	Enable depth testing during filter processing. More...
void	disableDepthTesting (void)
	Disable depth testing operation.
Public Member Functions inherited from Glip::CorePipeline::AbstractComponentLayout
	AbstractComponentLayout (const AbstractComponentLayout &)
	AbstractComponentLayout constructor. More...
void	checkInputPort (int i) const
	Check the validity of an input port. Raise an exception if any errors occur. More...
void	checkOutputPort (int i) const
	Check the validity of an output port. Raise an exception if any errors occur. More...
virtual std::string	getFullName (void) const
	Returns the full name of this component (might be overloaded). More...
const std::string &	getLayoutName (void) const
	Returns the layout name of this component. More...
int	getNumInputPort (void) const
	Get the number of input ports. More...
const std::string &	getInputPortName (int i) const
	Return the name of an input port. Raise an exception if any errors occur. More...
int	getInputPortID (const std::string &name) const
	Get the index of an input port knowing its name. Raise an exception if any errors occur. More...
bool	doesInputPortExist (const std::string &name) const
	Check if an input port exists, knowing its name. More...
int	getNumOutputPort (void) const
	Get the number of output ports. More...
const std::string &	getOutputPortName (int i) const
	Return the name of an output port. Raise an exception if any errors occur. More...
int	getOutputPortID (const std::string &name) const
	Get the index of an output port knowing its name. Raise an exception if any errors occur. More...
bool	doesOutputPortExist (const std::string &name) const
	Check if an output port exists, knowing its name. More...
Public Member Functions inherited from Glip::CoreGL::HdlAbstractTextureFormat
int	getWidth (void) const
int	getHeight (void) const
int	getNumPixels (void) const
int	getNumChannels (void) const
int	getNumElements (void) const
int	getAlignment (void) const
int	getPixelSize (void) const
virtual size_t	getRowSize (void) const
virtual size_t	getSize (void) const
int	getChannelDepth (void) const
GLenum	getGLMode (void) const
GLenum	getGLDepth (void) const
GLenum	getMinFilter (void) const
GLenum	getMagFilter (void) const
int	getBaseLevel (void) const
int	getMaxLevel (void) const
GLenum	getSWrapping (void) const
GLenum	getTWrapping (void) const
bool	isCompressed (void) const
bool	isFloatingPoint (void) const
const HdlTextureFormatDescriptor &	getFormatDescriptor (void) const
bool	operator== (const HdlAbstractTextureFormat &) const
bool	operator!= (const HdlAbstractTextureFormat &) const
bool	isCompatibleWith (const HdlAbstractTextureFormat &) const
	Check if the two formats share the same memory characteristics (sizes, number of channels, byte per pixel, internal GL mode, same mipmap levels). More...
HdlAbstractTextureFormat	getCompressedFormat (void) const
	Get the equivalent, but compressed, format. More...
HdlAbstractTextureFormat	getUncompressedFormat (void) const
	Get the equivalent, but uncompressed, format. More...
bool	isCorrespondingCompressedFormat (const HdlAbstractTextureFormat &) const
	Check if this and f share the same memory parameters except that the mode for f is the corresponding compressed mode of this. More...
virtual unsigned int	getSetting (GLenum param) const
	Obtain a setting value based on its GL name. More...

Protected Member Functions
	AbstractFilterLayout (const std::string &type, const HdlAbstractTextureFormat &f)
	AbstractFilterLayout constructor. More...
Protected Member Functions inherited from Glip::CorePipeline::AbstractComponentLayout
	AbstractComponentLayout (const std::string &_layoutName)
	AbstractComponentLayout constructor. More...
	AbstractComponentLayout (const std::string &_layoutName, const std::vector< std::string > &_inputPorts, const std::vector< std::string > &_outputPorts)
	AbstractComponentLayout constructor. More...
Protected Member Functions inherited from Glip::CoreGL::HdlAbstractTextureFormat
	HdlAbstractTextureFormat (int _width, int _height, GLenum _mode, GLenum _depth, GLenum _minFilter=GL_NEAREST, GLenum _magFilter=GL_NEAREST, GLenum _wraps=GL_CLAMP, GLenum _wrapt=GL_CLAMP, int _baseLevel=0, int _maxLevel=0)
	HdlAbstractTextureFormat Construtor. More...
	HdlAbstractTextureFormat (const HdlAbstractTextureFormat &copy)
	HdlAbstractTextureFormat Construtor. More...
void	setAlignment (int _alignment)
	Set the alignment for this format. More...

Additional Inherited Members
Static Public Member Functions inherited from Glip::CoreGL::HdlAbstractTextureFormat
static int	getMaxSize (void)
	Returns the maximum size for a texture. More...

Detailed Description

Filter layout (Read Only).

Constructor & Destructor Documentation

AbstractFilterLayout::AbstractFilterLayout ( const std::string &  type, const HdlAbstractTextureFormat &  f  )

protected

AbstractFilterLayout constructor.

Parameters

type	The typename of the filter layout.
f	The texture format associated to all outputs of the filter.

AbstractFilterLayout::AbstractFilterLayout

(

const AbstractFilterLayout &

c

)

AbstractFilterLayout constructor.

Parameters

c

Copy.

Member Function Documentation

void AbstractFilterLayout::enableBlending	(	const GLenum &	_sFactor = GL_ONE,
		const GLenum &	_dFactor = GL_ONE,
		const GLenum &	_blendingEquation = GL_FUNC_ADD
	)

Enables blending operation (the alpha channel is used).

Parameters

_sFactor	Blending factor to be applied to the source; among GL_ZERO, GL_ONE, GL_SRC_COLOR, GL_ONE_MINUS_SRC_COLOR, GL_DST_COLOR, GL_ONE_MINUS_DST_COLOR, GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA, GL_DST_ALPHA, GL_ONE_MINUS_DST_ALPHA, GL_CONSTANT_COLOR, GL_ONE_MINUS_CONSTANT_COLOR, GL_CONSTANT_ALPHA, GL_ONE_MINUS_CONSTANT_ALPHA and GL_SRC_ALPHA_SATURATE (see https://www.opengl.org/sdk/docs/man2/xhtml/glBlendFunc.xml for more information).
_dFactor	Blending factor to be applied to the destination; among GL_ZERO, GL_ONE, GL_SRC_COLOR, GL_ONE_MINUS_SRC_COLOR, GL_DST_COLOR, GL_ONE_MINUS_DST_COLOR, GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA, GL_DST_ALPHA, GL_ONE_MINUS_DST_ALPHA. GL_CONSTANT_COLOR, GL_ONE_MINUS_CONSTANT_COLOR, GL_CONSTANT_ALPHA and GL_ONE_MINUS_CONSTANT_ALPHA (see https://www.opengl.org/sdk/docs/man2/xhtml/glBlendFunc.xml for more information).
_blendingEquation	Setting the blending function, for mixing the source and destination color; among GL_FUNC_ADD, GL_FUNC_SUBTRACT, GL_FUNC_REVERSE_SUBTRACT, GL_MIN, GL_MAX (see https://www.opengl.org/sdk/docs/man2/xhtml/glBlendEquation.xml for more information).

void AbstractFilterLayout::enableDepthTesting

(

const GLenum &

_depthTestingFunction = GL_LESS

)

Enable depth testing during filter processing.

Parameters

_depthTestingFunction

Function used the depth testing; among GL_NEVER, GL_LESS, GL_EQUAL, GL_LEQUAL, GL_GREATER, GL_NOTEQUAL, GL_GEQUAL and GL_ALWAYS (see https://www.opengl.org/sdk/docs/man2/xhtml/glDepthFunc.xml for more information).

const GLenum & AbstractFilterLayout::getBlendingEquation

(

void

)

const

Returns

Get the equation used for the blending operation.

const GLenum & AbstractFilterLayout::getDepthTestingFunction

(

void

)

const

Returns

The depth testing function used if depth testing is enabled;

const GLenum & AbstractFilterLayout::getDFactor

(

void

)

const

Returns

Get the blending factor to be applied to the destination (only if blending is enabled).

GeometryModel & AbstractFilterLayout::getGeometryModel

(

void

)

const

Get the GeometryModel used by the filter.

Returns

GeometryModel object reference.

int AbstractFilterLayout::getNumUniformVars

(

void

)

const

Returns

The cumulative number of uniform variables.

const GLenum & AbstractFilterLayout::getSFactor

(

void

)

const

Returns

Get the blending factor to be applied to the source (only if blending is enabled).

const ShaderSource * AbstractFilterLayout::getShaderSource

(

GLenum

shaderType

)

const

Access the shader source of a particular type of shader.

Parameters

shaderType

The type of the targeted shader source, among GL_VERTEX_SHADER, GL_FRAGMENT_SHADER, GL_COMPUTE_SHADER, GL_TESS_CONTROL_SHADER, GL_TESS_EVALUATION_SHADER, GL_GEOMETRY_SHADER.

Returns

Pointer to the ShaderSource or NULL if no source was defined.

bool AbstractFilterLayout::isBlendingEnabled

(

void

)

const

Returns

true if blending is enabled.

bool AbstractFilterLayout::isClearingEnabled

(

void

)

const

Returns

true if clearing is enabled.

bool AbstractFilterLayout::isDepthTestingEnabled

(

void

)

const

Returns

True if the depth testing is enabled.

bool AbstractFilterLayout::isStandardGeometryModel

(

void

)

const

Returns

true if the filter will be using a standard quad as geometry.

---

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

• Filter.hpp
• Filter.cpp