Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefImage

CefBaseRefCounted
   |
   +--CefImage

   in cef_image.h

class CefImage
extends CefBaseRefCounted

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 must be called on the browser process UI thread.


Method Summary
 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|.
 virtual bool AddJPEG( float scale_factor, const void* jpeg_data, size_t jpeg_data_size )= 0
          Create a JPEG image representation for |scale_factor|.
 virtual bool AddPNG( float scale_factor, const void* png_data, size_t png_data_size )= 0
          Add a PNG image representation for |scale_factor|.
 static CefRefPtr< CefImage > CreateImage()
          Create a new CefImage.
 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|.
 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|.
 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|.
 virtual size_t GetHeight()= 0
          Returns the image height in density independent pixel (DIP) units.
 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|.
 virtual size_t GetWidth()= 0
          Returns the image width in density independent pixel (DIP) units.
 virtual bool HasRepresentation( float scale_factor )= 0
          Returns true if this image contains a representation for |scale_factor|.
 virtual bool IsEmpty()= 0
          Returns true if this Image is empty.
 virtual bool IsSame( CefRefPtr< CefImage > that )= 0
          Returns true if this Image and |that| Image share the same underlying storage.
 virtual bool RemoveRepresentation( float scale_factor )= 0
          Removes the representation for |scale_factor|.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

AddBitmap

public 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|. Only 32-bit RGBA/BGRA formats are supported. |pixel_width| and |pixel_height| are the bitmap representation size in pixel coordinates. |pixel_data| is the array of pixel data and should be |pixel_width| x |pixel_height| x 4 bytes in size. |color_type| and |alpha_type| values specify the pixel format.

AddJPEG

public virtual bool AddJPEG( float scale_factor, const void* jpeg_data, size_t jpeg_data_size )= 0;
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

public virtual bool AddPNG( float scale_factor, const void* png_data, size_t png_data_size )= 0;
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

public static CefRefPtr< CefImage > CreateImage();
Create a new CefImage. It will initially be empty. Use the Add*() methods to add representations at different scale factors.

GetAsBitmap

public 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|. Only 32-bit RGBA/BGRA formats are supported. |color_type| and |alpha_type| values specify the desired output pixel format. |pixel_width| and |pixel_height| are the output representation size in pixel coordinates. Returns a CefBinaryValue containing the pixel data on success or NULL on failure.

GetAsJPEG

public 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|. |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

public 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|. If |with_transparency| is true any alpha transparency in the image will be represented in the resulting PNG data. |pixel_width| and |pixel_height| are the output representation size in pixel coordinates. Returns a CefBinaryValue containing the PNG image data on success or NULL on failure.

GetHeight

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

GetRepresentationInfo

public 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|. |actual_scale_factor| is the actual scale factor for the representation. |pixel_width| and |pixel_height| are the representation size in pixel coordinates. Returns true on success.

GetWidth

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

HasRepresentation

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

IsEmpty

public virtual bool IsEmpty()= 0;
Returns true if this Image is empty.

IsSame

public virtual bool IsSame( CefRefPtr< CefImage > that )= 0;
Returns true if this Image and |that| Image share the same underlying storage. Will also return true if both images are empty.

RemoveRepresentation

public virtual bool RemoveRepresentation( float scale_factor )= 0;
Removes the representation for |scale_factor|. Returns true on success.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt