Container for a single image represented at different scale factors. More...

#include "include/cef_image.h"

Inheritance diagram for CefImage:

Public Member Functions
virtual bool	IsEmpty ()=0
	Returns true if this Image is empty. More...

virtual bool	IsSame (CefRefPtr< CefImage > that)=0
	Returns true if this Image and \|that\| Image share the same underlying storage. More...

virtual bool	AddBitmap (float scale_factor, int pixel_width, int pixel_height, cef_color_type_t color_type, cef_alpha_type_t alpha_type, const void *pixel_data, size_t pixel_data_size)=0
	Add a bitmap image representation for \|scale_factor\|. More...

virtual bool	AddPNG (float scale_factor, const void *png_data, size_t png_data_size)=0
	Add a PNG image representation for \|scale_factor\|. More...

virtual bool	AddJPEG (float scale_factor, const void *jpeg_data, size_t jpeg_data_size)=0
	Create a JPEG image representation for \|scale_factor\|. More...

virtual size_t	GetWidth ()=0
	Returns the image width in density independent pixel (DIP) units. More...

virtual size_t	GetHeight ()=0
	Returns the image height in density independent pixel (DIP) units. More...

virtual bool	HasRepresentation (float scale_factor)=0
	Returns true if this image contains a representation for \|scale_factor\|. More...

virtual bool	RemoveRepresentation (float scale_factor)=0
	Removes the representation for \|scale_factor\|. More...

virtual bool	GetRepresentationInfo (float scale_factor, float &actual_scale_factor, int &pixel_width, int &pixel_height)=0
	Returns information for the representation that most closely matches \|scale_factor\|. More...

virtual CefRefPtr< CefBinaryValue >	GetAsBitmap (float scale_factor, cef_color_type_t color_type, cef_alpha_type_t alpha_type, int &pixel_width, int &pixel_height)=0
	Returns the bitmap representation that most closely matches \|scale_factor\|. More...

virtual CefRefPtr< CefBinaryValue >	GetAsPNG (float scale_factor, bool with_transparency, int &pixel_width, int &pixel_height)=0
	Returns the PNG representation that most closely matches \|scale_factor\|. More...

virtual CefRefPtr< CefBinaryValue >	GetAsJPEG (float scale_factor, int quality, int &pixel_width, int &pixel_height)=0
	Returns the JPEG representation that most closely matches \|scale_factor\|. More...

Public Member Functions inherited from CefBaseRefCounted
virtual void	AddRef () const =0
	Called to increment the reference count for the object. More...

virtual bool	Release () const =0
	Called to decrement the reference count for the object. More...

virtual bool	HasOneRef () const =0
	Returns true if the reference count is 1. More...

virtual bool	HasAtLeastOneRef () const =0
	Returns true if the reference count is at least 1. More...

Static Public Member Functions
static CefRefPtr< CefImage >	CreateImage ()
	Create a new CefImage. More...

Additional Inherited Members
Protected Member Functions inherited from CefBaseRefCounted
virtual	~CefBaseRefCounted ()

Detailed Description

Container for a single image represented at different scale factors.

All image representations should be the same size in density independent pixel (DIP) units. For example, if the image at scale factor 1.0 is 100x100 pixels then the image at scale factor 2.0 should be 200x200 pixels – both images will display with a DIP size of 100x100 units. The methods of this class can be called on any browser process thread.

Member Function Documentation

◆ AddBitmap()

virtual bool CefImage::AddBitmap	(	float	scale_factor,
		int	pixel_width,
		int	pixel_height,
		cef_color_type_t	color_type,
		cef_alpha_type_t	alpha_type,
		const void *	pixel_data,
		size_t	pixel_data_size
	)

pure virtual

Add a bitmap image representation for |scale_factor|.

◆ AddJPEG()

virtual bool CefImage::AddJPEG	(	float	scale_factor,
		const void *	jpeg_data,
		size_t	jpeg_data_size
	)

pure virtual

Create a JPEG image representation for |scale_factor|.

|jpeg_data| is the image data of size |jpeg_data_size|. The JPEG format does not support transparency so the alpha byte will be set to 0xFF for all pixels.

◆ AddPNG()

virtual bool CefImage::AddPNG	(	float	scale_factor,
		const void *	png_data,
		size_t	png_data_size
	)

pure virtual

Add a PNG image representation for |scale_factor|.

|png_data| is the image data of size |png_data_size|. Any alpha transparency in the PNG data will be maintained.

◆ CreateImage()

static CefRefPtr<CefImage> CefImage::CreateImage ( )

static

Create a new CefImage.

It will initially be empty. Use the Add*() methods to add representations at different scale factors.

◆ GetAsBitmap()

virtual CefRefPtr<CefBinaryValue> CefImage::GetAsBitmap	(	float	scale_factor,
		cef_color_type_t	color_type,
		cef_alpha_type_t	alpha_type,
		int &	pixel_width,
		int &	pixel_height
	)

pure virtual

Returns the bitmap representation that most closely matches |scale_factor|.

◆ GetAsJPEG()

virtual CefRefPtr<CefBinaryValue> CefImage::GetAsJPEG	(	float	scale_factor,
		int	quality,
		int &	pixel_width,
		int &	pixel_height
	)

pure virtual

Returns the JPEG representation that most closely matches |scale_factor|.

|quality| determines the compression level with 0 == lowest and 100 == highest. The JPEG format does not support alpha transparency and the alpha channel, if any, will be discarded. |pixel_width| and |pixel_height| are the output representation size in pixel coordinates. Returns a CefBinaryValue containing the JPEG image data on success or NULL on failure.

◆ GetAsPNG()

virtual CefRefPtr<CefBinaryValue> CefImage::GetAsPNG	(	float	scale_factor,
		bool	with_transparency,
		int &	pixel_width,
		int &	pixel_height
	)

pure virtual

Returns the PNG representation that most closely matches |scale_factor|.

◆ GetHeight()

virtual size_t CefImage::GetHeight ( )

pure virtual

Returns the image height in density independent pixel (DIP) units.

◆ GetRepresentationInfo()

virtual bool CefImage::GetRepresentationInfo	(	float	scale_factor,
		float &	actual_scale_factor,
		int &	pixel_width,
		int &	pixel_height
	)

pure virtual

Returns information for the representation that most closely matches |scale_factor|.

◆ GetWidth()

virtual size_t CefImage::GetWidth ( )

pure virtual

Returns the image width in density independent pixel (DIP) units.

◆ HasRepresentation()

virtual bool CefImage::HasRepresentation ( float scale_factor )

pure virtual

Returns true if this image contains a representation for |scale_factor|.

◆ IsEmpty()

virtual bool CefImage::IsEmpty ( )

pure virtual

Returns true if this Image is empty.

◆ IsSame()

virtual bool CefImage::IsSame ( CefRefPtr< CefImage > that )

pure virtual

Returns true if this Image and |that| Image share the same underlying storage.

Will also return true if both images are empty.

◆ RemoveRepresentation()

virtual bool CefImage::RemoveRepresentation ( float scale_factor )

pure virtual

Removes the representation for |scale_factor|.

Returns true on success.

The documentation for this class was generated from the following file:

include/cef_image.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddBitmap()

◆ AddJPEG()

◆ AddPNG()

◆ CreateImage()

◆ GetAsBitmap()

◆ GetAsJPEG()

◆ GetAsPNG()

◆ GetHeight()

◆ GetRepresentationInfo()

◆ GetWidth()

◆ HasRepresentation()

◆ IsEmpty()

◆ IsSame()

◆ RemoveRepresentation()