-#ifndef __DALI_INTEGRATION_CORE_H__
-#define __DALI_INTEGRATION_CORE_H__
+#ifndef DALI_INTEGRATION_CORE_H
+#define DALI_INTEGRATION_CORE_H
/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
// EXTERNAL INCLUDES
#include <dali/public-api/common/dali-common.h>
#include <dali/public-api/common/view-mode.h>
+#include <dali/integration-api/context-notifier.h>
+#include <dali/integration-api/resource-policies.h>
namespace Dali
{
struct Event;
struct TouchData;
+
/**
* The reasons why further updates are required.
*/
-namespace KeepUpdating DALI_IMPORT_API
+namespace KeepUpdating
+{
+enum Reasons
{
- extern const unsigned int NOT_REQUESTED; ///< Zero means that no further updates are required
-
- // Bit-field values
- extern const unsigned int STAGE_KEEP_RENDERING; ///< 0x01 - Stage::KeepRendering() is being used
- extern const unsigned int INCOMING_MESSAGES; ///< 0x02 - Event-thread is sending messages to update-thread
- extern const unsigned int ANIMATIONS_RUNNING; ///< 0x04 - Animations are ongoing
- extern const unsigned int DYNAMICS_CHANGED; ///< 0x08 - A dynamics simulation is running
- extern const unsigned int LOADING_RESOURCES; ///< 0x10 - Resources are being loaded
- extern const unsigned int NOTIFICATIONS_PENDING; ///< 0x20 - Notifications are pending for the event-thread
- extern const unsigned int MONITORING_PERFORMANCE; ///< 0x40 - The --enable-performance-monitor option is being used
- extern const unsigned int RENDER_TASK_SYNC; ///< 0x80 - A render task is waiting for render sync
+ NOT_REQUESTED = 0, ///< Zero means that no further updates are required
+ STAGE_KEEP_RENDERING = 1<<1, ///< - Stage::KeepRendering() is being used
+ ANIMATIONS_RUNNING = 1<<2, ///< - Animations are ongoing
+ MONITORING_PERFORMANCE = 1<<3, ///< - The --enable-performance-monitor option is being used
+ RENDER_TASK_SYNC = 1<<4 ///< - A render task is waiting for render sync
};
+}
/**
* The status of the Core::Update operation.
* Constructor
*/
RenderStatus()
- : needsUpdate(false),
- hasRendered(false)
+ : needsUpdate( false ),
+ needsPostRender( false )
{
}
/**
* Set whether update needs to run following a render.
- * This might be because render has sent messages to update, or it has
- * some textures to upload over several frames.
+ * @param[in] updateRequired Set to true if an update is required to be run
*/
- void SetNeedsUpdate(bool updateRequired) { needsUpdate = updateRequired; }
+ void SetNeedsUpdate( bool updateRequired )
+ {
+ needsUpdate = updateRequired;
+ }
/**
* Query the update status following rendering of a frame.
- * @return true if update should run.
+ * @return True if update is required to be run
*/
- bool NeedsUpdate() { return needsUpdate; }
+ bool NeedsUpdate() const
+ {
+ return needsUpdate;
+ }
/**
- * Set whether there were new render instructions.
+ * Sets if a post-render should be run.
+ * If nothing is rendered this frame, we can skip post-render.
+ * @param[in] postRenderRequired Set to True if post-render is required to be run
*/
- void SetHasRendered(bool rendered) { hasRendered = rendered; }
+ void SetNeedsPostRender( bool postRenderRequired )
+ {
+ needsPostRender = postRenderRequired;
+ }
/**
- * Query whether there were new render instructions.
- * @return true if there were render instructions
+ * Queries if a post-render should be run.
+ * @return True if post-render is required to be run
*/
- bool HasRendered() { return hasRendered; }
+ bool NeedsPostRender() const
+ {
+ return needsPostRender;
+ }
private:
- bool needsUpdate;
- bool hasRendered;
+ bool needsUpdate :1; ///< True if update is required to be run
+ bool needsPostRender :1; ///< True if post-render is required to be run.
};
/**
*
* 7) Provide an implementation of the GestureManager interface, used to register gestures provided by the platform.
*
- * Suspend/Resume behaviour:
- *
- * The Core has no knowledge of the application lifecycle, but can be suspended.
- * In the suspended state, input events will not be processed, and animations will not progress any further.
- * The Core can still render in the suspended state; the same frame will be produced each time.
- *
* Multi-threading notes:
*
* The Dali API methods are not reentrant. If you access the API from multiple threads simultaneously, then the results
* @param[in] glAbstraction The interface providing OpenGL services.
* @param[in] glSyncAbstraction The interface providing OpenGL sync objects.
* @param[in] gestureManager The interface providing gesture manager services.
+ * @param[in] policy The data retention policy. This depends on application setting
+ * and platform support. Dali should honour this policy when deciding to discard
+ * intermediate resource data.
* @return A newly allocated Core.
*/
static Core* New(RenderController& renderController,
PlatformAbstraction& platformAbstraction,
GlAbstraction& glAbstraction,
GlSyncAbstraction& glSyncAbstraction,
- GestureManager& gestureManager);
+ GestureManager& gestureManager,
+ ResourcePolicy::DataRetention policy);
/**
* Non-virtual destructor. Core is not intended as a base class.
// GL Context Lifecycle
/**
+ * Get the object that will notify the application/toolkit when context is lost/regained
+ */
+ ContextNotifierInterface* GetContextNotifier();
+
+ /**
* Notify the Core that the GL context has been created.
* The context must be created before the Core can render.
* Multi-threading note: this method should be called from the rendering thread only
* Multi-threading note: this method should be called from the rendering thread only
* @post The Core is unaware of any GL context.
*/
- void ContextToBeDestroyed();
+ void ContextDestroyed();
+
+ /**
+ * Notify the Core that the GL context has been re-created, e.g. after ReplaceSurface
+ * or Context loss.
+ *
+ * In the case of ReplaceSurface, both ContextToBeDestroyed() and ContextCreated() will have
+ * been called on the render thread before this is called on the event thread.
+ *
+ * Multi-threading note: this method should be called from the main thread
+ */
+ void RecoverFromContextLoss();
/**
* Notify the Core that the GL surface has been resized.
*/
void SurfaceResized(unsigned int width, unsigned int height);
+ /**
+ * Notify the Core about the top margin size.
+ * Available stage size is reduced by this size.
+ * The stage is located below the size at the top of the display
+ * It is mainly useful for indicator in mobile device
+ * @param[in] margin margin size
+ */
+ void SetTopMargin( unsigned int margin );
+
// Core setters
/**
// Core Lifecycle
/**
- * Put Core into the suspended state.
- * Any ongoing event processing will be cancelled, for example multi-touch sequences.
- * The core expects the system has suspended us. Animation time will continue during the suspended
- * state.
- * Multi-threading note: this method should be called from the main thread
- * @post The Core is in the suspended state.
+ * Notify Core that the scene has been created.
*/
- void Suspend();
-
- /**
- * Resume the Core from the suspended state.
- * At the first update, the elapsed time passed to the animations will be equal to the time spent
- * suspended.
- * Multi-threading note: this method should be called from the main thread
- * @post The Core is not in the suspended state.
- */
- void Resume();
+ void SceneCreated();
/**
* Queue an event with Core.
void ProcessEvents();
/**
- * Update external raw touch data in core.
- * The core will use the touch data to generate Dali Touch/Gesture events for applications to use
- * in the update thread.
- * @param[in] touch The raw touch data.
- * @note This can be called from either the event thread OR a dedicated touch thread.
- */
- void UpdateTouchData(const TouchData& touch);
-
- /**
* The Core::Update() method prepares a frame for rendering. This method determines how many frames
* may be prepared, ahead of the rendering.
* For example if the maximum update count is 2, then Core::Update() for frame N+1 may be processed
} // namespace Dali
-#endif // __DALI_INTEGRATION_CORE_H__
+#endif // DALI_INTEGRATION_CORE_H