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

Primitive quad use to draw an effect on a quad (fullscreen by default). This is directly accessible from the GraphicsDevice.DrawQuad method. More...

Inheritance diagram for SiliconStudio.Paradox.Graphics.PrimitiveQuad:
SiliconStudio.Core.ComponentBase SiliconStudio.Core.IComponent SiliconStudio.Core.ICollectorHolder SiliconStudio.Core.IReferencable SiliconStudio.Core.IReferencable

Public Member Functions

 PrimitiveQuad (GraphicsDevice graphicsDevice)
 Initializes a new instance of the PrimitiveQuad class with a SimpleEffect. More...
 
 PrimitiveQuad (GraphicsDevice graphicsDevice, Effect effect)
 Initializes a new instance of the PrimitiveQuad class with a particular effect. More...
 
void Draw ()
 Draws a quad. The effect must have been applied before calling this method with pixel shader having the signature float2:TEXCOORD. More...
 
void Draw (Texture texture)
 Draws a quad with a texture. This Draw method is using the current effect bound to this instance. More...
 
void Draw (Texture texture, SamplerState samplerState, Color4 color)
 Draws a quad with a texture. This Draw method is using a simple pixel shader that is sampling the texture. More...
 
- Public Member Functions inherited from SiliconStudio.Core.ComponentBase
void Dispose ()
 
override string ToString ()
 

Properties

GraphicsDevice GraphicsDevice [get, set]
 Gets the graphics device. 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

- Public Attributes inherited from SiliconStudio.Core.ComponentBase
PropertyContainer Tags
 Gets the attached properties to this component. More...
 
- 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

Primitive quad use to draw an effect on a quad (fullscreen by default). This is directly accessible from the GraphicsDevice.DrawQuad method.

Definition at line 13 of file PrimitiveQuad.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Graphics.PrimitiveQuad.PrimitiveQuad ( GraphicsDevice  graphicsDevice)

Initializes a new instance of the PrimitiveQuad class with a SimpleEffect.

Parameters
graphicsDeviceThe graphics device.

Definition at line 23 of file PrimitiveQuad.cs.

SiliconStudio.Paradox.Graphics.PrimitiveQuad.PrimitiveQuad ( GraphicsDevice  graphicsDevice,
Effect  effect 
)

Initializes a new instance of the PrimitiveQuad class with a particular effect.

Parameters
graphicsDeviceThe graphics device.
effectThe effect.

Definition at line 32 of file PrimitiveQuad.cs.

Member Function Documentation

void SiliconStudio.Paradox.Graphics.PrimitiveQuad.Draw ( )

Draws a quad. The effect must have been applied before calling this method with pixel shader having the signature float2:TEXCOORD.

Definition at line 49 of file PrimitiveQuad.cs.

void SiliconStudio.Paradox.Graphics.PrimitiveQuad.Draw ( Texture  texture)

Draws a quad with a texture. This Draw method is using the current effect bound to this instance.

Parameters
textureThe texture.

Definition at line 60 of file PrimitiveQuad.cs.

References SiliconStudio.Core.Mathematics.Color.White.

void SiliconStudio.Paradox.Graphics.PrimitiveQuad.Draw ( Texture  texture,
SamplerState  samplerState,
Color4  color 
)

Draws a quad with a texture. This Draw method is using a simple pixel shader that is sampling the texture.

Parameters
textureThe texture to draw.
samplerStateState of the sampler. If null, default sampler is SamplerStateFactory.LinearClamp.
colorThe color.
Exceptions
System.ArgumentExceptionExpecting a Texture2D;texture

Definition at line 72 of file PrimitiveQuad.cs.

Property Documentation

GraphicsDevice SiliconStudio.Paradox.Graphics.PrimitiveQuad.GraphicsDevice
getset

Gets the graphics device.

The graphics device.

Definition at line 44 of file PrimitiveQuad.cs.


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