Inheritance diagram for xtd::drawing::bitmap:

Definition

Encapsulates a GDI+ bitmap, which consists of the pixel data for a graphics image and its attributes. A bitmap is an object used to work with images defined by pixel data.

class drawing_export_ bitmap : public xtd::drawing::image

xtd::drawing::bitmap::bitmap

bitmap(const xtd::drawing::image &original)

Initializes a new instance of the bitmap class from the specified existing image.

xtd::drawing::image

An abstract base class that provides functionality for the bitmap and metafile descended classes.

Definition image.hpp:49

drawing_export_

#define drawing_export_

Define shared library export.

Definition drawing_export.hpp:13

Inheritance: xtd::object → xtd::drawing::image → xtd::drawing::bitmap

Namespace: xtd::drawing

Library: xtd.drawing

Remarks: To draw an image on a Windows Form, you should use one of the draw_image methods.

Examples: about_dialog_from_executing_assembly_informations.cpp, graphics.cpp, hello_world_png.cpp, and image_effects.cpp.

Public Fields
static bitmap	empty
	Represent an empty bitmap.

Public Constructors
	bitmap (const xtd::drawing::image &original)
	Initializes a new instance of the bitmap class from the specified existing image.
	bitmap (const xtd::drawing::image &original, const xtd::drawing::size &new_size)
	Initializes a new instance of the bitmap class from the specified existing image, scaled to the specified size.
	bitmap (const xtd::drawing::image &original, xtd::int32 width, xtd::int32 height)
	Initializes a new instance of the bitmap class from the specified existing image, scaled to the specified size.
	bitmap (const xtd::drawing::image &original, const xtd::drawing::rectangle &new_rect)
	Initializes a new instance of the bitmap class from the specified existing image, resizing or cropping (without scaling) with the specified rectangle.
	bitmap (const xtd::string &filename)
	Initializes a new instance of the bitmap class from the specified file.
	bitmap (const xtd::string &filename, bool use_icm)
	Initializes a new instance of the bitmap class from the specified file.
	bitmap (std::istream &stream)
	Initializes a new instance of the bitmap class from the specified data stream.
	bitmap (std::istream &stream, bool use_icm)
	Initializes a new instance of the bitmap class from the specified data stream.
	bitmap (xtd::int32 width, xtd::int32 height)
	Initializes a new instance of the xtd::drawing::bitmap class with the specified size.
	bitmap (xtd::int32 width, xtd::int32 height, const xtd::drawing::graphics &g)
	Initializes a new instance of the xtd::drawing::bitmap class with the specified size and with the resolution of the specified xtd::drawing::raphics object.
	bitmap (xtd::int32 width, xtd::int32 height, xtd::drawing::imaging::pixel_format format)
	Initializes a new instance of the xtd::drawing::bitmap class with the specified size.
	bitmap (xtd::int32 width, xtd::int32 height, xtd::int32 stride, xtd::drawing::imaging::pixel_format format, xtd::intptr scan0)
	Initializes a new instance of the xtd::drawing::bitmap class with the specified size.
	bitmap (const xtd::drawing::size &size)
	Initializes a new instance of the xtd::drawing::bitmap class with the specified size.

Public Methods
bitmap	clone (const xtd::drawing::rectangle &rect) const
	Creates a copy of the section of this xtd::drawing::bitmap defined with a specified rectangle.
bitmap	clone (const xtd::drawing::rectangle_f &rect) const
	Creates a copy of the section of this xtd::drawing::bitmap defined with a specified rectangle.
auto	get_hbitmap () const -> xtd::intptr
	Creates a GDI bitmap object from this xtd::drawing::bitmap.
auto	get_hbitmap (const xtd::drawing::color &background) const -> xtd::intptr
	Creates a GDI bitmap object from this xtd::drawing::bitmap.
auto	get_hicon () const -> xtd::intptr
	Returns the handle to an icon.
auto	get_pixel (xtd::int32 x, xtd::int32 y) const -> drawing::color
	Gets the color of the specified pixel in this bitmap.
auto	lock_bits (const xtd::drawing::rectangle &rect, xtd::drawing::imaging::image_lock_mode flags, xtd::drawing::imaging::pixel_format format) -> xtd::drawing::imaging::bitmap_data
	Locks a xtd::drawing::bitmap into system memory.
auto	lock_bits (const xtd::drawing::rectangle &rect, xtd::drawing::imaging::image_lock_mode flags, xtd::drawing::imaging::pixel_format format, const xtd::drawing::imaging::bitmap_data &data) -> xtd::drawing::imaging::bitmap_data
	Locks a xtd::drawing::bitmap into system memory.
auto	make_transparent () -> void
	Makes the default transparent color transparent for this xtd::drawing::bitmap.
auto	make_transparent (const xtd::drawing::color &transparent_color) -> void
	Makes the specified color transparent for this xtd::drawing::bitmap.
auto	set_pixel (xtd::int32 x, xtd::int32 y, const xtd::drawing::color &color) -> void
	Sets the color of the specified pixel in this xtd::drawing::bitmap.
auto	set_resolution (xtd::int32 x_dpi, xtd::int32 y_dpi) -> void
	Sets the resolution for this xtd::drawing::bitmap.
auto	unlock_bits (const xtd::drawing::imaging::bitmap_data &data) -> void
	Unlocks this xtd::drawing::bitmap from system memory.

Public Deprecated Constructors
	bitmap (const char const bits)
	Initializes a new instance of the bitmap class from the specified data xpm.

Public Static Methods
static auto	from_hicon (xtd::intptr icon) -> bitmap
	Creates a xtd::drawing::bitmap from a Windows handle to an icon.

Additional Inherited Members
static image	empty
	Represent an empty xtd::drawing::image.
auto	alpha () const -> const xtd::byte *
	Gets the image alpha pointer, which represents the alpha data of the image.
auto	alpha () -> xtd::byte *
	Gets the image alpha pointer, which represents the alpha data of the image.
auto	flags () const noexcept -> xtd::int32
	Gets attribute flags for the pixel data of this xtd::drawing::image.
auto	frame_dimentions_list () const noexcept -> xtd::array< guid >
	Gets an array of GUIDs that represent the dimensions of frames within this image.
auto	handle () const noexcept -> xtd::intptr
	Gets the handle of this image.
auto	height () const noexcept -> xtd::int32
	Gets the height, in pixels, of this image.
auto	horizontal_resolution () const noexcept -> float
	Gets the horizontal resolution, in pixels per inch, of this image.
auto	palette () const noexcept -> xtd::drawing::imaging::color_palette
	Gets the color palette used for this image.
auto	palette (const xtd::drawing::imaging::color_palette &palette) noexcept -> void
	Sets the color palette used for this image.
auto	physical_dimension () const noexcept -> const xtd::drawing::size_f &
	Gets the width and height of this image.
auto	pixel_format () const noexcept -> xtd::drawing::imaging::pixel_format
	Gets the pixel format for this image.
auto	property_id_list () const noexcept -> const xtd::array< xtd::int32 > &
	Gets IDs of the property items stored in this image.
auto	property_items () const noexcept -> const xtd::array< xtd::drawing::imaging::property_item > &
	Gets all the property items (pieces of metadata) stored in this image.
auto	raw_format () const noexcept -> const xtd::drawing::imaging::image_format &
	Gets the file format of this image.
auto	rgb () const -> const xtd::byte *
	Gets the image data pointer, which represents the RGB data of the image.
auto	rgb () -> xtd::byte *
	Gets the image data pointer, which represents the RGB data of the image.
auto	size () const noexcept -> const xtd::drawing::size &
	Gets the width and height, in pixels, of this image.
auto	tag () const noexcept -> const xtd::any_object &
	Gets an object that provides additional data about the image.
auto	tag (const xtd::any_object &tag) noexcept -> void
	Sets an object that provides additional data about the image.
auto	vertical_resolution () const noexcept -> float
	Gets the vertical resolution, in pixels per inch, of this image.
auto	width () const noexcept -> xtd::int32
	Gets the width, in pixels, of this image.
auto	clone () const -> image
	Creates an exact copy of this xtd::drawing::image.
auto	create_graphics () -> xtd::drawing::graphics
	Creates the xtd::drawing::graphics for the image.
auto	equals (const object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const image &other) const noexcept -> bool override
	Indicates whether the current object is equal to another object of the same type.
auto	get_bounds (xtd::drawing::graphics_unit page_unit) const noexcept -> xtd::drawing::rectangle_f
	Gets the bounds of the image in the specified unit.
auto	get_encoder_parameter_list (xtd::guid encoder) const noexcept -> xtd::drawing::imaging::encoder_parameters
	Returns information about the parameters supported by the specified image encoder.
auto	get_frame_count (const xtd::drawing::imaging::frame_dimension &dimension) const -> xtd::usize
	Returns the number of frames of the specified dimension.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.
auto	get_property_item (int32 propid) -> xtd::drawing::imaging::property_item
	Gets the specified property item from this xtd::drawing::image.
auto	get_thmbnail_image (int32 thumb_width, int32 thunb_height) noexcept -> xtd::drawing::image
	Returns a thumbnail for this xtd::drawing::image.
auto	rotate_flip (xtd::drawing::rotate_flip_type rotate_flip_type) -> void
	Rotates, flips, or rotates and flips the xtd::drawing::image.
auto	save (const xtd::string &filename) const -> void
	Saves this xtd::drawing::image to the specified file or stream.
auto	save (const xtd::string &filename, const xtd::drawing::imaging::image_format &format) const -> void
	Saves this xtd::drawing::image to the specified file in the specified format.
auto	save (std::ostream &stream, const xtd::drawing::imaging::image_format &format) const -> void
	Saves this image to the specified stream in the specified format.
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
virtual auto	equals (const image &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
static auto	from_file (const xtd::string &filename) -> image
	Creates an image from the specified file.
static auto	from_hbitmap (xtd::intptr hbitmap) -> bitmap
	Creates a xtd::drawing::bitmap from a handle to a GDI bitmap.
static auto	from_stream (std::istream &stream) -> image
	Creates an xtd::drawing::image from the specified data stream.
static auto	from_xbm_data (const unsigned char *bits, int32 width, int32 height) -> bitmap
	Creates an xtd::drawing::image from the specified data pointer, width and hieght.
static auto	from_xpm_data (const char const bits) -> bitmap
	Creates an xtd::drawing::image from the specified data pointer.
static auto	get_pixel_format_size (xtd::drawing::imaging::pixel_format pixfmt) noexcept -> xtd::int32
	Returns the color depth, in number of bits per pixel, of the specified pixel format.
static auto	is_alpha_pixel_format (xtd::drawing::imaging::pixel_format pixfmt) noexcept -> bool
	Returns a value that indicates whether the pixel format for this xtd::drawing::image contains alpha information.
static auto	is_canonical_pixel_format (xtd::drawing::imaging::pixel_format pixfmt) noexcept -> bool
	Returns a value that indicates whether the pixel format is 32 bits per pixel.
static auto	is_extended_pixel_format (xtd::drawing::imaging::pixel_format pixfmt) noexcept -> bool
	Returns a value that indicates whether the pixel format is 64 bits per pixel.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

◆ bitmap() [1/14]

xtd::drawing::bitmap::bitmap ( const xtd::drawing::image & original )

explicit

Initializes a new instance of the bitmap class from the specified existing image.

Parameters

original The xtd::drawing::image from which to create the new bitmap.

◆ bitmap() [2/14]

xtd::drawing::bitmap::bitmap	(	const xtd::drawing::image &	original,
		const xtd::drawing::size &	new_size )

Initializes a new instance of the bitmap class from the specified existing image, scaled to the specified size.

Parameters

original	The xtd::drawing::image from which to create the new bitmap.
new_size	The xtd::drawing::size structure that represent the size of the new bitmap.

◆ bitmap() [3/14]

xtd::drawing::bitmap::bitmap	(	const xtd::drawing::image &	original,
		xtd::int32	width,
		xtd::int32	height )

Initializes a new instance of the bitmap class from the specified existing image, scaled to the specified size.

Parameters

original	The xtd::drawing::image from which to create the new bitmap.
width	The width, in pixels, of the new xtd::drawing::bitmap.
height	The height, in pixels, of the new xtd::drawing::bitmap.

◆ bitmap() [4/14]

xtd::drawing::bitmap::bitmap	(	const xtd::drawing::image &	original,
		const xtd::drawing::rectangle &	new_rect )

Initializes a new instance of the bitmap class from the specified existing image, resizing or cropping (without scaling) with the specified rectangle.

Parameters

original	The xtd::drawing::image from which to create the new bitmap.
new_rect	The xtd::drawing::rect structure that represent the location and size of the new bitmap.

◆ bitmap() [5/14]

xtd::drawing::bitmap::bitmap ( const xtd::string & filename )

explicit

Initializes a new instance of the bitmap class from the specified file.

Parameters

filename The bitmap file name and path.

Remarks: The file name and path can be relative to the application or an absolute path. Use this constructor to open images with the following file formats: BMP, GIF, EXIF, JPG, PNG and TIFF. For more information about supported formats, see Types of Bitmaps. The file remains locked until the xtd::drawing::bitmap is disposed.

◆ bitmap() [6/14]

xtd::drawing::bitmap::bitmap	(	const xtd::string &	filename,
		bool	use_icm )

explicit

Initializes a new instance of the bitmap class from the specified file.

Parameters

filename	The bitmap file name and path.
use_icm	true to use color correction for this xtd::drawing::bitmap; otherwise, false.

Remarks: The file name and path can be relative to the application or an absolute path. Use this constructor to open images with the following file formats: BMP, GIF, EXIF, JPG, PNG and TIFF. For more information about supported formats, see Types of Bitmaps. The file remains locked until the xtd::drawing::bitmap is disposed.

◆ bitmap() [7/14]

xtd::drawing::bitmap::bitmap ( std::istream & stream )

explicit

Initializes a new instance of the bitmap class from the specified data stream.

Parameters

stream The data stream used to load the image.

Remarks: You must keep the stream open for the lifetime of the xtd::drawing::bitmap.

◆ bitmap() [8/14]

xtd::drawing::bitmap::bitmap	(	std::istream &	stream,
		bool	use_icm )

explicit

Initializes a new instance of the bitmap class from the specified data stream.

Parameters

stream	The data stream used to load the image.
use_icm	true to use color correction for this xtd::drawing::bitmap; otherwise, false.

Remarks: You must keep the stream open for the lifetime of the xtd::drawing::bitmap.; Due to a limitation of the GDI+ decoder, an xtd::argument_exception is thrown if you construct a bitmap from a .png image file with a single dimension greater than 65,535 pixels.

◆ bitmap() [9/14]

xtd::drawing::bitmap::bitmap	(	xtd::int32	width,
		xtd::int32	height )

Initializes a new instance of the xtd::drawing::bitmap class with the specified size.

Parameters

width	The width, in pixels, of the new bitmap.
height	The height, in pixels, of the new bitmap.

◆ bitmap() [10/14]

xtd::drawing::bitmap::bitmap	(	xtd::int32	width,
		xtd::int32	height,
		const xtd::drawing::graphics &	g )

Initializes a new instance of the xtd::drawing::bitmap class with the specified size and with the resolution of the specified xtd::drawing::raphics object.

Parameters

width	The width, in pixels, of the new bitmap.
height	The height, in pixels, of the new bitmap.
g	The Graphics object that specifies the resolution for the new Bitmap.

Remarks: The new xtd::drawing::bitmap that this method creates takes its horizontal and vertical resolution from the xtd::drawing::graphics::dpi_x and xtd::drawing::graphics::dpi_y properties of g, respectively.

◆ bitmap() [11/14]

xtd::drawing::bitmap::bitmap	(	xtd::int32	width,
		xtd::int32	height,
		xtd::drawing::imaging::pixel_format	format )

Initializes a new instance of the xtd::drawing::bitmap class with the specified size.

Parameters

width	The width, in pixels, of the new bitmap.
height	The height, in pixels, of the new bitmap.
format	The pixel format for the new xtd::drawing::bitmap class with the specified size and format.

◆ bitmap() [12/14]

xtd::drawing::bitmap::bitmap	(	xtd::int32	width,
		xtd::int32	height,
		xtd::int32	stride,
		xtd::drawing::imaging::pixel_format	format,
		xtd::intptr	scan0 )

Initializes a new instance of the xtd::drawing::bitmap class with the specified size.

Parameters

width	The width, in pixels, of the new bitmap.
height	The height, in pixels, of the new bitmap.
stride	Integer that specifies the byte offset between the beginning of one scan line and the next. This is usually (but not necessarily) the number of bytes in the pixel format (for example, 2 for 16 bits per pixel) multiplied by the width of the bitmap. The value passed to this parameter must be a multiple of four.
format	The pixel format for the new xtd::drawing::bitmap class with the specified size and format.
scan0	Pointer to an array of bytes that contains the pixel data.

◆ bitmap() [13/14]

xtd::drawing::bitmap::bitmap ( const xtd::drawing::size & size )

explicit

Initializes a new instance of the xtd::drawing::bitmap class with the specified size.

Parameters

size	the size, in pixels, of the new bitmap.

◆ bitmap() [14/14]

xtd::drawing::bitmap::bitmap ( const char *const * bits )

explicit

Initializes a new instance of the bitmap class from the specified data xpm.

Parameters

bits	The data xpm used to load the image.

Deprecated: Replaced by xtd::drawing::image::from_xpm_data - Will be removed in version 1.2.0.

Member Function Documentation

◆ clone() [1/2]

bitmap xtd::drawing::bitmap::clone ( const xtd::drawing::rectangle & rect ) const

Creates a copy of the section of this xtd::drawing::bitmap defined with a specified rectangle.

Parameters

rect	Defines the portion of this bitmap to copy.

◆ clone() [2/2]

bitmap xtd::drawing::bitmap::clone ( const xtd::drawing::rectangle_f & rect ) const

Creates a copy of the section of this xtd::drawing::bitmap defined with a specified rectangle.

Parameters

rect	Defines the portion of this bitmap to copy.

◆ get_hbitmap() [1/2]

auto xtd::drawing::bitmap::get_hbitmap ( ) const -> xtd::intptr

nodiscard

Creates a GDI bitmap object from this xtd::drawing::bitmap.

Returns: A handle to the GDI bitmap object that this method creates.

Remarks: You are responsible for calling the GDI DeleteObject method to free the memory used by the GDI bitmap object. For more information about GDI bitmaps, see Bitmaps in the Windows GDI documentation.

◆ get_hbitmap() [2/2]

auto xtd::drawing::bitmap::get_hbitmap ( const xtd::drawing::color & background ) const -> xtd::intptr

nodiscard

Creates a GDI bitmap object from this xtd::drawing::bitmap.

Parameters

background A xtd::drawing::color structure that specifies the background color. This parameter is ignored if the bitmap is totally opaque.

Returns: A handle to the GDI bitmap object that this method creates.

Remarks: You are responsible for calling the GDI DeleteObject method to free the memory used by the GDI bitmap object. For more information about GDI bitmaps, see Bitmaps in the Windows GDI documentation.

◆ get_hicon()

auto xtd::drawing::bitmap::get_hicon ( ) const -> xtd::intptr

nodiscard

Returns the handle to an icon.

Returns: A Windows handle to an icon with the same image as the xtd::drawing::bitmap.

Remarks: Initially, an icon created from the handle will have the same size as the original bitmap.

◆ get_pixel()

auto xtd::drawing::bitmap::get_pixel	(	xtd::int32	x,
		xtd::int32	y ) const -> drawing::color

Gets the color of the specified pixel in this bitmap.

Parameters

x	The x-coordinate of the pixel to retrieve.
y	The y-coordinate of the pixel to retrieve.

Returns: A xtd::drawing::color structure that represents the color of the specified pixel.

◆ lock_bits() [1/2]

auto xtd::drawing::bitmap::lock_bits	(	const xtd::drawing::rectangle &	rect,
		xtd::drawing::imaging::image_lock_mode	flags,
		xtd::drawing::imaging::pixel_format	format ) -> xtd::drawing::imaging::bitmap_data

nodiscard

Locks a xtd::drawing::bitmap into system memory.

Parameters

rect	A xtd::drawing::rectangle structure that specifies the portion of the xtd::drawing::bitmap to lock.
flags	An xtd::drawing::imaging::image_lock_mode enumeration that specifies the access level (read/write) for the xtd::drawing::bitmap.
format	A xtd::drawing::imaging::pixel_format enumeration that specifies the data format of this xtd::drawing::bitmap.

Returns: A xtd::drawing::imaging::bitmap_data that contains information about this lock operation.

Remarks: Use the xtd::drawing::bitmap::lock_bits method to lock an existing bitmap in system memory so that it can be changed programmatically. You can change the color of an image with the xtd::drawing::bitmap::set_pixel method, although the xtd::drawing::bitmap::lock_bits method offers better performance for large-scale changes.; The xtd::drawing::imaging::bitmap_data specifies the attributes of the xtd::drawing::bitmap, such as size, pixel format, the starting address of the pixel data in memory, and length of each scan line (stride).; When calling this method, you should use a member of the xtd::drawing::imaging::pixel_format enumeration that contains a specific bits-per-pixel (BPP) value. Using xtd::drawing::imaging::pixel_format values such as xtd::drawing::imaging::pixel_format::indexed and xtd::drawing::imaging::pixel_format::gdi will throw an xtd::argument_exception. Also, passing the incorrect pixel format for a bitmap will throw an xtd::argument_exception.

◆ lock_bits() [2/2]

auto xtd::drawing::bitmap::lock_bits	(	const xtd::drawing::rectangle &	rect,
		xtd::drawing::imaging::image_lock_mode	flags,
		xtd::drawing::imaging::pixel_format	format,
		const xtd::drawing::imaging::bitmap_data &	data ) -> xtd::drawing::imaging::bitmap_data

nodiscard

Locks a xtd::drawing::bitmap into system memory.

Parameters

rect	A xtd::drawing::rectangle structure that specifies the portion of the xtd::drawing::bitmap to lock.
flags	An xtd::drawing::imaging::image_lock_mode enumeration that specifies the access level (read/write) for the xtd::drawing::bitmap.
format	A xtd::drawing::imaging::pixel_format enumeration that specifies the data format of this xtd::drawing::bitmap.
data	A xtd::drawing::imaging::bitmap_data that contains information about the lock operation.

Returns: A xtd::drawing::imaging::bitmap_data that contains information about this lock operation.

Remarks: Use the xtd::drawing::bitmap::lock_bits method to lock an existing bitmap in system memory so that it can be changed programmatically. You can change the color of an image with the xtd::drawing::bitmap::set_pixel method, although the xtd::drawing::bitmap::lock_bits method offers better performance for large-scale changes.; The xtd::drawing::imaging::bitmap_data specifies the attributes of the xtd::drawing::bitmap, such as size, pixel format, the starting address of the pixel data in memory, and length of each scan line (stride).; When calling this method, you should use a member of the xtd::drawing::imaging::pixel_format enumeration that contains a specific bits-per-pixel (BPP) value. Using xtd::drawing::imaging::pixel_format values such as xtd::drawing::imaging::pixel_format::indexed and xtd::drawing::imaging::pixel_format::gdi will throw an xtd::argument_exception. Also, passing the incorrect pixel format for a bitmap will throw an xtd::argument_exception.

◆ make_transparent() [1/2]

auto xtd::drawing::bitmap::make_transparent ( ) -> void

Makes the default transparent color transparent for this xtd::drawing::bitmap.

Remarks: The system palette defines one color as the default transparent, or alpha, color. This method makes the default transparent color transparent for this xtd::drawing::bitmap. If no transparent color is specified by the system, xtd::drawing::color::light_gray is the transparent color.; When you call xtd::drawing::bitmap::make_transparent, the bitmap will be converted to the xtd::drawing::imaging::pixel_format::format_32bpp_argb format, as this format supports an alpha channel.

◆ make_transparent() [2/2]

auto xtd::drawing::bitmap::make_transparent ( const xtd::drawing::color & transparent_color ) -> void

Makes the specified color transparent for this xtd::drawing::bitmap.

Parameters

transprent_color The xtd::drawing::color structure that represents the color to make transparent.

Remarks: When you call xtd::drawing::bitmap::make_transparent, the bitmap will be converted to the xtd::drawing::imaging::pixel_format::format_32bpp_argb format, as this format supports an alpha channel.

◆ set_pixel()

auto xtd::drawing::bitmap::set_pixel	(	xtd::int32	x,
		xtd::int32	y,
		const xtd::drawing::color &	color ) -> void

Sets the color of the specified pixel in this xtd::drawing::bitmap.

Parameters

x	The x-coordinate of the pixel to retrieve.
y	The y-coordinate of the pixel to retrieve.
color	A xtd::drawing::color structure that represents the color of the specified pixel.

◆ set_resolution()

auto xtd::drawing::bitmap::set_resolution	(	xtd::int32	x_dpi,
		xtd::int32	y_dpi ) -> void

Sets the resolution for this xtd::drawing::bitmap.

Parameters

x_dpi	The horizontal resolution, in dots per inch, of the xtd::drawing::bitmap.
y_dpi	The vertical resolution, in dots per inch, of the xtd::drawing::bitmap.

Remarks: Use this method to set the desired resolution on a newly created bitmap. Changing the resolution of the image does not change its physical size.

◆ unlock_bits()

auto xtd::drawing::bitmap::unlock_bits ( const xtd::drawing::imaging::bitmap_data & data ) -> void

Unlocks this xtd::drawing::bitmap from system memory.

Parameters

data	A xtd::drawing::imaging::bitmap_data that specifies information about the lock operation.

Remarks: The xtd::drawing::imaging::bitmap_data specifies the attributes of the xtd::drawing::bitmap, such as size, pixel format, the starting address of the pixel data in memory, and length of each scan line (stride).

◆ from_hicon()

auto xtd::drawing::bitmap::from_hicon ( xtd::intptr icon ) -> bitmap

staticnodiscard

Creates a xtd::drawing::bitmap from a Windows handle to an icon.

Parameters

hicon A handle to an icon.

Returns: The xtd::drawing::bitmap that this method creates.

Member Data Documentation

◆ empty

bitmap xtd::drawing::bitmap::empty

static

Represent an empty bitmap.

The documentation for this class was generated from the following file:

xtd.drawing/include/xtd/drawing/bitmap.hpp

Definition

Public Fields

Public Constructors

Public Methods

Public Deprecated Constructors

Public Static Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ bitmap() [1/14]

◆ bitmap() [2/14]

◆ bitmap() [3/14]

◆ bitmap() [4/14]

◆ bitmap() [5/14]

◆ bitmap() [6/14]

◆ bitmap() [7/14]

◆ bitmap() [8/14]

◆ bitmap() [9/14]

◆ bitmap() [10/14]

◆ bitmap() [11/14]

◆ bitmap() [12/14]

◆ bitmap() [13/14]

◆ bitmap() [14/14]

Member Function Documentation

◆ clone() [1/2]

◆ clone() [2/2]

◆ get_hbitmap() [1/2]

◆ get_hbitmap() [2/2]

◆ get_hicon()

◆ get_pixel()

◆ lock_bits() [1/2]

◆ lock_bits() [2/2]

◆ make_transparent() [1/2]

◆ make_transparent() [2/2]

◆ set_pixel()

◆ set_resolution()

◆ unlock_bits()

◆ from_hicon()

Member Data Documentation

◆ empty