xtd - Reference Guide  0.2.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Static Public Attributes | Public Member Functions | List of all members
xtd::drawing::bitmap Class Reference

#include <bitmap.h>

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.

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_box.cpp, about_dialog.cpp, about_dialog_system.cpp, colored_tab_pages.cpp, countries.cpp, and fill_rectangle.cpp.

Static Public Attributes

static bitmap empty
 Represent an empty bitmap. More...
 
- Static Public Attributes inherited from xtd::drawing::image
static image empty
 

Public Member Functions

 bitmap (const image &original)
 Initializes a new instance of the bitmap class from the specified existing image. More...
 
 bitmap (const 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. More...
 
 bitmap (const image &original, const rectangle &new_rect)
 Initializes a new instance of the bitmap class from the specified existing image, scaled to the specified rectangle. More...
 
 bitmap (const xtd::ustring &filename)
 Initializes a new instance of the bitmap class from the specified file. More...
 
 bitmap (std::istream &stream)
 Initializes a new instance of the bitmap class from the specified data stream. More...
 
 bitmap (const char *const *bits)
 Initializes a new instance of the bitmap class from the specified data xpm. More...
 
 bitmap (int32_t width, int32_t height)
 Initializes a new instance of the Bitmap class with the specified size. More...
 
 bitmap (const xtd::drawing::size &size)
 Initializes a new instance of the Bitmap class with the specified size. More...
 
bitmap clone (const rectangle &rect)
 Creates a copy of the section of this Bitmap defined with a specified rectangle. More...
 
bitmap clone (const rectangle_f &rect)
 Creates a copy of the section of this Bitmap defined with a specified rectangle. More...
 
drawing::color get_pixel (int32_t x, int32_t y) const
 Gets the color of the specified pixel in this bitmap. More...
 
void set_pixel (int32_t x, int32_t y, const drawing::color &color)
 Sets the color of the specified pixel in this bitmap. More...
 
- Public Member Functions inherited from xtd::drawing::image
graphics create_graphics ()
 Creates the xtd::drawing::graphics for the image. More...
 
int32_t flags () const
 Gets attribute flags for the pixel data of this Image. More...
 
const std::vector< guid > & frame_dimentions_list () const
 Gets an array of GUIDs that represent the dimensions of frames within this image. More...
 
intptr_t handle () const
 Get the handle of this image. More...
 
int32_t height () const
 Gets the height, in pixels, of this image. More...
 
float horizontal_resolution () const
 Gets the horizontal resolution, in pixels per inch, of this image. More...
 
imaging::color_palette palette () const
 Gets the color palette used for this image. More...
 
void palette (const imaging::color_palette &palette)
 Sets the color palette used for this image. More...
 
const size_fphysical_dimension () const
 Gets the width and height of this image. More...
 
imaging::pixel_format pixel_format () const
 Gets the pixel format for this image. More...
 
const std::vector< int32_t > & property_id_list () const
 Gets IDs of the property items stored in this image. More...
 
const std::vector< imaging::property_item > & property_items () const
 Gets all the property items (pieces of metadata) stored in this image. More...
 
const imaging::image_formatraw_format () const
 Gets the file format of this image. More...
 
void save (const xtd::ustring &filename) const
 
void save (const xtd::ustring &filename, const imaging::image_format &format) const
 
void save (std::ostream &stream, const imaging::image_format &format) const
 
const drawing::sizesize () const
 Gets the width and height, in pixels, of this image. More...
 
const std::anytag () const
 Gets an object that provides additional data about the image. More...
 
void tag (const std::any &tag)
 Sets an object that provides additional data about the image. More...
 
float vertical_resolution () const
 Gets the vertical resolution, in pixels per inch, of this image. More...
 
int32_t width () const
 Gets the width, in pixels, of this image. More...
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. More...
 
virtual xtd::ustring to_string () const noexcept
 Returns a std::string that represents the current object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from xtd::drawing::image
static image from_data (const char *const *bits)
 
static image from_file (const xtd::ustring &filename)
 Creates an image from the specified file. More...
 
static image from_hbitmap (intptr_t hbitmap)
 
static image from_stream (std::istream &stream)
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 
- Protected Attributes inherited from xtd::drawing::image
std::shared_ptr< datadata_ = std::make_shared<data>()
 
- Protected Member Functions inherited from xtd::drawing::image
 image (intptr_t hbitmap)
 
 image (const xtd::ustring &fileName)
 
 image (std::istream &stream)
 
 image (const char *const *bits)
 
 image (int32_t width, int32_t height)
 
 image (const image &image, int32_t width, int32_t height)
 
 image (const image &image, const rectangle &rect)
 
void update_properties ()
 

Constructor & Destructor Documentation

◆ bitmap() [1/8]

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

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

Parameters
originalThe xtd::drawing::image from which to create the new bitmap.

◆ bitmap() [2/8]

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

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

Parameters
originalThe xtd::drawing::image from which to create the new bitmap.
new_sizeThe xtd::drawing::size structure that represent the size of the new bitmap.

◆ bitmap() [3/8]

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

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

Parameters
originalThe xtd::drawing::image from which to create the new bitmap.
new_rectThe xtd::drawing::rect structure that represent the location and size of the new bitmap.

◆ bitmap() [4/8]

xtd::drawing::bitmap::bitmap ( const xtd::ustring filename)
inlineexplicit

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

Parameters
filenameThe 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 Bitmap is disposed.

◆ bitmap() [5/8]

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

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

Parameters
streamThe data stream used to load the image.

◆ bitmap() [6/8]

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

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

Parameters
bitsThe data xpm used to load the image.

◆ bitmap() [7/8]

xtd::drawing::bitmap::bitmap ( int32_t  width,
int32_t  height 
)
inline

Initializes a new instance of the Bitmap class with the specified size.

Parameters
widthThe width, in pixels, of the new bitmap.
heightThe height, in pixels, of the new bitmap.

◆ bitmap() [8/8]

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

Initializes a new instance of the Bitmap class with the specified size.

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

Member Function Documentation

◆ clone() [1/2]

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

Creates a copy of the section of this Bitmap defined with a specified rectangle.

Parameters
rectDefines the portion of this bitmap to copy.

◆ clone() [2/2]

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

Creates a copy of the section of this Bitmap defined with a specified rectangle.

Parameters
rectDefines the portion of this bitmap to copy.

◆ get_pixel()

drawing::color xtd::drawing::bitmap::get_pixel ( int32_t  x,
int32_t  y 
) const

Gets the color of the specified pixel in this bitmap.

Parameters
xThe x-coordinate of the pixel to retrieve.
yThe y-coordinate of the pixel to retrieve.
Returns
A xtd::drawing::color structure that represents the color of the specified pixel.

◆ set_pixel()

void xtd::drawing::bitmap::set_pixel ( int32_t  x,
int32_t  y,
const drawing::color color 
)

Sets the color of the specified pixel in this bitmap.

Parameters
xThe x-coordinate of the pixel to retrieve.
yThe y-coordinate of the pixel to retrieve.
colorA xtd::drawing::color structure that represents the color of the specified pixel.

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: