vtkPBRPrefilterTexture Class Reference

precompute prefilter texture used in physically based rendering More...

#include <vtkPBRPrefilterTexture.h>

Inheritance diagram for vtkPBRPrefilterTexture:

Collaboration diagram for vtkPBRPrefilterTexture:

Public Types
typedef vtkOpenGLTexture	Superclass
Public Types inherited from vtkOpenGLTexture
typedef vtkTexture	Superclass
Public Types inherited from vtkTexture
enum	VTKTextureBlendingMode {   VTK_TEXTURE_BLENDING_MODE_NONE = 0 , VTK_TEXTURE_BLENDING_MODE_REPLACE , VTK_TEXTURE_BLENDING_MODE_MODULATE , VTK_TEXTURE_BLENDING_MODE_ADD ,   VTK_TEXTURE_BLENDING_MODE_ADD_SIGNED , VTK_TEXTURE_BLENDING_MODE_INTERPOLATE , VTK_TEXTURE_BLENDING_MODE_SUBTRACT }
	Used to specify how the texture will blend its RGB and Alpha values with other textures and the fragment the texture is rendered upon. More...
enum	{   ClampToEdge = 0 , Repeat , MirroredRepeat , ClampToBorder ,   NumberOfWrapModes }
typedef vtkImageAlgorithm	Superclass
Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkPBRPrefilterTexture *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Load (vtkRenderer *) override
	Implement base class method.
void	Render (vtkRenderer *ren) override
	Implement base class method.
void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this texture.
void	SetInputTexture (vtkOpenGLTexture *)
	Get/Set the input texture.
virtual vtkOpenGLTexture *	GetInputTexture ()
	Get/Set the input texture.
virtual unsigned int	GetPrefilterSize ()
	Get size of texture (input texture height).
virtual unsigned int	GetPrefilterLevels ()
	Set/Get the number of mip-map levels.
virtual void	SetPrefilterLevels (unsigned int)
	Set/Get the number of mip-map levels.
virtual unsigned int	GetPrefilterMaxSamples ()
	Set/Get the maximum number of samples.
virtual void	SetPrefilterMaxSamples (unsigned int)
	Set/Get the maximum number of samples.
virtual bool	GetConvertToLinear ()
	Set/Get the conversion to linear color space.
virtual void	SetConvertToLinear (bool)
	Set/Get the conversion to linear color space.
virtual void	ConvertToLinearOn ()
	Set/Get the conversion to linear color space.
virtual void	ConvertToLinearOff ()
	Set/Get the conversion to linear color space.
Public Member Functions inherited from vtkOpenGLTexture
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkOpenGLTexture *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Render (vtkRenderer *ren) override
	Renders a texture map.
void	Load (vtkRenderer *) override
	Implement base class method.
void	PostRender (vtkRenderer *) override
	Cleans up after the texture rendering to restore the state of the graphics context.
void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this texture.
void	CopyTexImage (int x, int y, int width, int height)
	copy the renderers read buffer into this texture
virtual vtkTextureObject *	GetTextureObject ()
void	SetTextureObject (vtkTextureObject *)
int	GetTextureUnit () override
	Return the texture unit used for this texture.
int	IsTranslucent () override
	Is this Texture Translucent? returns false (0) if the texture is either fully opaque or has only fully transparent pixels and fully opaque pixels and the Interpolate flag is turn off.
virtual int	GetIsDepthTexture ()
	Provide for specifying a format for the texture.
virtual void	SetIsDepthTexture (int)
	Provide for specifying a format for the texture.
virtual int	GetTextureType ()
	What type of texture map GL_TEXTURE_2D versus GL_TEXTURE_RECTANGLE.
virtual void	SetTextureType (int)
	What type of texture map GL_TEXTURE_2D versus GL_TEXTURE_RECTANGLE.
Public Member Functions inherited from vtkTexture
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkTexture *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Render (vtkRenderer *ren)
	Renders a texture map.
virtual void	PostRender (vtkRenderer *)
	Cleans up after the texture rendering to restore the state of the graphics context.
virtual void	ReleaseGraphicsResources (vtkWindow *)
	Release any graphics resources that are being consumed by this texture.
virtual void	Load (vtkRenderer *)
	Abstract interface to renderer.
vtkImageData *	GetInput ()
	Get the input as a vtkImageData object.
unsigned char *	MapScalarsToColors (vtkDataArray *scalars)
	Map scalar values into color scalars.
virtual int	IsTranslucent ()
	Is this Texture Translucent? returns false (0) if the texture is either fully opaque or has only fully transparent pixels and fully opaque pixels and the Interpolate flag is turn off.
virtual int	GetTextureUnit ()
	Return the texture unit used for this texture.
virtual vtkTypeBool	GetInterpolate ()
	Turn on/off linear interpolation of the texture map when rendering.
virtual void	SetInterpolate (vtkTypeBool)
	Turn on/off linear interpolation of the texture map when rendering.
virtual void	InterpolateOn ()
	Turn on/off linear interpolation of the texture map when rendering.
virtual void	InterpolateOff ()
	Turn on/off linear interpolation of the texture map when rendering.
virtual bool	GetMipmap ()
	Turn on/off use of mipmaps when rendering.
virtual void	SetMipmap (bool)
	Turn on/off use of mipmaps when rendering.
virtual void	MipmapOn ()
	Turn on/off use of mipmaps when rendering.
virtual void	MipmapOff ()
	Turn on/off use of mipmaps when rendering.
virtual void	SetMaximumAnisotropicFiltering (float)
	Set/Get the maximum anisotropic filtering to use.
virtual float	GetMaximumAnisotropicFiltering ()
	Set/Get the maximum anisotropic filtering to use.
virtual void	SetQuality (int)
	Force texture quality to 16-bit or 32-bit.
virtual int	GetQuality ()
	Force texture quality to 16-bit or 32-bit.
void	SetQualityToDefault ()
	Force texture quality to 16-bit or 32-bit.
void	SetQualityTo16Bit ()
	Force texture quality to 16-bit or 32-bit.
void	SetQualityTo32Bit ()
	Force texture quality to 16-bit or 32-bit.
virtual void	SetColorMode (int)
	Default: ColorModeToDefault.
virtual int	GetColorMode ()
	Default: ColorModeToDefault.
void	SetColorModeToDefault ()
	Default: ColorModeToDefault.
void	SetColorModeToMapScalars ()
	Default: ColorModeToDefault.
void	SetColorModeToDirectScalars ()
	Default: ColorModeToDefault.
void	SetLookupTable (vtkScalarsToColors *)
	Specify the lookup table to convert scalars if necessary.
virtual vtkScalarsToColors *	GetLookupTable ()
	Specify the lookup table to convert scalars if necessary.
virtual vtkUnsignedCharArray *	GetMappedScalars ()
	Get Mapped Scalars.
void	SetTransform (vtkTransform *transform)
	Set a transform on the texture which allows one to scale, rotate and translate the texture.
virtual vtkTransform *	GetTransform ()
	Set a transform on the texture which allows one to scale, rotate and translate the texture.
virtual int	GetBlendingMode ()
	Used to specify how the texture will blend its RGB and Alpha values with other textures and the fragment the texture is rendered upon.
virtual void	SetBlendingMode (int)
	Used to specify how the texture will blend its RGB and Alpha values with other textures and the fragment the texture is rendered upon.
virtual bool	GetPremultipliedAlpha ()
	Whether the texture colors are premultiplied by alpha.
virtual void	SetPremultipliedAlpha (bool)
	Whether the texture colors are premultiplied by alpha.
virtual void	PremultipliedAlphaOn ()
	Whether the texture colors are premultiplied by alpha.
virtual void	PremultipliedAlphaOff ()
	Whether the texture colors are premultiplied by alpha.
virtual vtkTypeBool	GetRestrictPowerOf2ImageSmaller ()
	When the texture is forced to be a power of 2, the default behavior is for the "new" image's dimensions to be greater than or equal to with respects to the original.
virtual void	SetRestrictPowerOf2ImageSmaller (vtkTypeBool)
	When the texture is forced to be a power of 2, the default behavior is for the "new" image's dimensions to be greater than or equal to with respects to the original.
virtual void	RestrictPowerOf2ImageSmallerOn ()
	When the texture is forced to be a power of 2, the default behavior is for the "new" image's dimensions to be greater than or equal to with respects to the original.
virtual void	RestrictPowerOf2ImageSmallerOff ()
	When the texture is forced to be a power of 2, the default behavior is for the "new" image's dimensions to be greater than or equal to with respects to the original.
virtual bool	GetCubeMap ()
	Is this texture a cube map, if so it needs 6 inputs one for each side of the cube.
virtual void	CubeMapOn ()
	Is this texture a cube map, if so it needs 6 inputs one for each side of the cube.
virtual void	CubeMapOff ()
	Is this texture a cube map, if so it needs 6 inputs one for each side of the cube.
void	SetCubeMap (bool val)
	Is this texture a cube map, if so it needs 6 inputs one for each side of the cube.
virtual bool	GetUseSRGBColorSpace ()
	Is this texture using the sRGB color space.
virtual void	SetUseSRGBColorSpace (bool)
	Is this texture using the sRGB color space.
virtual void	UseSRGBColorSpaceOn ()
	Is this texture using the sRGB color space.
virtual void	UseSRGBColorSpaceOff ()
	Is this texture using the sRGB color space.
virtual void	SetBorderColor (float, float, float, float)
	Border Color (RGBA).
virtual void	SetBorderColor (float[4])
	Border Color (RGBA).
virtual float *	GetBorderColor ()
	Border Color (RGBA).
virtual void	GetBorderColor (float &, float &, float &, float &)
	Border Color (RGBA).
virtual void	GetBorderColor (float[4])
	Border Color (RGBA).
virtual int	GetWrap ()
	Wrap mode for the texture coordinates Valid values are:
virtual void	SetWrap (int)
	Wrap mode for the texture coordinates Valid values are:
virtual void	SetRepeat (vtkTypeBool r)
	Convenience functions to maintain backwards compatibility.
virtual vtkTypeBool	GetRepeat ()
	Convenience functions to maintain backwards compatibility.
virtual void	RepeatOn ()
	Convenience functions to maintain backwards compatibility.
virtual void	RepeatOff ()
	Convenience functions to maintain backwards compatibility.
virtual void	SetEdgeClamp (vtkTypeBool)
	Convenience functions to maintain backwards compatibility.
virtual vtkTypeBool	GetEdgeClamp ()
	Convenience functions to maintain backwards compatibility.
virtual void	EdgeClampOn ()
	Convenience functions to maintain backwards compatibility.
virtual void	EdgeClampOff ()
	Convenience functions to maintain backwards compatibility.
Public Member Functions inherited from vtkImageAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkImageAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	Process a request from the executive.
vtkImageData *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkImageData *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
vtkDataObject *	GetInput (int port)
	Get a data object for one of the input port connections.
vtkDataObject *	GetInput ()
	Get a data object for one of the input port connections.
vtkImageData *	GetImageDataInput (int port)
	Get a data object for one of the input port connections.
virtual void	AddInputData (vtkDataObject *)
	Assign a data object as input.
virtual void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetProgress (double)
	SetProgress is deprecated.
void	UpdateProgress (double amount)
	Update the progress of the process object.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	String based versions of SetInputArrayToProcess().
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
void	Register (vtkObjectBase *o) override
	Participate in garbage collection.
void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.
virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkPBRPrefilterTexture *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPBRPrefilterTexture *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkOpenGLTexture
static vtkOpenGLTexture *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenGLTexture *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkTexture
static vtkTexture *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkTexture *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)
static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPBRPrefilterTexture ()=default
	~vtkPBRPrefilterTexture () override
Protected Member Functions inherited from vtkOpenGLTexture
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLTexture ()
	~vtkOpenGLTexture () override
unsigned char *	ResampleToPowerOfTwo (int &xsize, int &ysize, unsigned char *dptr, int bpp, int maxDimGL)
Protected Member Functions inherited from vtkTexture
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTexture ()
	~vtkTexture () override
void	ExecuteData (vtkDataObject *) override
	This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers.
Protected Member Functions inherited from vtkImageAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageAlgorithm ()
	~vtkImageAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections.
virtual void	CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	Convenience method to copy the scalar type and number of components from the input data to the output data.
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	This is called in response to a REQUEST_DATA request from the executive.
virtual void	ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
	This is a convenience method that is implemented in many subclasses instead of RequestData.
virtual void	CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
	Copy the other point and cell data.
virtual void	Execute ()
	This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers.
virtual void	AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
	Allocate the output data.
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
	Allocate the output data.
int	FillOutputPortInformation (int port, vtkInformation *info) override
	These method should be reimplemented by subclasses that have more than a single input or single output.
int	FillInputPortInformation (int port, vtkInformation *info) override
	These method should be reimplemented by subclasses that have more than a single input or single output.
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
unsigned int	PrefilterSize
unsigned int	PrefilterLevels = 5
unsigned int	PrefilterMaxSamples = 512
vtkOpenGLTexture *	InputTexture = nullptr
bool	ConvertToLinear = false
Protected Attributes inherited from vtkOpenGLTexture
vtkTimeStamp	LoadTime
vtkWeakPointer< vtkRenderWindow >	RenderWindow
bool	ExternalTextureObject
vtkTextureObject *	TextureObject
int	IsDepthTexture
int	TextureType
int	PrevBlendParams [4]
Protected Attributes inherited from vtkTexture
bool	Mipmap
float	MaximumAnisotropicFiltering
int	Wrap
float	BorderColor [4]
vtkTypeBool	Interpolate
int	Quality
int	ColorMode
vtkScalarsToColors *	LookupTable
vtkUnsignedCharArray *	MappedScalars
vtkTransform *	Transform
int	BlendingMode
vtkTypeBool	RestrictPowerOf2ImageSmaller
int	SelfAdjustingTableRange
bool	PremultipliedAlpha
bool	CubeMap
bool	UseSRGBColorSpace
vtkTimeStamp	TranslucentComputationTime
int	TranslucentCachedResult
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

precompute prefilter texture used in physically based rendering

Prefilter texture is a cubemap result of integration of the input cubemap contribution in BRDF equation. The result depends on roughness coefficient so several levels of mipmap are used to store results of different roughness coefficients. It is used in Image Base Lighting to compute the specular part.

Definition at line 36 of file vtkPBRPrefilterTexture.h.

Member Typedef Documentation

Superclass

typedef vtkOpenGLTexture vtkPBRPrefilterTexture::Superclass

Definition at line 40 of file vtkPBRPrefilterTexture.h.

Constructor & Destructor Documentation

vtkPBRPrefilterTexture()

vtkPBRPrefilterTexture::vtkPBRPrefilterTexture ( )

protecteddefault

~vtkPBRPrefilterTexture()

vtkPBRPrefilterTexture::~vtkPBRPrefilterTexture ( )

overrideprotected

Member Function Documentation

New()

static vtkPBRPrefilterTexture * vtkPBRPrefilterTexture::New ( )

static

IsTypeOf()

static vtkTypeBool vtkPBRPrefilterTexture::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkPBRPrefilterTexture::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkOpenGLTexture.

SafeDownCast()

static vtkPBRPrefilterTexture * vtkPBRPrefilterTexture::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkPBRPrefilterTexture::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkOpenGLTexture.

NewInstance()

vtkPBRPrefilterTexture * vtkPBRPrefilterTexture::NewInstance

(

)

const

PrintSelf()

void vtkPBRPrefilterTexture::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkOpenGLTexture.

SetInputTexture()

void vtkPBRPrefilterTexture::SetInputTexture

(

vtkOpenGLTexture *

)

Get/Set the input texture.

GetInputTexture()

virtual vtkOpenGLTexture * vtkPBRPrefilterTexture::GetInputTexture ( )

virtual

Get/Set the input texture.

Load()

void vtkPBRPrefilterTexture::Load ( vtkRenderer *  )

overridevirtual

Implement base class method.

Reimplemented from vtkOpenGLTexture.

Render()

void vtkPBRPrefilterTexture::Render ( vtkRenderer *  ren )

inlineoverridevirtual

Implement base class method.

Reimplemented from vtkOpenGLTexture.

Definition at line 59 of file vtkPBRPrefilterTexture.h.

GetPrefilterSize()

virtual unsigned int vtkPBRPrefilterTexture::GetPrefilterSize ( )

virtual

Get size of texture (input texture height).

GetPrefilterLevels()

virtual unsigned int vtkPBRPrefilterTexture::GetPrefilterLevels ( )

virtual

Set/Get the number of mip-map levels.

Default is 5.

SetPrefilterLevels()

virtual void vtkPBRPrefilterTexture::SetPrefilterLevels ( unsigned int  )

virtual

Set/Get the number of mip-map levels.

Default is 5.

GetPrefilterMaxSamples()

virtual unsigned int vtkPBRPrefilterTexture::GetPrefilterMaxSamples ( )

virtual

Set/Get the maximum number of samples.

The number of samples for each roughness is between 1 at roughness = 0 and PrefilterMaxSamples at roughness = 1 Default is 512.

SetPrefilterMaxSamples()

virtual void vtkPBRPrefilterTexture::SetPrefilterMaxSamples ( unsigned int  )

virtual

Set/Get the maximum number of samples.

The number of samples for each roughness is between 1 at roughness = 0 and PrefilterMaxSamples at roughness = 1 Default is 512.

GetConvertToLinear()

virtual bool vtkPBRPrefilterTexture::GetConvertToLinear ( )

virtual

Set/Get the conversion to linear color space.

If the input texture is in sRGB color space and the conversion is not done by OpenGL directly with the texture format, the conversion can be done in the shader with this flag.

SetConvertToLinear()

virtual void vtkPBRPrefilterTexture::SetConvertToLinear ( bool  )

virtual

Set/Get the conversion to linear color space.

If the input texture is in sRGB color space and the conversion is not done by OpenGL directly with the texture format, the conversion can be done in the shader with this flag.

ConvertToLinearOn()

virtual void vtkPBRPrefilterTexture::ConvertToLinearOn ( )

virtual

Set/Get the conversion to linear color space.

If the input texture is in sRGB color space and the conversion is not done by OpenGL directly with the texture format, the conversion can be done in the shader with this flag.

ConvertToLinearOff()

virtual void vtkPBRPrefilterTexture::ConvertToLinearOff ( )

virtual

Set/Get the conversion to linear color space.

If the input texture is in sRGB color space and the conversion is not done by OpenGL directly with the texture format, the conversion can be done in the shader with this flag.

ReleaseGraphicsResources()

void vtkPBRPrefilterTexture::ReleaseGraphicsResources ( vtkWindow *  )

overridevirtual

Release any graphics resources that are being consumed by this texture.

The parameter window could be used to determine which graphic resources to release. Using the same texture object in multiple render windows is NOT currently supported.

Reimplemented from vtkOpenGLTexture.

Member Data Documentation

PrefilterSize

unsigned int vtkPBRPrefilterTexture::PrefilterSize

protected

Definition at line 111 of file vtkPBRPrefilterTexture.h.

PrefilterLevels

unsigned int vtkPBRPrefilterTexture::PrefilterLevels = 5

protected

Definition at line 112 of file vtkPBRPrefilterTexture.h.

PrefilterMaxSamples

unsigned int vtkPBRPrefilterTexture::PrefilterMaxSamples = 512

protected

Definition at line 113 of file vtkPBRPrefilterTexture.h.

InputTexture

vtkOpenGLTexture* vtkPBRPrefilterTexture::InputTexture = nullptr

protected

Definition at line 114 of file vtkPBRPrefilterTexture.h.

ConvertToLinear

bool vtkPBRPrefilterTexture::ConvertToLinear = false

protected

Definition at line 115 of file vtkPBRPrefilterTexture.h.

---

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

• Rendering/OpenGL2/vtkPBRPrefilterTexture.h