bitmap.cpp File Reference

#include <wx/image.h>
#include <wx/bitmap.h>
#include <wx/gdicmn.h>
#include <wx/mstream.h>
#include <wx/menu.h>
#include <wx/menuitem.h>
#include <wx/aui/auibar.h>
#include <wx/dcclient.h>
#include <wx/dcmemory.h>
#include <cstdint>
#include <mutex>
#include <unordered_map>
#include <asset_archive.h>
#include <bitmaps.h>
#include <bitmap_store.h>
#include <bitmaps/bitmap_opaque.h>
#include <pgm_base.h>
#include <eda_base_frame.h>
#include <eda_draw_frame.h>
#include <paths.h>

Go to the source code of this file.

Classes
struct	SCALED_BITMAP_ID
struct	std::hash< SCALED_BITMAP_ID >

Namespaces
namespace	std

Functions
BITMAP_STORE *	GetBitmapStore ()
wxBitmap	KiBitmap (BITMAPS aBitmap, int aHeightTag)
	Construct a wxBitmap from an image identifier Returns the image from the active theme if the image has multiple theme variants. More...
wxBitmap	KiBitmap (const BITMAP_OPAQUE *aBitmap)
	Compatibility shim for pcb_calculator until its images are pulled into the PNG pipeline. More...
int	KiIconScale (wxWindow *aWindow)
	Return the automatic scale factor that would be used for a given window by KiScaledBitmap and KiScaledSeparator. More...
static int	get_scale_factor (wxWindow *aWindow)
wxBitmap	KiScaledBitmap (BITMAPS aBitmap, wxWindow *aWindow, int aHeight, bool aQuantized)
	Construct a wxBitmap from a memory record, scaling it if device DPI demands it. More...
void	ClearScaledBitmapCache ()
	Wipes out the scaled bitmap cache so that the icon theme can be changed. More...
wxBitmap	KiScaledBitmap (const wxBitmap &aBitmap, wxWindow *aWindow)
	Overload of the above function that takes another wxBitmap as a parameter. More...
wxBitmap *	KiBitmapNew (BITMAPS aBitmap)
	Allocate a wxBitmap on heap from a memory record, held in a BITMAPS. More...
bool	SaveCanvasImageToFile (EDA_DRAW_FRAME *aFrame, const wxString &aFileName, BITMAP_TYPE aBitmapType)
	Save the current view as an image file. More...
void	AddBitmapToMenuItem (wxMenuItem *aMenu, const wxBitmap &aImage)
	Add a bitmap to a menuitem. More...
wxMenuItem *	AddMenuItem (wxMenu *aMenu, int aId, const wxString &aText, const wxBitmap &aImage, wxItemKind aType=wxITEM_NORMAL)
	Create and insert a menu item with an icon into aMenu. More...
wxMenuItem *	AddMenuItem (wxMenu *aMenu, int aId, const wxString &aText, const wxString &aHelpText, const wxBitmap &aImage, wxItemKind aType=wxITEM_NORMAL)
	Create and insert a menu item with an icon and a help message string into aMenu. More...
wxMenuItem *	AddMenuItem (wxMenu *aMenu, wxMenu *aSubMenu, int aId, const wxString &aText, const wxBitmap &aImage)
	Create and insert a menu item with an icon into aSubMenu in aMenu. More...
wxMenuItem *	AddMenuItem (wxMenu *aMenu, wxMenu *aSubMenu, int aId, const wxString &aText, const wxString &aHelpText, const wxBitmap &aImage)
	Create and insert a menu item with an icon and a help message string into aSubMenu in aMenu. More...

Variables
static std::unique_ptr< BITMAP_STORE >	s_BitmapStore
static std::unordered_map< SCALED_BITMAP_ID, wxBitmap >	s_ScaledBitmapCache
static std::mutex	s_BitmapCacheMutex

Function Documentation

AddBitmapToMenuItem()

void AddBitmapToMenuItem	(	wxMenuItem *	aMenu,
		const wxBitmap &	aImage
	)

Add a bitmap to a menuitem.

It is added only if use images in menus config option allows it. For wxITEM_CHECK or wxITEM_RADIO menuitems, the bitmap is added only on Windows, other platforms do not support it

Parameters

aMenu	is the menuitem.
aImage	is the icon to add to aMenu.

Definition at line 251 of file bitmap.cpp.

{
 // Retrieve the global application show icon option:
 bool useImagesInMenus = Pgm().GetCommonSettings()->m_Appearance.use_icons_in_menus;
 
 wxItemKind menu_type = aMenu->GetKind();
 
 if( useImagesInMenus && menu_type != wxITEM_CHECK && menu_type != wxITEM_RADIO )
 {
 aMenu->SetBitmap( aImage );
 }
}

References Pgm().

Referenced by ACTION_MENU::Add(), CONDITIONAL_MENU::AddCheckItem(), CONDITIONAL_MENU::AddItem(), AddMenuItem(), ACTION_MENU::appendCopy(), ACTION_MENU::DisplayTitle(), CONDITIONAL_MENU::Evaluate(), and SIM_PLOT_FRAME::setIconsForMenuItems().

AddMenuItem() [1/4]

wxMenuItem * AddMenuItem	(	wxMenu *	aMenu,
		int	aId,
		const wxString &	aText,
		const wxBitmap &	aImage,
		wxItemKind	aType = wxITEM_NORMAL
	)

Create and insert a menu item with an icon into aMenu.

Parameters

aMenu	is the menu to add the new item.
aId	is the command ID for the new menu item.
aText	is the string for the new menu item.
aImage	is the icon to add to the new menu item.
aType	is the type of menu :wxITEM_NORMAL (default), wxITEM_CHECK ...

Returns

a pointer to the new created wxMenuItem.

Definition at line 265 of file bitmap.cpp.

{
 wxMenuItem* item = new wxMenuItem( aMenu, aId, aText, wxEmptyString, aType );
 AddBitmapToMenuItem( item, aImage );
 
 aMenu->Append( item );
 
 return item;
}

References AddBitmapToMenuItem().

Referenced by GERBER_LAYER_WIDGET::AddRightClickMenuItems(), PCB_EDIT_FRAME::buildActionPluginMenus(), PROJECT_TREE_PANE::onRight(), LAYER_WIDGET::OnRightDownLayer(), LAYER_WIDGET::OnRightDownRender(), APPEARANCE_CONTROLS::rebuildLayerContextMenu(), PANEL_COLOR_SETTINGS::ShowColorContextMenu(), and SIM_PLOT_FRAME::SIGNAL_CONTEXT_MENU::SIGNAL_CONTEXT_MENU().

AddMenuItem() [2/4]

wxMenuItem * AddMenuItem	(	wxMenu *	aMenu,
		int	aId,
		const wxString &	aText,
		const wxString &	aHelpText,
		const wxBitmap &	aImage,
		wxItemKind	aType = wxITEM_NORMAL
	)

Create and insert a menu item with an icon and a help message string into aMenu.

Parameters

aMenu	is the menu to add the new item.
aId	is the command ID for the new menu item.
aText	is the string for the new menu item.
aHelpText	is the help message string for the new menu item.
aImage	is the icon to add to the new menu item.
aType	is the type of menu :wxITEM_NORMAL (default), wxITEM_CHECK ...

Returns

a pointer to the new created wxMenuItem.

Definition at line 277 of file bitmap.cpp.

{
 wxMenuItem* item = new wxMenuItem( aMenu, aId, aText, aHelpText, aType );
 AddBitmapToMenuItem( item, aImage );
 
 aMenu->Append( item );
 
 return item;
}

References AddBitmapToMenuItem().

AddMenuItem() [3/4]

wxMenuItem * AddMenuItem	(	wxMenu *	aMenu,
		wxMenu *	aSubMenu,
		int	aId,
		const wxString &	aText,
		const wxBitmap &	aImage
	)

Create and insert a menu item with an icon into aSubMenu in aMenu.

Parameters

aMenu	is the menu to add the new submenu item.
aSubMenu	is the submenu to add the new menu.
aId	is the command ID for the new menu item.
aText	is the string for the new menu item.
aImage	is the icon to add to the new menu item.

Returns

a pointer to the new created wxMenuItem,

Definition at line 290 of file bitmap.cpp.

{
 wxMenuItem* item = new wxMenuItem( aMenu, aId, aText );
 item->SetSubMenu( aSubMenu );
 AddBitmapToMenuItem( item, aImage );
 
 aMenu->Append( item );
 
 return item;
}

References AddBitmapToMenuItem().

AddMenuItem() [4/4]

wxMenuItem * AddMenuItem	(	wxMenu *	aMenu,
		wxMenu *	aSubMenu,
		int	aId,
		const wxString &	aText,
		const wxString &	aHelpText,
		const wxBitmap &	aImage
	)

Create and insert a menu item with an icon and a help message string into aSubMenu in aMenu.

Parameters

aMenu	is the menu to add the new submenu item.
aSubMenu	is the submenu to add the new menu.
aId	is the command ID for the new menu item.
aText	is the string for the new menu item.
aHelpText	is the help message string for the new menu item.
aImage	is the icon to add to the new menu item.

Returns

a pointer to the new created wxMenuItem.

Definition at line 303 of file bitmap.cpp.

{
 wxMenuItem* item = new wxMenuItem( aMenu, aId, aText, aHelpText );
 item->SetSubMenu( aSubMenu );
 AddBitmapToMenuItem( item, aImage );
 
 aMenu->Append( item );
 
 return item;
}

References AddBitmapToMenuItem().

ClearScaledBitmapCache()

void ClearScaledBitmapCache

(

)

Wipes out the scaled bitmap cache so that the icon theme can be changed.

TODO: move scaling system into BITMAP_STORE so this global doesn't need to exist

Definition at line 181 of file bitmap.cpp.

{
 std::lock_guard<std::mutex> guard( s_BitmapCacheMutex );
 s_ScaledBitmapCache.clear();
}

References s_BitmapCacheMutex, and s_ScaledBitmapCache.

Referenced by EDA_BASE_FRAME::ThemeChanged().

get_scale_factor()

static int get_scale_factor ( wxWindow *  aWindow )

static

Definition at line 145 of file bitmap.cpp.

{
 int requested_scale = Pgm().GetCommonSettings()->m_Appearance.icon_scale;
 
 if( requested_scale > 0 )
 return requested_scale;
 else
 return KiIconScale( aWindow );
}

References KiIconScale(), and Pgm().

Referenced by KiScaledBitmap().

GetBitmapStore()

BITMAP_STORE * GetBitmapStore

(

)

Definition at line 93 of file bitmap.cpp.

{
 if( !s_BitmapStore )
 {
 wxFileName path( PATHS::GetStockDataPath() + wxT( "/resources" ), wxT( "images.zip" ) );
 s_BitmapStore = std::make_unique<BITMAP_STORE>();
 }
 
 return s_BitmapStore.get();
}

References PATHS::GetStockDataPath(), path, and s_BitmapStore.

Referenced by EDA_BASE_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::HandleSystemColorChange(), KiBitmap(), KiBitmapNew(), KiScaledBitmap(), ACTION_TOOLBAR::onThemeChanged(), PANEL_KICAD_LAUNCHER::onThemeChanged(), PROJECT_TREE_PANE::onThemeChanged(), PCB_CALCULATOR_FRAME::onThemeChanged(), and ACTION_PLUGINS::register_action().

KiBitmap() [1/2]

wxBitmap KiBitmap	(	BITMAPS	aBitmap,
		int	aHeightTag = -1
	)

Construct a wxBitmap from an image identifier Returns the image from the active theme if the image has multiple theme variants.

Parameters

aBitmap	is from the BITMAPS enum in bitmaps_list.h
aHeightTag	is the requested height tag for multi-res bitmaps (-1 for any)

Definition at line 105 of file bitmap.cpp.

{
 return GetBitmapStore()->GetBitmap( aBitmap, aHeightTag );
}

References BITMAP_STORE::GetBitmap(), and GetBitmapStore().

Referenced by ACTION_MENU::Add(), CONDITIONAL_MENU::AddCheckItem(), CONDITIONAL_MENU::AddItem(), GERBER_LAYER_WIDGET::AddRightClickMenuItems(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BM2CMP_FRAME::BM2CMP_FRAME(), PCB_EDIT_FRAME::buildActionPluginMenus(), GRID_CELL_ICON_TEXT_POPUP::Create(), DIALOG_ABOUT::createStaticBitmap(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_ABOUT::DIALOG_ABOUT(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_IMPORT_SETTINGS::DIALOG_IMPORT_SETTINGS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MANAGE_REPOSITORIES::DIALOG_MANAGE_REPOSITORIES(), DIALOG_MIGRATE_SETTINGS::DIALOG_MIGRATE_SETTINGS(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST_IMPORT::DIALOG_NETLIST_IMPORT(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PCM::DIALOG_PCM(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCH_IMPORT_SETTINGS::DIALOG_SCH_IMPORT_SETTINGS(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TEMPLATE_SELECTOR::DIALOG_TEMPLATE_SELECTOR(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), ACTION_MENU::DisplayTitle(), GRID_CELL_ICON_TEXT_RENDERER::Draw(), EDA_REORDERABLE_LIST_DIALOG::EDA_REORDERABLE_LIST_DIALOG(), CONDITIONAL_MENU::Evaluate(), EVT_GRID_CMD_CELL_CHANGED(), EVT_MENU_RANGE(), EVT_TOOL_RANGE(), EVT_UPDATE_UI_RANGE(), NL_3D_VIEWER_PLUGIN_IMPL::exportCommandsAndImages(), NL_SCHEMATIC_PLUGIN_IMPL::exportCommandsAndImages(), NL_PCBNEW_PLUGIN_IMPL::exportCommandsAndImages(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GRID_CELL_ICON_TEXT_RENDERER::GetBestSize(), HIERARCHY_NAVIG_PANEL::HIERARCHY_NAVIG_PANEL(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_PLOT::init_Dialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_GENDRILL::InitDisplayParams(), DIALOG_ANNOTATE::InitValues(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::loadEEschemaSettings(), PROJECT_TREE::LoadIcons(), PROJECT_TREE_PANE::onRight(), LAYER_WIDGET::OnRightDownLayer(), LAYER_WIDGET::OnRightDownRender(), SIM_PLOT_FRAME::onSimFinished(), SIM_PLOT_FRAME::onSimStarted(), PANEL_ATTENUATORS::PANEL_ATTENUATORS(), PANEL_COMMON_SETTINGS::PANEL_COMMON_SETTINGS(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PCBNEW_ACTION_PLUGINS::PANEL_PCBNEW_ACTION_PLUGINS(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_REGULATOR::PANEL_REGULATOR(), PANEL_SETUP_BUSES::PANEL_SETUP_BUSES(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SETUP_RULES::PANEL_SETUP_RULES(), PANEL_SETUP_TRACKS_AND_VIAS::PANEL_SETUP_TRACKS_AND_VIAS(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_TEMPLATE_FIELDNAMES::PANEL_TEMPLATE_FIELDNAMES(), PANEL_TEXT_VARIABLES::PANEL_TEXT_VARIABLES(), PANEL_TRANSLINE::PANEL_TRANSLINE(), PANEL_VIA_SIZE::PANEL_VIA_SIZE(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PinShapeComboBox::PinShapeComboBox(), PinTypeComboBox::PinTypeComboBox(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PROPERTIES_FRAME::PROPERTIES_FRAME(), APPEARANCE_CONTROLS::rebuildLayerContextMenu(), APPEARANCE_CONTROLS::rebuildLayers(), PANEL_SETUP_PINMAP::reBuildMatrixPanel(), APPEARANCE_CONTROLS::rebuildNets(), APPEARANCE_CONTROLS::rebuildObjects(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), PANEL_SETUP_PINMAP::setDRCMatrixButtonState(), SIM_PLOT_FRAME::setIconsForMenuItems(), DIALOG_PAD_PROPERTIES::Show(), PANEL_FP_EDITOR_DEFAULTS::Show(), PANEL_SETUP_CONSTRAINTS::Show(), PANEL_COLOR_SETTINGS::ShowColorContextMenu(), SIM_PLOT_FRAME::SIGNAL_CONTEXT_MENU::SIGNAL_CONTEXT_MENU(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), TEARDROP_DIALOG::TEARDROP_DIALOG(), TEXT_BUTTON_FILE_BROWSER::TEXT_BUTTON_FILE_BROWSER(), TEXT_BUTTON_FP_CHOOSER::TEXT_BUTTON_FP_CHOOSER(), TEXT_BUTTON_SYMBOL_CHOOSER::TEXT_BUTTON_SYMBOL_CHOOSER(), TEXT_BUTTON_URL::TEXT_BUTTON_URL(), PANEL_ATTENUATORS::ThemeChanged(), PANEL_COLOR_CODE::ThemeChanged(), PANEL_REGULATOR::ThemeChanged(), PANEL_TRANSLINE::ThemeChanged(), PANEL_VIA_SIZE::ThemeChanged(), BM2CMP_FRAME::ToggleAspectRatioLock(), PANEL_COLOR_CODE::ToleranceSelection(), PANEL_ATTENUATORS::TransfAttenuatorDataToPanel(), DIALOG_PNS_LENGTH_TUNING_SETTINGS::TransferDataToWindow(), PANEL_TRANSLINE::TranslineTypeSelection(), DIALOG_UNUSED_PAD_LAYERS::updateImage(), and PANEL_ATTENUATORS::UpdateUI().

KiBitmap() [2/2]

wxBitmap KiBitmap

(

const BITMAP_OPAQUE *

aBitmap

)

Compatibility shim for pcb_calculator until its images are pulled into the PNG pipeline.

Definition at line 112 of file bitmap.cpp.

{
 wxMemoryInputStream is( aBitmap->png, aBitmap->byteCount );
 wxImage image( is, wxBITMAP_TYPE_PNG );
 wxBitmap bitmap( image );
 
 return bitmap;
}

References BITMAP_OPAQUE::byteCount, image, and BITMAP_OPAQUE::png.

KiBitmapNew()

wxBitmap * KiBitmapNew

(

BITMAPS

aBitmap

)

Allocate a wxBitmap on heap from a memory record, held in a BITMAPS.

Parameters

aBitmap

is from the BITMAPS enum in bitmaps_list.h

Returns

wxBitmap* - caller owns it.

Definition at line 207 of file bitmap.cpp.

{
 wxBitmap* bitmap = new wxBitmap( GetBitmapStore()->GetBitmap( aBitmap ) );
 
 return bitmap;
}

References GetBitmapStore().

Referenced by ABOUT_APP_INFO::CreateKiBitmap().

KiIconScale()

int KiIconScale

(

wxWindow *

aWindow

)

Return the automatic scale factor that would be used for a given window by KiScaledBitmap and KiScaledSeparator.

Definition at line 122 of file bitmap.cpp.

{
 #if defined( __WXMSW__) && wxCHECK_VERSION( 3, 1, 6 )
 // Basically don't try and scale within kicad and let wx do its thing
 // with wx introducing bitmap bundles, it will auto scale automatically with dpi
 // the issue is, none of the scaling factors have any tie to system scaling
 // this means wx is actually going to scale again causing even more distorted icons
 return 4;
 #else
 const int vert_size = aWindow->ConvertDialogToPixels( wxSize( 0, 8 ) ).y;
 
 // Autoscale won't exceed unity until the system has quite high resolution,
 // because we don't want the icons to look obviously scaled on a system
 // where it's easy to see it.
 
 if( vert_size > 34 ) return 8;
 else if( vert_size > 29 ) return 7;
 else if( vert_size > 24 ) return 6;
 else return 4;
 #endif
}

Referenced by ACTION_TOOLBAR::AddScaledSeparator(), PANEL_COMMON_SETTINGS::applySettingsToPanel(), get_scale_factor(), getGUIFont(), PANEL_COMMON_SETTINGS::OnIconScaleAuto(), and PCB_EDIT_FRAME::PrepareLayerIndicator().

KiScaledBitmap() [1/2]

wxBitmap KiScaledBitmap	(	BITMAPS	aBitmap,
		wxWindow *	aWindow,
		int	aHeight = -1,
		bool	aQuantized = false
	)

Construct a wxBitmap from a memory record, scaling it if device DPI demands it.

Internally this may use caching to avoid scaling the same image twice. If caching is used, it's guaranteed threadsafe.

Parameters

aBitmap	is from the BITMAPS enum in bitmaps_list.h
aWindow	target window for scaling context
aHeight	is the requested image height for the source bitmap, or -1 for any height
aQuantized	if true scaling will be rounded to integers (2X, 3X, etc.).

Definition at line 156 of file bitmap.cpp.

{
 // Bitmap conversions are cached because they can be slow.
 int scale = get_scale_factor( aWindow );
 
 if( aQuantized )
 scale = KiROUND( (double) scale / 4.0 ) * 4;
 
 SCALED_BITMAP_ID id = { static_cast<BITMAPS>( aBitmap ), scale };
 
 std::lock_guard<std::mutex> guard( s_BitmapCacheMutex );
 auto it = s_ScaledBitmapCache.find( id );
 
 if( it != s_ScaledBitmapCache.end() )
 {
 return it->second;
 }
 else
 {
 wxBitmap bitmap = GetBitmapStore()->GetBitmapScaled( aBitmap, scale, aHeight );
 return s_ScaledBitmapCache.emplace( id, bitmap ).first->second;
 }
}

References get_scale_factor(), BITMAP_STORE::GetBitmapScaled(), GetBitmapStore(), KiROUND(), s_BitmapCacheMutex, s_ScaledBitmapCache, and scale.

Referenced by ACTION_TOOLBAR::Add(), ACTION_TOOLBAR_PALETTE::AddAction(), PCB_EDIT_FRAME::AddActionPluginTools(), ACTION_TOOLBAR::AddButton(), ACTION_TOOLBAR::AddGroup(), PANEL_KICAD_LAUNCHER::CreateLaunchers(), ACTION_TOOLBAR::doSelectAction(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), KICAD_MANAGER_FRAME::RecreateBaseHToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), SYMBOL_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), EDA_3D_VIEWER_FRAME::ReCreateMainToolbar(), and ACTION_TOOLBAR::RefreshBitmaps().

KiScaledBitmap() [2/2]

wxBitmap KiScaledBitmap	(	const wxBitmap &	aBitmap,
		wxWindow *	aWindow
	)

Overload of the above function that takes another wxBitmap as a parameter.

Parameters

aBitmap	is the source bitmap to scale
aWindow	target window for scaling context

Definition at line 188 of file bitmap.cpp.

{
 const int scale = get_scale_factor( aWindow );
 
 if( scale == 4 )
 {
 return wxBitmap( aBitmap );
 }
 else
 {
 wxImage image = aBitmap.ConvertToImage();
 image.Rescale( scale * image.GetWidth() / 4, scale * image.GetHeight() / 4,
 wxIMAGE_QUALITY_BILINEAR );
 
 return wxBitmap( image );
 }
}

References get_scale_factor(), image, and scale.

SaveCanvasImageToFile()

bool SaveCanvasImageToFile	(	EDA_DRAW_FRAME *	aFrame,
		const wxString &	aFileName,
		BITMAP_TYPE	aBitmapType = BITMAP_TYPE::PNG
	)

Save the current view as an image file.

Parameters

aFrame	The current draw frame view to save.
aFileName	The file name to save the image. This will overwrite an existing file.
aBitmapType	The type of bitmap create as defined by wxImage.

Returns

True if the file was successfully saved or false if the file failed to be saved.

Definition at line 215 of file bitmap.cpp.

{
 wxCHECK( aFrame != nullptr, false );
 
 bool retv = true;
 
 // Make a screen copy of the canvas:
 wxSize image_size = aFrame->GetCanvas()->GetClientSize();
 
 wxClientDC dc( aFrame->GetCanvas() );
 wxBitmap bitmap( image_size.x, image_size.y );
 wxMemoryDC memdc;
 
 memdc.SelectObject( bitmap );
 memdc.Blit( 0, 0, image_size.x, image_size.y, &dc, 0, 0 );
 memdc.SelectObject( wxNullBitmap );
 
 wxImage image = bitmap.ConvertToImage();
 
 wxBitmapType type = wxBITMAP_TYPE_PNG;
 switch( aBitmapType )
 {
 case BITMAP_TYPE::PNG: type = wxBITMAP_TYPE_PNG; break;
 case BITMAP_TYPE::BMP: type = wxBITMAP_TYPE_BMP; break;
 case BITMAP_TYPE::JPG: type = wxBITMAP_TYPE_JPEG; break;
 }
 
 if( !image.SaveFile( aFileName, type ) )
 retv = false;
 
 image.Destroy();
 return retv;
}

References BMP, EDA_DRAW_FRAME::GetCanvas(), image, JPG, and PNG.

Referenced by SYMBOL_EDITOR_CONTROL::ExportView(), and FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng().

Variable Documentation

s_BitmapCacheMutex

std::mutex s_BitmapCacheMutex

static

Definition at line 90 of file bitmap.cpp.

Referenced by ClearScaledBitmapCache(), and KiScaledBitmap().

s_BitmapStore

std::unique_ptr<BITMAP_STORE> s_BitmapStore

static

Definition at line 50 of file bitmap.cpp.

Referenced by GetBitmapStore().

s_ScaledBitmapCache

std::unordered_map<SCALED_BITMAP_ID, wxBitmap> s_ScaledBitmapCache

static

Definition at line 88 of file bitmap.cpp.

Referenced by ClearScaledBitmapCache(), and KiScaledBitmap().