Bitmap.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/Bitmap.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_Bitmap_h
#define __PCL_Bitmap_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/Color.h>
#include <pcl/ImageRenderingModes.h>
#include <pcl/Rectangle.h>
#include <pcl/String.h>
#include <pcl/UIObject.h>
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace BitmapFormat
{
   enum value_type
   {
      ARGB32,               // AARRGGBB
      RGB32,                // ffRRGGBB
      ARGB32_Premultiplied, // AARRGGBB with premultiplied RGB
 
      // ### TODO: Core version 1.8.x: Implement 16-bit bitmap formats.
//       RGBA64,               // RRRRGGGGBBBBAAAA
//       RGBA64,               // RRRRGGGGBBBBffff
//       RGBA64_Premultiplied, // RRRRGGGGBBBBAAAA with premultiplied RGB
 
      NumberOfBitmapFormats,
 
      Invalid = -1
   };
}
 
// ----------------------------------------------------------------------------
 
namespace SVGRenderOption
{
   enum mask_type
   {
      IgnoreAspectRatio   = 0x00000000,  // Render freely to fill the specified rectangular area entirely, ignoring aspect ratio.
      PreserveAspectRatio = 0x00000001,  // Render within the specified rectangular area, preserving the original aspect ratio of the SVG drawing.
      Fast                = 0x00000000,  // Render with a fast, thread-safe implementation that supports most of the SVG 1.1 specification.
      HighQuality         = 0x00000010,  // Render with a high-quality, thread-unsafe implementation supporting the entire SVG 1.1 specification.
      Default             = PreserveAspectRatio|Fast
   };
};
 
using SVGRenderOptions = Flags<SVGRenderOption::mask_type>;
 
// ----------------------------------------------------------------------------
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
class PCL_CLASS ImageVariant;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Bitmap : public UIObject
{
public:
 
   using pixel_format = BitmapFormat::value_type;
 
   using display_channel = DisplayChannel::value_type;
 
   using mask_mode = MaskMode::value_type;
 
   Bitmap();
 
   Bitmap( int width, int height, pixel_format fmt = BitmapFormat::ARGB32 );
 
   Bitmap( const char** xpm );
 
   Bitmap( const String& filePath );
 
   Bitmap( const char* filePath );
 
   Bitmap( const IsoString& filePath );
 
   Bitmap( const void* data, size_type size, const char* format = "SVG", uint32 flags = 0 );
 
   Bitmap( const Bitmap& bmp, const pcl::Rect& r );
 
   Bitmap( const Bitmap& bmp, int x0, int y0, int x1, int y1 );
 
   Bitmap( const Bitmap& bmp ) : UIObject( bmp )
   {
   }
 
   Bitmap( Bitmap&& x ) : UIObject( std::move( x ) )
   {
   }
 
   ~Bitmap() override
   {
   }
 
   Bitmap& operator =( const Bitmap& bmp )
   {
      Assign( bmp );
      return *this;
   }
 
   Bitmap& operator =( Bitmap&& x )
   {
      Transfer( x );
      return *this;
   }
 
   static Bitmap& Null();
 
   pixel_format PixelFormat() const;
 
   void SetPixelFormat( pixel_format fmt );
 
   static Bitmap Render( const ImageVariant& image,
            int zoom = 1, display_channel displayChannel = DisplayChannel::RGBK, bool transparency = true,
            const ImageVariant* mask = nullptr, mask_mode maskMode = MaskMode::Default, bool maskInverted = false,
            const uint8** LUT = nullptr, bool fastDownsample = true, bool (*callback)() = nullptr );
 
   void GetDimensions( int& width, int& height ) const;
 
   int Width() const
   {
      int w, dum; GetDimensions( w, dum ); return w;
   }
 
   int Height() const
   {
      int dum, h; GetDimensions( dum, h ); return h;
   }
 
   pcl::Rect Bounds() const
   {
      int w, h; GetDimensions( w, h ); return pcl::Rect( w, h );
   }
 
   bool IsEmpty() const;
 
   operator bool() const
   {
      return !IsEmpty();
   }
 
   RGBA Pixel( int x, int y ) const;
 
   RGBA Pixel( const pcl::Point& p ) const
   {
      return Pixel( p.x, p.y );
   }
 
   void SetPixel( int x, int y, RGBA v );
 
   void SetPixel( const pcl::Point& p, RGBA v )
   {
      SetPixel( p.x, p.y, v );
   }
 
   const RGBA* ScanLine( int y ) const;
 
   RGBA* ScanLine( int y );
 
   Bitmap Mirrored() const;
 
   Bitmap MirroredHorizontally() const;
 
   Bitmap MirroredVertically() const;
 
   Bitmap Scaled( double sx, double sy, bool precise = true ) const;
 
   Bitmap Scaled( double sxy, bool precise = true ) const;
 
   Bitmap ScaledToWidth( int width, bool precise = true ) const;
 
   Bitmap ScaledToHeight( int height, bool precise = true ) const;
 
   Bitmap ScaledToSize( int width, int height, bool precise = true ) const;
 
   Bitmap Rotated( double angle, bool precise = true ) const;
 
   void Load( const String& filePath );
 
   void Save( const String& filePath, int quality = -1 ) const;
 
   void Load( const void* data, size_type size, const char* format = "SVG", uint32 flags = 0 );
 
   Bitmap Subimage( int x0, int y0, int x1, int y1 ) const;
 
   Bitmap Subimage( const pcl::Rect& r ) const
   {
      return Subimage( r.x0, r.y0, r.x1, r.y1 );
   }
 
   void Copy( const pcl::Point& p, const Bitmap& src, const pcl::Rect& r );
 
   void Copy( const pcl::Point& p, const Bitmap& src )
   {
      Copy( p, src, src.Bounds() );
   }
 
   void Copy( const Bitmap& src )
   {
      Copy( pcl::Point( 0 ), src );
   }
 
   void Fill( const pcl::Rect& rect, RGBA fillWith );
 
   void Fill( RGBA fillWith )
   {
      Fill( Bounds(), fillWith );
   }
 
   void Or( const pcl::Rect& rect, RGBA orWith );
 
   void Or( RGBA orWith )
   {
      Or( Bounds(), orWith );
   }
 
   void Or( const pcl::Point& p, const Bitmap& src, const pcl::Rect& r );
 
   void Or( const pcl::Point& p, const Bitmap& src )
   {
      Or( p, src, src.Bounds() );
   }
 
   void Or( const Bitmap& src )
   {
      Or( pcl::Point( 0 ), src );
   }
 
   void And( const pcl::Rect& rect, RGBA andWith );
 
   void And( RGBA andWith )
   {
      And( Bounds(), andWith );
   }
 
   void And( const pcl::Point& p, const Bitmap& src, const pcl::Rect& r );
 
   void And( const pcl::Point& p, const Bitmap& src )
   {
      And( p, src, src.Bounds() );
   }
 
   void And( const Bitmap& src )
   {
      And( pcl::Point( 0 ), src );
   }
 
   void Xor( const pcl::Rect& rect, RGBA xorWith );
 
   void Xor( RGBA xorWith )
   {
      Xor( Bounds(), xorWith );
   }
 
   void Xor( const pcl::Point& p, const Bitmap& src, const pcl::Rect& r );
 
   void Xor( const pcl::Point& p, const Bitmap& src )
   {
      Xor( p, src, src.Bounds() );
   }
 
   void Xor( const Bitmap& src )
   {
      Xor( pcl::Point( 0 ), src );
   }
 
   void XorRect( const pcl::Rect& rect, RGBA xorWith );
 
   void XorRect( RGBA xorWith )
   {
      XorRect( Bounds(), xorWith );
   }
 
   void Invert( const pcl::Rect& rect )
   {
      Xor( rect, 0x00ffffff );
   }
 
   void Invert()
   {
      Invert( Bounds() );
   }
 
   void InvertRect( const pcl::Rect& rect )
   {
      XorRect( rect, 0x00ffffff );
   }
 
   void InvertRect()
   {
      InvertRect( Bounds() );
   }
 
   void ReplaceColor( const pcl::Rect& rect, RGBA replaceThis, RGBA replaceWith );
 
   void ReplaceColor( RGBA replaceThis, RGBA replaceWith )
   {
      ReplaceColor( Bounds(), replaceThis, replaceWith );
   }
 
   void SetAlpha( const pcl::Rect& rect, uint8 newAlpha );
 
   void SetAlpha( uint8 newAlpha )
   {
      SetAlpha( Bounds(), newAlpha );
   }
 
   double PhysicalPixelRatio() const;
 
   void SetPhysicalPixelRatio( double ratio );
 
   static Bitmap FromSVGFile( const String& filePath, int width = 0, int height = 0,
                              SVGRenderOptions options = SVGRenderOption::Default );
 
   static Bitmap FromSVG( const IsoString& svgSource, int width = 0, int height = 0,
                          SVGRenderOptions options = SVGRenderOption::Default );
 
private:
 
   Bitmap( void* h ) : UIObject( h )
   {
   }
 
   void* CloneHandle() const override;
 
   friend class GraphicsContextBase;
   friend class Graphics;
   friend class VectorGraphics;
   friend class Action;
   friend class Brush;
   friend class Cursor;
   friend class Button;
   friend class PushButton;
   friend class ToolButton;
   friend class BitmapBox;
   friend class TabBox;
   friend class ComboBox;
   friend class TreeBox;
   friend class ImageView;
   friend class ImageWindow;
   friend class Process;
   friend class FileFormat;
};
 
// ----------------------------------------------------------------------------
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
} // pcl
 
#endif   // __PCL_Bitmap_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Bitmap.h - Released 2024-06-18T15:48:54Z