CefImage Class

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.

Inheritance Hierarchy

SystemObject
Internal.Xilium.CefGlueCefImage

Namespace: Internal.Xilium.CefGlue
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2024.1.1.0 (2024.1.1.0)

Syntax

Copy

public sealed class CefImage : IDisposable

The CefImage type exposes the following members.

Properties

	Name	Description
	Height	Returns the image height in density independent pixel (DIP) units.
	IsEmpty	Returns true if this Image is empty.
	Width	Returns the image width in density independent pixel (DIP) units.

Top

Methods

	Name	Description
	AddBitmap	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	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	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	Create a new CefImage. It will initially be empty. Use the Add*() methods to add representations at different scale factors.
	Dispose	Releases all resources used by the CefImage
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	(Overrides ObjectFinalize.)
	GetAsBitmap	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	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	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.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetRepresentationInfo	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.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasRepresentation	Returns true if this image contains a representation for \|scale_factor\|.
	IsSame	Returns true if this Image and \|that\| Image share the same underlying storage. Will also return true if both images are empty.
	RemoveRepresentation	Removes the representation for \|scale_factor\|. Returns true on success.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	MethodInvoke	Calls the object method by name. (Defined by ObjectEx.)
	PropertyGet(String, Object, Boolean)	Overloaded. Gets the value of the object property by name. (Defined by ObjectEx.)
	PropertyGetT(String, Object, Boolean)	Overloaded. Gets the value of the object property by name. (Defined by ObjectEx.)
	PropertySet	Sets the value of the object property by name. (Defined by ObjectEx.)

Top

Reference

Internal.Xilium.CefGlue Namespace