C# Class Axiom.Media.PixelUtil

Show file Open project: WolfgangSt/axiom Class Usage Examples

Public Methods

Method Description
GetBitDepths ( PixelFormat format ) : int[]
GetBitMasks ( PixelFormat format ) : uint[]
GetComponentType ( PixelFormat format ) : PixelComponentType
GetFormatForBitDepths ( PixelFormat format, ushort integerBits, ushort floatBits ) : PixelFormat
GetFormatFromName ( string name ) : PixelFormat
GetFormatFromName ( string name, bool accessibleOnly ) : PixelFormat
GetFormatFromName ( string name, bool accessibleOnly, bool caseSensitive ) : PixelFormat

Gets the format from given name.

GetFormatName ( PixelFormat format ) : string
GetMemorySize ( int width, int height, int depth, PixelFormat format ) : int

Returns the size in memory of a region with the given extents and pixel format with consecutive memory layout.

In case that the format is non-compressed, this simply returns width * height * depth * PixelConverter.GetNumElemBytes(format). In the compressed case, this does serious magic.

GetNumElemBits ( PixelFormat format ) : int

Returns the size in bits of an element of the given pixel format.

GetNumElemBytes ( PixelFormat format ) : int

Returns the size in bytes of an element of the given pixel format.

HasAlpha ( PixelFormat format ) : bool
IsAccessible ( PixelFormat format ) : bool
IsCompressed ( PixelFormat format ) : bool
IsFloatingPoint ( PixelFormat format ) : bool
IsLuminance ( PixelFormat format ) : bool
IsNativeEndian ( PixelFormat format ) : bool

Method Details

GetBitDepths() public static method

public static GetBitDepths ( PixelFormat format ) : int[]
format PixelFormat
return int[]

GetBitMasks() public static method

public static GetBitMasks ( PixelFormat format ) : uint[]
format PixelFormat
return uint[]

GetComponentType() public static method

public static GetComponentType ( PixelFormat format ) : PixelComponentType
format PixelFormat
return PixelComponentType

GetFormatForBitDepths() public static method

public static GetFormatForBitDepths ( PixelFormat format, ushort integerBits, ushort floatBits ) : PixelFormat
format PixelFormat
integerBits ushort
floatBits ushort
return PixelFormat

GetFormatFromName() public static method

public static GetFormatFromName ( string name ) : PixelFormat
name string
return PixelFormat

GetFormatFromName() public static method

public static GetFormatFromName ( string name, bool accessibleOnly ) : PixelFormat
name string
accessibleOnly bool
return PixelFormat

GetFormatFromName() public static method

Gets the format from given name.
public static GetFormatFromName ( string name, bool accessibleOnly, bool caseSensitive ) : PixelFormat
name string The string of format name
accessibleOnly bool If true, non-accessible format will treat as invalid format, otherwise, all supported formats are valid.
caseSensitive bool Should be set true if string match should use case sensitivity.
return PixelFormat

GetFormatName() public static method

public static GetFormatName ( PixelFormat format ) : string
format PixelFormat
return string

GetMemorySize() public static method

Returns the size in memory of a region with the given extents and pixel format with consecutive memory layout.
In case that the format is non-compressed, this simply returns width * height * depth * PixelConverter.GetNumElemBytes(format). In the compressed case, this does serious magic.
public static GetMemorySize ( int width, int height, int depth, PixelFormat format ) : int
width int Width of the area
height int Height of the area
depth int Depth of the area
format PixelFormat Format of the area
return int

GetNumElemBits() public static method

Returns the size in bits of an element of the given pixel format.
public static GetNumElemBits ( PixelFormat format ) : int
format PixelFormat Pixel format to test.
return int

GetNumElemBytes() public static method

Returns the size in bytes of an element of the given pixel format.
public static GetNumElemBytes ( PixelFormat format ) : int
format PixelFormat Pixel format to test.
return int

HasAlpha() public static method

public static HasAlpha ( PixelFormat format ) : bool
format PixelFormat
return bool

IsAccessible() public static method

public static IsAccessible ( PixelFormat format ) : bool
format PixelFormat
return bool

IsCompressed() public static method

public static IsCompressed ( PixelFormat format ) : bool
format PixelFormat
return bool

IsFloatingPoint() public static method

public static IsFloatingPoint ( PixelFormat format ) : bool
format PixelFormat
return bool

IsLuminance() public static method

public static IsLuminance ( PixelFormat format ) : bool
format PixelFormat
return bool

IsNativeEndian() public static method

public static IsNativeEndian ( PixelFormat format ) : bool
format PixelFormat
return bool