gz/rendering/ShaderParam.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#ifndef GZ_RENDERING_SHADERPARAM_HH_
#define GZ_RENDERING_SHADERPARAM_HH_
 
#include <cstdint>
#include <cstring>
#include <memory>
#include <string>
 
#include <gz/common/SuppressWarning.hh>
 
#include "gz/rendering/config.hh"
#include "gz/rendering/Export.hh"
 
namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    class ShaderParamPrivate;
 
    class IGNITION_RENDERING_VISIBLE ShaderParam
    {
      public: enum ParamType : uint16_t
      {
        PARAM_NONE = 0,
 
        PARAM_FLOAT = 1,
 
        PARAM_INT = 2,
 
        PARAM_FLOAT_BUFFER = 3,
 
        PARAM_INT_BUFFER = 4,
 
        PARAM_TEXTURE = 5,
 
        PARAM_TEXTURE_CUBE = 6,
      };
 
      public: ShaderParam();
 
      public: ShaderParam(const ShaderParam &_other);
 
      public: ~ShaderParam();
 
      public: ParamType Type() const;
 
      public: uint32_t Count() const;
 
      public: ShaderParam &operator=(const ShaderParam &_other);
 
      public: void operator=(const float _value);
 
      public: void operator=(const int _value);
 
      public: void SetTexture(const std::string &_value,
          ShaderParam::ParamType _type = ShaderParam::ParamType::PARAM_TEXTURE,
          uint32_t _uvSetIndex = 0u);
 
      public: void InitializeBuffer(uint32_t _count);
 
      public: void UpdateBuffer(float *_floatBuffer);
 
      public: void UpdateBuffer(int *_intBuffer);
 
      public: bool Value(float *_value) const;
 
      public: bool Value(int *_value) const;
 
      public: bool Value(std::string &_value, uint32_t &_uvSetIndex) const;
 
      public: bool Buffer(std::shared_ptr<void> &_buffer) const;
 
      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<ShaderParamPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
    }
  }
}
 
#endif