LibreOffice Module vcl (master) 1
Public Member Functions | Private Attributes | List of all members
vcl::ScopedBitmapAccess< Access, Bitmap, Acquire > Class Template Reference

This template handles BitmapAccess the RAII way. More...

#include <scopedbitmapaccess.hxx>

Inheritance diagram for vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >:
[legend]
Collaboration diagram for vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >:
[legend]

Public Member Functions

 ScopedBitmapAccess (Bitmap &rBitmap)
 
 ScopedBitmapAccess (Access *pAccess, Bitmap &rBitmap)
 
 ScopedBitmapAccess ()
 
ScopedBitmapAccess & operator= (ScopedBitmapAccess &&other)
 
 ScopedBitmapAccess (const ScopedBitmapAccess &)=delete
 
ScopedBitmapAccess & operator= (const ScopedBitmapAccess &)=delete
 
 ~ScopedBitmapAccess () COVERITY_NOEXCEPT_FALSE
 
void reset ()
 
bool operator! () const
 
 operator bool () const
 
Access * get ()
 
const Access * get () const
 
Access * operator-> ()
 
const Access * operator-> () const
 
Access & operator* ()
 
const Access & operator* () const
 

Private Attributes

Access * mpAccess
 
Bitmap * mpBitmap
 

Detailed Description

template<class Access, class Bitmap, Access *(Bitmap::*)() Acquire>
class vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >

This template handles BitmapAccess the RAII way.

Please don't use directly, but through the ready-made typedefs ScopedReadAccess and ScopedWriteAccess in classes Bitmap and AlphaMask.

Use as follows: Bitmap aBitmap; Bitmap::ScopedReadAccess pReadAccess( aBitmap ); pReadAccess->SetPixel()...

Bitmap aBitmap2; BitmapScopedWriteAccess pWriteAccess( bCond ? aBitmap2.AcquireWriteAccess() : 0, aBitmap2 ); if ( pWriteAccess )...

Attention: \n for practical reasons, ScopedBitmapAccess stores a
reference to the provided bitmap, thus, make sure that the bitmap specified at construction time lives at least as long as the ScopedBitmapAccess.

Definition at line 48 of file scopedbitmapaccess.hxx.

Constructor & Destructor Documentation

◆ ScopedBitmapAccess() [1/4]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::ScopedBitmapAccess ( Bitmap &  rBitmap)
inlineexplicit

Definition at line 51 of file scopedbitmapaccess.hxx.

References vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess, and vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpBitmap.

◆ ScopedBitmapAccess() [2/4]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::ScopedBitmapAccess ( Access *  pAccess,
Bitmap &  rBitmap 
)
inline

Definition at line 58 of file scopedbitmapaccess.hxx.

◆ ScopedBitmapAccess() [3/4]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::ScopedBitmapAccess ( )
inline

Definition at line 64 of file scopedbitmapaccess.hxx.

◆ ScopedBitmapAccess() [4/4]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::ScopedBitmapAccess ( const ScopedBitmapAccess< Access, Bitmap, Acquire > &  )
delete

◆ ~ScopedBitmapAccess()

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::~ScopedBitmapAccess ( )
inline

Definition at line 84 of file scopedbitmapaccess.hxx.

References vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess, vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpBitmap, and Bitmap::ReleaseAccess().

Member Function Documentation

◆ get() [1/2]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
Access * vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::get ( )
inline

Definition at line 105 of file scopedbitmapaccess.hxx.

References Access, and vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess.

Referenced by vcl::unotools::bitmapExFromXBitmap(), OutputDevice::BlendBitmapWithAlpha(), vcl::bitmap::CanvasExtractBitmapData(), vcl::bitmap::CanvasTransformBitmap(), BitmapEx::ChangeColorAlpha(), BitmapSymmetryCheck::check(), vcl::bitmap::CreateFromData(), Bitmap::Dither(), OutputDevice::DrawDeviceAlphaBitmapSlowPath(), BitmapScaleSuperFilter::execute(), BitmapGaussianSeparableBlurFilter::execute(), ImplVectorizer::ImplVectorize(), Bitmap::Mirror(), and vcl::PDFWriterImpl::writeBitmapObject().

◆ get() [2/2]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
const Access * vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::get ( ) const
inline

Definition at line 106 of file scopedbitmapaccess.hxx.

References Access, and vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess.

◆ operator bool()

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator bool ( ) const
inlineexplicit

Definition at line 100 of file scopedbitmapaccess.hxx.

References vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess.

◆ operator!()

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
bool vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator! ( ) const
inline

Definition at line 99 of file scopedbitmapaccess.hxx.

References vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess.

◆ operator*() [1/2]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
Access & vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator* ( void  )
inline

Definition at line 111 of file scopedbitmapaccess.hxx.

References Access, and vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess.

◆ operator*() [2/2]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
const Access & vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator* ( void  ) const
inline

Definition at line 112 of file scopedbitmapaccess.hxx.

References Access, and vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess.

◆ operator->() [1/2]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
Access * vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator-> ( )
inline

Definition at line 108 of file scopedbitmapaccess.hxx.

References Access, and vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess.

◆ operator->() [2/2]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
const Access * vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator-> ( ) const
inline

Definition at line 109 of file scopedbitmapaccess.hxx.

References Access, and vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess.

◆ operator=() [1/2]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
ScopedBitmapAccess & vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator= ( const ScopedBitmapAccess< Access, Bitmap, Acquire > &  )
delete

◆ operator=() [2/2]

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
ScopedBitmapAccess & vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator= ( ScopedBitmapAccess< Access, Bitmap, Acquire > &&  other)
inline

Definition at line 71 of file scopedbitmapaccess.hxx.

References vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess, and vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpBitmap.

◆ reset()

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
void vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::reset ( )
inline

Definition at line 90 of file scopedbitmapaccess.hxx.

References vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess, vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpBitmap, and Bitmap::ReleaseAccess().

Referenced by Bitmap::Adjust(), OutputDevice::BlendBitmap(), OutputDevice::BlendBitmapWithAlpha(), Bitmap::CopyPixel(), Bitmap::CopyPixel_AlphaOptimized(), createBlendFrame(), vcl::bitmap::CreateFromData(), Bitmap::CreateMask(), Bitmap::CreateRegion(), Bitmap::Crop(), DetectEdges(), Bitmap::Dither(), vcl::bitmap::DrawAndClipBitmap(), OutputDevice::EmulateDrawTransparent(), BitmapScaleSuperFilter::execute(), BitmapColorQuantizationFilter::execute(), BitmapConvolutionMatrixFilter::execute(), BitmapDuoToneFilter::execute(), BitmapEmbossGreyFilter::execute(), BitmapGaussianSeparableBlurFilter::execute(), BitmapMedianFilter::execute(), BitmapMonochromeFilter::execute(), BitmapPopArtFilter::execute(), BitmapSeparableUnsharpenFilter::execute(), BitmapSepiaFilter::execute(), BitmapSimpleColorQuantizationFilter::execute(), BitmapSobelGreyFilter::execute(), BitmapSolarizeFilter::execute(), BitmapFastScaleFilter::execute(), BitmapInterpolateScaleFilter::execute(), BitmapLightenFilter::execute(), BitmapMaskToAlphaFilter::execute(), Bitmap::Expand(), Bitmap::ImplConvertDown8BPP(), Bitmap::ImplMakeGreyscales(), ImplVectorizer::ImplVectorize(), ImportTiffGraphicImport(), Bitmap::Invert(), Bitmap::Mirror(), vcl::pngWrite(), readWebp(), Bitmap::Replace(), Bitmap::Rotate(), and JPEGWriter::Write().

Member Data Documentation

◆ mpAccess

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
Access* vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpAccess
private

Definition at line 115 of file scopedbitmapaccess.hxx.

Referenced by vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::get(), vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator bool(), vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator!(), vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator*(), vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator->(), vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator=(), vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::reset(), vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::ScopedBitmapAccess(), and vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::~ScopedBitmapAccess().

◆ mpBitmap

template<class Access , class Bitmap , Access *(Bitmap::*)() Acquire>
Bitmap* vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::mpBitmap
private

Definition at line 116 of file scopedbitmapaccess.hxx.

Referenced by vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::operator=(), vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::reset(), vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::ScopedBitmapAccess(), and vcl::ScopedBitmapAccess< Access, Bitmap, Acquire >::~ScopedBitmapAccess().

The documentation for this class was generated from the following file:
Generated on Thu Jan 26 2023 21:36:11 for LibreOffice Module vcl (master) by doxygen 1.9.3