#define DALI_TOOLKIT_VISUAL_PROPERTIES_H
/*
- * Copyright (c) 2016 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.
namespace Toolkit
{
+/**
+ * @addtogroup dali_toolkit_visuals
+ * @{
+ */
+
+/**
+ * @brief All the visual types
+ * @SINCE_1_1.45
+ */
namespace Visual
{
IMAGE, ///< Renders an image into the control's quad. @SINCE_1_1.45
MESH, ///< Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. @SINCE_1_1.45
PRIMITIVE, ///< Renders a simple 3D shape, such as a cube or sphere. @SINCE_1_1.45
- WIREFRAME, ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2_2
+ WIREFRAME ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2_2
};
+/**
+ * @brief Visual Property
+ * @SINCE_1_1.45
+ */
namespace Property
{
+/**
+ * @brief Visual Property
+ * @SINCE_1_1.45
+ */
enum
{
/**
* @note Will override the existing shaders.
* @see Shader::Property
*/
- SHADER,
+ SHADER
};
} // namespace Property
+/**
+ * @brief Shader for Visuals
+ * @SINCE_1_1.45
+ */
namespace Shader
{
+/**
+ * @brief Shader Property
+ * @SINCE_1_1.45
+ */
namespace Property
{
+/**
+ * @brief The type of Shader
+ * @SINCE_1_1.45
+ */
enum
{
/**
* @brief The vertex shader.
- * @details Name "vertexShader", type Property::STRING.
+ * @details Name "vertexShader", type Property::STRING or Property::ARRAY of Property::STRING.
+ * A Property::ARRAY of Property::STRING values can be used to split the shader string over multiple lines.
* @SINCE_1_1.45
* @note Optional
* @note If not supplied, the visual's already set vertex shader is used.
/**
* @brief The fragment shader.
- * @details Name "fragmentShader", type Property::STRING.
+ * @details Name "fragmentShader", type Property::STRING or Property::ARRAY of Property::STRING.
+ * A Property::ARRAY of Property::STRING values can be used to split the shader string over multiple lines.
* @SINCE_1_1.45
* @note Optional
* @note If not supplied, the visual's already set fragment shader is used.
} // namespace Visual
+/**
+ * @}
+ */
+
} // namespace Toolkit
} // namespace Dali