gz/rendering/Image.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2015 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_IMAGE_HH_
#define GZ_RENDERING_IMAGE_HH_
 
#include <memory>
 
#include <gz/common/SuppressWarning.hh>
 
#include "gz/rendering/config.hh"
#include "gz/rendering/PixelFormat.hh"
#include "gz/rendering/Export.hh"
 
namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    class Camera;
    class PixelBuffer;
 
    class IGNITION_RENDERING_VISIBLE Image
    {
      typedef std::shared_ptr<unsigned char> DataPtr;
 
      public: Image() = default;
 
      public: Image(unsigned int _width, unsigned int _height,
                  PixelFormat _format);
 
      public: ~Image();
 
      public: unsigned int Width() const;
 
      public: unsigned int Height() const;
 
      public: PixelFormat Format() const;
 
      public: unsigned int Depth() const;
 
      public: unsigned int MemorySize() const;
 
      public: const void *Data() const;
 
      public: void *Data();
 
      public: template <typename T>
              const T *Data() const;
 
      public: template <typename T>
              T *Data();
 
      private: explicit Image(const PixelBuffer &_buffer);
 
      private: friend class Camera;
 
      private: unsigned int width = 0;
 
      private: unsigned int height = 0;
 
      private: PixelFormat format = PF_UNKNOWN;
 
      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: DataPtr data = nullptr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
 
    template <typename T>
    const T *Image::Data() const
    {
      return static_cast<const T *>(this->data.get());
    }
 
    template <typename T>
    T *Image::Data()
    {
      return static_cast<T *>(this->data.get());
    }
    }
  }
}
#endif