System::Drawing::Imaging::BitmapData Class Reference

Represents a set of attributes of a 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. More...

#include "bitmap_data.h"

Inherits System::Object.

Public Member Functions

ASPOSECPP_SHARED_API int get_Width () const
 Returns the width of the image in pixels. More...
 
ASPOSECPP_SHARED_API void set_Width (int value)
 Sets the width of the image in pixels. More...
 
ASPOSECPP_SHARED_API int get_Height () const
 Returns the height of the image in pixels. More...
 
ASPOSECPP_SHARED_API void set_Height (int value)
 Sets the height of the image in pixels. More...
 
ASPOSECPP_SHARED_API int get_Stride () const
 Returns the stride width of the image in bytes. More...
 
ASPOSECPP_SHARED_API void set_Stride (int value)
 Sets the stride width of the image in bytes. More...
 
ASPOSECPP_SHARED_API IntPtr get_Scan0 () const
 Returns the address of the first pixel data in the bitmap. More...
 
ASPOSECPP_SHARED_API void set_Scan0 (IntPtr value)
 Sets the address of the first pixel data in the bitmap. More...
 
ASPOSECPP_SHARED_API PixelFormat get_PixelFormat () const
 Returns the pixel format of the bitmap image. More...
 
ASPOSECPP_SHARED_API void set_PixelFormat (PixelFormat value)
 Sets the pixel format of the bitmap image. More...
 
- 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 TypeInfoGetType () 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)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a set of attributes of a 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.

Member Function Documentation

◆ get_Height()

ASPOSECPP_SHARED_API int System::Drawing::Imaging::BitmapData::get_Height ( ) const

Returns the height of the image in pixels.

◆ get_PixelFormat()

ASPOSECPP_SHARED_API PixelFormat System::Drawing::Imaging::BitmapData::get_PixelFormat ( ) const

Returns the pixel format of the bitmap image.

◆ get_Scan0()

ASPOSECPP_SHARED_API IntPtr System::Drawing::Imaging::BitmapData::get_Scan0 ( ) const

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

◆ get_Stride()

ASPOSECPP_SHARED_API int System::Drawing::Imaging::BitmapData::get_Stride ( ) const

Returns the stride width of the image in bytes.

◆ get_Width()

ASPOSECPP_SHARED_API int System::Drawing::Imaging::BitmapData::get_Width ( ) const

Returns the width of the image in pixels.

◆ set_Height()

ASPOSECPP_SHARED_API void System::Drawing::Imaging::BitmapData::set_Height ( int  value)

Sets the height of the image in pixels.

Parameters
valueThe value to set

◆ set_PixelFormat()

ASPOSECPP_SHARED_API void System::Drawing::Imaging::BitmapData::set_PixelFormat ( PixelFormat  value)

Sets the pixel format of the bitmap image.

Parameters
valueThe value to set

◆ set_Scan0()

ASPOSECPP_SHARED_API void System::Drawing::Imaging::BitmapData::set_Scan0 ( IntPtr  value)

Sets the address of the first pixel data in the bitmap.

Parameters
valueThe value to set

◆ set_Stride()

ASPOSECPP_SHARED_API void System::Drawing::Imaging::BitmapData::set_Stride ( int  value)

Sets the stride width of the image in bytes.

Parameters
valueThe value to set

◆ set_Width()

ASPOSECPP_SHARED_API void System::Drawing::Imaging::BitmapData::set_Width ( int  value)

Sets the width of the image in pixels.

Parameters
valueThe value to set