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

This renderer draws a full-screen image as background. The ratio or the texture used is preserved. The texture is centered and cropped along X or Y axis depending on the screen ratio. More...

Inheritance diagram for SiliconStudio.Paradox.Effects.BackgroundRenderer:
SiliconStudio.Paradox.Effects.Renderer

Public Member Functions

 BackgroundRenderer (IServiceRegistry services)
 Initializes a new instance of the BackgroundRenderer with null texture. More...
 
 BackgroundRenderer (IServiceRegistry services, string backgroundTexturePath)
 Initializes a new instance of the BackgroundRenderer using the provided file as background texture. More...
 
- Public Member Functions inherited from SiliconStudio.Paradox.Effects.Renderer
virtual void Load ()
 Loads this instance. This method is called when a RenderPass is attached (directly or indirectly) to the children of SiliconStudio.Paradox.Effects.RenderSystem.Pipeline More...
 
virtual void Unload ()
 Unloads this instance. This method is called when a RenderPass is de-attached (directly or indirectly) to the children of SiliconStudio.Paradox.Effects.RenderSystem.Pipeline More...
 

Protected Member Functions

override void OnRendering (RenderContext context)
 
- Protected Member Functions inherited from SiliconStudio.Paradox.Effects.Renderer
 Renderer (IServiceRegistry services)
 Initializes a new instance of the Renderer class. More...
 
virtual void BeginRendering (RenderContext context)
 
virtual void EndRendering (RenderContext context)
 

Properties

Texture2D BackgroundTexture [get, set]
 Gets or sets the texture displayed as background. More...
 
- Properties inherited from SiliconStudio.Paradox.Effects.Renderer
IServiceRegistry Services [get, set]
 Gets the services. More...
 
GraphicsDevice GraphicsDevice [get]
 Gets the graphics device. More...
 
RenderSystem RenderSystem [get, set]
 Gets the render system. More...
 
EffectSystem EffectSystem [get, set]
 Gets the effect system. More...
 
RenderPass Pass [get, set]
 Gets the pass this processor is attached to. More...
 
string DebugName [get, set]
 Gets or sets the name of the debug. More...
 

Detailed Description

This renderer draws a full-screen image as background. The ratio or the texture used is preserved. The texture is centered and cropped along X or Y axis depending on the screen ratio.

This renderer does not write into the depth buffer

Definition at line 18 of file BackgroundRenderer.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Effects.BackgroundRenderer.BackgroundRenderer ( IServiceRegistry  services)

Initializes a new instance of the BackgroundRenderer with null texture.

Parameters
servicesThe services.

Definition at line 31 of file BackgroundRenderer.cs.

SiliconStudio.Paradox.Effects.BackgroundRenderer.BackgroundRenderer ( IServiceRegistry  services,
string  backgroundTexturePath 
)

Initializes a new instance of the BackgroundRenderer using the provided file as background texture.

Parameters
servicesThe services.
backgroundTexturePathThe path to the background texture to use

Definition at line 41 of file BackgroundRenderer.cs.

Member Function Documentation

override void SiliconStudio.Paradox.Effects.BackgroundRenderer.OnRendering ( RenderContext  context)
protectedvirtual

Property Documentation

Texture2D SiliconStudio.Paradox.Effects.BackgroundRenderer.BackgroundTexture
getset

Gets or sets the texture displayed as background.

Definition at line 25 of file BackgroundRenderer.cs.


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