Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Paradox.Effects.RenderPass Class Reference

RenderPass is a hierarchy that defines how to collect and render meshes. More...

Inheritance diagram for SiliconStudio.Paradox.Effects.RenderPass:
SiliconStudio.Core.ComponentBase SiliconStudio.Core.IComponent SiliconStudio.Core.ICollectorHolder SiliconStudio.Core.IReferencable SiliconStudio.Core.IReferencable SiliconStudio.Paradox.Effects.RenderPipeline

Public Member Functions

 RenderPass ()
 Initializes a new instance of the RenderPass class. More...
 
 RenderPass (string name)
 Initializes a new instance of the RenderPass class. More...
 
override string ToString ()
 
- Public Member Functions inherited from SiliconStudio.Core.ComponentBase
void Dispose ()
 
override string ToString ()
 

Public Attributes

DelegateHolder< RenderContextStartPass
 The start action. More...
 
DelegateHolder< RenderContextEndPass
 The end action. More...
 
- Public Attributes inherited from SiliconStudio.Core.ComponentBase
PropertyContainer Tags
 Gets the attached properties to this component. More...
 

Properties

bool Enabled [get, set]
 Gets or sets a value indicating whether this RenderPass is enabled for collection. More...
 
RenderPass Parent [get, set]
 Gets the parent pass. More...
 
RenderPipeline Pipeline [get]
 Gets the pipeline (root node, which should be of type RenderPipeline). More...
 
ParameterCollection Parameters [get, set]
 Gets or sets the parameters. More...
 
TrackingCollection< RendererRenderers [get]
 Gets the Renderers attached to this renderpass. More...
 
TrackingCollection< RenderPassChildren [get]
 Gets the sub render passes. More...
 
- Properties inherited from SiliconStudio.Core.ComponentBase
long Id [get, set]
 
string Name [get, set]
 Gets or sets the name of this component. More...
 
bool IsDisposed [get, set]
 Has the component been disposed or not yet. More...
 
- Properties inherited from SiliconStudio.Core.IComponent
long Id [get]
 Gets the id of this component. More...
 
string Name [get]
 Gets the name of this component. More...
 
- Properties inherited from SiliconStudio.Core.IReferencable
int ReferenceCount [get]
 Gets the reference count of this instance. More...
 
- Properties inherited from SiliconStudio.Core.ICollectorHolder
ObjectCollector Collector [get]
 Gets the collector. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SiliconStudio.Core.ComponentBase
 ComponentBase ()
 Initializes a new instance of the ComponentBase class. More...
 
 ComponentBase (string name)
 Initializes a new instance of the ComponentBase class. More...
 
virtual void OnNameChanged ()
 Called when Name property was changed. More...
 
virtual void Destroy ()
 Disposes of object resources. More...
 

Detailed Description

RenderPass is a hierarchy that defines how to collect and render meshes.

Definition at line 19 of file RenderPass.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Effects.RenderPass.RenderPass ( )

Initializes a new instance of the RenderPass class.

Definition at line 27 of file RenderPass.cs.

SiliconStudio.Paradox.Effects.RenderPass.RenderPass ( string  name)

Initializes a new instance of the RenderPass class.

Parameters
nameThe name.

Definition at line 35 of file RenderPass.cs.

References DirectX.switch().

Member Function Documentation

override string SiliconStudio.Paradox.Effects.RenderPass.ToString ( )

Definition at line 163 of file RenderPass.cs.

Member Data Documentation

DelegateHolder<RenderContext> SiliconStudio.Paradox.Effects.RenderPass.EndPass

The end action.

Definition at line 130 of file RenderPass.cs.

DelegateHolder<RenderContext> SiliconStudio.Paradox.Effects.RenderPass.StartPass

The start action.

Definition at line 125 of file RenderPass.cs.

Property Documentation

TrackingCollection<RenderPass> SiliconStudio.Paradox.Effects.RenderPass.Children
get

Gets the sub render passes.

The sub render passes.

Definition at line 159 of file RenderPass.cs.

Referenced by SiliconStudio.Paradox.Effects.RenderPassExtensions.Foreach().

bool SiliconStudio.Paradox.Effects.RenderPass.Enabled
getset

Gets or sets a value indicating whether this RenderPass is enabled for collection.

true if enabled for collection; otherwise, false.

Definition at line 90 of file RenderPass.cs.

Referenced by SiliconStudio.Paradox.Effects.SlideShowPlugin.Load().

ParameterCollection SiliconStudio.Paradox.Effects.RenderPass.Parameters
getset

Gets or sets the parameters.

The parameters.

Definition at line 138 of file RenderPass.cs.

RenderPass SiliconStudio.Paradox.Effects.RenderPass.Parent
getset

Gets the parent pass.

The parent pass.

Definition at line 98 of file RenderPass.cs.

RenderPipeline SiliconStudio.Paradox.Effects.RenderPass.Pipeline
get

Gets the pipeline (root node, which should be of type RenderPipeline).

The root pass.

Definition at line 107 of file RenderPass.cs.

TrackingCollection<Renderer> SiliconStudio.Paradox.Effects.RenderPass.Renderers
get

Gets the Renderers attached to this renderpass.

The Renderers.

Definition at line 145 of file RenderPass.cs.


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