.\" This is a wxWidgets manpage page generated from the XML docs .TH wxBitmap 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation" .SH NAME wxBitmap \- Represents a bitmap .SH DESCRIPTION This class encapsulates the concept of a platform-dependent bitmap, either monochrome or colour or colour with alpha channel support. .SH "PARENTS" wxGDIObject wxObject .SH "INCLUDE FILES" wx/bitmap.h .SH MEMBERS .SS wxBitmap () Default constructor. .SS wxBitmap (const wxBitmap& bitmap) Copy constructor. Note that this does not take a fresh copy of the data, but instead makes the internal data point to bitmap 's data. So changing one bitmap will change the other. To make a real copy, you can use: wxBitmap newBitmap = oldBitmap.GetSubBitmap( wxRect(0, 0, oldBitmap.GetWidth(), oldBitmap.GetHeight())); .SS wxBitmap (void* dataint typeint widthint heightint depth = -1) Creates a bitmap from the given data which is interpreted in platform-dependent manner. .SS wxBitmap (const char bits[]int widthint heightint depth = 1) Creates a bitmap from an array of bits. You should only use this function for monochrome bitmaps ( depth 1) in portable programs: in this case the bits parameter should contain an XBM image. For other bit depths, the behaviour is platform dependent: under Windows, the data is passed without any changes to the underlying CreateBitmap() API. Under other platforms, only monochrome bitmaps may be created using this constructor and wxImage should be used for creating colour bitmaps from static data. .SS wxBitmap (int widthint heightint depth = -1) Creates a new bitmap. A depth of -1 indicates the depth of the current screen or visual. Some platforms only support 1 for monochrome and -1 for the current colour setting. Beginning with version 2.5.4 of wxWidgets a depth of 32 including an alpha channel is supported under MSW, Mac and GTK+. .SS wxBitmap (const char** bits) Creates a bitmap from XPM data. .SS wxBitmap (const wxString& namelong type) Loads a bitmap from a file or resource. .SS wxBitmap (const wxImage& imgint depth = -1) Creates bitmap object from the image. This has to be done to actually display an image as you cannot draw an image directly on a window. The resulting bitmap will use the provided colour depth (or that of the current system if depth is -1) which entails that a colour reduction has to take place. When in 8-bit mode (PseudoColour mode), the GTK port will use a color cube created on program start-up to look up colors. This ensures a very fast conversion, but the image quality won't be perfect (and could be better for photo images using more sophisticated dithering algorithms). On Windows, if there is a palette present (set with SetPalette), it will be used when creating the wxBitmap (most useful in 8-bit display mode). On other platforms, the palette is currently ignored. .SS ~wxBitmap () Destroys the wxBitmap object and possibly the underlying bitmap data. Because reference counting is used, the bitmap may not actually be destroyed at this point - only when the reference count is zero will the data be deleted. If the application omits to delete the bitmap explicitly, the bitmap will be destroyed automatically by wxWidgets when the application exits. Do not delete a bitmap that is selected into a memory device context. .SS static void AddHandler (wxBitmapHandler* handler) Adds a handler to the end of the static list of format handlers. .SS static void CleanUpHandlers () Deletes all bitmap handlers. This function is called by wxWidgets on exit. .SS wxImage ConvertToImage () Creates an image from a platform-dependent bitmap. This preserves mask information so that bitmaps and images can be converted back and forth without loss in that respect. .SS bool CopyFromIcon (const wxIcon& icon) Creates the bitmap from an icon. .SS virtual bool Create (int widthint heightint depth = -1) Creates a fresh bitmap. If the final argument is omitted, the display depth of the screen is used. .SS virtual bool Create (void* dataint typeint widthint heightint depth = -1) Creates a bitmap from the given data, which can be of arbitrary type. .SS static wxBitmapHandler* FindHandler (const wxString& name) Finds the handler with the given name. .SS static wxBitmapHandler* FindHandler (const wxString& extensionwxBitmapType bitmapType) Finds the handler associated with the given extension and type. .SS static wxBitmapHandler* FindHandler (wxBitmapType bitmapType) Finds the handler associated with the given bitmap type. .SS int GetDepth () Gets the colour depth of the bitmap. A value of 1 indicates a monochrome bitmap. .SS static wxList& GetHandlers () Returns the static list of bitmap format handlers. .SS int GetHeight () Gets the height of the bitmap in pixels. .SS wxPalette* GetPalette () Gets the associated palette (if any) which may have been loaded from a file or set for the bitmap. .SS wxMask* GetMask () .SS int GetWidth () Gets the width of the bitmap in pixels. .SS wxBitmap GetSubBitmap (const wxRect&rect) Returns a sub bitmap of the current one as long as the rect belongs entirely to the bitmap. This function preserves bit depth and mask information. .SS static void InitStandardHandlers () Adds the standard bitmap format handlers, which, depending on wxWidgets configuration, can be handlers for Windows bitmap, Windows bitmap resource, and XPM. This function is called by wxWidgets on startup. .SS static void InsertHandler (wxBitmapHandler* handler) Adds a handler at the start of the static list of format handlers. .SS bool LoadFile (const wxString& namewxBitmapType type) Loads a bitmap from a file or resource. .SS bool Ok () Returns true if bitmap data is present. .SS static bool RemoveHandler (const wxString& name) Finds the handler with the given name, and removes it. The handler is not deleted. .SS bool SaveFile (const wxString& namewxBitmapType typewxPalette* palette = NULL) Saves a bitmap in the named file. .SS void SetDepth (int depth) Sets the depth member (does not affect the bitmap data). .SS void SetHeight (int height) Sets the height member (does not affect the bitmap data). .SS void SetMask (wxMask* mask) .SS void SetPalette (const wxPalette& palette) Sets the associated palette. (Not implemented under GTK+). .SS void SetWidth (int width) Sets the width member (does not affect the bitmap data). .SS wxBitmap& operator = (const wxBitmap& bitmap) Assignment operator. This operator does not copy any data, but instead passes a pointer to the data in bitmap and increments a reference counter. It is a fast operation. .SS bool operator == (const wxBitmap& bitmap) Equality operator. This operator tests whether the internal data pointers are equal (a fast test). .SS bool operator != (const wxBitmap& bitmap) Inequality operator. This operator tests whether the internal data pointers are unequal (a fast test). .SH "SEE ALSO" wxGDIObject wxObject wxBitmap overview , supported bitmap file formats , wxDC::Blit , wxIcon wxCursor wxBitmap , wxMemoryDC .SH "AUTHORS" Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.