xtd::drawing::imaging::bitmap_data Struct Reference

Inheritance diagram for xtd::drawing::imaging::bitmap_data:

Definition

Specifies the attributes of a bitmap image. The xtd::drawing::imaging::bitmap_data struct 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 Properties
int32	height
	Gets or 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
	Gets or sets the format of the pixel information in the xtd::drawing::bitmap object that returned this xtd::drawing::imaging::bitmap_data object.
int32	reserved
	Reserved. Do not use.
intptr	scan0
	Gets or 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
	Gets or sets the stride width (also called scan width) of the xtd::drawing::bitmap object.
int32	width
	Gets or 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
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual xtd::size	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<class object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.
template<class object_a_t, class object_b_t>
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<class object_a_t, class object_b_t>
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Member Data Documentation

height

int32 xtd::drawing::imaging::bitmap_data::height

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

Parameters

value

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

Returns

This current instance.

pixel_format

xtd::drawing::imaging::pixel_format xtd::drawing::imaging::bitmap_data::pixel_format

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

Parameters

value

A 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

int32 xtd::drawing::imaging::bitmap_data::reserved

Reserved. Do not use.

Parameters

value

Reserved. Do not use.

Returns

This current instance.

scan0

intptr xtd::drawing::imaging::bitmap_data::scan0

Gets or 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

value

The address of the first pixel data in the bitmap.

Returns

This current instance.

stride

int32 xtd::drawing::imaging::bitmap_data::stride

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

Parameters

value

The 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

int32 xtd::drawing::imaging::bitmap_data::width

Gets or 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

value

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

Returns

This current instance.

---

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

• xtd.drawing/include/xtd/drawing/imaging/bitmap_data.hpp