Document wxGraphicsBitmap and methods involving it.
Document wxGraphics{Context,Renderer}::CreateBitmap() and CreateSubBitmap() and wxGraphicsContext::DrawBitmap() as well as the (trivial) class itself. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69351 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -265,6 +265,24 @@ enum wxCompositionMode
|
||||
wxCOMPOSITION_ADD /**< @e R = @e S + @e D */
|
||||
};
|
||||
|
||||
/**
|
||||
Represents a bitmap.
|
||||
|
||||
The objects of this class are not created directly but only via
|
||||
wxGraphicsContext or wxGraphicsRenderer CreateBitmap() and
|
||||
CreateSubBitmap() methods. They can subsequently be used with
|
||||
wxGraphicsContext::DrawBitmap(). The only other operation is testing for
|
||||
the bitmap validity which can be performed using IsNull() method inherited
|
||||
from the base class.
|
||||
*/
|
||||
class wxGraphicsBitmap : public wxGraphicsObject
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Default constructor creates an invalid bitmap.
|
||||
*/
|
||||
wxGraphicsBitmap() {}
|
||||
};
|
||||
|
||||
/**
|
||||
@class wxGraphicsContext
|
||||
@@ -368,6 +386,23 @@ public:
|
||||
*/
|
||||
virtual void ConcatTransform(const wxGraphicsMatrix& matrix) = 0;
|
||||
|
||||
/**
|
||||
Creates wxGraphicsBitmap from an existing wxBitmap.
|
||||
|
||||
Returns an invalid wxNullGraphicsBitmap on failure.
|
||||
*/
|
||||
virtual wxGraphicsBitmap CreateBitmap( const wxBitmap &bitmap ) = 0;
|
||||
|
||||
/**
|
||||
Extracts a sub-bitmap from an existing bitmap.
|
||||
|
||||
Currently this function is implemented in the native MSW and OS X
|
||||
versions but not when using Cairo.
|
||||
*/
|
||||
virtual wxGraphicsBitmap CreateSubBitmap(const wxGraphicsBitmap& bitmap,
|
||||
wxDouble x, wxDouble y,
|
||||
wxDouble w, wxDouble h) = 0;
|
||||
|
||||
/**
|
||||
Creates a native brush from a wxBrush.
|
||||
*/
|
||||
@@ -465,8 +500,14 @@ public:
|
||||
Draws the bitmap. In case of a mono bitmap, this is treated as a mask
|
||||
and the current brushed is used for filling.
|
||||
*/
|
||||
virtual void DrawBitmap(const wxBitmap& bmp, wxDouble x, wxDouble y,
|
||||
//@{
|
||||
virtual void DrawBitmap(const wxGraphicsBitmap& bmp,
|
||||
wxDouble x, wxDouble y,
|
||||
wxDouble w, wxDouble h ) = 0;
|
||||
virtual void DrawBitmap(const wxBitmap& bmp,
|
||||
wxDouble x, wxDouble y,
|
||||
wxDouble w, wxDouble h) = 0;
|
||||
//@}
|
||||
|
||||
/**
|
||||
Draws an ellipse.
|
||||
@@ -852,6 +893,22 @@ public:
|
||||
class wxGraphicsRenderer : public wxObject
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Creates wxGraphicsBitmap from an existing wxBitmap.
|
||||
|
||||
Returns an invalid wxNullGraphicsBitmap on failure.
|
||||
*/
|
||||
virtual wxGraphicsBitmap CreateBitmap( const wxBitmap &bitmap ) = 0;
|
||||
|
||||
/**
|
||||
Creates wxGraphicsBitmap from a native bitmap handle.
|
||||
|
||||
@a bitmap meaning is platform-dependent. Currently it's a GDI+ @c
|
||||
Bitmap pointer under MSW, @c CGImage pointer under OS X or a @c
|
||||
cairo_surface_t pointer when using Cairo under any platform.
|
||||
*/
|
||||
virtual wxGraphicsBitmap CreateBitmapFromNativeBitmap( void* bitmap ) = 0;
|
||||
|
||||
/**
|
||||
Creates a wxGraphicsContext from a wxWindow.
|
||||
*/
|
||||
@@ -952,6 +1009,16 @@ public:
|
||||
wxDouble radius,
|
||||
const wxGraphicsGradientStops& stops) = 0;
|
||||
|
||||
/**
|
||||
Extracts a sub-bitmap from an existing bitmap.
|
||||
|
||||
Currently this function is implemented in the native MSW and OS X
|
||||
versions but not when using Cairo.
|
||||
*/
|
||||
virtual wxGraphicsBitmap CreateSubBitmap(const wxGraphicsBitmap& bitmap,
|
||||
wxDouble x, wxDouble y,
|
||||
wxDouble w, wxDouble h) = 0;
|
||||
|
||||
/**
|
||||
Returns the default renderer on this platform. On OS X this is the Core
|
||||
Graphics (a.k.a. Quartz 2D) renderer, on MSW the GDIPlus renderer, and
|
||||
|
Reference in New Issue
Block a user