Dali 3D User Interface Engine
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
Dali::Integration Namespace Reference

Namespaces

namespace  anonymous_namespace{touch-event-combiner.cpp}
 
namespace  KeepUpdating
 The reasons why further updates are required.
 
namespace  Log
 
namespace  Profiling
 
namespace  TouchEventCombiner
 

Classes

class  Bitmap
 Bitmap class. More...
 
class  ContextNotifierInterface
 Interface to inform dali core of context loss and regain. More...
 
class  UpdateStatus
 The status of the Core::Update operation. More...
 
class  RenderStatus
 The status of the Core::Render operation. More...
 
class  Core
 Integration::Core is used for integration with the native windowing system. More...
 
struct  TouchData
 TouchData structure represents the raw touch information from touch-screen for a single touch event e.g. More...
 
class  GestureManager
 GestureManager is an abstract interface, used by Dali to register and unregister gestures provided by the adaptor. More...
 
class  GlAbstraction
 GlAbstraction is an abstract interface, used to access OpenGL services. More...
 
class  GlSyncAbstraction
 This abstraction defines an API for syncing CPU with GPU. More...
 
class  BufferSize
 Used to avoid accidentally mixing the order of parameters where some are uint dimensions and one is a buffer size. More...
 
class  ImageData
 A simple container for image data. More...
 
class  LocklessBuffer
 The LocklessBuffer class implements double buffering eligible for multi-(two) threaded use, where it's possible to read from one thread and write from another without requiring a mutex lock to avoid performance hit. More...
 
class  PlatformAbstraction
 PlatformAbstraction is an abstract interface, used by Dali to access platform specific services. More...
 
class  RenderController
 Abstract interface for an object which controls rendering. More...
 
class  ResourceCache
 Abstract interface to receive notifications of resource IO operations. More...
 
class  ResourceRequest
 Used to request a resource from the native filesystem. More...
 
struct  ResourceType
 The abstract base class for resource types. More...
 
struct  BitmapResourceType
 BitmapResourceType describes a bitmap resource, which can be requested from ResourceLoader::LoadResource() or AllocateBitmapImage. More...
 
struct  NativeImageResourceType
 NativeImageResourceType describes a native image resource, which can be injected through ResourceManager::AddNativeImage() or requested through ResourceLoader::LoadResource(). More...
 
struct  RenderTargetResourceType
 RenderTargetResourceType describes a bitmap resource, which can injected through ResourceManager::AddTargetImage() More...
 
class  SystemOverlay
 Use this interface to draw content for system-level indicators, dialogs etc. More...
 

Typedefs

typedef IntrusivePtr< BitmapBitmapPtr
 
typedef unsigned char PixelBuffer
 Pixel data buffers are composed of these. More...
 
typedef std::vector< TouchDataTouchDataContainer
 
typedef
TouchDataContainer::iterator 
TouchDataIter
 
typedef IntrusivePtr< ImageDataImageDataPtr
 
typedef IntrusivePtr
< Dali::RefObject
ResourcePointer
 Used to return loaded resources for rendering etc. More...
 
typedef unsigned int ResourceId
 Used to identify a resource loading operation. More...
 

Enumerations

enum  ProfilingType { PROFILING_TYPE_PAN_GESTURE, PROFILING_TYPE_END }
 
enum  ResourceFailure { FailureUnknown, FailureFileNotFound, FailureInvalidPath }
 Used to determine why a resource IO operation has failed. More...
 
enum  LoadStatus { RESOURCE_LOADING, RESOURCE_PARTIALLY_LOADED, RESOURCE_COMPLETELY_LOADED }
 Used to inform the current loading status. More...
 
enum  LoadResourcePriority {
  LoadPriorityLowest, LoadPriorityLow, LoadPriorityNormal, LoadPriorityHigh,
  LoadPriorityHighest
}
 Used to prioritize between loading operations. More...
 
enum  ResourceTypeId { ResourceBitmap, ResourceNativeImage, ResourceTargetImage }
 Extendable set of resource types. More...
 

Functions

void ConvertToGlFormat (Pixel::Format pixelformat, unsigned &pixelDataType, unsigned &internalFormat)
 Returns GL data type and internal format for specified pixel format. More...
 
ImageDataPtr NewBitmapImageData (unsigned imageWidth, unsigned imageHeight, Pixel::Format pixelFormat)
 A convenience function for creating the common case of an uncompressed image having width * height pixels in the buffer. More...
 
void SetPanGesturePredictionMode (int mode)
 Called by adaptor to set the pan gesture prediction mode from an environment variable. More...
 
void SetPanGesturePredictionAmount (unsigned int amount)
 Called by adaptor to set the prediction amount of the pan gesture from an environment variable. More...
 
void SetPanGestureMaximumPredictionAmount (unsigned int amount)
 Sets the upper bound of the prediction amount for clamping from an environment variable. More...
 
void SetPanGestureMinimumPredictionAmount (unsigned int amount)
 Sets the lower bound of the prediction amount for clamping from an environment variable. More...
 
void SetPanGesturePredictionAmountAdjustment (unsigned int amount)
 Sets the prediction amount to adjust when the pan velocity is changed from an environment variable. More...
 
void SetPanGestureSmoothingMode (int mode)
 Called to set how pan gestures smooth input. More...
 
void SetPanGestureSmoothingAmount (float amount)
 Sets the smoothing amount of the pan gesture. More...
 
void EnableProfiling (ProfilingType type)
 Called by adaptor to provide profiling information. More...
 

Variables

const ResourceId InvalidResourceId = (ResourceId)-1
 

Typedef Documentation

Definition at line 44 of file bitmap.h.

Definition at line 36 of file image-data.h.

Pixel data buffers are composed of these.

Definition at line 46 of file bitmap.h.

typedef unsigned int Dali::Integration::ResourceId

Used to identify a resource loading operation.

These unique ResourceId values can be used to identify a resource loading transaction in core-adaptor communication. A resource transaction is asynchronous and many can be in-flight concurrently. A ResourceId allows the core to track a resource transaction over its lifetime and match an asynchronous completion notification to the corresponding load request or to cancel the operation early.

A resource transaction begins with a call to PlatformAbstraction::LoadResource() Later asynchronous status notifications obtained by polling PlatformAbstraction::GetResources() can be mapped to corresponding LoadResource() invocations using the ResourceId value. It is the core's responsibility to ensure that each invocation of PlatformAbstraction::LoadResource() passes in a Request object with a unique integer ResourceId.

See Also
Dali::Integration::PlatformAbstraction::LoadResource Dali::Integration::PlatformAbstraction::GetResources Dali::Integration::ResourceCache Dali::Internal::ImageFactoryCache::RequestId

Definition at line 51 of file resource-declarations.h.

Used to return loaded resources for rendering etc.

Definition at line 43 of file resource-cache.h.

Definition at line 28 of file touch-data.h.

typedef TouchDataContainer::iterator Dali::Integration::TouchDataIter

Definition at line 31 of file touch-data.h.

Enumeration Type Documentation

Used to prioritize between loading operations.

Enumerator
LoadPriorityLowest 
LoadPriorityLow 
LoadPriorityNormal 
LoadPriorityHigh 
LoadPriorityHighest 

Definition at line 43 of file resource-request.h.

Used to inform the current loading status.

Enumerator
RESOURCE_LOADING 

There are missing resources, being loaded.

RESOURCE_PARTIALLY_LOADED 

Enough resource has been loaded to start low quality rendering.

RESOURCE_COMPLETELY_LOADED 

The resource has been completely loaded.

Definition at line 57 of file resource-declarations.h.

Enumerator
PROFILING_TYPE_PAN_GESTURE 
PROFILING_TYPE_END 

Definition at line 32 of file profiling.h.

Used to determine why a resource IO operation has failed.

Enumerator
FailureUnknown 
FailureFileNotFound 
FailureInvalidPath 

Definition at line 33 of file resource-cache.h.

Extendable set of resource types.

Enumerator
ResourceBitmap 
ResourceNativeImage 
ResourceTargetImage 

Definition at line 46 of file resource-types.h.

Function Documentation

DALI_IMPORT_API void Dali::Integration::ConvertToGlFormat ( Pixel::Format  pixelformat,
unsigned &  pixelDataType,
unsigned &  internalFormat 
)

Returns GL data type and internal format for specified pixel format.

Parameters
[in]pixelformatpixel format (eg. Pixel::RGBA32)
[out]pixelDataTypepixel data type (eg. GL_UNSIGNED_BYTE)
[out]internalFormatpixel internal format (eg. GL_RGBA)

! < Hardcoded so we can test before we move to GLES 3.0 or greater.

! < Hardcoded so we can test before we move to GLES 3.0 or greater.

Definition at line 37 of file bitmap.cpp.

References Dali::Pixel::A8, Dali::Pixel::BGR565, Dali::Pixel::BGR8888, Dali::Pixel::BGRA4444, Dali::Pixel::BGRA5551, Dali::Pixel::BGRA8888, Dali::Pixel::COMPRESSED_R11_EAC, Dali::Pixel::COMPRESSED_RG11_EAC, Dali::Pixel::COMPRESSED_RGB8_ETC1, Dali::Pixel::COMPRESSED_RGB8_ETC2, Dali::Pixel::COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2, Dali::Pixel::COMPRESSED_RGB_PVRTC_4BPPV1, Dali::Pixel::COMPRESSED_RGBA8_ETC2_EAC, Dali::Pixel::COMPRESSED_RGBA_ASTC_10x10_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_10x5_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_10x6_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_10x8_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_12x10_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_12x12_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_4x4_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_5x4_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_5x5_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_6x5_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_6x6_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_8x5_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_8x6_KHR, Dali::Pixel::COMPRESSED_RGBA_ASTC_8x8_KHR, Dali::Pixel::COMPRESSED_SIGNED_R11_EAC, Dali::Pixel::COMPRESSED_SIGNED_RG11_EAC, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_10x10_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_10x5_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_10x6_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_10x8_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_12x10_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_12x12_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_4x4_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_5x4_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_5x5_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_6x5_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_6x6_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_8x5_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_8x6_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ASTC_8x8_KHR, Dali::Pixel::COMPRESSED_SRGB8_ALPHA8_ETC2_EAC, Dali::Pixel::COMPRESSED_SRGB8_ETC2, Dali::Pixel::COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2, DALI_LOG_ERROR, DALI_LOG_INFO, GL_ALPHA, GL_BGRA_EXT, GL_COMPRESSED_R11_EAC, GL_COMPRESSED_RG11_EAC, GL_COMPRESSED_RGB8_ETC2, GL_COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2, GL_COMPRESSED_RGBA8_ETC2_EAC, GL_COMPRESSED_RGBA_ASTC_10x10_KHR, GL_COMPRESSED_RGBA_ASTC_10x5_KHR, GL_COMPRESSED_RGBA_ASTC_10x6_KHR, GL_COMPRESSED_RGBA_ASTC_10x8_KHR, GL_COMPRESSED_RGBA_ASTC_12x10_KHR, GL_COMPRESSED_RGBA_ASTC_12x12_KHR, GL_COMPRESSED_RGBA_ASTC_4x4_KHR, GL_COMPRESSED_RGBA_ASTC_5x4_KHR, GL_COMPRESSED_RGBA_ASTC_5x5_KHR, GL_COMPRESSED_RGBA_ASTC_6x5_KHR, GL_COMPRESSED_RGBA_ASTC_6x6_KHR, GL_COMPRESSED_RGBA_ASTC_8x5_KHR, GL_COMPRESSED_RGBA_ASTC_8x6_KHR, GL_COMPRESSED_RGBA_ASTC_8x8_KHR, GL_COMPRESSED_SIGNED_R11_EAC, GL_COMPRESSED_SIGNED_RG11_EAC, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_10x10_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_10x5_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_10x6_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_10x8_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_12x10_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_12x12_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_4x4_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_5x4_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_5x5_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_6x5_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_6x6_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_8x5_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_8x6_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ASTC_8x8_KHR, GL_COMPRESSED_SRGB8_ALPHA8_ETC2_EAC, GL_COMPRESSED_SRGB8_ETC2, GL_COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2, GL_LUMINANCE, GL_LUMINANCE_ALPHA, GL_RGB, GL_RGBA, GL_UNSIGNED_BYTE, GL_UNSIGNED_SHORT_4_4_4_4, GL_UNSIGNED_SHORT_5_5_5_1, GL_UNSIGNED_SHORT_5_6_5, Dali::Pixel::INVALID, Dali::Pixel::L8, Dali::Pixel::LA88, Dali::Pixel::RGB565, Dali::Pixel::RGB888, Dali::Pixel::RGB8888, Dali::Pixel::RGBA4444, Dali::Pixel::RGBA5551, and Dali::Pixel::RGBA8888.

Referenced by Dali::Internal::BitmapTexture::AreaUpdated(), Dali::Internal::CompressedBitmapTexture::AssignBitmap(), Dali::Internal::BitmapTexture::AssignBitmap(), Dali::Internal::FrameBufferTexture::CreateGlTexture(), Dali::Internal::Adaptor::NativeBitmapBuffer::PrepareTexture(), and Dali::Internal::BitmapTexture::Update().

Here is the caller graph for this function:

DALI_IMPORT_API void Dali::Integration::EnableProfiling ( ProfilingType  type)

Called by adaptor to provide profiling information.

Precondition
Should be called after Core creation.
Parameters
typeThe type of profiling information to output.

Definition at line 73 of file profiling.cpp.

References Dali::Internal::GestureEventProcessor::EnablePanGestureProfiling(), Dali::PropertyTypes::Get(), PROFILING_TYPE_END, and PROFILING_TYPE_PAN_GESTURE.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

DALI_IMPORT_API ImageDataPtr Dali::Integration::NewBitmapImageData ( unsigned  imageWidth,
unsigned  imageHeight,
Pixel::Format  pixelFormat 
)

A convenience function for creating the common case of an uncompressed image having width * height pixels in the buffer.

Parameters
[in]imageWidthThe width in pixels of the image.
[in]imageHeightThe height in pixels of the image.
[in]pixelFormatThe format of the image data in the buffer.

Definition at line 72 of file image-data.cpp.

References Dali::Pixel::BGRA8888, DALI_ASSERT_DEBUG, Dali::Pixel::GetBytesPerPixel(), and Dali::Integration::ImageData::New().

Here is the call graph for this function:

DALI_IMPORT_API void Dali::Integration::SetPanGestureMaximumPredictionAmount ( unsigned int  amount)

Sets the upper bound of the prediction amount for clamping from an environment variable.

Parameters
[in]amountThe prediction amount in milliseconds

Definition at line 27 of file input-options.cpp.

References Dali::PropertyTypes::Get(), and Dali::Internal::GestureEventProcessor::SetPanGestureMaximumPredictionAmount().

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

DALI_IMPORT_API void Dali::Integration::SetPanGestureMinimumPredictionAmount ( unsigned int  amount)

Sets the lower bound of the prediction amount for clamping from an environment variable.

Parameters
[in]amountThe prediction amount in milliseconds

Definition at line 33 of file input-options.cpp.

References Dali::PropertyTypes::Get(), and Dali::Internal::GestureEventProcessor::SetPanGestureMinimumPredictionAmount().

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

DALI_IMPORT_API void Dali::Integration::SetPanGesturePredictionAmount ( unsigned int  amount)

Called by adaptor to set the prediction amount of the pan gesture from an environment variable.

Parameters
[in]amountThe prediction amount in milliseconds

Definition at line 21 of file input-options.cpp.

References Dali::PropertyTypes::Get(), and Dali::Internal::GestureEventProcessor::SetPanGesturePredictionAmount().

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

DALI_IMPORT_API void Dali::Integration::SetPanGesturePredictionAmountAdjustment ( unsigned int  amount)

Sets the prediction amount to adjust when the pan velocity is changed from an environment variable.

If the pan velocity is accelerating, the prediction amount will be increased by the specified amount until it reaches the upper bound. If the pan velocity is decelerating, the prediction amount will be decreased by the specified amount until it reaches the lower bound.

Parameters
[in]amountThe prediction amount in milliseconds

Definition at line 39 of file input-options.cpp.

References Dali::PropertyTypes::Get(), and Dali::Internal::GestureEventProcessor::SetPanGesturePredictionAmountAdjustment().

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

DALI_IMPORT_API void Dali::Integration::SetPanGesturePredictionMode ( int  mode)

Called by adaptor to set the pan gesture prediction mode from an environment variable.

Precondition
Should be called after Core creation.
Parameters
modeThe pan gesture prediction mode.

Definition at line 15 of file input-options.cpp.

References Dali::PropertyTypes::Get(), and Dali::Internal::GestureEventProcessor::SetPanGesturePredictionMode().

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize(), UtcDaliPanGestureNoPredictionNoSmoothing(), UtcDaliPanGestureNoPredictionSmoothing(), UtcDaliPanGesturePredictionNoSmoothing(), UtcDaliPanGesturePredictionSmoothing(), UtcDaliPanGestureSetProperties(), and UtcDaliPanGestureSetPropertiesAlreadyPanning().

Here is the call graph for this function:

Here is the caller graph for this function:

DALI_IMPORT_API void Dali::Integration::SetPanGestureSmoothingAmount ( float  amount)

Sets the smoothing amount of the pan gesture.

Parameters
[in]amountThe smoothing amount [0.0f,1.0f] - 0.0f would be no smoothing, 1.0f maximum smoothing

Definition at line 51 of file input-options.cpp.

References Dali::PropertyTypes::Get(), and Dali::Internal::GestureEventProcessor::SetPanGestureSmoothingAmount().

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

DALI_IMPORT_API void Dali::Integration::SetPanGestureSmoothingMode ( int  mode)

Called to set how pan gestures smooth input.

Parameters
[in]modeThe smoothing mode to use

Definition at line 45 of file input-options.cpp.

References Dali::PropertyTypes::Get(), and Dali::Internal::GestureEventProcessor::SetPanGestureSmoothingMode().

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize(), UtcDaliPanGestureNoPredictionNoSmoothing(), UtcDaliPanGestureNoPredictionSmoothing(), UtcDaliPanGesturePredictionNoSmoothing(), UtcDaliPanGesturePredictionSmoothing(), and UtcDaliPanGestureSetProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

const ResourceId Dali::Integration::InvalidResourceId = (ResourceId)-1
Dali Docs Home
Read more about Dali