Render pass passes set of objects to be rendered down to renderer. More...

#include <kanzi/graphics_3d/renderpass.hpp>

Inheritance diagram for kanzi::Renderpass:

Public Member Functions
	Renderpass (Domain *domain, string_view name="")

void	applyBufferSettingsAndCulling (const Renderer3D *userRenderer) const

void	setObjectSource (ObjectSourceSharedPtr objectSource)
	Sets an object source for render pass. More...

KzuObjectSource *	getObjectSource () const
	Gets object source from render pass. More...

void	setColorBuffer (bool clearEnabled, ColorRGBA clearColor, GraphicsColorWriteMode writeMode)
	Sets a color buffer for render pass. More...

void	setDepthBuffer (bool depthClearEnabled, float clearValue, bool depthTestEnabled, bool depthWriteEnabled)
	Sets a depth buffer for render pass. More...

void	setStencilBuffer (bool stencilClearEnabled, unsigned int clearValue, bool stencilTestEnabled, GraphicsStencilOperation stencilModeSfail, GraphicsStencilOperation stencilModeDPfail, GraphicsStencilOperation stencilModeDPpass, GraphicsCompareFunction stencilFunction)
	Sets a stencil buffer for render pass. More...

void	setViewportAbsolute (unsigned int x, unsigned int y, unsigned int width, unsigned int height)
	Sets the view port's size in absolute coordinates (pixels) More...

void	setViewportRelative (float x, float y, float width, float height)
	Sets the view port's size in coordinates relative to screen size (0.f = left, 1.f = right) (0.f = top, 1.f = bottom) More...

void	setRenderOnce (bool renderOnce)
	Sets render pass to state where it gets rendered once and is disabled after that. More...

void	iterateTransformedObjects (Renderer3D renderer, const KzcDynamicArray transformedObjects, Renderer3D::ApplyObjectFunction applyFunction)

virtual void	loadFromKZB (const KzuResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
	Function for loading the resource from .KZB. More...

virtual void	applyOverride (Renderer3D renderer, const TransformedScene3D transformedScene, RenderContextStack &renderContextStack) KZ_OVERRIDE

virtual void	requiresDepthBuffer (bool &out_allowDepthClear, bool &out_requiresDepth) const KZ_OVERRIDE

virtual void	initialize () KZ_OVERRIDE

Public Member Functions inherited from kanzi::Composer
	Composer (Domain *domain, string_view name="")

virtual void	reset ()

void	apply (Renderer3D renderer, const TransformedScene3D transformedScene, RenderContextStack &renderContextStack)

void	setRenderTarget (FramebufferSharedPtr renderTarget)

FramebufferSharedPtr	getRenderTarget () const

ComposerContainer::const_iterator	beginChildren () const

ComposerContainer::const_iterator	endChildren () const

void	addChild (ComposerSharedPtr childComposer)
	Adds a child to composer. More...

void	addChildAtIndex (size_t index, ComposerSharedPtr childComposer)
	Add child composer at given index in parent. More...

void	removeChild (ComposerSharedPtr childComposer)
	Removes a child from composer. More...

void	removeAllChildren ()
	Removes all m_children from composer. More...

ComposerSharedPtr	getChildComposer (size_t index)
	Gets a child composer from composer at given index. If index is out of range 0 is returned. More...

size_t	getChildCount () const
	Returns the amount of render passes in composer. More...

Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () const

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

virtual void	finishLoadingOverride (const KzuResourceLoaderThreadContext *threadContext)
	Function for finishing the loading of the resource. More...

virtual void	unloadOverride ()
	Unload function for resource. More...

virtual kzUint	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

void	setKZB (const KzuBinaryDirectory *binaryDirectory, kzString path)

void	setLoaded ()

kzString	getName () const
	Accessor. More...

void	load ()

void	unload ()

bool	isLoaded () const

void	kzuResourceLoad_private (const KzuResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...

void	kzuResourceFinishLoading_private (const KzuResourceLoaderThreadContext *threadContext)
	Private function for finishing the loading of the resource. More...

KzuResourceLoadingStrategy	getLoadingStrategy () const

void	setLoadingStrategy (KzuResourceLoadingStrategy loadingStrategy)

bool	getKeepAlive () const
	Tells if the resource has keep alive flag set. More...

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

KzuPropertyManager *	getPropertyManager () const
	Returns the property manager of the object. More...

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

virtual const Metaclass *	getDynamicMetaclass () const
	Returns the metaclass of the dynamic type of the object. More...

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
	Sets the local value of a property. More...

void	setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
	Sets the local value of a resource id property with a resource pointer. More...

template<typename DataType >
DataType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

template<typename DataType >
bool	getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)

void	setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)

template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
bool	getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

void	copyLocalValues (const Object &other)
	Copies all local values from another object. More...

virtual void	onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

AppliedStyleEntry *	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)

void	applyObjectStyles ()
	Apply all styles for an object node. More...

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Static Public Member Functions
static RenderpassSharedPtr	create (Domain *domain)

Static Public Member Functions inherited from kanzi::Composer
static ComposerSharedPtr	create (Domain *domain, string_view name="")

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
void	applyCameraAndViewport (const Renderer3D userRenderer, const KzuTransformedObjectNode transformedCameraNode, RenderContextStack &renderContextStack, const KzuViewport viewport, const KzuScissor scissor)

Protected Member Functions inherited from kanzi::Composer
void	applyChildren (Renderer3D renderer, const TransformedScene3D transformedScene, RenderContextStack &renderContextStack)

Protected Member Functions inherited from kanzi::Resource
KzuResourceLoadState	getLoadState ()
	Access. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Static Protected Member Functions
static kzsError	applyLight (KzuTransformedObjectNode transformedObjectNode, Renderer3D renderer)

Properties
static PropertyType< bool >	FlushAfterRenderProperty
	FlushAfterRender property. More...

static PropertyType< float >	ViewportXProperty
	ViewportX property. More...

static PropertyType< float >	ViewportYProperty
	ViewportY property. More...

static PropertyType< float >	ViewportWidthProperty
	ViewportWidth property. More...

static PropertyType< float >	ViewportHeightProperty
	ViewportHeight property. More...

static PropertyType < KzuViewportCoordinateType >	ViewportTypeProperty
	ViewportType property. More...

static PropertyType< string >	RenderPassCameraProperty
	RenderPassCamera property. More...

static PropertyType< ResourceID >	RenderPassObjectSourceProperty
	RenderPassObjectSource property. More...

static PropertyType< ResourceID >	RenderPassMaterialProperty
	RenderPassMaterial property. More...

static PropertyType< ResourceID >	RenderPassRenderTargetProperty
	RenderPassRenderTarget property. More...

static PropertyType< bool >	FrustumCullingOnProperty
	FrustumCullingOn property. More...

static PropertyType < GraphicsCullMode >	CullModeProperty
	CullMode property. More...

static PropertyType< bool >	RenderOnceProperty
	RenderOnce property. More...

static PropertyType< bool >	SortBatchesByShaderProperty
	SortBatchesByShader property. More...

static PropertyType< ColorRGBA >	ColorBufferClearColorProperty
	ColorBufferClearColor property. More...

static PropertyType< bool >	ColorBufferClearEnabledProperty
	ColorBufferClearEnabled property. More...

static PropertyType < GraphicsColorWriteMode >	ColorWriteModeProperty
	ColorWriteMode property. More...

static PropertyType< bool >	DepthBufferClearEnabledProperty
	DepthBufferClearEnabled property. More...

static PropertyType< float >	DepthBufferClearValueProperty
	DepthBufferClearValue property. More...

static PropertyType< bool >	DepthBufferTestEnabledProperty
	DepthBufferTestEnabled property. More...

static PropertyType< bool >	DepthBufferWriteEnabledProperty
	DepthBufferWriteEnabled property. More...

static PropertyType< bool >	StencilBufferClearEnabledProperty
	StencilBufferClearEnabled property. More...

static PropertyType< int >	StencilBufferClearValueProperty
	StencilBufferClearValue property. More...

static PropertyType < GraphicsStencilOperation >	StencilFailOperationProperty
	StencilFailOperation property. More...

static PropertyType < GraphicsStencilOperation >	StencilPassDepthFailOperationProperty
	StencilPassDepthFailOperation property. More...

static PropertyType < GraphicsStencilOperation >	StencilPassDepthPassOperationProperty
	StencilPassDepthPassOperation property. More...

static PropertyType < GraphicsCompareFunction >	StencilFunctionProperty
	StencilFunction property. More...

static PropertyType< int >	StencilFunctionReferenceValueProperty
	StencilFunctionReferenceValue property. More...

static PropertyType< int >	StencilFunctionReferenceMaskProperty
	StencilFunctionReferenceMask property. More...

static PropertyType< bool >	StencilBufferTestEnabledProperty
	StencilBufferTestEnabled property. More...

static PropertyType< bool >	RenderPassScissorEnabledProperty
	RenderPassScissorEnabled property. More...

static PropertyType< float >	RenderPassScissorXProperty
	RenderPassScissorX property. More...

static PropertyType< float >	RenderPassScissorYProperty
	RenderPassScissorY property. More...

static PropertyType< float >	RenderPassScissorWidthProperty
	RenderPassScissorWidth property. More...

static PropertyType< float >	RenderPassScissorHeightProperty
	RenderPassScissorHeight property. More...

static PropertyType < KzuViewportCoordinateType >	RenderPassScissorTypeProperty
	RenderPassScissorType property. More...

static PropertyType< bool >	ComposerEnabledProperty
	ComposerEnabled property. More...

bool	isFlushAfterRender () const
	Gets the value of FlushAfterRenderProperty. More...

void	setFlushAfterRender (bool value)
	Sets the value of FlushAfterRenderProperty. More...

float	getViewportX () const
	Gets the value of ViewportXProperty. More...

void	setViewportX (float value)
	Sets the value of ViewportXProperty. More...

float	getViewportY () const
	Gets the value of ViewportYProperty. More...

void	setViewportY (float value)
	Sets the value of ViewportYProperty. More...

float	getViewportWidth () const
	Gets the value of ViewportWidthProperty. More...

void	setViewportWidth (float value)
	Sets the value of ViewportWidthProperty. More...

float	getViewportHeight () const
	Gets the value of ViewportHeightProperty. More...

void	setViewportHeight (float value)
	Sets the value of ViewportHeightProperty. More...

KzuViewportCoordinateType	getViewportType () const
	Gets the value of ViewportTypeProperty. More...

void	setViewportType (KzuViewportCoordinateType value)
	Sets the value of ViewportTypeProperty. More...

string	getRenderPassCamera () const
	Gets the value of RenderPassCameraProperty. More...

void	setRenderPassCamera (string value)
	Sets the value of RenderPassCameraProperty. More...

ResourceID	getRenderPassObjectSourceResourceID () const
	Gets the value of RenderPassObjectSourceProperty. More...

void	setRenderPassObjectSourceResourceID (ResourceID value)
	Sets the value of RenderPassObjectSourceProperty. More...

ResourceID	getRenderPassMaterialResourceID () const
	Gets the value of RenderPassMaterialProperty. More...

void	setRenderPassMaterialResourceID (ResourceID value)
	Sets the value of RenderPassMaterialProperty. More...

ResourceID	getRenderPassRenderTargetResourceID () const
	Gets the value of RenderPassRenderTargetProperty. More...

void	setRenderPassRenderTargetResourceID (ResourceID value)
	Sets the value of RenderPassRenderTargetProperty. More...

bool	isFrustumCullingOn () const
	Gets the value of FrustumCullingOnProperty. More...

void	setFrustumCullingOn (bool value)
	Sets the value of FrustumCullingOnProperty. More...

GraphicsCullMode	getCullMode () const
	Gets the value of CullModeProperty. More...

void	setCullMode (GraphicsCullMode value)
	Sets the value of CullModeProperty. More...

bool	isSortBatchesByShader () const
	Gets the value of SortBatchesByShaderProperty. More...

void	setSortBatchesByShader (bool value)
	Sets the value of SortBatchesByShaderProperty. More...

ColorRGBA	getColorBufferClearColor () const
	Gets the value of ColorBufferClearColorProperty. More...

void	setColorBufferClearColor (ColorRGBA value)
	Sets the value of ColorBufferClearColorProperty. More...

bool	isColorBufferClearEnabled () const
	Gets the value of ColorBufferClearEnabledProperty. More...

void	setColorBufferClearEnabled (bool value)
	Sets the value of ColorBufferClearEnabledProperty. More...

GraphicsColorWriteMode	getColorWriteMode () const
	Gets the value of ColorWriteModeProperty. More...

void	setColorWriteMode (GraphicsColorWriteMode value)
	Sets the value of ColorWriteModeProperty. More...

bool	isDepthBufferClearEnabled () const
	Gets the value of DepthBufferClearEnabledProperty. More...

void	setDepthBufferClearEnabled (bool value)
	Sets the value of DepthBufferClearEnabledProperty. More...

float	getDepthBufferClearValue () const
	Gets the value of DepthBufferClearValueProperty. More...

void	setDepthBufferClearValue (float value)
	Sets the value of DepthBufferClearValueProperty. More...

bool	isDepthBufferTestEnabled () const
	Gets the value of DepthBufferTestEnabledProperty. More...

void	setDepthBufferTestEnabled (bool value)
	Sets the value of DepthBufferTestEnabledProperty. More...

bool	isDepthBufferWriteEnabled () const
	Gets the value of DepthBufferWriteEnabledProperty. More...

void	setDepthBufferWriteEnabled (bool value)
	Sets the value of DepthBufferWriteEnabledProperty. More...

bool	isStencilBufferClearEnabled () const
	Gets the value of StencilBufferClearEnabledProperty. More...

void	setStencilBufferClearEnabled (bool value)
	Sets the value of StencilBufferClearEnabledProperty. More...

int	getStencilBufferClearValue () const
	Gets the value of StencilBufferClearValueProperty. More...

void	setStencilBufferClearValue (int value)
	Sets the value of StencilBufferClearValueProperty. More...

GraphicsStencilOperation	getStencilFailOperation () const
	Gets the value of StencilFailOperationProperty. More...

void	setStencilFailOperation (GraphicsStencilOperation value)
	Sets the value of StencilFailOperationProperty. More...

GraphicsStencilOperation	getStencilPassDepthFailOperation () const
	Gets the value of StencilPassDepthFailOperationProperty. More...

void	setStencilPassDepthFailOperation (GraphicsStencilOperation value)
	Sets the value of StencilPassDepthFailOperationProperty. More...

GraphicsStencilOperation	getStencilPassDepthPassOperation () const
	Gets the value of StencilPassDepthPassOperationProperty. More...

void	setStencilPassDepthPassOperation (GraphicsStencilOperation value)
	Sets the value of StencilPassDepthPassOperationProperty. More...

GraphicsCompareFunction	getStencilFunction () const
	Gets the value of StencilFunctionProperty. More...

void	setStencilFunction (GraphicsCompareFunction value)
	Sets the value of StencilFunctionProperty. More...

int	getStencilFunctionReferenceValue () const
	Gets the value of StencilFunctionReferenceValueProperty. More...

void	setStencilFunctionReferenceValue (int value)
	Sets the value of StencilFunctionReferenceValueProperty. More...

int	getStencilFunctionReferenceMask () const
	Gets the value of StencilFunctionReferenceMaskProperty. More...

void	setStencilFunctionReferenceMask (int value)
	Sets the value of StencilFunctionReferenceMaskProperty. More...

bool	isStencilBufferTestEnabled () const
	Gets the value of StencilBufferTestEnabledProperty. More...

void	setStencilBufferTestEnabled (bool value)
	Sets the value of StencilBufferTestEnabledProperty. More...

bool	isRenderPassScissorEnabled () const
	Gets the value of RenderPassScissorEnabledProperty. More...

void	setRenderPassScissorEnabled (bool value)
	Sets the value of RenderPassScissorEnabledProperty. More...

float	getRenderPassScissorX () const
	Gets the value of RenderPassScissorXProperty. More...

void	setRenderPassScissorX (float value)
	Sets the value of RenderPassScissorXProperty. More...

float	getRenderPassScissorY () const
	Gets the value of RenderPassScissorYProperty. More...

void	setRenderPassScissorY (float value)
	Sets the value of RenderPassScissorYProperty. More...

float	getRenderPassScissorWidth () const
	Gets the value of RenderPassScissorWidthProperty. More...

void	setRenderPassScissorWidth (float value)
	Sets the value of RenderPassScissorWidthProperty. More...

float	getRenderPassScissorHeight () const
	Gets the value of RenderPassScissorHeightProperty. More...

void	setRenderPassScissorHeight (float value)
	Sets the value of RenderPassScissorHeightProperty. More...

KzuViewportCoordinateType	getRenderPassScissorType () const
	Gets the value of RenderPassScissorTypeProperty. More...

void	setRenderPassScissorType (KzuViewportCoordinateType value)
	Sets the value of RenderPassScissorTypeProperty. More...

bool	isComposerEnabled () const
	Gets the value of ComposerEnabledProperty. More...

void	setComposerEnabled (bool value)
	Sets the value of ComposerEnabledProperty. More...

Additional Inherited Members
Public Types inherited from kanzi::Composer
typedef vector< ComposerSharedPtr >	ComposerContainer

Protected Types inherited from kanzi::Object
typedef vector < AppliedStyleEntry * >	AppliedStyleContainer
	Applied style container. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Render pass passes set of objects to be rendered down to renderer.

Rendering attributes are selected from render pass properties, that includes view port, clear color, depth & stencil buffer and other characteristics.

Constructor & Destructor Documentation

kanzi::Renderpass::Renderpass	(	Domain *	domain,
		string_view	name = `""`
	)

explicit

Member Function Documentation

bool kanzi::Renderpass::isFlushAfterRender ( ) const

inline

Gets the value of FlushAfterRenderProperty.

See also: setFlushAfterRender()

void kanzi::Renderpass::setFlushAfterRender ( bool value )

inline

Sets the value of FlushAfterRenderProperty.

See also: isFlushAfterRender()

float kanzi::Renderpass::getViewportX ( ) const

inline

Gets the value of ViewportXProperty.

See also: setViewportX()

void kanzi::Renderpass::setViewportX ( float value )

inline

Sets the value of ViewportXProperty.

See also: getViewportX()

float kanzi::Renderpass::getViewportY ( ) const

inline

Gets the value of ViewportYProperty.

See also: setViewportY()

void kanzi::Renderpass::setViewportY ( float value )

inline

Sets the value of ViewportYProperty.

See also: getViewportY()

float kanzi::Renderpass::getViewportWidth ( ) const

inline

Gets the value of ViewportWidthProperty.

See also: setViewportWidth()

void kanzi::Renderpass::setViewportWidth ( float value )

inline

Sets the value of ViewportWidthProperty.

See also: getViewportWidth()

float kanzi::Renderpass::getViewportHeight ( ) const

inline

Gets the value of ViewportHeightProperty.

See also: setViewportHeight()

void kanzi::Renderpass::setViewportHeight ( float value )

inline

Sets the value of ViewportHeightProperty.

See also: getViewportHeight()

KzuViewportCoordinateType kanzi::Renderpass::getViewportType ( ) const

inline

Gets the value of ViewportTypeProperty.

See also: setViewportType()

void kanzi::Renderpass::setViewportType ( KzuViewportCoordinateType value )

inline

Sets the value of ViewportTypeProperty.

See also: getViewportType()

string kanzi::Renderpass::getRenderPassCamera ( ) const

inline

Gets the value of RenderPassCameraProperty.

See also: setRenderPassCamera()

void kanzi::Renderpass::setRenderPassCamera ( string value )

inline

Sets the value of RenderPassCameraProperty.

See also: getRenderPassCamera()

ResourceID kanzi::Renderpass::getRenderPassObjectSourceResourceID ( ) const

inline

Gets the value of RenderPassObjectSourceProperty.

See also: setRenderPassObjectSourceResourceID()

void kanzi::Renderpass::setRenderPassObjectSourceResourceID ( ResourceID value )

inline

Sets the value of RenderPassObjectSourceProperty.

See also: getRenderPassObjectSourceResourceID()

ResourceID kanzi::Renderpass::getRenderPassMaterialResourceID ( ) const

inline

Gets the value of RenderPassMaterialProperty.

See also: setRenderPassMaterialResourceID()

void kanzi::Renderpass::setRenderPassMaterialResourceID ( ResourceID value )

inline

Sets the value of RenderPassMaterialProperty.

See also: getRenderPassMaterialResourceID()

ResourceID kanzi::Renderpass::getRenderPassRenderTargetResourceID ( ) const

inline

Gets the value of RenderPassRenderTargetProperty.

See also: setRenderPassRenderTargetResourceID()

void kanzi::Renderpass::setRenderPassRenderTargetResourceID ( ResourceID value )

inline

Sets the value of RenderPassRenderTargetProperty.

See also: getRenderPassRenderTargetResourceID()

bool kanzi::Renderpass::isFrustumCullingOn ( ) const

inline

Gets the value of FrustumCullingOnProperty.

See also: setFrustumCullingOn()

void kanzi::Renderpass::setFrustumCullingOn ( bool value )

inline

Sets the value of FrustumCullingOnProperty.

See also: isFrustumCullingOn()

GraphicsCullMode kanzi::Renderpass::getCullMode ( ) const

inline

Gets the value of CullModeProperty.

See also: setCullMode()

void kanzi::Renderpass::setCullMode ( GraphicsCullMode value )

inline

Sets the value of CullModeProperty.

See also: getCullMode()

bool kanzi::Renderpass::isSortBatchesByShader ( ) const

inline

Gets the value of SortBatchesByShaderProperty.

See also: setSortBatchesByShader()

void kanzi::Renderpass::setSortBatchesByShader ( bool value )

inline

Sets the value of SortBatchesByShaderProperty.

See also: isSortBatchesByShader()

ColorRGBA kanzi::Renderpass::getColorBufferClearColor ( ) const

inline

Gets the value of ColorBufferClearColorProperty.

See also: setColorBufferClearColor()

void kanzi::Renderpass::setColorBufferClearColor ( ColorRGBA value )

inline

Sets the value of ColorBufferClearColorProperty.

See also: getColorBufferClearColor()

bool kanzi::Renderpass::isColorBufferClearEnabled ( ) const

inline

Gets the value of ColorBufferClearEnabledProperty.

See also: setColorBufferClearEnabled()

void kanzi::Renderpass::setColorBufferClearEnabled ( bool value )

inline

Sets the value of ColorBufferClearEnabledProperty.

See also: isColorBufferClearEnabled()

GraphicsColorWriteMode kanzi::Renderpass::getColorWriteMode ( ) const

inline

Gets the value of ColorWriteModeProperty.

See also: setColorWriteMode()

void kanzi::Renderpass::setColorWriteMode ( GraphicsColorWriteMode value )

inline

Sets the value of ColorWriteModeProperty.

See also: getColorWriteMode()

bool kanzi::Renderpass::isDepthBufferClearEnabled ( ) const

inline

Gets the value of DepthBufferClearEnabledProperty.

See also: setDepthBufferClearEnabled()

void kanzi::Renderpass::setDepthBufferClearEnabled ( bool value )

inline

Sets the value of DepthBufferClearEnabledProperty.

See also: isDepthBufferClearEnabled()

float kanzi::Renderpass::getDepthBufferClearValue ( ) const

inline

Gets the value of DepthBufferClearValueProperty.

See also: setDepthBufferClearValue()

void kanzi::Renderpass::setDepthBufferClearValue ( float value )

inline

Sets the value of DepthBufferClearValueProperty.

See also: getDepthBufferClearValue()

bool kanzi::Renderpass::isDepthBufferTestEnabled ( ) const

inline

Gets the value of DepthBufferTestEnabledProperty.

See also: setDepthBufferTestEnabled()

void kanzi::Renderpass::setDepthBufferTestEnabled ( bool value )

inline

Sets the value of DepthBufferTestEnabledProperty.

See also: isDepthBufferTestEnabled()

bool kanzi::Renderpass::isDepthBufferWriteEnabled ( ) const

inline

Gets the value of DepthBufferWriteEnabledProperty.

See also: setDepthBufferWriteEnabled()

void kanzi::Renderpass::setDepthBufferWriteEnabled ( bool value )

inline

Sets the value of DepthBufferWriteEnabledProperty.

See also: isDepthBufferWriteEnabled()

bool kanzi::Renderpass::isStencilBufferClearEnabled ( ) const

inline

Gets the value of StencilBufferClearEnabledProperty.

See also: setStencilBufferClearEnabled()

void kanzi::Renderpass::setStencilBufferClearEnabled ( bool value )

inline

Sets the value of StencilBufferClearEnabledProperty.

See also: isStencilBufferClearEnabled()

int kanzi::Renderpass::getStencilBufferClearValue ( ) const

inline

Gets the value of StencilBufferClearValueProperty.

See also: setStencilBufferClearValue()

void kanzi::Renderpass::setStencilBufferClearValue ( int value )

inline

Sets the value of StencilBufferClearValueProperty.

See also: getStencilBufferClearValue()

GraphicsStencilOperation kanzi::Renderpass::getStencilFailOperation ( ) const

inline

Gets the value of StencilFailOperationProperty.

See also: setStencilFailOperation()

void kanzi::Renderpass::setStencilFailOperation ( GraphicsStencilOperation value )

inline

Sets the value of StencilFailOperationProperty.

See also: getStencilFailOperation()

GraphicsStencilOperation kanzi::Renderpass::getStencilPassDepthFailOperation ( ) const

inline

Gets the value of StencilPassDepthFailOperationProperty.

See also: setStencilPassDepthFailOperation()

void kanzi::Renderpass::setStencilPassDepthFailOperation ( GraphicsStencilOperation value )

inline

Sets the value of StencilPassDepthFailOperationProperty.

See also: getStencilPassDepthFailOperation()

GraphicsStencilOperation kanzi::Renderpass::getStencilPassDepthPassOperation ( ) const

inline

Gets the value of StencilPassDepthPassOperationProperty.

See also: setStencilPassDepthPassOperation()

void kanzi::Renderpass::setStencilPassDepthPassOperation ( GraphicsStencilOperation value )

inline

Sets the value of StencilPassDepthPassOperationProperty.

See also: getStencilPassDepthPassOperation()

GraphicsCompareFunction kanzi::Renderpass::getStencilFunction ( ) const

inline

Gets the value of StencilFunctionProperty.

See also: setStencilFunction()

void kanzi::Renderpass::setStencilFunction ( GraphicsCompareFunction value )

inline

Sets the value of StencilFunctionProperty.

See also: getStencilFunction()

int kanzi::Renderpass::getStencilFunctionReferenceValue ( ) const

inline

Gets the value of StencilFunctionReferenceValueProperty.

See also: setStencilFunctionReferenceValue()

void kanzi::Renderpass::setStencilFunctionReferenceValue ( int value )

inline

Sets the value of StencilFunctionReferenceValueProperty.

See also: getStencilFunctionReferenceValue()

int kanzi::Renderpass::getStencilFunctionReferenceMask ( ) const

inline

Gets the value of StencilFunctionReferenceMaskProperty.

See also: setStencilFunctionReferenceMask()

void kanzi::Renderpass::setStencilFunctionReferenceMask ( int value )

inline

Sets the value of StencilFunctionReferenceMaskProperty.

See also: getStencilFunctionReferenceMask()

bool kanzi::Renderpass::isStencilBufferTestEnabled ( ) const

inline

Gets the value of StencilBufferTestEnabledProperty.

See also: setStencilBufferTestEnabled()

void kanzi::Renderpass::setStencilBufferTestEnabled ( bool value )

inline

Sets the value of StencilBufferTestEnabledProperty.

See also: isStencilBufferTestEnabled()

bool kanzi::Renderpass::isRenderPassScissorEnabled ( ) const

inline

Gets the value of RenderPassScissorEnabledProperty.

See also: setRenderPassScissorEnabled()

void kanzi::Renderpass::setRenderPassScissorEnabled ( bool value )

inline

Sets the value of RenderPassScissorEnabledProperty.

See also: isRenderPassScissorEnabled()

float kanzi::Renderpass::getRenderPassScissorX ( ) const

inline

Gets the value of RenderPassScissorXProperty.

See also: setRenderPassScissorX()

void kanzi::Renderpass::setRenderPassScissorX ( float value )

inline

Sets the value of RenderPassScissorXProperty.

See also: getRenderPassScissorX()

float kanzi::Renderpass::getRenderPassScissorY ( ) const

inline

Gets the value of RenderPassScissorYProperty.

See also: setRenderPassScissorY()

void kanzi::Renderpass::setRenderPassScissorY ( float value )

inline

Sets the value of RenderPassScissorYProperty.

See also: getRenderPassScissorY()

float kanzi::Renderpass::getRenderPassScissorWidth ( ) const

inline

Gets the value of RenderPassScissorWidthProperty.

See also: setRenderPassScissorWidth()

void kanzi::Renderpass::setRenderPassScissorWidth ( float value )

inline

Sets the value of RenderPassScissorWidthProperty.

See also: getRenderPassScissorWidth()

float kanzi::Renderpass::getRenderPassScissorHeight ( ) const

inline

Gets the value of RenderPassScissorHeightProperty.

See also: setRenderPassScissorHeight()

void kanzi::Renderpass::setRenderPassScissorHeight ( float value )

inline

Sets the value of RenderPassScissorHeightProperty.

See also: getRenderPassScissorHeight()

KzuViewportCoordinateType kanzi::Renderpass::getRenderPassScissorType ( ) const

inline

Gets the value of RenderPassScissorTypeProperty.

See also: setRenderPassScissorType()

void kanzi::Renderpass::setRenderPassScissorType ( KzuViewportCoordinateType value )

inline

Sets the value of RenderPassScissorTypeProperty.

See also: getRenderPassScissorType()

bool kanzi::Renderpass::isComposerEnabled ( ) const

inline

Gets the value of ComposerEnabledProperty.

See also: setComposerEnabled()

void kanzi::Renderpass::setComposerEnabled ( bool value )

inline

Sets the value of ComposerEnabledProperty.

See also: isComposerEnabled()

static RenderpassSharedPtr kanzi::Renderpass::create ( Domain * domain )

static

void kanzi::Renderpass::applyBufferSettingsAndCulling ( const Renderer3D * userRenderer ) const

void kanzi::Renderpass::setObjectSource ( ObjectSourceSharedPtr objectSource )

Sets an object source for render pass.

KzuObjectSource* kanzi::Renderpass::getObjectSource ( ) const

Gets object source from render pass.

void kanzi::Renderpass::setColorBuffer	(	bool	clearEnabled,
		ColorRGBA	clearColor,
		GraphicsColorWriteMode	writeMode
	)

Sets a color buffer for render pass.

void kanzi::Renderpass::setDepthBuffer	(	bool	depthClearEnabled,
		float	clearValue,
		bool	depthTestEnabled,
		bool	depthWriteEnabled
	)

Sets a depth buffer for render pass.

Parameters

renderPass	renderPass to be applied.
depthClearEnabled	Is depth buffer cleared on beginning of this renderpass.
clearValue	clearValue clear value used if clearing enabled, use KZU_RENDER_PASS_DEFAULT_DEPTH_CLEAR_VALUE by default.
depthTestEnabled	Depth testing enabled / disabled.
depthWriteEnabled	Writing to depth buffer enabled / disabled.

void kanzi::Renderpass::setStencilBuffer	(	bool	stencilClearEnabled,
		unsigned int	clearValue,
		bool	stencilTestEnabled,
		GraphicsStencilOperation	stencilModeSfail,
		GraphicsStencilOperation	stencilModeDPfail,
		GraphicsStencilOperation	stencilModeDPpass,
		GraphicsCompareFunction	stencilFunction
	)

Sets a stencil buffer for render pass.

void kanzi::Renderpass::setViewportAbsolute	(	unsigned int	x,
		unsigned int	y,
		unsigned int	width,
		unsigned int	height
	)

Sets the view port's size in absolute coordinates (pixels)

void kanzi::Renderpass::setViewportRelative	(	float	x,
		float	y,
		float	width,
		float	height
	)

Sets the view port's size in coordinates relative to screen size (0.f = left, 1.f = right) (0.f = top, 1.f = bottom)

void kanzi::Renderpass::setRenderOnce ( bool renderOnce )

Sets render pass to state where it gets rendered once and is disabled after that.

void kanzi::Renderpass::iterateTransformedObjects	(	Renderer3D *	renderer,
		const KzcDynamicArray *	transformedObjects,
		Renderer3D::ApplyObjectFunction	applyFunction
	)

virtual void kanzi::Renderpass::loadFromKZB	(	const KzuResourceLoaderThreadContext *	threadContext,
		KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

virtual

Function for loading the resource from .KZB.

This function is called when loading the data from .KZB file. Implementations should call super class loadFromKZB before reading anything else from inputStream. This function is called from arbitrary loading threads. The parameter threadContext contains thread safe memory manager and a thread specific Property manager which can be locked with the threadLock in the threadContext. This function may not access resource manager or the UIDomain due to race conditions.

Reimplemented from kanzi::Composer.

virtual void kanzi::Renderpass::applyOverride	(	Renderer3D *	renderer,
		const TransformedScene3D *	transformedScene,
		RenderContextStack &	renderContextStack
	)

virtual

Reimplemented from kanzi::Composer.

virtual void kanzi::Renderpass::requiresDepthBuffer	(	bool &	out_allowDepthClear,
		bool &	out_requiresDepth
	)		const

virtual

Reimplemented from kanzi::Composer.

virtual void kanzi::Renderpass::initialize ( )

virtual

Reimplemented from kanzi::Composer.

void kanzi::Renderpass::applyCameraAndViewport	(	const Renderer3D *	userRenderer,
		const KzuTransformedObjectNode *	transformedCameraNode,
		RenderContextStack &	renderContextStack,
		const KzuViewport *	viewport,
		const KzuScissor *	scissor
	)

protected

static kzsError kanzi::Renderpass::applyLight	(	KzuTransformedObjectNode *	transformedObjectNode,
		Renderer3D *	renderer
	)

staticprotected

Member Data Documentation

PropertyType<bool> kanzi::Renderpass::FlushAfterRenderProperty

static

FlushAfterRender property.

The default value is false.

See also: setFlushAfterRender(), isFlushAfterRender()

PropertyType<float> kanzi::Renderpass::ViewportXProperty

static

ViewportX property.

The default value is 0.0f.

See also: setViewportX(), getViewportX()

PropertyType<float> kanzi::Renderpass::ViewportYProperty

static

ViewportY property.

The default value is 0.0f.

See also: setViewportY(), getViewportY()

PropertyType<float> kanzi::Renderpass::ViewportWidthProperty

static

ViewportWidth property.

The default value is 1.0f.

See also: setViewportWidth(), getViewportWidth()

PropertyType<float> kanzi::Renderpass::ViewportHeightProperty

static

ViewportHeight property.

The default value is 1.0f.

See also: setViewportHeight(), getViewportHeight()

PropertyType<KzuViewportCoordinateType> kanzi::Renderpass::ViewportTypeProperty

static

ViewportType property.

The default value is KZU_VIEWPORT_COORDINATE_RELATIVE.

See also: setViewportType(), getViewportType()

PropertyType<string> kanzi::Renderpass::RenderPassCameraProperty

static

RenderPassCamera property.

The default value is "".

See also: setRenderPassCamera(), getRenderPassCamera()

PropertyType<ResourceID> kanzi::Renderpass::RenderPassObjectSourceProperty

static

RenderPassObjectSource property.

The default value is ResourceID().

See also: setRenderPassObjectSourceResourceID(), getRenderPassObjectSourceResourceID()

PropertyType<ResourceID> kanzi::Renderpass::RenderPassMaterialProperty

static

RenderPassMaterial property.

The default value is ResourceID().

See also: setRenderPassMaterialResourceID(), getRenderPassMaterialResourceID()

PropertyType<ResourceID> kanzi::Renderpass::RenderPassRenderTargetProperty

static

RenderPassRenderTarget property.

The default value is ResourceID().

See also: setRenderPassRenderTargetResourceID(), getRenderPassRenderTargetResourceID()

PropertyType<bool> kanzi::Renderpass::FrustumCullingOnProperty

static

FrustumCullingOn property.

The default value is false.

See also: setFrustumCullingOn(), isFrustumCullingOn()

PropertyType<GraphicsCullMode> kanzi::Renderpass::CullModeProperty

static

CullMode property.

The default value is GraphicsCullModeBack.

See also: setCullMode(), getCullMode()

PropertyType<bool> kanzi::Renderpass::RenderOnceProperty

static

RenderOnce property.

The default value is false.

See also: setRenderOnce(), isRenderOnce()

PropertyType<bool> kanzi::Renderpass::SortBatchesByShaderProperty

static

SortBatchesByShader property.

The default value is false.

See also: setSortBatchesByShader(), isSortBatchesByShader()

PropertyType<ColorRGBA> kanzi::Renderpass::ColorBufferClearColorProperty

static

ColorBufferClearColor property.

The default value is ColorRGBA(0.4f, 0.4f, 0.4f, 1.0f).

See also: setColorBufferClearColor(), getColorBufferClearColor()

PropertyType<bool> kanzi::Renderpass::ColorBufferClearEnabledProperty

static

ColorBufferClearEnabled property.

The default value is false.

See also: setColorBufferClearEnabled(), isColorBufferClearEnabled()

PropertyType<GraphicsColorWriteMode> kanzi::Renderpass::ColorWriteModeProperty

static

ColorWriteMode property.

The default value is GraphicsColorWriteModeRGBA.

See also: setColorWriteMode(), getColorWriteMode()

PropertyType<bool> kanzi::Renderpass::DepthBufferClearEnabledProperty

static

DepthBufferClearEnabled property.

The default value is true.

See also: setDepthBufferClearEnabled(), isDepthBufferClearEnabled()

PropertyType<float> kanzi::Renderpass::DepthBufferClearValueProperty

static

DepthBufferClearValue property.

The default value is 1.0f.

See also: setDepthBufferClearValue(), getDepthBufferClearValue()

PropertyType<bool> kanzi::Renderpass::DepthBufferTestEnabledProperty

static

DepthBufferTestEnabled property.

The default value is true.

See also: setDepthBufferTestEnabled(), isDepthBufferTestEnabled()

PropertyType<bool> kanzi::Renderpass::DepthBufferWriteEnabledProperty

static

DepthBufferWriteEnabled property.

The default value is true.

See also: setDepthBufferWriteEnabled(), isDepthBufferWriteEnabled()

PropertyType<bool> kanzi::Renderpass::StencilBufferClearEnabledProperty

static

StencilBufferClearEnabled property.

The default value is false.

See also: setStencilBufferClearEnabled(), isStencilBufferClearEnabled()

PropertyType<int> kanzi::Renderpass::StencilBufferClearValueProperty

static

StencilBufferClearValue property.

The default value is 0.

See also: setStencilBufferClearValue(), getStencilBufferClearValue()

PropertyType<GraphicsStencilOperation> kanzi::Renderpass::StencilFailOperationProperty

static

StencilFailOperation property.

The default value is GraphicsStencilOperationKeep.

See also: setStencilFailOperation(), getStencilFailOperation()

PropertyType<GraphicsStencilOperation> kanzi::Renderpass::StencilPassDepthFailOperationProperty

static

StencilPassDepthFailOperation property.

The default value is GraphicsStencilOperationKeep.

See also: setStencilPassDepthFailOperation(), getStencilPassDepthFailOperation()

PropertyType<GraphicsStencilOperation> kanzi::Renderpass::StencilPassDepthPassOperationProperty

static

StencilPassDepthPassOperation property.

The default value is GraphicsStencilOperationKeep.

See also: setStencilPassDepthPassOperation(), getStencilPassDepthPassOperation()

PropertyType<GraphicsCompareFunction> kanzi::Renderpass::StencilFunctionProperty

static

StencilFunction property.

The default value is GraphicsCompareFunctionNever.

See also: setStencilFunction(), getStencilFunction()

PropertyType<int> kanzi::Renderpass::StencilFunctionReferenceValueProperty

static

StencilFunctionReferenceValue property.

The default value is 0.

See also: setStencilFunctionReferenceValue(), getStencilFunctionReferenceValue()

PropertyType<int> kanzi::Renderpass::StencilFunctionReferenceMaskProperty

static

StencilFunctionReferenceMask property.

The default value is 255.

See also: setStencilFunctionReferenceMask(), getStencilFunctionReferenceMask()

PropertyType<bool> kanzi::Renderpass::StencilBufferTestEnabledProperty

static

StencilBufferTestEnabled property.

The default value is false.

See also: setStencilBufferTestEnabled(), isStencilBufferTestEnabled()

PropertyType<bool> kanzi::Renderpass::RenderPassScissorEnabledProperty

static

RenderPassScissorEnabled property.

The default value is false.

See also: setRenderPassScissorEnabled(), isRenderPassScissorEnabled()

PropertyType<float> kanzi::Renderpass::RenderPassScissorXProperty

static

RenderPassScissorX property.

The default value is 0.0f.

See also: setRenderPassScissorX(), getRenderPassScissorX()

PropertyType<float> kanzi::Renderpass::RenderPassScissorYProperty

static

RenderPassScissorY property.

The default value is 0.0f.

See also: setRenderPassScissorY(), getRenderPassScissorY()

PropertyType<float> kanzi::Renderpass::RenderPassScissorWidthProperty

static

RenderPassScissorWidth property.

The default value is 1.0f.

See also: setRenderPassScissorWidth(), getRenderPassScissorWidth()

PropertyType<float> kanzi::Renderpass::RenderPassScissorHeightProperty

static

RenderPassScissorHeight property.

The default value is 1.0f.

See also: setRenderPassScissorHeight(), getRenderPassScissorHeight()

PropertyType<KzuViewportCoordinateType> kanzi::Renderpass::RenderPassScissorTypeProperty

static

RenderPassScissorType property.

The default value is KZU_VIEWPORT_COORDINATE_RELATIVE.

See also: setRenderPassScissorType(), getRenderPassScissorType()

PropertyType<bool> kanzi::Renderpass::ComposerEnabledProperty

static

ComposerEnabled property.

The default value is true.

See also: setComposerEnabled(), isComposerEnabled()

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

kanzi/graphics_3d/renderpass.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation