Material Class

Delta Engine Documentation

Displays images or shapes via shaders in 2D or 3D. Always need a shader and a diffuse map, which can be a single , an , or a Image ImageAnimation SpriteSheet View code on GitHub

Inheritance Hierarchy

System Object
DeltaEngine.Content ContentData
DeltaEngine.Content Material

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

Syntax

C++

Copy to Clipboard Print

public sealed class Material : ContentData, 
	IEquatable<Material>

public sealed class Material : ContentData, 
	IEquatable<Material>

Public NotInheritable Class Material 
	Inherits ContentData 
	Implements IEquatable(Of Material)

Public NotInheritable Class Material 
	Inherits ContentData 
	Implements IEquatable(Of Material)

public ref class Material sealed : public ContentData, 
	IEquatable<Material^>

public ref class Material sealed : public ContentData, 
	IEquatable<Material^>

[<SealedAttribute>]
type Material =  
    class 
        inherit ContentData 
        interface IEquatable<Material>
    end

[<SealedAttribute>]
type Material =  
    class 
        inherit ContentData 
        interface IEquatable<Material>
    end

The Material type exposes the following members.

Constructors

	Name	Description
	Material(Color)	Creates an 1x1 image with a colored shader material for simple solid flat surfaces. View code on GitHub
	Material(Color, ShaderFlags)	Initializes a new instance of the Material class
	Material(Shader, Image)	Special constructor for creating custom shaders and images or reusing existing instances. View code on GitHub
	Material(ShaderFlags, String)	As opposed to loading a material from content it can also be created with this constructor. If imageOrAnimationName is used you need to provide either a DiffuseMap or an Animation. View code on GitHub
	Material(Size, ShaderFlags)	Creates a new image with the specified size to be filled dynamically (via .DiffuseMap.Fill). View code on GitHub

Top

Methods

	Name	Description
	CreateDefault	(Inherited from ContentData.)
	Dispose	View code on GitHub (Inherited from ContentData.)
	DisposeData	(Overrides ContentData DisposeData .)
	Equals(Object)	View code on GitHub (Overrides Object Equals(Object).)
	Equals(Material)	View code on GitHub
	GetHashCode	View code on GitHub (Overrides Object GetHashCode .)
	InternalCreateDefault	View code on GitHub (Inherited from ContentData.)
	LoadData	(Overrides ContentData LoadData(Stream).)
	ToString	(Overrides ContentData ToString .)

Top

Fields

	Name	Description
	ContentChanged	(Inherited from ContentData.)

Top

Properties

	Name	Description
	AllowCreationIfContentNotFound	(Inherited from ContentData.)
	Animation
	DefaultColor
	DiffuseMap	View code on GitHub
	Duration
	IsDisposed	View code on GitHub (Inherited from ContentData.)
	LightMap
	MaterialRenderSize	When using the Sprite(Material, Vector2D) constructor this size is used for the draw area. It is calculated from the DiffuseMap.PixelSize and the default content resolution, i.e. a 100x200 pixel image will be displayed aspect ratio correct relative to the window size. View code on GitHub
	MetaData	(Inherited from ContentData.)
	Name	View code on GitHub (Inherited from ContentData.)
	RenderingCalculator
	RenderSizeMode
	Shader
	SpriteSheet

Top

Remarks

Tests: DeltaEngine.Tests.Content.MaterialTests

Examples

7 unit tests call DeltaEngine.Content.Material

Copy to Clipboard Print

[Test]
public void TestPixelBasedRenderSize()
{
    material.RenderSizeMode = RenderSizeMode.PixelBased;
    Assert.AreEqual(0.3125f, material.MaterialRenderSize.Width);
    Assert.AreEqual(0.3125f, material.MaterialRenderSize.Height);
}

[Test]
public void TestPixelBasedRenderSize()
{
    material.RenderSizeMode = RenderSizeMode.PixelBased;
    Assert.AreEqual(0.3125f, material.MaterialRenderSize.Width);
    Assert.AreEqual(0.3125f, material.MaterialRenderSize.Height);
}

Copy to Clipboard Print

[Test]
public void Test800X480RenderSize()
{
    material.RenderSizeMode = RenderSizeMode.SizeFor800X480;
    Assert.AreEqual(0.125f, material.MaterialRenderSize.Width);
    Assert.AreEqual(0.125f, material.MaterialRenderSize.Height);
}

[Test]
public void Test800X480RenderSize()
{
    material.RenderSizeMode = RenderSizeMode.SizeFor800X480;
    Assert.AreEqual(0.125f, material.MaterialRenderSize.Width);
    Assert.AreEqual(0.125f, material.MaterialRenderSize.Height);
}

Copy to Clipboard Print

[Test]
public void Test1024X720RenderSize()
{
    material.RenderSizeMode = RenderSizeMode.SizeFor1024X768;
    Assert.AreEqual(0.09765625f, material.MaterialRenderSize.Width);
    Assert.AreEqual(0.09765625f, material.MaterialRenderSize.Height);
}

[Test]
public void Test1024X720RenderSize()
{
    material.RenderSizeMode = RenderSizeMode.SizeFor1024X768;
    Assert.AreEqual(0.09765625f, material.MaterialRenderSize.Width);
    Assert.AreEqual(0.09765625f, material.MaterialRenderSize.Height);
}