Class SimpleOutlineProperties

Namespace

Gamelogic.Fx.PostProcessing.Effects

Assembly

Gamelogic.Fx.dll

[Serializable]
public sealed class SimpleOutlineProperties : ShaderProperties

Inheritance

object

ShaderProperties

SimpleOutlineProperties

Inherited Members

ShaderProperties.Shader

ShaderProperties.OnValidate()

ShaderProperties.OnEnable()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BackgroundColor

Background color when no edge is detected.

public Color BackgroundColor { get; set; }

Property Value

Color

Remarks

Alpha determines how much of the original image shines through.

EdgeFactor

Factor used to multiply the edge value before taking a threshold.

public float EdgeFactor { get; set; }

Property Value

float

JumpSize

Factor used to multiply sample offsets.

public float JumpSize { get; set; }

Property Value

float

Remarks

A way to fake bigger kernel sizes.

LineColor

Color used to draw the detected edges.

public Color LineColor { get; set; }

Property Value

Color

Remarks

Alpha determines how much of the original image shines through.

OutlineSource

Enable to use a different texture as the source for edge detection.

public OutlineSource OutlineSource { get; set; }

Property Value

OutlineSource

OutlineSourceTexture

Alternate source texture for edge detection.

public Texture OutlineSourceTexture { get; set; }

Property Value

Texture

RequiresDepthTexture

Indicates whether this shader requires access to the camera depth texture.

public override bool RequiresDepthTexture { get; }

Property Value

bool

Remarks

Override and return true if the shader samples depth information. This is used by higher-level systems to enable the correct camera flags.

RequiresNormalsTexture

Indicates whether this shader requires access to the camera normals texture.

public override bool RequiresNormalsTexture { get; }

Property Value

bool

Remarks

Override and return true if the shader samples scene normals. This is used by higher-level systems to ensure normals are generated when needed.

ShaderName

Gets the name of the shader used by this property set.

public override string ShaderName { get; }

Property Value

string

Remarks

This name is passed to the internal shader lookup system when the properties are enabled. It should match the full shader path as defined in the shader file.

Threshold

Threshold above which a pixel is considered an edge.

public float Threshold { get; set; }

Property Value

float

Methods

SetMaterialProperties(Material)

Applies all shader-related properties to the given material.

public override void SetMaterialProperties(Material effectMaterial)

Parameters

effectMaterial Material

Remarks

Subclasses should override this method and set all relevant shader uniforms (for example, floats, vectors, colors, textures, and keywords).