Kanzi  3.9.4
Kanzi Engine API
kanzi::CubeMapRenderPass Class Reference

Use the Cubemap Render Pass to create a cubemap texture that represents the scene from some location. More...

#include <kanzi/core.ui/graphics3d/cubemap_render_pass.hpp>

Inheritance diagram for kanzi::CubeMapRenderPass:
[legend]

Public Member Functions

 KZ_METACLASS_END ()
 
- Public Member Functions inherited from kanzi::RenderPass
void addChild (RenderPassSharedPtr childRenderPass)
 Adds a render pass as the last child of the render pass you set. More...
 
void attach ()
 Attaches the render pass. More...
 
void attachRecursive (Node &node)
 Recursively attaches a render pass tree. More...
 
ChildConstIterator beginChildren () const
 Returns an iterator to the beginning of the container of child render passes. More...
 
BindingLookupContextPtr createLookupContext (RenderPassSharedPtr templateRoot)
 Creates a lookup context for a given render pass. More...
 
void detach ()
 Detaches the render pass. More...
 
void detachRecursive ()
 Recursively detaches a render pass tree. More...
 
ChildConstIterator endChildren () const
 Returns an iterator to the end of the container of child render passes. More...
 
string getCamera () const
 Gets the value of the CameraProperty. More...
 
RenderPassSharedPtr getChild (size_t index)
 Gets a child render pass at the given index. More...
 
size_t getChildCount () const
 Returns the number of child render passes. More...
 
size_t getChildIndex (RenderPass &childRenderPass) const
 Gets the index of a child in this render pass. More...
 
virtual CompositionRequirements getCompositionRequirements ()
 Queries if a render pass requires a depth buffer. More...
 
NodegetHostNode () const
 Gets the host node of a render pass. More...
 
Vector4 getInputViewport () const
 Gets the value of InputViewportAreaProperty. More...
 
RenderPassgetParent () const
 Gets the parent of a render pass. More...
 
ScenegetSceneForRenderPass () const
 Gets the scene being rendered by the render pass. More...
 
RenderPassSharedPtr getTemplateRoot () const
 Gets the template root of this render pass. More...
 
Viewport2DgetViewportForRenderPass () const
 Gets a viewport parent for a render pass. More...
 
void insertChild (size_t index, RenderPassSharedPtr childRenderPass)
 Adds a render pass as a child render pass at given index of the render pass you set. More...
 
bool isAttached () const
 Tells if a render pass is attached. More...
 
bool isAttaching () const
 Tells if a render pass is attaching. More...
 
bool isDetached () const
 Tells if a render pass is detached. More...
 
bool isDetaching () const
 Tells if render pass is detaching. More...
 
bool isEnabled () const
 Gets the value of the EnabledProperty property. More...
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
template<typename T >
shared_ptr< TlookupObject (string_view relativePath)
 Lookup a relative object of specific type. More...
 
void removeAllChildren ()
 Removes all child render passes from a render pass. More...
 
void removeChild (RenderPass &childRenderPass)
 Removes a child render pass. More...
 
void removeChild (size_t index)
 Removes a child render pass. More...
 
void render (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
 Recursively render RenderPass and all of its child render passes. More...
 
void restoreResourcesRecursive ()
 Recursively calls restoreResources for a RenderPass and all its children. More...
 
void setCamera (string_view value)
 Sets the value of the CameraProperty. More...
 
void setEnabled (bool value)
 Sets the value of the EnabledProperty. More...
 
void setHostNode (Node *hostNode)
 Sets the host node of a render pass. More...
 
void setParent (RenderPass *parent)
 Sets the parent of a render pass. More...
 
void setTemplateRoot (RenderPassSharedPtr templateRoot)
 Sets the template root for this render pass. More...
 
 ~RenderPass () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsage () const
 Function for getting the memory usage of a resource. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set. More...
 
void reload ()
 
void reloadFromFile (string_view filePath)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
 ~Resource () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
virtual ~PropertyObject ()
 
- Public Member Functions inherited from kanzi::BindingHostConceptImpl< RenderPass >
void addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
 Adds an already-created binding runtime to this binding host. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot)
 Sets a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding)
 Wrapper for setting a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Sets a binding to a certain property. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding with owner. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a binding with owner. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot)
 Sets a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
 Wrapper for setting a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Sets a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
- Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator beginBindingRuntimes () const
 Returns an iterator to the beginning of binding runtimes. More...
 
BindingRuntimeConstIterator endBindingRuntimes () const
 Returns an iterator to the end of binding runtimes. More...
 
AbstractBindingRuntimeSharedPtr getBindingRuntime (size_t idx)
 Gets binding by index. More...
 
size_t getBindingRuntimeCount () const
 Gets the number of binding runtimes added to this node. More...
 
void removeAllBindings ()
 Removes all binding runtimes. More...
 
void removeBinding (AbstractBindingRuntime &bindingRuntime)
 Removes a binding runtime added earlier. More...
 
void removeBindingsWithOwner (shared_ptr< void > owner)
 Removes all binding runtimes with the specified owner. More...
 

Static Public Member Functions

static CubeMapRenderPassSharedPtr create (Domain *domain, string_view name)
 Create function. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::RenderPass
static RenderPassSharedPtr create (Domain *domain, string_view name)
 Create a render pass. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

 CubeMapRenderPass (Domain *domain, string_view name)
 Constructor. More...
 
void renderOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings) override
 RenderPass::renderOverride() implementation. More...
 
void restoreResources () override
 RenderPass::restoreResources() implementation. More...
 
void updateResultTexture (Renderer3D &renderer)
 Updates the Result Texture to reflect the properties of the node. More...
 
- Protected Member Functions inherited from kanzi::RenderPass
CameraacquireCamera (string_view relativePath) const
 Acquires a Camera node based on the value of the Camera property. More...
 
CompositionRequirements combineChildCompositionRequirements (CompositionRequirements requirements)
 Iterates the children for composition requirements. More...
 
CompositionRequirements getChildCompositionRequirements ()
 Iterates the children for composition requirements. More...
 
virtual void onAttached ()
 Called when a render pass becomes attached. More...
 
virtual void onDetached ()
 Called when a render pass becomes detached. More...
 
void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Object::onPropertyChanged() implementation. More...
 
void renderChildren (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
 Render all child render passes of a render pass. More...
 
virtual void renderChildrenOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
 Implementation-dependent rendering of all child render passes of a render pass. More...
 
 RenderPass (Domain *domain, string_view name)
 Constructor. More...
 
template<typename T >
void updatePropertyValueSourceAndNotify (AbstractPropertyType propertyType, typename PropertyType< T >::Descriptor::TypedValueSource &valueSource, const T &value)
 Updates the local value of a property in a Draw Objects Render Pass. More...
 
- Protected Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsageOverride () const
 
virtual void reloadFromFileOverride (string_view filePath)
 
virtual void reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
virtual void reloadOverride ()
 
 Resource (Domain *domain, string_view name)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
- Protected Member Functions inherited from kanzi::BindingHostConceptImpl< RenderPass >
BindingTargetRuntimePtr createModifierBindingTarget (shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Creates a property modifier binding target for given combination of property type and field. More...
 
BindingTargetRuntimePtr createValueSourceBindingTarget (shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence, bool reuseAllowed)
 Creates a value source binding target for given combination of property type and field. More...
 
RenderPassgetThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
const RenderPassgetThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
- Protected Member Functions inherited from kanzi::BindingHostConcept
void attachBindings ()
 Attach all bindings stored in this object. More...
 
void detachBindings ()
 Detach bindings. More...
 

Properties

static PropertyType< ResourceSharedPtrCompositionTargetProperty
 Use the Composition Target property to set the target to which you want to render the result of this render pass. More...
 
static PropertyType< ResourceSharedPtrResultTextureProperty
 Use the Result Texture property to fetch the texture to which this CubeMapRenderPass is rendered. More...
 
static PropertyType< ResourceSharedPtrResultDepthTextureProperty
 Use the Result Depth Texture property to fetch the cubemap depth texture to which this CubeMapRenderPass renders its content. More...
 
static PropertyType< int > ResolutionProperty
 Use the Resolution property to set the dimensions of the automatically created composition cubemap target textures. More...
 
static PropertyType< GraphicsFormatPixelFormatProperty
 Use the Pixel Format property to set on the GPU the target pixel format of the automatically created composition target textures. More...
 
static PropertyType< GraphicsFormatDepthFormatProperty
 Use the Depth Format property to define the format of the depth texture. More...
 
static PropertyType< GraphicsCompareFunctionDepthCompareFunctionProperty
 Use the Depth Compare Function property to set the function that you want to use when comparing depth values with comparison samplers. More...
 
static PropertyType< Sampler::FilterFilterModeProperty
 Use the Filter Mode property to set how texels are sampled when using the composition target as a texture: More...
 
static PropertyType< Sampler::MipmapModeMipmapModeProperty
 Use the MipmapMode property to set how mipmaps are generated for the composition target. More...
 
static PropertyType< bool > ResolveImmediatelyProperty
 Sets whether the Cubemap Render Pass generates mipmaps immediately after rendering. More...
 
static PropertyType< string > OverrideCameraProperty
 Use the Override Camera property to set a camera to use for rendering. This camera overrides the default camera. More...
 
TextureSharedPtr getCompositionTarget () const
 Gets the value of the CompositionTargetProperty property. More...
 
void setCompositionTarget (TextureSharedPtr value)
 Sets the value of the CompositionTargetProperty property. More...
 
TextureSharedPtr getResultTexture () const
 Gets the value of the ResultTextureProperty property. More...
 
void setResultTexture (TextureSharedPtr value)
 Sets the value of the ResultTextureProperty property. More...
 
TextureSharedPtr getResultDepthTexture () const
 Gets the value of the ResultDepthTextureProperty property. More...
 
void setResultDepthTexture (TextureSharedPtr value)
 Sets the value of the ResultTextureProperty property. More...
 
void setResolution (int value)
 Sets the value of the ResolutionProperty property. More...
 
int getResolution () const
 Gets the value of the ResolutionProperty property. More...
 
GraphicsFormat getPixelFormat () const
 Gets the value of the PixelFormatProperty property. More...
 
void setPixelFormat (GraphicsFormat value)
 Sets the value of the PixelFormatProperty property. More...
 
GraphicsFormat getDepthTextureFormat () const
 Gets the value of the DepthFormatProperty. More...
 
void setDepthTextureFormat (GraphicsFormat value)
 Sets the value of the DepthFormatProperty. More...
 
GraphicsCompareFunction getDepthCompareFunction () const
 Gets the value of the DepthCompareFunctionProperty. More...
 
void setDepthCompareFunction (GraphicsCompareFunction value)
 Sets the value of the DepthCompareFunctionProperty. More...
 
Sampler::Filter getFilterMode () const
 Gets the value of the FilterModeProperty. More...
 
void setFilterMode (Sampler::Filter value)
 Sets the value of the FilterModeProperty. More...
 
Sampler::MipmapMode getMipmapMode () const
 Gets the value of the MipmapModeProperty. More...
 
void setMipmapMode (Sampler::MipmapMode value)
 Sets the value of the MipmapModeProperty. More...
 
bool isResolveImmediately () const
 Returns the value of the ResolveImmediatelyProperty. More...
 
void setResolveImmediately (bool value)
 Sets the value of the ResolveImmediatelyProperty. More...
 
string getOverrideCamera () const
 Gets the value of the OverrideCameraProperty property. More...
 
void setOverrideCamera (string_view value)
 Sets the value of the OverrideCameraProperty property. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::RenderPass
enum  AttachmentState { Detached, Detaching, Attaching, Attached }
 Attachment state for keeping track current status. More...
 
typedef BindingRuntimeContainer::const_iterator BindingRuntimeConstIterator
 Const iterator type for binding runtime container. More...
 
typedef vector< AbstractBindingRuntimeSharedPtrBindingRuntimeContainer
 Container type for binding runtimes. More...
 
typedef BindingRuntimeContainer::iterator BindingRuntimeIterator
 Iterator type for binding runtime container. More...
 
using CameraSettingsPtr = unique_ptr< CameraSettings >
 Camera settings unique pointer type. More...
 
typedef ChildContainer::const_iterator ChildConstIterator
 Child container iterator type. More...
 
typedef vector< RenderPassSharedPtrChildContainer
 Container type for children. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Types inherited from kanzi::BindingHostConcept
using BindingHostConceptSharedPtr = shared_ptr< BindingHostConcept >
 Binding host concept shared pointer type. More...
 
using BindingRuntimeConstIterator = BindingRuntimeContainer::const_iterator
 Const iterator for binding runtimes. More...
 
using BindingRuntimeContainer = vector< AbstractBindingRuntimeSharedPtr >
 Container for binding runtimes. More...
 
using BindingRuntimeIterator = BindingRuntimeContainer::iterator
 Iterator for binding runtimes. More...
 
- Static Public Attributes inherited from kanzi::RenderPass
static PropertyType< string > CameraProperty
 Sets the Camera node that you want this render pass to use to render content. More...
 
static PropertyType< bool > EnabledProperty
 Use the Enabled property to turn render passes and render pass trees on or off. More...
 
static PropertyType< Vector4InputViewportAreaProperty
 Reports the size of the Viewport 2D that uses this render pass. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::RenderPass
AttachmentState m_attachmentState
 Render pass attachment state. More...
 
ChildContainer m_children
 Child render passes. More...
 
bool m_enabled
 Render pass enabled state. More...
 
Nodem_hostNode
 Pointer to host node this render pass is attached under. More...
 
PropertyType< Vector4 >::Descriptor::TypedValueSource m_inputViewportAreaValueSource
 Value source for the input viewport area property. More...
 
RenderPassm_parent
 Pointer to parent render pass. More...
 
weak_ptr< RenderPassm_templateRoot
 Weak pointer to template root object of this render pass. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 
- Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer m_bindingRuntimes
 Bindings in this object. More...
 

Detailed Description

Use the Cubemap Render Pass to create a cubemap texture that represents the scene from some location.

You can use the generated cubemap as a cubemap texture. For example, use this approach to create environment maps for a scene.

The Cubemap Render Pass is similar to the CompositionTargetRenderPass, except that the Cubemap Render Pass sets each face of a cubemap as the composition target before rendering the descendant render passes.

Configuring the cubemap

Cubemap Render Pass creates a cubemap by default, if the CompositionTargetProperty property is not set. The attributes of the generated cubemap are derived from these properties of the CubeMapRenderPass:

To explicitly set the cubemap target, use the CompositionTargetProperty property.

Accessing the composition result

To access the composition result, use the ResultTextureProperty property.

If the value of the CompositionTargetProperty property is set, the ResultTextureProperty property gets that value. If the CompositionTargetProperty is null, the cubemap render pass creates a result texture based on the values of the ResolutionProperty, PixelFormatProperty, FilterModeProperty, and MipmapModeProperty properties.

When getting the output, always bind to or get the value of the ResultTextureProperty property.

Examples

To create and use a Cubemap Render Pass:

// Create a Cubemap Render Pass.
CubeMapRenderPassSharedPtr cubeMapRenderPass = CubeMapRenderPass::create(domain, "cubemap");
// In the Cubemap Render Pass create a Blit Render Pass that runs once per each face of the cubemap.
cubeMapRenderPass->addChild(blit);
CameraSharedPtr camera = Camera::create(domain, "camera");
m_scene->addChild(camera);
m_scene->setCamera(camera);
m_viewportLayer->setRenderPass(cubeMapRenderPass);
m_viewportLayer->setOpacity(0.9f);
Since
Kanzi 3.8.0

Constructor & Destructor Documentation

◆ CubeMapRenderPass()

kanzi::CubeMapRenderPass::CubeMapRenderPass ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Member Function Documentation

◆ getCompositionTarget()

TextureSharedPtr kanzi::CubeMapRenderPass::getCompositionTarget ( ) const
inline

Gets the value of the CompositionTargetProperty property.

Returns
The value of the Composition Target property.
See also
setCompositionTarget()

◆ setCompositionTarget()

void kanzi::CubeMapRenderPass::setCompositionTarget ( TextureSharedPtr  value)
inline

Sets the value of the CompositionTargetProperty property.

Parameters
valueThe new value of the Composition Target property.
See also
getCompositionTarget()

◆ getResultTexture()

TextureSharedPtr kanzi::CubeMapRenderPass::getResultTexture ( ) const
inline

Gets the value of the ResultTextureProperty property.

Returns
The value of the Result Texture property.
See also
setResultTexture()

◆ setResultTexture()

void kanzi::CubeMapRenderPass::setResultTexture ( TextureSharedPtr  value)
inline

Sets the value of the ResultTextureProperty property.

Parameters
valueThe new value of the Result Texture property.
See also
getResultTexture()

◆ getResultDepthTexture()

TextureSharedPtr kanzi::CubeMapRenderPass::getResultDepthTexture ( ) const
inline

Gets the value of the ResultDepthTextureProperty property.

Returns
The value of the Result Depth Texture property.
See also
setResultDepthTexture()

◆ setResultDepthTexture()

void kanzi::CubeMapRenderPass::setResultDepthTexture ( TextureSharedPtr  value)
inline

Sets the value of the ResultTextureProperty property.

Parameters
valueThe new value of the Result Depth Texture property.
See also
getResultDepthTexture()

◆ setResolution()

void kanzi::CubeMapRenderPass::setResolution ( int  value)
inline

Sets the value of the ResolutionProperty property.

Parameters
valueThe new value of the Resolution property.
See also
getResolution()

◆ getResolution()

int kanzi::CubeMapRenderPass::getResolution ( ) const
inline

Gets the value of the ResolutionProperty property.

Returns
The value of the Resolution property.
See also
setResolution()

◆ getPixelFormat()

GraphicsFormat kanzi::CubeMapRenderPass::getPixelFormat ( ) const
inline

Gets the value of the PixelFormatProperty property.

Returns
The value of the Pixel Format property.
See also
setPixelFormat()

◆ setPixelFormat()

void kanzi::CubeMapRenderPass::setPixelFormat ( GraphicsFormat  value)
inline

Sets the value of the PixelFormatProperty property.

Parameters
valueThe new value of the Pixel Format property.
See also
getPixelFormat()

◆ getDepthTextureFormat()

GraphicsFormat kanzi::CubeMapRenderPass::getDepthTextureFormat ( ) const
inline

Gets the value of the DepthFormatProperty.

Returns
The value of the Depth Format property.

◆ setDepthTextureFormat()

void kanzi::CubeMapRenderPass::setDepthTextureFormat ( GraphicsFormat  value)
inline

Sets the value of the DepthFormatProperty.

Parameters
valueThe new value of the Depth Format property.

◆ getDepthCompareFunction()

GraphicsCompareFunction kanzi::CubeMapRenderPass::getDepthCompareFunction ( ) const
inline

Gets the value of the DepthCompareFunctionProperty.

Returns
The value of the Depth Compare Function property.

◆ setDepthCompareFunction()

void kanzi::CubeMapRenderPass::setDepthCompareFunction ( GraphicsCompareFunction  value)
inline

Sets the value of the DepthCompareFunctionProperty.

Parameters
valueThe value of the Depth Compare Function property.

◆ getFilterMode()

Sampler::Filter kanzi::CubeMapRenderPass::getFilterMode ( ) const
inline

Gets the value of the FilterModeProperty.

Returns
The value of the Filter Mode property.

◆ setFilterMode()

void kanzi::CubeMapRenderPass::setFilterMode ( Sampler::Filter  value)
inline

Sets the value of the FilterModeProperty.

Parameters
valueThe new value of the Filter Mode property.

◆ getMipmapMode()

Sampler::MipmapMode kanzi::CubeMapRenderPass::getMipmapMode ( ) const
inline

Gets the value of the MipmapModeProperty.

Returns
The value of the Mipmap Mode property.

◆ setMipmapMode()

void kanzi::CubeMapRenderPass::setMipmapMode ( Sampler::MipmapMode  value)
inline

Sets the value of the MipmapModeProperty.

Parameters
valueThe new value of the Mipmap Mode property.

◆ isResolveImmediately()

bool kanzi::CubeMapRenderPass::isResolveImmediately ( ) const
inline

Returns the value of the ResolveImmediatelyProperty.

Returns
The value of the ResolveImmediatelyProperty.
Since
Kanzi 3.9.0

◆ setResolveImmediately()

void kanzi::CubeMapRenderPass::setResolveImmediately ( bool  value)
inline

Sets the value of the ResolveImmediatelyProperty.

Parameters
valueThe value of the ResolveImmediatelyProperty to set.
Since
Kanzi 3.9.0

◆ getOverrideCamera()

string kanzi::CubeMapRenderPass::getOverrideCamera ( ) const
inline

Gets the value of the OverrideCameraProperty property.

See also
setOverrideCamera()

◆ setOverrideCamera()

void kanzi::CubeMapRenderPass::setOverrideCamera ( string_view  value)
inline

Sets the value of the OverrideCameraProperty property.

See also
getOverrideCamera()

◆ KZ_METACLASS_END()

kanzi::CubeMapRenderPass::KZ_METACLASS_END ( )

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::CubeMapRenderPass::makeEditorInfo ( )
static

◆ create()

static CubeMapRenderPassSharedPtr kanzi::CubeMapRenderPass::create ( Domain domain,
string_view  name 
)
static

Create function.

◆ renderOverride()

void kanzi::CubeMapRenderPass::renderOverride ( Renderer3D renderer,
CompositionStack compositionStack,
const CameraSettings cameraSettings 
)
overrideprotectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

◆ updateResultTexture()

void kanzi::CubeMapRenderPass::updateResultTexture ( Renderer3D renderer)
protected

Updates the Result Texture to reflect the properties of the node.

This function first attempts to use the Composition Target. If that fails, it uses the ResolutionProperty, PixelFormatProperty, FilterModeProperty, and MipmapModeProperty properties to generate a new texture.

Parameters
rendererRenderer used for validating cube map settings.

◆ restoreResources()

void kanzi::CubeMapRenderPass::restoreResources ( )
overrideprotectedvirtual

RenderPass::restoreResources() implementation.

Reimplemented from kanzi::RenderPass.

Member Data Documentation

◆ CompositionTargetProperty

PropertyType<ResourceSharedPtr> kanzi::CubeMapRenderPass::CompositionTargetProperty
static

Use the Composition Target property to set the target to which you want to render the result of this render pass.

The default value is ResourceSharedPtr().

See also
setCompositionTarget(), getCompositionTarget()

◆ ResultTextureProperty

PropertyType<ResourceSharedPtr> kanzi::CubeMapRenderPass::ResultTextureProperty
static

Use the Result Texture property to fetch the texture to which this CubeMapRenderPass is rendered.

The default value is ResourceSharedPtr().

See also
setResultTexture(), getResultTexture()

◆ ResultDepthTextureProperty

PropertyType<ResourceSharedPtr> kanzi::CubeMapRenderPass::ResultDepthTextureProperty
static

Use the Result Depth Texture property to fetch the cubemap depth texture to which this CubeMapRenderPass renders its content.

The default value is ResourceSharedPtr().

See also
setResultDepthTexture(), getResultDepthTexture()

◆ ResolutionProperty

PropertyType<int> kanzi::CubeMapRenderPass::ResolutionProperty
static

Use the Resolution property to set the dimensions of the automatically created composition cubemap target textures.

The default value is 64.

See also
setResolution(), getResolution()

◆ PixelFormatProperty

PropertyType<GraphicsFormat> kanzi::CubeMapRenderPass::PixelFormatProperty
static

Use the Pixel Format property to set on the GPU the target pixel format of the automatically created composition target textures.

The default value is RGBA.

See also
getPixelFormat(), setPixelFormat()

◆ DepthFormatProperty

PropertyType<GraphicsFormat> kanzi::CubeMapRenderPass::DepthFormatProperty
static

Use the Depth Format property to define the format of the depth texture.

If the Depth Format property is not set, depth texture is not used and, if necessary, depth renderbuffer is used.

◆ DepthCompareFunctionProperty

PropertyType<GraphicsCompareFunction> kanzi::CubeMapRenderPass::DepthCompareFunctionProperty
static

Use the Depth Compare Function property to set the function that you want to use when comparing depth values with comparison samplers.

The default value is kanzi::GraphicsCompareFunctionDisabled.

◆ FilterModeProperty

PropertyType<Sampler::Filter> kanzi::CubeMapRenderPass::FilterModeProperty
static

Use the Filter Mode property to set how texels are sampled when using the composition target as a texture:

◆ MipmapModeProperty

PropertyType<Sampler::MipmapMode> kanzi::CubeMapRenderPass::MipmapModeProperty
static

Use the MipmapMode property to set how mipmaps are generated for the composition target.

◆ ResolveImmediatelyProperty

PropertyType<bool> kanzi::CubeMapRenderPass::ResolveImmediatelyProperty
static

Sets whether the Cubemap Render Pass generates mipmaps immediately after rendering.

To generate the mipmaps later in another Cubemap Render Pass, set this property to false. The default value is true.

Since
Kanzi 3.9.0

◆ OverrideCameraProperty

PropertyType<string> kanzi::CubeMapRenderPass::OverrideCameraProperty
static

Use the Override Camera property to set a camera to use for rendering. This camera overrides the default camera.


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