Inheritance diagram for Osp::Ui::Controls::OverlayPanel:

Deprecated:: This class is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Remarks:: The OverlayPanel control can only be attached to a Form control by using Osp::Ui::Container::AddControl method, because of its native characteristics. Since OverlayPanel inherits a Panel control, it can be used as a container if needed.

The OverlayPanel class is an implementation of the OverlayPanel control. The OverlayPanel is a special type of panel which is used to specify a region where the developer can playback video or camera preview. It is called an overlay because it is possible to overlay other graphics and controls on top of the panel. The OverlayPanel consists of two layers, the foreground panel and background buffer which supports H/W accelerated rendering. Due to the hardware accelerated nature, there is a limitation with an OverlayPanel. The Form that houses an OverlayPanel can only have a black, opaque background. The overlay panel can manipulate the rotation, the aspect ratio and the size of input buffer.

Example: Please refer to the camera preview example of Osp::Media::Camera

List of all members.

Public Types
enum	BufferPixelFormat { BUFFER_PIXEL_FORMAT_ARGB8888, BUFFER_PIXEL_FORMAT_RGB565, BUFFER_PIXEL_FORMAT_YCbCr420_PLANAR }
enum	Rotation { ROTATION_NONE, ROTATION_90, ROTATION_180, ROTATION_270, ROTATION_NONE_LR, ROTATION_NONE_UD, ROTATION_90_LR, ROTATION_90_UD, ROTATION_180_LR, ROTATION_180_UD, ROTATION_270_LR, ROTATION_270_UD }
Public Member Functions
result	Construct (const Osp::Graphics::Rectangle &rect)
result	GetBackgroundBufferInfo (Osp::Graphics::BufferInfo &info) const
Osp::Graphics::Color	GetMaskingColor (void) const
	OverlayPanel (void)
result	SetInputBuffer (const Osp::Graphics::Dimension &destDim, const Osp::Base::ByteBuffer &srcBuffer, const Osp::Graphics::Dimension &srcDim, BufferPixelFormat srcFormat)
void	SetRendererAspectRatio (bool fix)
void	SetRendererRotation (OverlayPanel::Rotation rotation)
void	SetRendererSize (Osp::Graphics::Dimension &dim)
virtual	~OverlayPanel (void)

Member Enumeration Documentation

enum Osp::Ui::Controls::OverlayPanel::BufferPixelFormat

Defines the pixel formats.

Deprecated:: This enumerator is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Enumerator:

BUFFER_PIXEL_FORMAT_ARGB8888	The ARGB8888 pixel format
BUFFER_PIXEL_FORMAT_RGB565	The RGB565 pixel format
BUFFER_PIXEL_FORMAT_YCbCr420_PLANAR	The 8 bit Y plane followed by 8 bit 2 X 2 subsampled U and V planes

enum Osp::Ui::Controls::OverlayPanel::Rotation

Defines the various rotation options.

Deprecated:: This enumerator is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Enumerator:

ROTATION_NONE	No rotation
ROTATION_90	The 90 degree rotation
ROTATION_180	The 180 degree rotation
ROTATION_270	The 270 degree rotation
ROTATION_NONE_LR	The horizontal mirroring
ROTATION_NONE_UD	The vertical mirroring
ROTATION_90_LR	The 90 degree rotation with horizontal mirroring
ROTATION_90_UD	The 90 degree rotation with vertical mirroring
ROTATION_180_LR	The 180 degree rotation with horizontal mirroring
ROTATION_180_UD	The 180 degree rotation with vertical mirroring
ROTATION_270_LR	The 270 degree rotation with horizontal mirroring
ROTATION_270_UD	The 270 degree rotation with vertical mirroring

Constructor & Destructor Documentation

Osp::Ui::Controls::OverlayPanel::OverlayPanel ( void )

This is the default constructor for this class.

Deprecated:: This method is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

virtual Osp::Ui::Controls::OverlayPanel::~OverlayPanel ( void ) [virtual]

This is the destructor for this class.

Deprecated:: This method is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Member Function Documentation

result Osp::Ui::Controls::OverlayPanel::Construct ( const Osp::Graphics::Rectangle & rect )

Initializes this instance of OverlayPanel at the specified rectangle.

Deprecated:: This method is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Compatibility:: This method has compatibility issues with bada API versions prior to 2.0.
For more information, see here.

Returns:: An error code

Parameters:

[in] rect The location and size of the OverlayPanel control
The maximum size is 480 x 800 on a WVGA screen, or 240 x 400 on a WQVGA screen.
The minimum size of this control is 32 x 32 on a WVGA screen.

Exceptions:

E_SUCCESS	The method is successful.
E_INVALID_STATE	This instance has already been constructed.
E_INVALID_ARG	A specified input parameter is invalid.
E_OUT_OF_MEMORY	The memory is insufficient.
E_SYSTEM	A system error has occurred.

Remarks:: In the bada API versions prior to 2.0, the width and the height of the control must be greater than 0.
From bada API version 2.0, the size of the control must be within the range defined by the minimum size and the maximum size.; Do not use OverlayPanel in combination with OverlayRegion. If used, OverlayPanel may not work as expected.

See also:: Osp::Ui::Container

result Osp::Ui::Controls::OverlayPanel::GetBackgroundBufferInfo ( Osp::Graphics::BufferInfo & info ) const

Gets the information of the background buffer.

Deprecated:: This method is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Compatibility:: This method has compatibility issues with bada API versions prior to 2.0
For more information, see here.

Returns:: An error code

Parameters:

[out] info The information of the background buffer

Exceptions:

E_SUCCESS	The method is successful.
E_OPERATION_FAILED	The operation has failed.
E_INVALID_STATE	This instance has not been constructed as yet.

Remarks:: Currently, this function provides buffer information except the pointer of the RGB color buffer.
Therefore, info.pPixels is always assigned null.

Osp::Graphics::Color Osp::Ui::Controls::OverlayPanel::GetMaskingColor ( void ) const

Gets the masking color of this control.

Deprecated:: This method is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Returns:: The pixel color format

result Osp::Ui::Controls::OverlayPanel::SetInputBuffer	(	const Osp::Graphics::Dimension &	destDim,
		const Osp::Base::ByteBuffer &	srcBuffer,
		const Osp::Graphics::Dimension &	srcDim,
		BufferPixelFormat	srcFormat
	)

Sets the input buffer.

Deprecated:: This method is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Compatibility:: This method has compatibility issues with bada API versions prior to 1.2.
For more information, see here.

Compatibility:: This method has compatibility issues with bada API versions prior to 2.0
For more information, see here.

Parameters:

[in]	destDim	The dimension of the window to be drawn
[in]	srcBuffer	The source buffer
[in]	srcDim	The source dimension
[in]	srcFormat	The pixel format of buffer data

Exceptions:

E_SUCCESS	The method is successful.
E_INVALID_ARG	A specified input parameter is invalid.
E_SYSTEM	A system error has occurred.
E_UNSUPPORTED_FORMAT	The specified pixel format is not supported.
E_INVALID_STATE	This instance has not been constructed as yet.

Remarks:: BUFFER_PIXEL_FORMAT_ARGB8888, and BUFFER_PIXEL_FORMAT_RGB565 are not supported.
Form::Draw() and Form::Show() methods should be called to properly display the input buffer.

void Osp::Ui::Controls::OverlayPanel::SetRendererAspectRatio ( bool fix )

Sets the aspect ratio of the renderer.

Deprecated:: This method is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Compatibility:: This method has compatibility issues with bada API versions prior to 2.0
For more information, see here.

Parameters:

[in] fix Set to true if the renderer will display the aspect ratio of the input buffer even if the renderer and input data have different aspect ratios,
else false

void Osp::Ui::Controls::OverlayPanel::SetRendererRotation ( OverlayPanel::Rotation rotation )

Sets the rotation of the input buffer.
All the rotations are clock-wise.

Deprecated:: This method is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Compatibility:: This method has compatibility issues with bada API versions prior to 2.0
For more information, see here.

Parameters:

[in] rotation The rotation

void Osp::Ui::Controls::OverlayPanel::SetRendererSize ( Osp::Graphics::Dimension & dim )

Changes the size of the displayed renderer.

Deprecated:: This method is deprecated. Instead of using this class, use the OverlayRegion class, that supports video playback and camera preview.

Since:: 1.0

Compatibility:: This method has compatibility issues with bada API versions prior to 2.0
For more information, see here.

Parameters:

[in] dim The dimension of the window to draw

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

FUiCtrlOverlayPanel.h

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation