Inherits System::Drawing::Image.

Public Member Functions
ASPOSECPP_SHARED_API	Bitmap (const SharedPtr< Image > &original)

ASPOSECPP_SHARED_API	Bitmap (const SharedPtr< System::IO::Stream > &stream, bool useIcm=false)

ASPOSECPP_SHARED_API	Bitmap (const String &filename)

ASPOSECPP_SHARED_API	Bitmap (const String &filename, bool useIcm)

ASPOSECPP_SHARED_API	Bitmap (int width, int height, Imaging::PixelFormat format=Imaging::PixelFormat::Format32bppArgb)

ASPOSECPP_SHARED_API	Bitmap (const SharedPtr< Image > &original, const Size &size)

ASPOSECPP_SHARED_API	Bitmap (const SharedPtr< Image > &original, int width, int height)

	MEMBER_FUNCTION_MAKE_OBJECT (Bitmap, CODEPORTING_ARGS(const SharedPtr< Image > &original, int width, int height), CODEPORTING_ARGS(original, width, height))

virtual ASPOSECPP_SHARED_API int	get_Width () const override
	Returns the width of the image in pixels. More...

virtual ASPOSECPP_SHARED_API int	get_Height () const override
	Returns the height of the image in pixels. More...

virtual ASPOSECPP_SHARED_API Imaging::ImageFormatPtr	get_RawFormat () const override
	Returns the file format of the image represented by the current object. More...

virtual ASPOSECPP_SHARED_API Imaging::PixelFormat	get_PixelFormat () const override
	Returns the pixel format of the image represented by the current object. More...

virtual ASPOSECPP_SHARED_API Imaging::ColorPalettePtr	get_Palette () const override
	Returns the color palette used by the image represented by the current object. More...

ASPOSECPP_SHARED_API void	set_Palette (Imaging::ColorPalettePtr value) override

ASPOSECPP_SHARED_API void	SetResolution (float xDpi, float yDpi)

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

ASPOSECPP_SHARED_API Imaging::BitmapDataPtr	LockBits (const Rectangle &rect, Imaging::ImageLockMode flags, Imaging::PixelFormat format)

ASPOSECPP_SHARED_API Imaging::BitmapDataPtr	LockBits (const Rectangle &rect, Imaging::ImageLockMode flags, Imaging::PixelFormat format, const Imaging::BitmapDataPtr &bitmap_data)

ASPOSECPP_SHARED_API void	UnlockBits (const Imaging::BitmapDataPtr &bitmap_data)

ASPOSECPP_SHARED_API Color	GetPixel (int x, int y)

ASPOSECPP_SHARED_API void	MakeTransparent (Color transparent_color=Color::get_LightGray())

ASPOSECPP_SHARED_API IntPtr	GetHbitmap ()

virtual ASPOSECPP_SHARED_API SharedPtr< Image >	Clone () override

ASPOSECPP_SHARED_API SharedPtr< Bitmap >	Clone (Rectangle rect, Imaging::PixelFormat format)

ASPOSECPP_SHARED_API SharedPtr< Bitmap >	Clone (RectangleF rect, Imaging::PixelFormat format)

virtual ASPOSECPP_SHARED_API void	RotateFlip (RotateFlipType rotate_flip_type) override

virtual ASPOSECPP_SHARED_API const SkBitmap *	GetSkBitmap () const override
	Returns a raw pointer to the underlying SkBitmap object. More...

virtual ASPOSECPP_SHARED_API bool	IsMultiImage () const override
	Returns whether the original format is a multi-image. More...

ASPOSECPP_SHARED_API void	PremultipleColors ()
	Premultiplies the colors of the pixels of the image represented by the current object. More...

ASPOSECPP_SHARED_API bool	BeginPixelProcessing (bool update_colors=1)

ASPOSECPP_SHARED_API bool	EndPixelProcessing (bool update_colors=1)

ASPOSECPP_SHARED_API ArrayPtr< uint8_t >	ComputeHash ()

Public Member Functions inherited from System::Drawing::Image
ASPOSECPP_SHARED_API void	Save (const String &filename)

ASPOSECPP_SHARED_API void	Save (const String &filename, const Imaging::ImageFormatPtr &format)

ASPOSECPP_SHARED_API void	Save (const SharedPtr< System::IO::Stream > &stream, const Imaging::ImageFormatPtr &format)

ASPOSECPP_SHARED_API void	Save (const String &filename, const Imaging::ImageCodecInfoPtr &encoder, const Imaging::EncoderParametersPtr &encoder_params)

ASPOSECPP_SHARED_API void	Save (const SharedPtr< System::IO::Stream > &stream, const Imaging::ImageCodecInfoPtr &encoder, const Imaging::EncoderParametersPtr &encoder_params)

ASPOSECPP_SHARED_API void	SaveAdd (const Imaging::EncoderParametersPtr &encoder_params)

ASPOSECPP_SHARED_API void	SaveAdd (const SharedPtr< Image > &image, const Imaging::EncoderParametersPtr &encoder_params)

virtual ASPOSECPP_SHARED_API ArrayPtr< int >	get_PropertyIdList () const
	Gets IDs of the property items stored in this image. More...

ASPOSECPP_SHARED_API RectangleF	GetBounds (GraphicsUnit &page_unit)

virtual int32_t	get_Flags () const

ASPOSECPP_SHARED_API Size	get_Size () const

virtual ASPOSECPP_SHARED_API System::SharedPtr< System::Object >	get_Tag () const
	Gets an object that provides additional data about the image. More...

virtual ASPOSECPP_SHARED_API void	set_Tag (const System::SharedPtr< System::Object > tag)
	Sets an object that provides additional data about the image. More...

ASPOSECPP_SHARED_API float	get_HorizontalResolution () const
	Returns the horizontal resolution of the image represented by the current object in pixels per inch. More...

ASPOSECPP_SHARED_API float	get_VerticalResolution () const
	Returns the vertical resolution of the image represented by the current object in pixels per inch. More...

ASPOSECPP_SHARED_API ArrayPtr< Guid >	get_FrameDimensionsList () const

ASPOSECPP_SHARED_API int	GetFrameCount (const Imaging::FrameDimensionPtr &dimension)

ASPOSECPP_SHARED_API int	SelectActiveFrame (const Imaging::FrameDimensionPtr &dimension, int frameIndex)

virtual ASPOSECPP_SHARED_API ArrayPtr< SharedPtr< Imaging::PropertyItem > >	get_PropertyItems () const
	Gets all the property items(pieces of metadata) stored in this image. More...

void	Dispose () override
	Releases all resources aquired by the current object. More...

ASPOSECPP_SHARED_API SharedPtr< Image >	GetThumbnailImage (int thumbWidth, int thumbHeight, Image::GetThumbnailImageAbort callback, IntPtr callbackData)

Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API	Object ()
	Creates object. Initializes all internal data structures. More...

virtual ASPOSECPP_SHARED_API	~Object ()
	Destroys object. Frees all internal data structures. More...

ASPOSECPP_SHARED_API	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

ASPOSECPP_SHARED_API void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

ASPOSECPP_SHARED_API void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual ASPOSECPP_SHARED_API bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual ASPOSECPP_SHARED_API int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual ASPOSECPP_SHARED_API String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ASPOSECPP_SHARED_API ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual ASPOSECPP_SHARED_API const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual ASPOSECPP_SHARED_API bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual ASPOSECPP_SHARED_API void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual ASPOSECPP_SHARED_API bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	Equals (float const &objA, float const &objB)

template<>
bool	Equals (double const &objA, double const &objB)

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)

template<>
bool	ReferenceEquals (String const &str1, String const &str2)

Static Public Member Functions
static ASPOSECPP_SHARED_API SharedPtr< Bitmap >	ConvertToARGBImage (const SharedPtr< Bitmap > &src_bmp)

Static Public Member Functions inherited from System::Drawing::Image
static ASPOSECPP_SHARED_API SharedPtr< Image >	FromStream (const SharedPtr< System::IO::Stream > &stream, bool use_embedded_color_management=false, bool validate_image_data=1)

static ASPOSECPP_SHARED_API SharedPtr< Image >	FromFile (const String &filename, bool use_embedded_color_management=false)

static ASPOSECPP_SHARED_API bool	IsAlphaPixelFormat (Imaging::PixelFormat pixfmt)

static ASPOSECPP_SHARED_API int	GetPixelFormatSize (Imaging::PixelFormat pixfmt)

static ASPOSECPP_SHARED_API SharedPtr< Bitmap >	FromHbitmap (IntPtr hbitmap)

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

Additional Inherited Members
Public Types inherited from System::Drawing::Image
using	GetThumbnailImageAbort = System::MulticastDelegate< bool()>
	A callback to cancel GetThumbnailImage execution. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Detailed Description

Represents a GDI+ bitmap image. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ Bitmap() [1/7]

ASPOSECPP_SHARED_API System::Drawing::Bitmap::Bitmap ( const SharedPtr< Image > & original )

Constructs a new Bitmap object from the specified existing image.

Parameters

original The existing image to create the bitmap image from

◆ Bitmap() [2/7]

ASPOSECPP_SHARED_API System::Drawing::Bitmap::Bitmap	(	const SharedPtr< System::IO::Stream > &	stream,
		bool	useIcm = `false`
	)

Constructs a new Bitmap object from the specified stream.

Parameters

stream	A stream that contains image data
useIcm	IGNORED

◆ Bitmap() [3/7]

ASPOSECPP_SHARED_API System::Drawing::Bitmap::Bitmap ( const String & filename )

Constructs a new Bitmap object from the specified file.

Parameters

filename A name of the file that contains image data

◆ Bitmap() [4/7]

ASPOSECPP_SHARED_API System::Drawing::Bitmap::Bitmap	(	const String &	filename,
		bool	useIcm
	)

Constructs a new Bitmap object from the specified file.

Parameters

filename	A name of the file that contains image data
useIcm	IGNORED

◆ Bitmap() [5/7]

ASPOSECPP_SHARED_API System::Drawing::Bitmap::Bitmap	(	int	width,
		int	height,
		Imaging::PixelFormat	format = `Imaging::PixelFormat::Format32bppArgb`
	)

Constructs a new Bitmap object that represents a bitmap image with the specified width, height, pixel format and pixel data.

Parameters

width	The width of the image
height	The height of the image
format	The pixel format of the image

◆ Bitmap() [6/7]

ASPOSECPP_SHARED_API System::Drawing::Bitmap::Bitmap	(	const SharedPtr< Image > &	original,
		const Size &	size
	)

Constructs a new Bitmap object from the specified existing image, scaled to the specified size.

Parameters

original	The existing image to create the bitmap image from
size	The size of the new image

◆ Bitmap() [7/7]

ASPOSECPP_SHARED_API System::Drawing::Bitmap::Bitmap	(	const SharedPtr< Image > &	original,
		int	width,
		int	height
	)

Constructs a new Bitmap object from the specified existing image with width and height scaled to the specified values.

Parameters

original	The existing image to create the bitmap image from
width	Width of the new image
height	Height of the new image

Member Function Documentation

◆ BeginPixelProcessing()

ASPOSECPP_SHARED_API bool System::Drawing::Bitmap::BeginPixelProcessing ( bool update_colors = 1 )

Enables pixel processing mode.

Parameters

update_colors Specifies whether to update colors.

◆ Clone() [1/3]

virtual ASPOSECPP_SHARED_API SharedPtr<Image> System::Drawing::Bitmap::Clone ( )

overridevirtual

Creates a copy of the current object.

Returns: A copy of the current object.

Implements System::Drawing::Image.

◆ Clone() [2/3]

ASPOSECPP_SHARED_API SharedPtr<Bitmap> System::Drawing::Bitmap::Clone	(	Rectangle	rect,
		Imaging::PixelFormat	format
	)

Creates a Bitmap object that represents a copy of a region of the bitmap image represented by the current object.

Parameters

rect	The rectangle that specifies the region to copy
format	The pixel format for the new Bitmap

Returns: The created Bitmap object

◆ Clone() [3/3]

ASPOSECPP_SHARED_API SharedPtr<Bitmap> System::Drawing::Bitmap::Clone	(	RectangleF	rect,
		Imaging::PixelFormat	format
	)

Creates a Bitmap object that represents a copy of a region of the bitmap image represented by the current object.

Parameters

rect	The rectangle that specifies the region to copy
format	The pixel format for the new Bitmap

Returns: The created Bitmap object

◆ ComputeHash()

ASPOSECPP_SHARED_API ArrayPtr<uint8_t> System::Drawing::Bitmap::ComputeHash ( )

Computes the SHA1 hash value.

Returns: The computed hash code.

◆ ConvertToARGBImage()

static ASPOSECPP_SHARED_API SharedPtr<Bitmap> System::Drawing::Bitmap::ConvertToARGBImage ( const SharedPtr< Bitmap > & src_bmp )

static

Creates a copy of the specified bitmap image with pixel format changed to Format32bppArgb.

Parameters

src_bmp The original bitmap to copy

Returns: The copy of the original bitmap with the pixel format changed to Format32bppArgb

◆ EndPixelProcessing()

ASPOSECPP_SHARED_API bool System::Drawing::Bitmap::EndPixelProcessing ( bool update_colors = 1 )

Disables pixel processing mode.

Parameters

update_colors Specifies whether to update colors.

◆ get_Height()

virtual ASPOSECPP_SHARED_API int System::Drawing::Bitmap::get_Height ( ) const

overridevirtual

Returns the height of the image in pixels.

Implements System::Drawing::Image.

◆ get_Palette()

virtual ASPOSECPP_SHARED_API Imaging::ColorPalettePtr System::Drawing::Bitmap::get_Palette ( ) const

overridevirtual

Returns the color palette used by the image represented by the current object.

Reimplemented from System::Drawing::Image.

◆ get_PixelFormat()

virtual ASPOSECPP_SHARED_API Imaging::PixelFormat System::Drawing::Bitmap::get_PixelFormat ( ) const

overridevirtual

Returns the pixel format of the image represented by the current object.

Implements System::Drawing::Image.

◆ get_RawFormat()

virtual ASPOSECPP_SHARED_API Imaging::ImageFormatPtr System::Drawing::Bitmap::get_RawFormat ( ) const

overridevirtual

Returns the file format of the image represented by the current object.

Implements System::Drawing::Image.

◆ get_Width()

virtual ASPOSECPP_SHARED_API int System::Drawing::Bitmap::get_Width ( ) const

overridevirtual

Returns the width of the image in pixels.

Implements System::Drawing::Image.

◆ GetHbitmap()

ASPOSECPP_SHARED_API IntPtr System::Drawing::Bitmap::GetHbitmap ( )

Creates a GDI bitmap object from the bitmap represented by the current object.

Returns: A handle to the created GDI bitmap object.

◆ GetPixel()

ASPOSECPP_SHARED_API Color System::Drawing::Bitmap::GetPixel	(	int	x,
		int	y
	)

Returns the color of the specified pixel.

Parameters

x	The X coordinate of the pixel whose color to return
y	The Y coordinate of the pixel whose color to return

Returns: The color of the specified pixel

◆ GetSkBitmap()

virtual ASPOSECPP_SHARED_API const SkBitmap* System::Drawing::Bitmap::GetSkBitmap ( ) const

overridevirtual

Returns a raw pointer to the underlying SkBitmap object.

Implements System::Drawing::Image.

◆ IsMultiImage()

virtual ASPOSECPP_SHARED_API bool System::Drawing::Bitmap::IsMultiImage ( ) const

overridevirtual

Returns whether the original format is a multi-image.

Reimplemented from System::Drawing::Image.

◆ LockBits() [1/2]

ASPOSECPP_SHARED_API Imaging::BitmapDataPtr System::Drawing::Bitmap::LockBits	(	const Rectangle &	rect,
		Imaging::ImageLockMode	flags,
		Imaging::PixelFormat	format
	)

Locks a Bitmap into system memory.

Parameters

rect	A rectangle that specifies the region of the image to lock
flags	Specifies the access level to the bitmap
format	The data format of this bitmap

Returns: A shared pointer to a BitmapData object that contains information about the performed lock operation

◆ LockBits() [2/2]

ASPOSECPP_SHARED_API Imaging::BitmapDataPtr System::Drawing::Bitmap::LockBits	(	const Rectangle &	rect,
		Imaging::ImageLockMode	flags,
		Imaging::PixelFormat	format,
		const Imaging::BitmapDataPtr &	bitmap_data
	)

Locks a Bitmap into system memory.

Parameters

rect	A rectangle that specifies the region of the image to lock
flags	Specifies the access level to the bitmap
format	The data format of this bitmap
bitmap_data	Contains information about the lock operation

Returns: A shared pointer to a BitmapData object that contains information about the performed lock operation

◆ MakeTransparent()

ASPOSECPP_SHARED_API void System::Drawing::Bitmap::MakeTransparent ( Color transparent_color = Color::get_LightGray() )

Changes the color of all pixels with the specified color to transparent.

Parameters

transparent_color The color of the pixels whose color to change

◆ MEMBER_FUNCTION_MAKE_OBJECT()

System::Drawing::Bitmap::MEMBER_FUNCTION_MAKE_OBJECT	(	Bitmap	,
		CODEPORTING_ARGS(const SharedPtr< Image > &original, int width, int height)	,
		CODEPORTING_ARGS(original, width, height)
	)

◆ PremultipleColors()

ASPOSECPP_SHARED_API void System::Drawing::Bitmap::PremultipleColors ( )

Premultiplies the colors of the pixels of the image represented by the current object.

◆ RotateFlip()

virtual ASPOSECPP_SHARED_API void System::Drawing::Bitmap::RotateFlip ( RotateFlipType rotate_flip_type )

overridevirtual

Rotates image to multiple of 90 degrees and flips.

Parameters

rotate_flip_type The type of rotation and/or flip operation

Reimplemented from System::Drawing::Image.

◆ set_Palette()

ASPOSECPP_SHARED_API void System::Drawing::Bitmap::set_Palette ( Imaging::ColorPalettePtr value )

overridevirtual

Sets the color palette used by the image represented by the current object.

Parameters

value The value to set

Reimplemented from System::Drawing::Image.

◆ SetPixel()

ASPOSECPP_SHARED_API void System::Drawing::Bitmap::SetPixel	(	int	x,
		int	y,
		Color	color
	)

Sets the color of the specified pixel in the bitmap image represented by the current object.

Parameters

x	X coordinate of the pixel
y	Y coordinate of the pixel
color	The new color to set

◆ SetResolution()

ASPOSECPP_SHARED_API void System::Drawing::Bitmap::SetResolution	(	float	xDpi,
		float	yDpi
	)

Sets the resolution of the image.

Parameters

xDpi	The new horizontal resolution in pixels per inch.
yDpi	The new vertical resolution in pixels per inch.

◆ UnlockBits()

ASPOSECPP_SHARED_API void System::Drawing::Bitmap::UnlockBits ( const Imaging::BitmapDataPtr & bitmap_data )

Unlocks the specified bitmap from system memory.

Parameters

bitmap_data An object that contains information about the lock operation

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Bitmap() [1/7]

◆ Bitmap() [2/7]

◆ Bitmap() [3/7]

◆ Bitmap() [4/7]

◆ Bitmap() [5/7]

◆ Bitmap() [6/7]

◆ Bitmap() [7/7]

Member Function Documentation

◆ BeginPixelProcessing()

◆ Clone() [1/3]

◆ Clone() [2/3]

◆ Clone() [3/3]

◆ ComputeHash()

◆ ConvertToARGBImage()

◆ EndPixelProcessing()

◆ get_Height()

◆ get_Palette()

◆ get_PixelFormat()

◆ get_RawFormat()

◆ get_Width()

◆ GetHbitmap()

◆ GetPixel()

◆ GetSkBitmap()

◆ IsMultiImage()

◆ LockBits() [1/2]

◆ LockBits() [2/2]

◆ MakeTransparent()

◆ MEMBER_FUNCTION_MAKE_OBJECT()

◆ PremultipleColors()

◆ RotateFlip()

◆ set_Palette()

◆ SetPixel()

◆ SetResolution()

◆ UnlockBits()