Size Structure

Delta Engine Documentation

Holds the width and height of an object (e.g. a rectangle). View code on GitHub

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

Syntax

public struct Size : IEquatable<Size>, 
	Lerp<Size>, Lerp

public struct Size : IEquatable<Size>, 
	Lerp<Size>, Lerp

Public Structure Size 
	Implements IEquatable(Of Size), Lerp(Of Size), 
	Lerp

Public Structure Size 
	Implements IEquatable(Of Size), Lerp(Of Size), 
	Lerp

public value class Size : IEquatable<Size>, 
	Lerp<Size>, Lerp

public value class Size : IEquatable<Size>, 
	Lerp<Size>, Lerp

[<SealedAttribute>]
type Size =  
    struct 
        interface IEquatable<Size>
        interface Lerp<Size>
        interface Lerp 
    end

[<SealedAttribute>]
type Size =  
    struct 
        interface IEquatable<Size>
        interface Lerp<Size>
        interface Lerp 
    end

The Size type exposes the following members.

Constructors

	Name	Description
	Size(Single)	Initializes a new instance of the Size class
	Size(String)	Initializes a new instance of the Size class
	Size(Single, Single)	Initializes a new instance of the Size class

Top

Methods

	Name	Description
	Equals(Object)	View code on GitHub (Overrides ValueType Equals(Object).)
	Equals(Size)	View code on GitHub
	GetHashCode	View code on GitHub (Overrides ValueType GetHashCode .)
	IsNearlyEqual
	Lerp
	ToString	View code on GitHub (Overrides ValueType ToString .)

Top

Operators

	Name	Description
	Addition
	Division(Single, Size)
	Division(Size, Size)
	Division(Size, Single)
	Equality
	(Vector2D to Size)
	Inequality
	Multiply(Single, Size)
	Multiply(Size, Size)
	Multiply(Size, Single)
	Subtraction

Top

Fields

	Name	Description
	Half
	One
	SizeInBytes
	Unused
	Zero

Top

Properties

	Name	Description
	AspectRatio	View code on GitHub
	Height	View code on GitHub
	Length	View code on GitHub
	Width	View code on GitHub

Top

Remarks

Tests: DeltaEngine.Tests.Datatypes.SizeTests

Examples

23 unit tests call DeltaEngine.Datatypes.Size

Copy to Clipboard Print

[Test]
public void StaticSizes()
{
    Assert.AreEqual(new Size(), Size.Zero);
    Assert.AreEqual(new Size(0.0f, 0.0f), Size.Zero);
    Assert.AreEqual(new Size(0.5f, 0.5f), Size.Half);
    Assert.AreEqual(new Size(1.0f, 1.0f), Size.One);
    Assert.AreEqual(new Size(-1.0f, -1.0f), Size.Unused);
    Assert.AreEqual(8, Size.SizeInBytes);
}

[Test]
public void StaticSizes()
{
    Assert.AreEqual(new Size(), Size.Zero);
    Assert.AreEqual(new Size(0.0f, 0.0f), Size.Zero);
    Assert.AreEqual(new Size(0.5f, 0.5f), Size.Half);
    Assert.AreEqual(new Size(1.0f, 1.0f), Size.One);
    Assert.AreEqual(new Size(-1.0f, -1.0f), Size.Unused);
    Assert.AreEqual(8, Size.SizeInBytes);
}

Copy to Clipboard Print

[Test]
public void CreateWithEqualWidthAndHeight()
{
    var size = new Size(-1.2f);
    Assert.AreEqual(-1.2f, size.Width);
    Assert.AreEqual(-1.2f, size.Height);
}

[Test]
public void CreateWithEqualWidthAndHeight()
{
    var size = new Size(-1.2f);
    Assert.AreEqual(-1.2f, size.Width);
    Assert.AreEqual(-1.2f, size.Height);
}

Copy to Clipboard Print

[Test]
public void CreateFromString()
{
    var size = new Size("1.2, 2.4");
    Assert.AreEqual(1.2f, size.Width);
    Assert.AreEqual(2.4f, size.Height);
}

[Test]
public void CreateFromString()
{
    var size = new Size("1.2, 2.4");
    Assert.AreEqual(1.2f, size.Width);
    Assert.AreEqual(2.4f, size.Height);
}