/**
Gets the image type associated with this handler.
*/
- long GetType() const;
+ wxBitmapType GetType() const;
/**
Loads a image from a stream, putting the resulting data into @e image. If the
class wxImage : public wxObject
{
public:
-
+
/**
Creates an empty wxImage object without an alpha channel.
*/
wxImage();
-
+
/**
Creates an image with the given size and clears it if requested.
Does not create an alpha channel.
-
+
@param width
Specifies the width of the image.
@param height
Clear the image with zeros.
*/
wxImage(int width, int height, bool clear = true);
-
+
/**
Creates an image from data in memory. If static_data is false
then the wxImage will take ownership of the data and free it
afterwards. For this, it has to be allocated with @e malloc.
-
+
@param width
Specifies the width of the image.
@param height
A pointer to RGB data
@param static_data
Indicates if the data should be free'd after use
-
+
*/
wxImage(int width, int height, unsigned char* data, bool static_data = false);
-
+
/**
Creates an image from data in memory. If static_data is false
then the wxImage will take ownership of the data and free it
afterwards. For this, it has to be allocated with @e malloc.
-
+
@param width
Specifies the width of the image.
@param height
A pointer to alpha-channel data
@param static_data
Indicates if the data should be free'd after use
-
+
*/
wxImage(int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false );
-
+
/**
Creates an image from XPM data.
-
+
@param xpmData
A pointer to XPM image data.
*/
wxImage(const char* const* xpmData);
-
+
/**
Creates an image from a file.
-
+
@param name
Name of the file from which to load the image.
@param type
@see LoadFile()
*/
- wxImage(const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1);
-
+ wxImage(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_ANY, int index = -1);
+
/**
Creates an image from a file using MIME-types to specify the type.
-
+
@param name
Name of the file from which to load the image.
@param type
See above
*/
wxImage(const wxString& name, const wxString& mimetype, int index = -1);
-
+
/**
Creates an image from a stream.
-
+
@param stream
Opened input stream from which to load the image. Currently,
the stream must support seeking.
@param index
See above.
*/
- wxImage(wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1);
-
+ wxImage(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY, int index = -1);
+
/**
Creates an image from a stream using MIME-types to specify the type.
-
+
@param stream
Opened input stream from which to load the image. Currently,
the stream must support seeking.
See above.
*/
wxImage(wxInputStream& stream, const wxString& mimetype, int index = -1);
-
+
/**
Destructor.
@see Blur(), BlurHorizontal()
*/
wxImage BlurVertical(int blurRadius);
-
+
/**
Returns @true if the current image handlers can read this file
*/
*/
static wxImageHandler* FindHandler(const wxString& name);
static wxImageHandler* FindHandler(const wxString& extension,
- long imageType);
- static wxImageHandler* FindHandler(long imageType);
+ wxBitmapType imageType);
+ static wxImageHandler* FindHandler(wxBitmapType imageType);
static wxImageHandler* FindHandlerMime(const wxString& mimetype);
//@}
Return alpha value at given pixel location.
*/
unsigned char GetAlpha(int x, int y) const;
-
+
/**
Returns pointer to the array storing the alpha values for this image. This
pointer is @NULL for the images without the alpha channel. If the image
(exceptions are TIFF and ICO formats).
*/
static int GetImageCount(const wxString& filename,
- long type = wxBITMAP_TYPE_ANY);
+ wxBitmapType type = wxBITMAP_TYPE_ANY);
static int GetImageCount(wxInputStream& stream,
- long type = wxBITMAP_TYPE_ANY);
+ wxBitmapType type = wxBITMAP_TYPE_ANY);
//@}
/**
/**
Gets a user-defined option as an integer. The function is case-insensitive
- to @e name. If the given option is not present, the function returns 0.
+ to @e name. If the given option is not present, the function returns 0.
Use HasOption() is 0 is a possibly valid value for the option.
Options for wxPNGHandler
@li wxIMAGE_OPTION_PNG_FORMAT: Format for saving a PNG file.
@li wxIMAGE_OPTION_PNG_BITDEPTH: Bit depth for every channel (R/G/B/A).
-
+
Supported values for wxIMAGE_OPTION_PNG_FORMAT:
@li wxPNG_TYPE_COLOUR: Stores RGB image.
@li wxPNG_TYPE_GREY: Stores grey image, converts from RGB.
*/
wxImage GetSubImage(const wxRect& rect) const;
+ /**
+ Gets the type of image found by LoadFile or specified with SaveFile
+ @since 2.9.0
+ */
+ wxBitmapType GetType() const;
+
/**
Gets the width of the image in pixels.
@see SaveFile()
*/
bool LoadFile(const wxString& name,
- long type = wxBITMAP_TYPE_ANY,
+ wxBitmapType type = wxBITMAP_TYPE_ANY,
int index = -1);
bool LoadFile(const wxString& name, const wxString& mimetype,
int index = -1);
- bool LoadFile(wxInputStream& stream, long type,
+ bool LoadFile(wxInputStream& stream, wxBitmapType type,
int index = -1);
bool LoadFile(wxInputStream& stream,
const wxString& mimetype,
Example:
@param quality
- Determines what method to use for resampling the image.
-
+ Determines what method to use for resampling the image.
+
Can be one of the following:
@li wxIMAGE_QUALITY_NORMAL: Uses the normal default scaling method of
pixel replication
wxImage Scale(int width, int height,
int quality = wxIMAGE_QUALITY_NORMAL) const;
- /**
+ /**
Assigns new data as alpha channel to the image.
If @e static_data is false the data will be
free()'d after use.
*/
void SetAlpha(unsigned char* alpha = NULL,
bool static_data = false);
-
+
/**
Sets the alpha value for the given pixel. This function should only be
called if the image has alpha channel data, use HasAlpha() to
projects / wxWidgets.git / blobdiff