dali-scene3d/public-api/loader/parse-renderer-state.h

   1 #ifndef DALI_SCENE3D_LOADERERER_INTERPRET_RENDERER_STATE_H
   2 #define DALI_SCENE3D_LOADERERER_INTERPRET_RENDERER_STATE_H
   3 /*
   4  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19
  20 #include "dali-scene3d/public-api/loader/renderer-state.h"
  21 #include "dali-scene3d/public-api/loader/string-callback.h"
  22
  23 namespace Dali
  24 {
  25 namespace Scene3D
  26 {
  27 namespace Loader
  28 {
  29 namespace RendererState
  30 {
  31 /*
  32  * @brief Attempts to interpret a string for renderer states, which can be a combination of the following
  33  *  (using '|' as a delimiter, if multiple specified):<br/>
  34  *  - one of Value, exc. for NONE or those with the _BITS, _SHIFT, _MASK or _ITEMS suffix;<br/>
  35  *  - DEPTH_FUNC:${one of Comparison::Type, exc. OMIT};<br/>
  36  *  - BLEND_(SRC_DST)_(RGB|ALPHA):${one of BlendFactor::Type, exc. OMIT};<br/>
  37  *  - BUFFER_MODE:${one of BufferMode::Type, exc. OMIT};
  38  * @param string The string to parse;
  39  * @param length The length of the string; If left at 0, strlen() will be called, which of
  40  *   course is only suitable i the string is null-terminated.
  41  * @param onError The callback to call when an error occurred.
  42  * @note No other characters are allowed.
  43  */
  44 DALI_SCENE3D_API Type Parse(const char* string, size_t length = 0, StringCallback onError = DefaultErrorCallback);
  45
  46 } // namespace RendererState
  47 } // namespace Loader
  48 } // namespace Scene3D
  49 } // namespace Dali
  50
  51 #endif //DALI_SCENE3D_LOADERERER_INTERPRET_RENDERER_STATE_H