VerticesEngine.Graphics.vxUtilityEffect Class Reference

Inheritance diagram for VerticesEngine.Graphics.vxUtilityEffect:

Public Member Functions
	vxUtilityEffect (Effect effect)
Public Member Functions inherited from VerticesEngine.Graphics.vxShader
	vxShader (Effect effect)

Properties
Matrix	World [set]
	Sets the world.
Matrix	WVP [set]
	The World * View * Projection Cumulative Matrix Value.
Vector2	UVOffset [set]
	An offset for Texture Coordinates.
Vector2	DistortionUVOffset [set]
	An offset for Distortion Coordinates.
Vector2	UVFactor [set]
	A UV Factor to keep repeating UV Coordinates the same during plane scaling.
Color	DiffuseLight [set]
float	SpecularIntensity [set]
float	SpecularPower [set]
Vector3	LightDirection [set]
	Sets the light direction.
Color	AmbientLightColor [set]
Color	EmissiveColour [set]
Color	SelectionColour [set]
Texture2D	DiffuseTexture [get, set]
	Gets or sets the diffuse texture. Note this is not needed by the Utility effect but kept for information purposes.
Texture2D	NormalMap [get, set]
	Normal Map for this mesh.
Texture2D	SurfaceMap [get, set]
	Gets or sets the surface map for this mesh. The Surface Map uses the following RGBA channels as: R: Specular Power, G: Specular Intensity, B: Reflection Map Value, A: Emissivity.
bool	IsNormalMapEnabled [set]
bool	DoSSR [get, set]
bool	ReflectionIntensity [set]
RenderTarget2D	ShadowMap [get, set]
	Specular Map. Note, setting this will set the same specular map for all meshes.
Texture2D	AlphaMaskTexture [get, set]
	Alpha Mask.
float	AlphaMaskCutoff [get, set]
	Alpha Mask Cutoff.
Texture2D	EmissiveMap [get, set]
float	DistortionScale [set]
Texture2D	DistortionMap [get, set]
Matrix[]	ShadowTransform [set]
	Sets the shadow transform.
Vector4[]	TileBounds [set]
	Sets the tile bounds.
bool	IsShadowsEnabled [set]
	Sets a value indicating whether this T:VerticesEngine.Graphics.vxUtilityEffect do shadow.
float	ShadowBrightness [set]
	Sets the shadow brightness. 0 being the Darkest and 1 being no shadow.
int	NumberOfShadowBlendSamples [set]
	Sets the number samples for shadow edge blending.
Texture2D	RandomTexture2D [get, set]
	Gets or sets the random texture2 d.
Vector2[]	PoissonKernel [get, set]
	Gets or sets the poisson kernel.
float[]	PoissonKernelScale [get, set]
	Gets or sets the poisson kernel scale.
float	BlendSampleCount [get, set]
	The number of blends to be done when blurring the shadow edge.
int	ShadowBlurStart [get, set]
Color[]	DebugShadowSplitColors [get, set]

Additional Inherited Members
Static Public Member Functions inherited from VerticesEngine.Graphics.vxShader
static void	PrintParameterValues (Effect effect)
static object	GetParameterValue (EffectParameter Parameter)
Protected Member Functions inherited from VerticesEngine.Graphics.vxShader
override void	Dispose (bool disposing)

Property Documentation

DiffuseTexture

Texture2D VerticesEngine.Graphics.vxUtilityEffect.DiffuseTexture

getset

Gets or sets the diffuse texture. Note this is not needed by the Utility effect but kept for information purposes.

The diffuse texture.

IsShadowsEnabled

bool VerticesEngine.Graphics.vxUtilityEffect.IsShadowsEnabled

set

Sets a value indicating whether this T:VerticesEngine.Graphics.vxUtilityEffect do shadow.

true if do shadow; otherwise, false.

LightDirection

Vector3 VerticesEngine.Graphics.vxUtilityEffect.LightDirection

set

Sets the light direction.

The light direction.

NumberOfShadowBlendSamples

int VerticesEngine.Graphics.vxUtilityEffect.NumberOfShadowBlendSamples

set

Sets the number samples for shadow edge blending.

The number samples.

PoissonKernel

Vector2 [] VerticesEngine.Graphics.vxUtilityEffect.PoissonKernel

getset

Gets or sets the poisson kernel.

The poisson kernel.

PoissonKernelScale

float [] VerticesEngine.Graphics.vxUtilityEffect.PoissonKernelScale

getset

Gets or sets the poisson kernel scale.

The poisson kernel scale.

RandomTexture2D

Texture2D VerticesEngine.Graphics.vxUtilityEffect.RandomTexture2D

getset

Gets or sets the random texture2 d.

The random texture2 d.

ShadowBrightness

float VerticesEngine.Graphics.vxUtilityEffect.ShadowBrightness

set

Sets the shadow brightness. 0 being the Darkest and 1 being no shadow.

The shadow brightness.

ShadowTransform

Matrix [] VerticesEngine.Graphics.vxUtilityEffect.ShadowTransform

set

Sets the shadow transform.

The shadow transform.

SurfaceMap

Texture2D VerticesEngine.Graphics.vxUtilityEffect.SurfaceMap

getset

Gets or sets the surface map for this mesh. The Surface Map uses the following RGBA channels as: R: Specular Power, G: Specular Intensity, B: Reflection Map Value, A: Emissivity.

The surface map.

TileBounds

Vector4 [] VerticesEngine.Graphics.vxUtilityEffect.TileBounds

set

Sets the tile bounds.

The tile bounds.

World

Matrix VerticesEngine.Graphics.vxUtilityEffect.World

set

Sets the world.

The world.

---

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

• /github/workspace/src/VerticesEngine/src.shared/Graphics/Effects/vxUtilityEffect.cs