RenderTarget.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") = 0;
 * 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_RENDERTARGET_HH_
#define GZ_RENDERING_RENDERTARGET_HH_
 
#include <string>
 
#include <gz/math/Color.hh>
 
#include "gz/rendering/config.hh"
#include "gz/rendering/RenderTypes.hh"
#include "gz/rendering/Image.hh"
#include "gz/rendering/Object.hh"
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
    //
    class GZ_RENDERING_VISIBLE RenderTarget :
      public virtual Object
    {
      public: virtual ~RenderTarget();
 
      public: virtual unsigned int Width() const = 0;
 
      public: virtual unsigned int Height() const = 0;
 
      public: virtual void SetWidth(const unsigned int _width) = 0;
 
      public: virtual void SetHeight(const unsigned int _height) = 0;
 
      public: virtual PixelFormat Format() const = 0;
 
      public: virtual void SetFormat(PixelFormat _format,
                                     bool _reinterpretable = false) = 0;
 
      public: virtual bool Reinterpretable() const = 0;
 
      public: virtual void Copy(Image &_image) const = 0;
 
      public: virtual math::Color BackgroundColor() const = 0;
 
      // Documentation inherited
      public: using Object::PreRender;
 
      public: virtual void PreRender(const CameraPtr &_camera) = 0;
 
      public: virtual void AddRenderPass(const RenderPassPtr &_pass) = 0;
 
      public: virtual void RemoveRenderPass(const RenderPassPtr &_pass) = 0;
 
      public: virtual void RemoveAllRenderPasses() = 0;
 
      public: virtual unsigned int RenderPassCount() const = 0;
 
      public: virtual RenderPassPtr RenderPassByIndex(unsigned int _index)
          const = 0;
    };
 
    /* \class RenderTexture RenderTexture.hh \
     * gz/rendering/RenderTexture.hh
     */
    class GZ_RENDERING_VISIBLE RenderTexture :
      public virtual RenderTarget
    {
      public: virtual ~RenderTexture();
 
      // if this is an OpenGL render texture
      public: virtual unsigned int GLId() const = 0;
 
      public: virtual void MetalId(void *_textureIdPtr) const = 0;
    };
 
    /* \class RenderWindow RenderWindow.hh \
     * gz/rendering/RenderWindow.hh
     */
    class GZ_RENDERING_VISIBLE RenderWindow :
      public virtual RenderTarget
    {
      public: virtual ~RenderWindow();
 
      public: virtual std::string Handle() const = 0;
 
      public: virtual void SetHandle(const std::string &_handle) = 0;
 
      public: virtual double DevicePixelRatio() const = 0;
 
      public: virtual void SetDevicePixelRatio(const double _ratio) = 0;
 
      public: virtual void OnResize(unsigned int _width,
                  unsigned int _height) = 0;
 
      public: virtual void OnMove() = 0;
    };
    }
  }
}
#endif