GLIP-Lib
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Glip::CorePipeline::FilterLayout Class Reference

Filter layout. More...

#include <Filter.hpp>

Inheritance diagram for Glip::CorePipeline::FilterLayout:
Inheritance graph

Public Member Functions

 FilterLayout (const std::string &type, const HdlAbstractTextureFormat &fout, const ShaderSource &fragmentSource, GeometryModel *geometry=NULL)
 FilterLayout constructor. More...
 
 FilterLayout (const std::string &type, const HdlAbstractTextureFormat &fout, const std::map< GLenum, ShaderSource * > &sources, GeometryModel *geometry=NULL)
 FilterLayout constructor. More...
 
- Public Member Functions inherited from Glip::CorePipeline::ComponentLayout
 ComponentLayout (const std::string &_layoutName)
 ComponentLayout constructor. More...
 
 ComponentLayout (const AbstractComponentLayout &)
 ComponentLayout constructor. More...
 
void setInputPortName (int i, const std::string &newName)
 Change the name of an input port. More...
 
void setOutputPortName (int i, const std::string &newName)
 Change the name of an output port. More...
 
- 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::CorePipeline::AbstractFilterLayout
 AbstractFilterLayout (const AbstractFilterLayout &)
 AbstractFilterLayout constructor. More...
 
const ShaderSourcegetShaderSource (GLenum shaderType) const
 Access the shader source of a particular type of shader. More...
 
GeometryModelgetGeometryModel (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::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 HdlTextureFormatDescriptorgetFormatDescriptor (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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Glip::CoreGL::HdlAbstractTextureFormat
static int getMaxSize (void)
 Returns the maximum size for a texture. More...
 
- Protected Member Functions inherited from Glip::CorePipeline::ComponentLayout
int addOutputPort (const std::string &name)
 Add an output port. More...
 
int addInputPort (const std::string &name)
 Add an input port. 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::CorePipeline::AbstractFilterLayout
 AbstractFilterLayout (const std::string &type, const HdlAbstractTextureFormat &f)
 AbstractFilterLayout 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...
 

Detailed Description

Filter layout.

Constructor & Destructor Documentation

FilterLayout::FilterLayout ( const std::string &  type,
const HdlAbstractTextureFormat fout,
const ShaderSource fragmentSource,
GeometryModel geometry = NULL 
)

FilterLayout constructor.

Parameters
typeThe typename of the filter layout.
foutThe texture format of all the outputs.
fragmentSourceThe ShaderSource of the fragement shader.
geometryThe geometry model to use in this filter (if left to NULL, the standard quad will be used, otherwise the object will be copied).
FilterLayout::FilterLayout ( const std::string &  type,
const HdlAbstractTextureFormat fout,
const std::map< GLenum, ShaderSource * > &  sources,
GeometryModel geometry = NULL 
)

FilterLayout constructor.

Parameters
typeThe typename of the filter layout.
foutThe texture format of all the outputs.
sourcesList of all the sources, map to their respective types (GL_VERTEX_SHADER, GL_FRAGMENT_SHADER, GL_COMPUTE_SHADER, GL_TESS_CONTROL_SHADER, GL_TESS_EVALUATION_SHADER, GL_GEOMETRY_SHADER), the objects will be copied.
geometryThe geometry model to use in this filter (if left to NULL, the standard quad will be used, otherwise the object will be copied).

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