From 08dc9405cb04a9435520bed4fa4209fb10aead5f Mon Sep 17 00:00:00 2001 From: Tobias Taschner Date: Tue, 5 Jan 2016 15:03:33 +0100 Subject: [PATCH] Document wxBitmap::CreateScaled() and wxBitmap::Create() overload. The two methods were previously undocumented but might be of interest to user code for high DPI display compatibility. --- interface/wx/bitmap.h | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/interface/wx/bitmap.h b/interface/wx/bitmap.h index c8068a6647..500002ae4a 100644 --- a/interface/wx/bitmap.h +++ b/interface/wx/bitmap.h @@ -437,6 +437,40 @@ public: */ virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH); + /** + Create a bitmap compatible with the given DC, inheriting its magnification factor + + @param width + The width of the bitmap in pixels, must be strictly positive. + @param height + The height of the bitmap in pixels, must be strictly positive. + @param dc + DC from wich the scaling factor is inherited + + @return @true if the creation was successful. + + @since 3.1.0 + */ + bool Create(int width, int height, const wxDC& dc); + + /** + Create a bitmap with a scale factor, width and height are multiplied with that factor + + @param width + The width of the bitmap in pixels, must be strictly positive. + @param height + The height of the bitmap in pixels, must be strictly positive. + @param depth + The number of bits used to represent each bitmap pixel. + @param logicalScale + Scale factor used by the bitmap + + @return @true if the creation was successful. + + @since 3.1.0 + */ + bool CreateScaled(int logwidth, int logheight, int depth, double logicalScale); + /* Creates a bitmap from the given data, which can be of arbitrary type.