BitmapSurface

#include <Ultralight/platform/Surface.h>

Overview

The default surface implementation, backed by a bitmap.

This is automatically provided by the library when you call Renderer::Create() without defining a custom SurfaceFactory.

This implementation uses a Bitmap to store pixel data (retrieve it via BitmapSurface::bitmap()).

Inheritance diagram for BitmapSurface:

Public Member Functions
virtual uint32_t	width () const override
	Width (in pixels).
virtual uint32_t	height () const override
	Height (in pixels).
virtual uint32_t	row_bytes () const override
	Number of bytes between rows (usually width * 4)
virtual size_t	size () const override
	Size in bytes.
virtual void *	LockPixels () override
	Lock the pixel buffer and get a pointer to the beginning of the data for reading/writing.
virtual void	UnlockPixels () override
	Unlock the pixel buffer.
virtual void	Resize (uint32_t width, uint32_t height) override
	Resize the pixel buffer to a certain width and height (both in pixels).
RefPtr< Bitmap >	bitmap ()
	Get the underlying Bitmap.
Public Member Functions inherited from Surface
virtual	~Surface ()
virtual void	set_dirty_bounds (const IntRect &bounds)
	Set the dirty bounds to a certain value.
virtual IntRect	dirty_bounds () const
	Get the dirty bounds.
virtual void	ClearDirtyBounds ()
	Clear the dirty bounds.

Protected Member Functions
	BitmapSurface (uint32_t width, uint32_t height)
virtual	~BitmapSurface ()
	BitmapSurface (const BitmapSurface &)=delete
void	operator= (const BitmapSurface &)=delete
Protected Member Functions inherited from Surface
	Surface ()

Protected Attributes
void *	impl_
Protected Attributes inherited from Surface
IntRect	dirty_bounds_

Friends
class	BitmapSurfaceFactory

Constructor & Destructor Documentation

BitmapSurface() [1/2]

BitmapSurface ( uint32_t width, uint32_t height )

protected

~BitmapSurface()

virtual ~BitmapSurface ( )

protectedvirtual

BitmapSurface() [2/2]

BitmapSurface ( const BitmapSurface & )

protecteddelete

Member Function Documentation

bitmap()

RefPtr< Bitmap > bitmap

(

)

Get the underlying Bitmap.

height()

virtual uint32_t height ( ) const

overridevirtual

Height (in pixels).

Implements Surface.

LockPixels()

virtual void * LockPixels ( )

overridevirtual

Lock the pixel buffer and get a pointer to the beginning of the data for reading/writing.

Note

Native pixel format is premultiplied BGRA 32-bit (8 bits per channel).

Implements Surface.

operator=()

void operator= ( const BitmapSurface & )

protecteddelete

Resize()

virtual void Resize ( uint32_t width, uint32_t height )

overridevirtual

Resize the pixel buffer to a certain width and height (both in pixels).

This should never be called while pixels are locked.

Implements Surface.

row_bytes()

virtual uint32_t row_bytes ( ) const

overridevirtual

Number of bytes between rows (usually width * 4)

Implements Surface.

size()

virtual size_t size ( ) const

overridevirtual

Size in bytes.

Implements Surface.

UnlockPixels()

virtual void UnlockPixels ( )

overridevirtual

Unlock the pixel buffer.

Implements Surface.

width()

virtual uint32_t width ( ) const

overridevirtual

Width (in pixels).

Implements Surface.

Friends And Related Symbol Documentation

BitmapSurfaceFactory

friend class BitmapSurfaceFactory

friend

Member Data Documentation

impl_

void* impl_

protected

---

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

• Ultralight/platform/Surface.h