AtomicNET : AtomicEngine Namespace

Image Class

%Image resource.

Syntax

public class Image : Resource

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from Resource.

Public Constructors

Image ()
Documentation for this section has not yet been entered.
Construct empty.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

[read-only]
Array bool . Documentation for this section has not yet been entered.
AsyncLoadState AsyncLoadState . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Components uint . Documentation for this section has not yet been entered.
[read-only]
Compressed bool . Documentation for this section has not yet been entered.
[read-only]
CompressedFormat CompressedFormat . Documentation for this section has not yet been entered.
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Cubemap bool . Documentation for this section has not yet been entered.
[read-only]
Depth int . Documentation for this section has not yet been entered.
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Height int . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
MemoryUse uint . Documentation for this section has not yet been entered. (Inherited from Resource.)
Name string . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
NameHash StringHash . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
NextLevel Image . Documentation for this section has not yet been entered.
[read-only]
NextSibling Image . Documentation for this section has not yet been entered.
[read-only]
NumCompressedLevels uint . Documentation for this section has not yet been entered.
[read-only]
SRGB bool . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeNameStatic string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
UseTimer uint . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
Width int . Documentation for this section has not yet been entered.

Public Methods

AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
override
BeginLoad (Deserializer) : bool
Load resource from stream. May be called from a worker thread. Return true if successful.
BeginLoad (Deserializer) : bool
Load resource from stream. May be called from a worker thread. Return true if successful. (Inherited from Resource.)
CleanupLevels ()
Clean up the mip levels.
Clear (Color)
Clear the image with a color.
ClearInt (uint)
Clear the image with an integer color. R component is in the 8 lowest bits.
ConvertToRGBA () : Image
Return image converted to 4-component (RGBA) to circumvent modern rendering API's not supporting e.g. the luminance-alpha format.
static
csb_Atomic_Image_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
EndLoad () : bool
Finish resource loading. Always called from the main thread. Return true if successful. (Inherited from Resource.)
FlipHorizontal () : bool
Flip image horizontally. Return true if successful.
FlipVertical () : bool
Flip image vertically. Return true if successful.
GetAsyncLoadState () : AsyncLoadState
Return the asynchronous loading state. (Inherited from Resource.)
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetComponents () : uint
Return number of color components.
GetCompressedFormat () : CompressedFormat
Return compressed format.
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetDepth () : int
Return depth.
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetHeight () : int
Return height.
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetLevels (Vector<Image>)
Get all stored mip levels starting from this.
GetMemoryUse () : uint
Return memory use in bytes, possibly approximate. (Inherited from Resource.)
GetName () : string
Return name. (Inherited from Resource.)
GetNameHash () : StringHash
Return name hash. (Inherited from Resource.)
GetNextLevel () : Image
Return next mip level by bilinear filtering. Note that if the image is already 1x1x1, will keep returning an image of that size.
GetNextSibling () : Image
Return the next sibling image of an array or cubemap.
GetNumCompressedLevels () : uint
Return number of compressed mip levels. Returns 0 if the image is has not been loaded from a source file containing multiple mip levels.
GetPixel (int, int) : Color
Return a 2D pixel color.
GetPixel (int, int, int) : Color
Return a 3D pixel color.
GetPixelBilinear (float, float) : Color
Return a bilinearly sampled 2D pixel color. X and Y have the range 0-1.
GetPixelInt (int, int) : uint
Return a 2D pixel integer color. R component is in the 8 lowest bits.
GetPixelInt (int, int, int) : uint
Return a 3D pixel integer color. R component is in the 8 lowest bits.
GetPixelTrilinear (float, float, float) : Color
Return a trilinearly sampled 3D pixel color. X, Y and Z have the range 0-1.
GetSubimage (IntRect) : Image
Return subimage from the image by the defined rect or null if failed. 3D images are not supported. You must free the subimage yourself.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetUseTimer () : uint
Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero. (Inherited from Resource.)
GetWidth () : int
Return width.
HasAlphaChannel () : bool
Whether this texture has an alpha channel
HasEventHandlers () : bool
Return whether has subscribed to any event. (Inherited from AObject.)
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender. (Inherited from AObject.)
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event. (Inherited from AObject.)
IsArray () : bool
Whether this texture has been detected as a volume, only relevant for DDS.
IsCompressed () : bool
Return whether is compressed.
IsCubemap () : bool
Whether this texture is detected as a cubemap, only relevant for DDS.
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
IsSRGB () : bool
Whether this texture is in sRGB, only relevant for DDS.
Load (Deserializer) : bool
Documentation for this section has not yet been entered. (Inherited from Resource.)
LoadColorLUT (Deserializer) : bool
Load as color LUT. Return true if successful.
PrecalculateLevels ()
Precalculate the mip levels. Used by asynchronous texture loading.
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
ResetUseTimer ()
Reset last used timer. (Inherited from Resource.)
Resize (int, int) : bool
Resize image by bilinear resampling. Return true if successful.
override
Save (Serializer) : bool
Save the image to a stream. Regardless of original format, the image is saved as png. Compressed image data is not supported. Return true if successful.
Save (Serializer) : bool
Save resource. Return true if successful. (Inherited from Resource.)
SaveBMP (string) : bool
Save in BMP format. Return true if successful.
SaveDDS (string) : bool
Documentation for this section has not yet been entered.
SaveJPG (string, int) : bool
Save in JPG format with compression quality. Return true if successful.
SavePNG (string) : bool
Save in PNG format. Return true if successful.
SaveTGA (string) : bool
Save in TGA format. Return true if successful.
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetAsyncLoadState (AsyncLoadState)
Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user. (Inherited from Resource.)
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetMemoryUse (uint)
Set memory use in bytes, possibly approximate. (Inherited from Resource.)
SetName (string)
Set name. (Inherited from Resource.)
SetPixel (int, int, Color)
Set a 2D pixel.
SetPixel (int, int, int, Color)
Set a 3D pixel.
SetPixelInt (int, int, uint)
Set a 2D pixel with an integer color. R component is in the 8 lowest bits.
SetPixelInt (int, int, int, uint)
Set a 3D pixel with an integer color. R component is in the 8 lowest bits.
SetSize (int, int, uint) : bool
Set 2D size and number of color components. Old image data will be destroyed and new data is undefined. Return true if successful.
SetSize (int, int, int, uint) : bool
Set 3D size and number of color components. Old image data will be destroyed and new data is undefined. Return true if successful.
SetSubimage (Image, IntRect) : bool
Copy contents of the image into the defined rect, scaling if necessary. This image should already be large enough to include the rect. Compressed and 3D images are not supported.
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event. (Inherited from AObject.)
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event. (Inherited from AObject.)
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object) (Inherited from AObject.)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events. (Inherited from AObject.)
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

Image Constructor

Documentation for this section has not yet been entered.

Syntax

public Image ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Image Constructor

Construct empty.

Syntax

public Image (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Array Property

Documentation for this section has not yet been entered.

Syntax

public bool Array { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

BeginLoad Method

Load resource from stream. May be called from a worker thread. Return true if successful.

Syntax

public override bool BeginLoad (Deserializer source)

Parameters

source
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

CleanupLevels Method

Clean up the mip levels.

Syntax

public void CleanupLevels ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Clear Method

Clear the image with a color.

Syntax

public void Clear (Color color)

Parameters

color
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ClearInt Method

Clear the image with an integer color. R component is in the 8 lowest bits.

Syntax

public void ClearInt (uint uintColor)

Parameters

uintColor
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Components Property

Documentation for this section has not yet been entered.

Syntax

public uint Components { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Compressed Property

Documentation for this section has not yet been entered.

Syntax

public bool Compressed { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

CompressedFormat Property

Documentation for this section has not yet been entered.

Syntax

public CompressedFormat CompressedFormat { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ConvertToRGBA Method

Return image converted to 4-component (RGBA) to circumvent modern rendering API's not supporting e.g. the luminance-alpha format.

Syntax

public Image ConvertToRGBA ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_Image_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_Image_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Cubemap Property

Documentation for this section has not yet been entered.

Syntax

public bool Cubemap { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Depth Property

Documentation for this section has not yet been entered.

Syntax

public int Depth { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

FlipHorizontal Method

Flip image horizontally. Return true if successful.

Syntax

public bool FlipHorizontal ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

FlipVertical Method

Flip image vertically. Return true if successful.

Syntax

public bool FlipVertical ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetComponents Method

Return number of color components.

Syntax

public uint GetComponents ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetCompressedFormat Method

Return compressed format.

Syntax

public CompressedFormat GetCompressedFormat ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetDepth Method

Return depth.

Syntax

public int GetDepth ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetHeight Method

Return height.

Syntax

public int GetHeight ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLevels Method

Get all stored mip levels starting from this.

Syntax

public void GetLevels (Vector<Image> levels)

Parameters

levels
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetNextLevel Method

Return next mip level by bilinear filtering. Note that if the image is already 1x1x1, will keep returning an image of that size.

Syntax

public Image GetNextLevel ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetNextSibling Method

Return the next sibling image of an array or cubemap.

Syntax

public Image GetNextSibling ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetNumCompressedLevels Method

Return number of compressed mip levels. Returns 0 if the image is has not been loaded from a source file containing multiple mip levels.

Syntax

public uint GetNumCompressedLevels ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPixel Method

Return a 2D pixel color.

Syntax

public Color GetPixel (int x, int y)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPixel Method

Return a 3D pixel color.

Syntax

public Color GetPixel (int x, int y, int z)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.
z
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPixelBilinear Method

Return a bilinearly sampled 2D pixel color. X and Y have the range 0-1.

Syntax

public Color GetPixelBilinear (float x, float y)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPixelInt Method

Return a 2D pixel integer color. R component is in the 8 lowest bits.

Syntax

public uint GetPixelInt (int x, int y)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPixelInt Method

Return a 3D pixel integer color. R component is in the 8 lowest bits.

Syntax

public uint GetPixelInt (int x, int y, int z)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.
z
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPixelTrilinear Method

Return a trilinearly sampled 3D pixel color. X, Y and Z have the range 0-1.

Syntax

public Color GetPixelTrilinear (float x, float y, float z)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.
z
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSubimage Method

Return subimage from the image by the defined rect or null if failed. 3D images are not supported. You must free the subimage yourself.

Syntax

public Image GetSubimage (IntRect rect)

Parameters

rect
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetWidth Method

Return width.

Syntax

public int GetWidth ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

HasAlphaChannel Method

Whether this texture has an alpha channel

Syntax

public bool HasAlphaChannel ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Height Property

Documentation for this section has not yet been entered.

Syntax

public int Height { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsArray Method

Whether this texture has been detected as a volume, only relevant for DDS.

Syntax

public bool IsArray ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsCompressed Method

Return whether is compressed.

Syntax

public bool IsCompressed ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsCubemap Method

Whether this texture is detected as a cubemap, only relevant for DDS.

Syntax

public bool IsCubemap ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsSRGB Method

Whether this texture is in sRGB, only relevant for DDS.

Syntax

public bool IsSRGB ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

LoadColorLUT Method

Load as color LUT. Return true if successful.

Syntax

public bool LoadColorLUT (Deserializer source)

Parameters

source
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NextLevel Property

Documentation for this section has not yet been entered.

Syntax

public Image NextLevel { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NextSibling Property

Documentation for this section has not yet been entered.

Syntax

public Image NextSibling { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NumCompressedLevels Property

Documentation for this section has not yet been entered.

Syntax

public uint NumCompressedLevels { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

PrecalculateLevels Method

Precalculate the mip levels. Used by asynchronous texture loading.

Syntax

public void PrecalculateLevels ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Resize Method

Resize image by bilinear resampling. Return true if successful.

Syntax

public bool Resize (int width, int height)

Parameters

width
Documentation for this section has not yet been entered.
height
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Save Method

Save the image to a stream. Regardless of original format, the image is saved as png. Compressed image data is not supported. Return true if successful.

Syntax

public override bool Save (Serializer dest)

Parameters

dest
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SaveBMP Method

Save in BMP format. Return true if successful.

Syntax

public bool SaveBMP (string fileName)

Parameters

fileName
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SaveDDS Method

Documentation for this section has not yet been entered.

Syntax

public bool SaveDDS (string fileName)

Parameters

fileName
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SaveJPG Method

Save in JPG format with compression quality. Return true if successful.

Syntax

public bool SaveJPG (string fileName, int quality)

Parameters

fileName
Documentation for this section has not yet been entered.
quality
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SavePNG Method

Save in PNG format. Return true if successful.

Syntax

public bool SavePNG (string fileName)

Parameters

fileName
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SaveTGA Method

Save in TGA format. Return true if successful.

Syntax

public bool SaveTGA (string fileName)

Parameters

fileName
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetPixel Method

Set a 2D pixel.

Syntax

public void SetPixel (int x, int y, Color color)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.
color
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetPixel Method

Set a 3D pixel.

Syntax

public void SetPixel (int x, int y, int z, Color color)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.
z
Documentation for this section has not yet been entered.
color
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetPixelInt Method

Set a 2D pixel with an integer color. R component is in the 8 lowest bits.

Syntax

public void SetPixelInt (int x, int y, uint uintColor)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.
uintColor
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetPixelInt Method

Set a 3D pixel with an integer color. R component is in the 8 lowest bits.

Syntax

public void SetPixelInt (int x, int y, int z, uint uintColor)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.
z
Documentation for this section has not yet been entered.
uintColor
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetSize Method

Set 2D size and number of color components. Old image data will be destroyed and new data is undefined. Return true if successful.

Syntax

public bool SetSize (int width, int height, uint components)

Parameters

width
Documentation for this section has not yet been entered.
height
Documentation for this section has not yet been entered.
components
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetSize Method

Set 3D size and number of color components. Old image data will be destroyed and new data is undefined. Return true if successful.

Syntax

public bool SetSize (int width, int height, int depth, uint components)

Parameters

width
Documentation for this section has not yet been entered.
height
Documentation for this section has not yet been entered.
depth
Documentation for this section has not yet been entered.
components
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetSubimage Method

Copy contents of the image into the defined rect, scaling if necessary. This image should already be large enough to include the rect. Compressed and 3D images are not supported.

Syntax

public bool SetSubimage (Image image, IntRect rect)

Parameters

image
Documentation for this section has not yet been entered.
rect
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SRGB Property

Documentation for this section has not yet been entered.

Syntax

public bool SRGB { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Width Property

Documentation for this section has not yet been entered.

Syntax

public int Width { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0