Shader Class

Delta Engine Documentation

Tells the GPU how to render 2D or 3D material data on screen. Usually loaded from content. This base class has no functionality, some common functionality can be found in ShaderWithFormat. Provide multiple framework specific shader codes if creating manually. View code on GitHub

Inheritance Hierarchy

System Object
  DeltaEngine.Content ContentData
    DeltaEngine.Content Shader
      DeltaEngine.Content.Tests MockImageTests MockShader
      DeltaEngine.Graphics ShaderWithFormat
      DeltaEngine.Tests.Content FakeShader

Namespace: DeltaEngine.Content
Assembly: DeltaEngine (in DeltaEngine.dll) Version: 1.1.1.0 (1.1.1)

Syntax

C++

Copy to Clipboard Print

public abstract class Shader : ContentData, 
	IEquatable<Shader>

public abstract class Shader : ContentData, 
	IEquatable<Shader>

Public MustInherit Class Shader 
	Inherits ContentData 
	Implements IEquatable(Of Shader)

Public MustInherit Class Shader 
	Inherits ContentData 
	Implements IEquatable(Of Shader)

public ref class Shader abstract : public ContentData, 
	IEquatable<Shader^>

public ref class Shader abstract : public ContentData, 
	IEquatable<Shader^>

[<AbstractClassAttribute>]
type Shader =  
    class 
        inherit ContentData 
        interface IEquatable<Shader>
    end

[<AbstractClassAttribute>]
type Shader =  
    class 
        inherit ContentData 
        interface IEquatable<Shader>
    end

The Shader type exposes the following members.

Constructors

	Name	Description
	Shader	Initializes a new instance of the Shader class

Top

Methods

	Name	Description
	ApplyFogSettings
	ApplyShaderParameters
	Bind
	BindVertexDeclaration
	CreateDefault	(Inherited from ContentData.)
	CreateShader
	Dispose	View code on GitHub (Inherited from ContentData.)
	DisposeData	(Inherited from ContentData.)
	Equals(Object)	View code on GitHub (Overrides Object Equals(Object).)
	Equals(Shader)	View code on GitHub
	FillShaderCode
	GetHashCode	(Overrides Object GetHashCode .)
	InternalCreateDefault	View code on GitHub (Inherited from ContentData.)
	LoadData	(Overrides ContentData LoadData(Stream).)
	SetDiffuseTexture
	SetJointMatrices
	SetLightmapTexture
	SetModelViewProjection(Matrix)
	SetModelViewProjection(Matrix, Matrix, Matrix)
	SetSunLight
	ToString	View code on GitHub (Inherited from ContentData.)
	TryCreateShader

Top

Fields

	Name	Description
	ContentChanged	(Inherited from ContentData.)

Top

Properties

	Name	Description
	AllowCreationIfContentNotFound	(Inherited from ContentData.)
	Data
	Flags	View code on GitHub
	IsDisposed	View code on GitHub (Inherited from ContentData.)
	MetaData	(Inherited from ContentData.)
	Name	View code on GitHub (Inherited from ContentData.)

Top

Remarks

Tests: DeltaEngine.Tests.Content.ShaderTests

Examples

2 unit tests call DeltaEngine.Content.Shader

Copy to Clipboard Print

[Test]
public void ShadersAreEqualWhenTheFlagsAreTheSame()
{
    Shader coloredShader = CreateShaderByFlags(ShaderFlags.Colored);
    Assert.AreEqual(coloredShader, CreateShaderByFlags(ShaderFlags.Colored));
    Assert.AreNotEqual(coloredShader, CreateShaderByFlags(ShaderFlags.Textured));
}

[Test]
public void ShadersAreEqualWhenTheFlagsAreTheSame()
{
    Shader coloredShader = CreateShaderByFlags(ShaderFlags.Colored);
    Assert.AreEqual(coloredShader, CreateShaderByFlags(ShaderFlags.Colored));
    Assert.AreNotEqual(coloredShader, CreateShaderByFlags(ShaderFlags.Textured));
}

Copy to Clipboard Print

[Test]
public void CompareShaderCreationDatas()
{
    var data1 = new ShaderCreationData(ShaderFlags.Colored);
    var data2 = new ShaderCreationData(ShaderFlags.Textured);
    var data3 = new ShaderCreationData(ShaderFlags.Textured);
    Assert.IsFalse(data1.Equals(data2));
    Assert.IsTrue(data2.Equals(data3));
    Assert.AreNotEqual(data1, data2);
    Assert.AreEqual(data2, data3);
}

[Test]
public void CompareShaderCreationDatas()
{
    var data1 = new ShaderCreationData(ShaderFlags.Colored);
    var data2 = new ShaderCreationData(ShaderFlags.Textured);
    var data3 = new ShaderCreationData(ShaderFlags.Textured);
    Assert.IsFalse(data1.Equals(data2));
    Assert.IsTrue(data2.Equals(data3));
    Assert.AreNotEqual(data1, data2);
    Assert.AreEqual(data2, data3);
}