Skip to content

Commit

Permalink
Document wxBitmap::CreateScaled() and wxBitmap::Create() overload.
Browse files Browse the repository at this point in the history
The two methods were previously undocumented but might be of interest
to user code for high DPI display compatibility.
  • Loading branch information
TcT2k committed Jan 5, 2016
1 parent fd900b2 commit 3ab3acd
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions interface/wx/bitmap.h
Expand Up @@ -437,6 +437,40 @@ class wxBitmap : public wxGDIObject
*/
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.
Expand Down

0 comments on commit 3ab3acd

Please sign in to comment.