xtd 0.2.0
Loading...
Searching...
No Matches
xtd::drawing::imaging::bitmap_data Class Referencefinal
Inheritance diagram for xtd::drawing::imaging::bitmap_data:
xtd::object

Definition

Specifies the attributes of a bitmap image. The xtd::drawing::imaging::bitmap_data class is used by the xtd::drawing::bitmap::lock_bits and xtd::drawing::bitmap::unlock_bits methods of the xtd::drawing::bitmap class. Not inheritable.

Namespace
xtd::drawing::imaging
Library
xtd.drawing

Public Constructors

 bitmap_data ()=default
 Initializes a new instance of the xtd::drawing::imaging::bitmap_data class.
 

Public Properties

int32 height () const noexcept
 Gets the pixel height of the xtd::drawing::bitmap object. Also sometimes referred to as the number of scan lines.
 
bitmap_dataheight (int32 value) noexcept
 Sets the pixel height of the xtd::drawing::bitmap object. Also sometimes referred to as the number of scan lines.
 
xtd::drawing::imaging::pixel_format pixel_format () const noexcept
 Gets the format of the pixel information in the xtd::drawing::bitmap object that returned this xtd::drawing::imaging::bitmap_data object.
 
bitmap_datapixel_format (xtd::drawing::imaging::pixel_format value) noexcept
 Sets the format of the pixel information in the xtd::drawing::bitmap object that returned this xtd::drawing::imaging::bitmap_data object.
 
int32 reserved () const noexcept
 Reserved. Do not use.
 
bitmap_datareserved (int32 value) noexcept
 Reserved. Do not use.
 
intptr scan0 () const noexcept
 Gets or sets the address of the first pixel data in the bitmap. This can also be thought of as the first scan line in the bitmap.
 
bitmap_datascan0 (intptr value) noexcept
 Sets or sets the address of the first pixel data in the bitmap. This can also be thought of as the first scan line in the bitmap.
 
int32 stride () const noexcept
 Gets the stride width (also called scan width) of the xtd::drawing::bitmap object.
 
bitmap_datastride (int32 value) noexcept
 Sets the stride width (also called scan width) of the xtd::drawing::bitmap object.
 
int32 width () const noexcept
 Gets or sets the pixel width of the xtd::drawing::bitmap object. This can also be thought of as the number of pixels in one scan line.
 
bitmap_datawidth (int32 value) noexcept
 Sets or sets the pixel width of the xtd::drawing::bitmap object. This can also be thought of as the number of pixels in one scan line.
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object.
 
virtual xtd::ustring to_string () const noexcept
 Returns a xtd::ustring that represents the current object.
 
- 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.
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

Constructor & Destructor Documentation

◆ bitmap_data()

xtd::drawing::imaging::bitmap_data::bitmap_data ( )
default

Initializes a new instance of the xtd::drawing::imaging::bitmap_data class.

Member Function Documentation

◆ height() [1/2]

int32 xtd::drawing::imaging::bitmap_data::height ( ) const
noexcept

Gets the pixel height of the xtd::drawing::bitmap object. Also sometimes referred to as the number of scan lines.

Returns
The pixel height of the xtd::drawing::bitmap object.

◆ height() [2/2]

bitmap_data & xtd::drawing::imaging::bitmap_data::height ( int32  value)
noexcept

Sets the pixel height of the xtd::drawing::bitmap object. Also sometimes referred to as the number of scan lines.

Parameters
valueThe pixel height of the xtd::drawing::bitmap object.
Returns
This current instance.

◆ pixel_format() [1/2]

xtd::drawing::imaging::pixel_format xtd::drawing::imaging::bitmap_data::pixel_format ( ) const
noexcept

Gets the format of the pixel information in the xtd::drawing::bitmap object that returned this xtd::drawing::imaging::bitmap_data object.

Returns
A xtd::drawing::imaging::pixel_format that specifies the format of the pixel information in the associated xtd::drawing::bitmap object.
Remarks
The format defines how many bits of memory are needed to store the color information for a single pixel.

◆ pixel_format() [2/2]

bitmap_data & xtd::drawing::imaging::bitmap_data::pixel_format ( xtd::drawing::imaging::pixel_format  value)
noexcept

Sets the format of the pixel information in the xtd::drawing::bitmap object that returned this xtd::drawing::imaging::bitmap_data object.

Parameters
valueA xtd::drawing::imaging::pixel_format that specifies the format of the pixel information in the associated xtd::drawing::bitmap object.
Returns
This current instance.
Remarks
The format defines how many bits of memory are needed to store the color information for a single pixel.

◆ reserved() [1/2]

int32 xtd::drawing::imaging::bitmap_data::reserved ( ) const
noexcept

Reserved. Do not use.

Returns
Reserved. Do not use.

◆ reserved() [2/2]

bitmap_data & xtd::drawing::imaging::bitmap_data::reserved ( int32  value)
noexcept

Reserved. Do not use.

Parameters
valueReserved. Do not use.
Returns
This current instance.

◆ scan0() [1/2]

intptr xtd::drawing::imaging::bitmap_data::scan0 ( ) const
noexcept

Gets or sets the address of the first pixel data in the bitmap. This can also be thought of as the first scan line in the bitmap.

Returns
The address of the first pixel data in the bitmap.

◆ scan0() [2/2]

bitmap_data & xtd::drawing::imaging::bitmap_data::scan0 ( intptr  value)
noexcept

Sets or sets the address of the first pixel data in the bitmap. This can also be thought of as the first scan line in the bitmap.

Parameters
valueThe address of the first pixel data in the bitmap.
Returns
This current instance.

◆ stride() [1/2]

int32 xtd::drawing::imaging::bitmap_data::stride ( ) const
noexcept

Gets the stride width (also called scan width) of the xtd::drawing::bitmap object.

Returns
The stride width, in bytes, of the xtd::drawing::bitmap object.
Remarks
The stride is the width of a single row of pixels (a scan line), rounded up to a four-byte boundary. If the stride is positive, the bitmap is top-down. If the stride is negative, the bitmap is bottom-up.

◆ stride() [2/2]

bitmap_data & xtd::drawing::imaging::bitmap_data::stride ( int32  value)
noexcept

Sets the stride width (also called scan width) of the xtd::drawing::bitmap object.

Parameters
valueThe stride width, in bytes, of the xtd::drawing::bitmap object.
Returns
This current instance.
Remarks
The stride is the width of a single row of pixels (a scan line), rounded up to a four-byte boundary. If the stride is positive, the bitmap is top-down. If the stride is negative, the bitmap is bottom-up.

◆ width() [1/2]

int32 xtd::drawing::imaging::bitmap_data::width ( ) const
noexcept

Gets or sets the pixel width of the xtd::drawing::bitmap object. This can also be thought of as the number of pixels in one scan line.

Returns
The pixel width of the xtd::drawing::bitmap object.

◆ width() [2/2]

bitmap_data & xtd::drawing::imaging::bitmap_data::width ( int32  value)
noexcept

Sets or sets the pixel width of the xtd::drawing::bitmap object. This can also be thought of as the number of pixels in one scan line.

Parameters
valueThe pixel width of the xtd::drawing::bitmap object.
Returns
This current instance.

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