Image Class

SFML.Net

Image Class

Image is the low-level class for loading and manipulating images

Inheritance Hierarchy

SystemObject SFMLObjectBase
SFML.GraphicsImage

Namespace: SFML.Graphics
Assembly: sfmlnet-graphics-2 (in sfmlnet-graphics-2.dll) Version: 2.2.0.0 (2.2.0)

Syntax

public class Image : ObjectBase

Public Class Image
	Inherits ObjectBase

public ref class Image : public ObjectBase

type Image =  
    class
        inherit ObjectBase
    end

The Image type exposes the following members.

Constructors

	Name	Description
	Image(Byte)	Construct the image from a file in memory
	Image(Stream)	Construct the image from a file in a stream
	Image(String)	Construct the image from a file
	Image(Color)	Construct the image directly from an array of pixels
	Image(Image)	Construct the image from another image
	Image(UInt32, UInt32)	Construct the image with black color
	Image(UInt32, UInt32, Color)	Construct the image from a single color
	Image(UInt32, UInt32, Byte)	Construct the image directly from an array of pixels

Methods

	Name	Description
	Copy(Image, UInt32, UInt32)	Copy pixels from another image onto this one. This function does a slow pixel copy and should only be used at initialization time
	Copy(Image, UInt32, UInt32, IntRect)	Copy pixels from another image onto this one. This function does a slow pixel copy and should only be used at initialization time
	Copy(Image, UInt32, UInt32, IntRect, Boolean)	Copy pixels from another image onto this one. This function does a slow pixel copy and should only be used at initialization time
	CreateMaskFromColor(Color)	Create a transparency mask from a specified colorkey
	CreateMaskFromColor(Color, Byte)	Create a transparency mask from a specified colorkey
	Destroy	Handle the destruction of the object (Overrides ObjectBaseDestroy(Boolean).)
	Dispose	Explicitely dispose the object (Inherited from ObjectBase.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Dispose the object (Inherited from ObjectBase.)
	FlipHorizontally	Flip the image horizontally
	FlipVertically	Flip the image vertically
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetPixel	Get a pixel from the image
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SaveToFile	Save the contents of the image to a file
	SetPixel	Change the color of a pixel
	ToString	Provide a string describing the object (Overrides ObjectToString.)

Properties

	Name	Description
	CPointer	Access to the internal pointer of the object. For internal use only (Inherited from ObjectBase.)
	Pixels	Get a copy of the array of pixels (RGBA 8 bits integers components) Array size is Width x Height x 4
	Size	Size of the image, in pixels