Interface IImageData

Interface describing operations that are possible on arbitrary image data types. Also contains the pixel data as byte array.

Namespace: Fusee.Base.Common

Assembly: Fusee.Base.Common.dll

Syntax

public interface IImageData

Properties

Height

Height in pixels.

Declaration

int Height { get; }

Property Value

Type	Description
System.Int32

IsEmpty

Returns true if IImageData has not been initialized with an byte array.

Declaration

bool IsEmpty { get; }

Property Value

Type	Description
System.Boolean

PixelData

The pixel values.

Declaration

byte[] PixelData { get; }

Property Value

Type	Description
System.Byte[]

PixelFormat

Offers additional Information about the color format of the texture.

Declaration

ImagePixelFormat PixelFormat { get; }

Property Value

Type	Description
ImagePixelFormat

Width

Width in pixels.

Declaration

int Width { get; }

Property Value

Type	Description
System.Int32

Methods

Blt(Int32, Int32, IImageData, Int32, Int32, Int32, Int32)

Block Image Transfer. Write a block of pixels to this instance from some other IImageData

Declaration

void Blt(int xDst, int yDst, IImageData src, int xSrc = 0, int ySrc = 0, int width = 0, int height = 0)

Parameters

Type	Name	Description
System.Int32	xDst	x offset (pixels) of destination.
System.Int32	yDst	y offset (pixels) of destination.
IImageData	src	The source IImageData instance. The pixel Block will be copied from here.
System.Int32	xSrc	x offset (pixels) of source.
System.Int32	ySrc	y offset (pixels) of source.
System.Int32	width	Width of the pixel block in pixels.
System.Int32	height	Height of the pixel block in pixels.

ScanLines(Int32, Int32, Int32, Int32)

Expose a set of pixel lines (enables IImageData to be used as source in other instances' Blt)

Declaration

IEnumerator<ScanLine> ScanLines(int xSrc = 0, int ySrc = 0, int width = 0, int height = 0)

Parameters

Type	Name	Description
System.Int32	xSrc	x offset (pixels) of source.
System.Int32	ySrc	y offset (pixels) of source.
System.Int32	width	Width of all Scanlines in pixels.
System.Int32	height	Height of all Scanlines in pixels.

Returns

Type	Description
System.Collections.Generic.IEnumerator<ScanLine>