Inviwo  0.9.10.1
Inviwo documentation
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
inviwo::ImageGLProcessor Class Reference

Base class for image processing on the GPU using OpenGL. More...

#include <imageglprocessor.h>

+ Inheritance diagram for inviwo::ImageGLProcessor:

Public Member Functions

 ImageGLProcessor (std::shared_ptr< const ShaderResource > fragmentShader, bool buildShader=true)
 
 ImageGLProcessor (const std::string &fragmentShader, bool buildShader=true)
 
virtual void initializeResources () override
 
virtual void process () override
 
- Public Member Functions inherited from inviwo::Processor
 Processor (const std::string &identifier="", const std::string &displayName="")
 
virtual const ProcessorInfo getProcessorInfo () const =0
 
std::string getClassIdentifier () const
 
std::string getCategory () const
 
CodeState getCodeState () const
 
Tags getTags () const
 
void setIdentifier (const std::string &identifier)
 
const std::string & getIdentifier () const
 
void setDisplayName (const std::string &displayName)
 
const std::string & getDisplayName () const
 
virtual std::vector< std::string > getPath () const override
 
virtual void setProcessorWidget (std::unique_ptr< ProcessorWidget > processorWidget)
 
ProcessorWidget * getProcessorWidget () const
 
bool hasProcessorWidget () const
 
virtual void setNetwork (ProcessorNetwork *network)
 
ProcessorNetwork * getNetwork () const
 
Port * getPort (const std::string &identifier) const
 
Inport * getInport (const std::string &identifier) const
 
Outport * getOutport (const std::string &identifier) const
 
const std::vector< Inport * > & getInports () const
 
const std::vector< Outport * > & getOutports () const
 
const std::string & getPortGroup (Port *port) const
 
std::vector< std::string > getPortGroups () const
 
const std::vector< Port * > & getPortsInGroup (const std::string &portGroup) const
 
const std::vector< Port * > & getPortsInSameGroup (Port *port) const
 
bool allInportsConnected () const
 
bool allInportsAreReady () const
 
bool isSource () const
 
bool isSink () const
 
bool isReady () const
 
virtual void doIfNotReady ()
 
virtual void setValid () override
 
virtual void invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty=nullptr) override
 
void addInteractionHandler (InteractionHandler *interactionHandler)
 
void removeInteractionHandler (InteractionHandler *interactionHandler)
 
bool hasInteractionHandler () const
 
const std::vector< InteractionHandler * > & getInteractionHandlers () const
 
virtual void invokeEvent (Event *event) override
 
virtual void propagateEvent (Event *event, Outport *source) override
 
virtual Processor * getProcessor () override
 
virtual const Processor * getProcessor () const override
 
virtual void serialize (Serializer &s) const override
 
virtual void deserialize (Deserializer &d) override
 
template<typename T , typename std::enable_if_t< std::is_base_of< Inport, T >::value, int > = 0>
T & addPort (std::unique_ptr< T > port, const std::string &portGroup="default")
 
template<typename T , typename std::enable_if_t< std::is_base_of< Outport, T >::value, int > = 0>
T & addPort (std::unique_ptr< T > port, const std::string &portGroup="default")
 
template<typename T >
T & addPort (T &port, const std::string &portGroup="default")
 
Port * removePort (const std::string &identifier)
 
Inport * removePort (Inport *port)
 
Outport * removePort (Outport *port)
 
- Public Member Functions inherited from inviwo::PropertyOwner
virtual ~PropertyOwner ()
 Removes all properties and notifies its observers of the removal.
 
virtual void addProperty (Property *property, bool owner=true)
 
virtual void addProperty (Property &property)
 
template<typename... Ts>
void addProperties (Ts &... properties)
 
virtual void insertProperty (size_t index, Property *property, bool owner=true)
 insert property property at position index If index is not valid, the property is appended. More...
 
virtual void insertProperty (size_t index, Property &property)
 insert property property at position index If index is not valid, the property is appended. More...
 
virtual Property * removeProperty (const std::string &identifier)
 
virtual Property * removeProperty (Property *property)
 
virtual Property * removeProperty (Property &property)
 
virtual Property * removeProperty (size_t index)
 remove property referred to by index More...
 
const std::vector< Property * > & getProperties () const
 
const std::vector< CompositeProperty * > & getCompositeProperties () const
 
std::vector< Property * > getPropertiesRecursive () const
 
Property * getPropertyByIdentifier (const std::string &identifier, bool recursiveSearch=false) const
 
Property * getPropertyByPath (const std::vector< std::string > &path) const
 
template<class T >
std::vector< T * > getPropertiesByType (bool recursiveSearch=false) const
 
size_t size () const
 
Property * operator[] (size_t)
 
const Property * operator[] (size_t) const
 
iterator begin ()
 
iterator end ()
 
const_iterator cbegin () const
 
const_iterator cend () const
 
virtual bool isValid () const
 
InvalidationLevel getInvalidationLevel () const
 
void setAllPropertiesCurrentStateAsDefault ()
 
void resetAllPoperties ()
 
virtual InviwoApplication * getInviwoApplication ()
 
- Public Member Functions inherited from inviwo::PropertyOwnerObservable
void notifyObserversWillAddProperty (Property *property, size_t index)
 
void notifyObserversDidAddProperty (Property *property, size_t index)
 
void notifyObserversWillRemoveProperty (Property *property, size_t index)
 
void notifyObserversDidRemoveProperty (Property *property, size_t index)
 
- Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
 Observable (const Observable< PropertyOwnerObserver > &other)
 
 Observable (Observable< PropertyOwnerObserver > &&other)
 
Observable< PropertyOwnerObserver > & operator= (const Observable< PropertyOwnerObserver > &other)
 
Observable< PropertyOwnerObserver > & operator= (Observable< PropertyOwnerObserver > &&other)
 
void addObserver (PropertyOwnerObserver *observer)
 
void removeObserver (PropertyOwnerObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 
- Public Member Functions inherited from inviwo::MetaDataOwner
 MetaDataOwner (const MetaDataOwner &rhs)=default
 
MetaDataOwner & operator= (const MetaDataOwner &rhs)=default
 
void copyMetaDataFrom (const MetaDataOwner &src)
 
void copyMetaDataTo (MetaDataOwner &dst)
 
template<typename T >
T * createMetaData (const std::string &key)
 
template<typename T , typename U >
void setMetaData (const std::string &key, U value)
 
template<typename T >
bool unsetMetaData (const std::string &key)
 unset, i.e. remove the metadata entry matching the given key and type More...
 
template<typename T , typename U >
U getMetaData (const std::string &key, U val) const
 
template<typename T >
T * getMetaData (const std::string &key)
 
template<typename T >
const T * getMetaData (const std::string &key) const
 
MetaDataMap * getMetaDataMap ()
 
const MetaDataMap * getMetaDataMap () const
 
template<typename T >
bool hasMetaData (const std::string &key) const
 
- Public Member Functions inherited from inviwo::Observable< ProcessorObserver >
 Observable (const Observable< ProcessorObserver > &other)
 
 Observable (Observable< ProcessorObserver > &&other)
 
Observable< ProcessorObserver > & operator= (const Observable< ProcessorObserver > &other)
 
Observable< ProcessorObserver > & operator= (Observable< ProcessorObserver > &&other)
 
void addObserver (ProcessorObserver *observer)
 
void removeObserver (ProcessorObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 

Protected Member Functions

void markInvalid ()
 
virtual void preProcess (TextureUnitContainer &cont)
 this function gets called right before the actual processing but after the shader has been activated More...
 
virtual void postProcess ()
 this function gets called at the end of the process function More...
 
virtual void afterInportChanged ()
 this function gets called whenever the inport changes More...
 
size2_t calcOutputDimensions () const
 
- Protected Member Functions inherited from inviwo::Processor
void addPortToGroup (Port *port, const std::string &portGroup)
 
void removePortFromGroups (Port *port)
 
- Protected Member Functions inherited from inviwo::PropertyOwner
 PropertyOwner (const PropertyOwner &rhs)
 
PropertyOwner & operator= (const PropertyOwner &that)=delete
 
- Protected Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
void forEachObserver (C callback)
 
- Protected Member Functions inherited from inviwo::ObservableInterface
void addObservationHelper (Observer *observer)
 
void removeObservationHelper (Observer *observer)
 
- Protected Member Functions inherited from inviwo::ProcessorObservable
void notifyObserversAboutPropertyChange (Property *p)
 
void notifyObserversInvalidationBegin (Processor *p)
 
void notifyObserversInvalidationEnd (Processor *p)
 
void notifyObserversIdentifierChanged (Processor *p, const std::string &oldIdentifier)
 
void notifyObserversDisplayNameChanged (Processor *p, const std::string &oldDisplayName)
 
void notifyObserversProcessorPortAdded (Processor *p, Port *port)
 
void notifyObserversProcessorPortRemoved (Processor *p, Port *port)
 
void notifyObserversAboutToProcess (Processor *p)
 
void notifyObserversFinishedProcess (Processor *p)
 
void notifyObserversSourceChange (Processor *p)
 
void notifyObserversSinkChange (Processor *p)
 
void notifyObserversReadyChange (Processor *p)
 
- Protected Member Functions inherited from inviwo::Observable< ProcessorObserver >
void forEachObserver (C callback)
 

Static Protected Member Functions

static void createCustomImage (const size2_t &dim, const DataFormatBase *dataFormat, const SwizzleMask &swizzleMask, ImageInport &inport, ImageOutport &outport)
 
static void createDefaultImage (const size2_t &dim, ImageInport &inport, ImageOutport &outport)
 

Protected Attributes

ImageInport inport_
 
ImageOutport outport_
 
const DataFormatBase * dataFormat_
 
SwizzleMask swizzleMask_
 
bool internalInvalid_
 
std::string fragmentShader_
 
Shader shader_
 
- Protected Attributes inherited from inviwo::Processor
std::unique_ptr< ProcessorWidget > processorWidget_
 
StateCoordinator< bool > isReady_
 
StateCoordinator< bool > isSink_
 
StateCoordinator< bool > isSource_
 
- Protected Attributes inherited from inviwo::PropertyOwner
std::vector< Property * > properties_
 
std::vector< EventProperty * > eventProperties_
 
std::vector< CompositeProperty * > compositeProperties_
 
std::vector< std::unique_ptr< Property > > ownedProperties_
 
- Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap metaData_
 
- Protected Attributes inherited from inviwo::ProcessorObservable
friend ProcessorNetworkEvaluator
 
friend Property
 

Additional Inherited Members

- Public Types inherited from inviwo::PropertyOwner
using iterator = std::vector< Property * >::iterator
 
using const_iterator = std::vector< Property * >::const_iterator
 

Detailed Description

Base class for image processing on the GPU using OpenGL.

The ImageGLProcessor provides the basic structure for image processing on the GPU. Derived shaders have to provide a custom fragment shader which is used during rendering. Optionally, derived classes can overwrite ImageGLProcessor::postProcess() to perform post-processing of the image data set in the outport. Furthermore, it is possible to be notified of changes in the input image by overwriting ImageGLProcessor::afterInportChanged().

See also
VolumeGLProcessor

Member Function Documentation

◆ afterInportChanged()

void inviwo::ImageGLProcessor::afterInportChanged ( )
protectedvirtual

this function gets called whenever the inport changes

overwrite this function in the derived class to be notified of inport onChange events

Reimplemented in inviwo::ImageMapping.

◆ initializeResources()

void inviwo::ImageGLProcessor::initializeResources ( )
overridevirtual

InitializeResources is called whenever a property with InvalidationLevel::InvalidResources is changes.

Reimplemented from inviwo::Processor.

Reimplemented in inviwo::ImageResample, inviwo::Tonemapping, and inviwo::Jacobian2D.

◆ postProcess()

void inviwo::ImageGLProcessor::postProcess ( )
protectedvirtual

this function gets called at the end of the process function

overwrite this function in the derived class to perform post-processing

Reimplemented in inviwo::ImageNormalizationProcessor, and inviwo::ImageChannelSelect.

◆ preProcess()

void inviwo::ImageGLProcessor::preProcess ( TextureUnitContainer &  cont)
protectedvirtual

this function gets called right before the actual processing but after the shader has been activated

overwrite this function in the derived class to perform things like custom shader setup

Reimplemented in inviwo::ImageGrayscale, inviwo::ImageSharpen, inviwo::ImageHueSaturationLuminance, inviwo::ImageGamma, inviwo::Jacobian2D, inviwo::ImageBrightnessContrast, inviwo::ImageOpacity, inviwo::Tonemapping, inviwo::ImageGradient, inviwo::ImageHighPass, inviwo::ImageNormalizationProcessor, inviwo::ImageBinary, inviwo::ImageEdgeDarken, inviwo::ImageMapping, inviwo::FindEdges, and inviwo::ImageChannelSelect.

◆ process()

void inviwo::ImageGLProcessor::process ( )
overridevirtual

Deriving classes should override this function to do the main work of the processor. This function is called by the ProcessorNetworkEvaluator when the network is evaluated and the processor is invalid, i.e. some of its inports or properties has been modified, and is ready i.e. all non optional inports have valid data.

See also
ProcessorNetworkEvaluator
Inport
Property

Reimplemented from inviwo::Processor.

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