audacia/src/ImageManipulation.h

77 lines
2.7 KiB
C++

/**********************************************************************
Audacity: A Digital Audio Editor
ImageManipulation.h
Dominic Mazzoni
**********************************************************************/
#include "MemoryX.h"
#include <wx/defs.h>
class wxColour;
class wxImage;
// This looks at the first pixel in the image, and shifts
// the entire image by the vector difference between that
// pixel and the dstColour. For better control, use
// ChangeImageColour(wxImage, wxColour*, wxColour*) below
AUDACITY_DLL_API
std::unique_ptr<wxImage> ChangeImageColour(wxImage * srcImage, wxColour & dstColour);
// This function takes a source image, which it assumes to
// be grayscale, and smoothly changes the overall color
// to the specified color, and returns the result as a
// NEW image. This works well for grayscale 3D images.
// Audacity uses this routines to make the buttons
// (skip-start, play, stop, record, skip-end) adapt to
// the color scheme of the user.
AUDACITY_DLL_API
std::unique_ptr<wxImage> ChangeImageColour(wxImage * srcImage,
wxColour & srcColour,
wxColour & dstColour);
// Takes a background image, foreground image, and mask
// (i.e. the alpha channel for the foreground), and
// returns a NEW image where the foreground has been
// overlaid onto the background using alpha-blending,
// at location (xoff, yoff).
AUDACITY_DLL_API
std::unique_ptr<wxImage> OverlayImage(wxImage * background, wxImage * foreground,
wxImage * mask, int xoff, int yoff);
// JKC: will probably change name from 'teBmps' to 'tIndexBmp';
using teBmps = int; /// The index of a bitmap resource in Theme Resources.
// Same idea, but this time the mask is an alpha channel in
// the foreground bitmap, and it's all retrieved from Themes.
AUDACITY_DLL_API
std::unique_ptr<wxImage> OverlayImage(teBmps eBack, teBmps eForeground,
int xoff, int yoff);
// Creates an image with a solid background color
AUDACITY_DLL_API
std::unique_ptr<wxImage> CreateBackground(int width, int height, wxColour colour);
// Creates an image with the Mac OS X Aqua stripes, to be used
// as a background
AUDACITY_DLL_API
std::unique_ptr<wxImage> CreateAquaBackground(int width, int height, int offset);
// Uses color on all OS except Mac, uses Aqua
AUDACITY_DLL_API
std::unique_ptr<wxImage> CreateSysBackground(int width, int height, int offset,
wxColour colour);
// Pastes one image into another at specified location.
AUDACITY_DLL_API
void PasteSubImage( wxImage * pDest, wxImage * pSrc, int x, int y );
// Gets a rectangle from within another image, INCLUDING the alpha channel
AUDACITY_DLL_API
wxImage GetSubImageWithAlpha( const wxImage & Src, const wxRect &rect );