GrapeCity.Documents.DX.DXGI.FormatHelper

Class FormatHelper

Namespace

GrapeCity.Documents.DX.DXGI

Assembly

GcDocs.DX.Windows.dll

Helper to use with Format.

public static class FormatHelper

Inheritance

object

FormatHelper

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

ComputeScanlineCount(Format, int)

Computes the scanline count (number of scanlines).

public static int ComputeScanlineCount(Format fmt, int height)

Parameters

fmt Format

The Format.

height int

The height.

Returns

int

The scanline count.

IsCompressed(Format)

Returns true if the Format is a compressed format.

public static bool IsCompressed(Format fmt)

Parameters

fmt Format

The format to check for compressed.

Returns

bool

True if the Format is a compressed format

IsPacked(Format)

Determines whether the specified Format is packed.

public static bool IsPacked(Format fmt)

Parameters

fmt Format

The DXGI Format.

Returns

bool

true if the specified Format is packed; otherwise, false.

IsSRgb(Format)

Determines whether the specified Format is a SRGB format.

public static bool IsSRgb(Format fmt)

Parameters

fmt Format

The Format.

Returns

bool

true if the specified Format is a SRGB format; otherwise, false.

IsTypeless(Format)

Determines whether the specified Format is typeless.

public static bool IsTypeless(Format fmt)

Parameters

fmt Format

The Format.

Returns

bool

true if the specified Format is typeless; otherwise, false.

IsValid(Format)

Returns true if the Format is valid.

public static bool IsValid(Format format)

Parameters

format Format

A format to validate

Returns

bool

True if the Format is valid.

IsVideo(Format)

Determines whether the specified Format is video.

public static bool IsVideo(Format fmt)

Parameters

fmt Format

The Format.

Returns

bool

true if the specified Format is video; otherwise, false.

SizeOfInBits(Format)

Calculates the size of a Format in bits.

public static int SizeOfInBits(Format format)

Parameters

format Format

The dxgi format.

Returns

int

size of in bits

SizeOfInBytes(Format)

Calculates the size of a Format in bytes.

public static float SizeOfInBytes(Format format)

Parameters

format Format

The dxgi format.

Returns

float

size of in bytes