#define DALI_SHADER_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 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 Dali
{
+/**
+ * @addtogroup dali_core_rendering_effects
+ * @{
+ */
namespace Internal DALI_INTERNAL
{
*
* @SINCE_1_1.43
*/
-class DALI_IMPORT_API Shader : public Handle
+class DALI_CORE_API Shader : public Handle
{
public:
struct Hint
{
/**
- * @brief Hint value
+ * @brief Enumeration for the hint value.
* @SINCE_1_1.45
*/
enum Value
};
/**
- * @brief An enumeration of properties belonging to the Shader class.
+ * @brief Enumeration for instances of properties belonging to the Shader class.
* @SINCE_1_1.43
*/
struct Property
{
+ /**
+ * @brief Enumeration for instances of properties belonging to the Shader class.
+ * @SINCE_1_1.43
+ */
enum
{
/**
- * @brief Name: "program", Type: MAP
- * @note The default value is empty
- * @note Format: {"vertex":"","fragment":"",hints:"","vertexPrefix":"","fragmentPrefix":""}
+ * @brief Name: "program", Type: MAP.
+ * @note The default value is empty.
+ * @note Format: {"vertex":"","fragment":"",hints:"","vertexPrefix":"","fragmentPrefix":""}
* @SINCE_1_1.43
*/
PROGRAM = DEFAULT_OBJECT_PROPERTY_START_INDEX
};
/**
- * @brief Create Shader.
+ * @brief Creates Shader.
*
* @SINCE_1_1.43
* @param[in] vertexShader Vertex shader code for the effect.
Hint::Value hints = Hint::NONE );
/**
- * @brief Default constructor, creates an empty handle
+ * @brief Default constructor, creates an empty handle.
*
* @SINCE_1_1.43
*/
Shader();
/**
- * @brief Destructor
+ * @brief Destructor.
* This is non-virtual since derived Handle types must not contain data or virtual methods.
*
* @SINCE_1_1.43
~Shader();
/**
- * @brief Copy constructor
+ * @brief Copy constructor.
*
* @SINCE_1_1.43
* @param[in] handle A handle to a Shader object
Shader( const Shader& handle );
/**
- * @brief Downcast to a shader handle.
- * If not a shader the returned shader handle is left uninitialized.
+ * @brief Downcasts to a shader handle.
+ * If not, a shader the returned shader handle is left uninitialized.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
static Shader DownCast( BaseHandle handle );
/**
- * @brief Assignment operator, changes this handle to point at the same object
+ * @brief Assignment operator, changes this handle to point at the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
explicit DALI_INTERNAL Shader( Internal::Shader* effect );
};
+/**
+ * @}
+ */
} // namespace Dali
#endif // DALI_SHADER_H