Gorgon
Show / Hide Table of Contents

Class GorgonImageInfo

Provides information describing how to create an image.

Inheritance
object
GorgonImageInfo
Implements
IGorgonImageInfo
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Gorgon.Graphics.Imaging
Assembly: Gorgon.Graphics.Imaging.dll
Syntax
public class GorgonImageInfo : IGorgonImageInfo

Constructors

| Edit this page View Source

GorgonImageInfo(IGorgonImageInfo, ImageType?, BufferFormat?)

Initializes a new instance of the GorgonImageInfo class.

Declaration
public GorgonImageInfo(IGorgonImageInfo info, ImageType? imageType = null, BufferFormat? format = null)
Parameters
Type Name Description
IGorgonImageInfo info

The initial image information to copy into this instance.

ImageType? imageType

[Optional] An updated image type.

BufferFormat? format

[Optional] An updated image pixel format.

| Edit this page View Source

GorgonImageInfo(ImageType, BufferFormat)

Initializes a new instance of the GorgonImageInfo class.

Declaration
public GorgonImageInfo(ImageType imageType, BufferFormat format)
Parameters
Type Name Description
ImageType imageType

The type of the image to create.

BufferFormat format

The format describing how a pixel is laid out in memory.

Properties

| Edit this page View Source

ArrayCount

Property to return the total number of images there are in an image array.

Declaration
public int ArrayCount { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Depth

Property to return the depth of an image, in pixels.

Declaration
public int Depth { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Format

Property to return the pixel format for an image.

Declaration
public BufferFormat Format { get; set; }
Property Value
Type Description
BufferFormat
| Edit this page View Source

HasPreMultipliedAlpha

Property to return whether the image data is using premultiplied alpha.

Declaration
public bool HasPreMultipliedAlpha { get; }
Property Value
Type Description
bool
| Edit this page View Source

Height

Property to return the height of an image, in pixels.

Declaration
public int Height { get; set; }
Property Value
Type Description
int
| Edit this page View Source

ImageType

Property to return the type of image data.

Declaration
public ImageType ImageType { get; set; }
Property Value
Type Description
ImageType
| Edit this page View Source

IsPowerOfTwo

Property to return whether the size of the texture is a power of 2 or not.

Declaration
public bool IsPowerOfTwo { get; }
Property Value
Type Description
bool
| Edit this page View Source

MipCount

Property to return the number of mip map levels in the image.

Declaration
public int MipCount { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Width

Property to return the width of an image, in pixels.

Declaration
public int Width { get; set; }
Property Value
Type Description
int

Implements

IGorgonImageInfo

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)
GorgonNullExtensions.AsNullable<T>(object)
GorgonNullExtensions.IfNull<T>(object, T)
GorgonNullExtensions.IsNull(object)
  • Edit this page
  • View Source
In this article
Back to top Copyright 2023 - Licensed under the MIT license by Michael Winsor (Tape_Worm).
Send comments on this topic to the author