Post-processing pass that converts HDR linear color input to LDR gamma color. More...

#include <Urho3D/RenderPipeline/Passes/ToneMappingPass.h>

Inheritance diagram for Urho3D::ToneMappingPass:

Classes
struct	PipelineStateCache

Public Types
enum	Mode { None, Reinhard, ReinhardWhite, Uncharted2, Count }

Public Member Functions
	ToneMappingPass (Context *context)


void	CollectParameters (StringVariantMap &params) const override

void	InitializeView (RenderPipelineView *view) override
	Initialize render pass before using it in view.

void	UpdateParameters (const RenderPipelineSettings &settings, const StringVariantMap &params) override

void	Render (const SharedRenderPassState &sharedState) override
	Execute render commands.

Public Member Functions inherited from Urho3D::RenderPass
	RenderPass (Context *context)

virtual const ea::string &	GetPassName () const
	Return unique pass name.

virtual void	Update (const SharedRenderPassState &sharedState)
	Perform update that does not invoke any rendering commands.

void	SetEnabled (bool enabled)

bool	IsEnabledEffectively () const

const RenderPassTraits &	GetTraits () const

bool	IsEnabledByDefault () const

void	SetEnabledByDefault (bool enabled)

const ea::string &	GetComment () const

void	SetComment (const ea::string &comment)

Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.

	~Serializable () override
	Destruct.

virtual void	OnSetAttribute (const AttributeInfo &attr, const Variant &src)
	Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.

virtual void	OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
	Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.

virtual ObjectReflection *	GetReflection () const
	Return reflection used for serialization.

virtual const ea::vector< AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined.

void	SerializeInBlock (Archive &archive) override
	Serialize content from/to archive. May throw ArchiveException.

void	SerializeInBlock (Archive &archive, bool serializeTemporary)

virtual bool	Load (Deserializer &source)
	Load from binary data. Return true if successful.

virtual bool	Save (Serializer &dest) const
	Save as binary data. Return true if successful.

virtual bool	LoadXML (const XMLElement &source)
	Load from XML data. Return true if successful.

virtual bool	SaveXML (XMLElement &dest) const
	Save as XML data. Return true if successful.

virtual bool	LoadJSON (const JSONValue &source)
	Load from JSON data. Return true if successful.

virtual bool	SaveJSON (JSONValue &dest) const
	Save as JSON data. Return true if successful.

virtual bool	Load (const ea::string &resourceName)
	Load from binary resource.

virtual bool	LoadXML (const ea::string &resourceName)
	Load from XML resource.

virtual bool	LoadJSON (const ea::string &resourceName)
	Load from JSON resource.

virtual bool	LoadFile (const ea::string &resourceName)
	Load from resource of automatically detected type.

virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.

virtual bool	SaveDefaultAttributes (const AttributeInfo &attr) const
	Return whether should save default-valued attributes into XML. Default false.

bool	SetAttribute (unsigned index, const Variant &value)

bool	SetAttribute (const ea::string &name, const Variant &value)
	Set attribute by name. Return true if successfully set.

void	SetInstanceDefault (bool enable)
	(Internal use) Set instance-level default flag.

void	SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
	(Internal use) Set instance-level default value. Allocate the internal data structure as necessary.

virtual Variant	GetInstanceDefault (const ea::string &name) const
	(Internal use) Get instance-level default value.

void	ResetToDefault ()
	Reset all editable attributes to their default values.

void	RemoveInstanceDefault ()
	Remove instance's default values if they are set previously.

void	SetTemporary (bool enable)

Variant	GetAttribute (unsigned index) const

Variant	GetAttribute (const ea::string &name) const
	Return attribute value by name. Return empty if not found.

Variant	GetAttributeDefault (unsigned index) const

Variant	GetAttributeDefault (const ea::string &name) const
	Return attribute default value by name. Return empty if not found.

unsigned	GetNumAttributes () const

void	CopyAttributes (const Serializable *source, bool resetToDefault=true)
	Copy all attributes from another serializable.

SharedPtr< Serializable >	Clone (bool resetToDefault=true) const
	Clone this serializable.

bool	IsTemporary () const

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static void	RegisterObject (Context *context)

Static Public Member Functions inherited from Urho3D::RenderPass
static void	RegisterObject (Context *context)

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Member Functions
void	InvalidateCache ()

void	RestoreCache (const SharedRenderPassState &sharedState)

Protected Member Functions inherited from Urho3D::RenderPass
void	DeclareParameter (const ea::string &name, const Variant &value, StringVariantMap &params) const

const Variant &	LoadParameter (const ea::string &name, const StringVariantMap &params) const

void	ConnectToRenderBuffer (WeakPtr< RenderBuffer > &renderBuffer, StringHash name, const SharedRenderPassState &sharedState, bool required=true) const

Protected Attributes
ea::optional< PipelineStateCache >	pipelineStates_

Mode	mode_ {}

Protected Attributes inherited from Urho3D::RenderPass
struct Urho3D::RenderPass::Attributes	attributes_

bool	isEnabledByUser_ {}

bool	isEnabledInternally_ {true}

RenderPassTraits	traits_

Protected Attributes inherited from Urho3D::Serializable
ea::unique_ptr< VariantMap >	instanceDefaultValues_
	Attribute default value at each instance level.

bool	setInstanceDefault_
	When true, store the attribute value as instance's default value (internal use only).

bool	temporary_
	Temporary flag.

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Private Member Functions
	URHO3D_OBJECT (ToneMappingPass, RenderPass)

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Detailed Description

Post-processing pass that converts HDR linear color input to LDR gamma color.

Member Function Documentation

◆ CollectParameters()

void Urho3D::ToneMappingPass::CollectParameters ( StringVariantMap & params ) const

overridevirtual

Implement RenderPass.

Reimplemented from Urho3D::RenderPass.

◆ UpdateParameters()

void Urho3D::ToneMappingPass::UpdateParameters	(	const RenderPipelineSettings &	settings,
		const StringVariantMap &	params
	)

overridevirtual

Update settings and parameters of the pass. This function is always called before any rendering updates or getters.

Reimplemented from Urho3D::RenderPass.

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

Urho3D/RenderPipeline/Passes/ToneMappingPass.h
Urho3D/RenderPipeline/Passes/ToneMappingPass.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CollectParameters()

◆ UpdateParameters()