2d_render_target_init_settings_helper.h

Go to the documentation of this file.

#ifndef SDK_2D_RENDER_TARGET_INIT_SETTINGS_HELPER_H_
#define SDK_2D_RENDER_TARGET_INIT_SETTINGS_HELPER_H_
 
#include <string>
#include <map>
#include <base/inc/platform.h>
#include <base/inc/sdk_results.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_any_handler.h>
#include <visualizationlayer/inc/scene/texture_interface.h>
#include "../os_specific_types.h"
#include "../2d_render_target_init_settings_interface.h"
 
#include <base/inc/sdk_pshpack1.h>
 
namespace sdk {
namespace gfx {
 
SDK_PACK(struct SkiaFBOParameters
{
  SDKUInt32           viewport_width;     
  SDKUInt32           viewport_height;    
  PixelFormats        pixel_format;       
  SDKUInt32           samples_count;      
  SDKUInt32           stencil_buff_bits;  
  SDKUInt32           fbo_id;             
});
 
SDK_PACK(struct SkiaTextureParameters
{
  SDKUInt32           viewport_width;     
  SDKUInt32           viewport_height;    
  PixelFormats        pixel_format;       
  SDKUInt32           samples_count;      
  SDKUInt32           texture_id;         
});
 
class RenderTargetInitSettingsHelper : 
 
  public sdk::gfx::I2DRenderTargetInitSettings
 
{
 public:
  virtual SDKResult SDK_CALLTYPE SetProperty(const SDKString& id,
    const SDKAny& value) throw() {
    return kSDKResult_NotImplemented;
  } // Property value can't be changed
  virtual SDKResult SDK_CALLTYPE GetProperty(const SDKString& id,
    SDKAny& value) const throw();
 
  virtual SDKAtomicRefCount SDK_CALLTYPE AddRef() const throw();
  virtual SDKAtomicRefCount SDK_CALLTYPE Release() const throw();
  virtual SDKResult SDK_CALLTYPE GetInterface(const InterfaceId& id,
    void** obj_ptr) throw();
 
  // Note, that Render target supports only square pixel, that means, that
  // DPI by Ox should be equal to DPI by Oy. In case they are not equal - 
  // maximum of both DPIs will be used
#if defined(SDK_OS_WIN) && defined(SDK_GRAPHICS_USE_DIRECTX_10_1) // Direct2D specific
  static SDKResult CreateRenderTargetInitSettings(
    const D2D1_RENDER_TARGET_PROPERTIES* common_props, 
    RenderTargetInitSettingsSP& settings) throw(); 
 
  static SDKResult CreateRenderTargetInitSettings(
    const HWND hwnd, // HWND handle, the D2D1_HWND_RENDER_TARGET_PROPERTIES.hwnd will be ignored
    const D2D1_HWND_RENDER_TARGET_PROPERTIES* hwnd_props, // If NULL - default settings will be used
    const D2D1_RENDER_TARGET_PROPERTIES* common_props,    // If NULL - default settings will be used
    RenderTargetInitSettingsSP& settings) throw(); 
 
  static SDKResult CreateRenderTargetInitSettings(
    const IDXGISurface* dxgi_surface,                  // DXGI surface
    const D2D1_RENDER_TARGET_PROPERTIES* common_props, // If NULL - default settings will be used
    RenderTargetInitSettingsSP& settings) throw(); 
#endif // SDK_OS_WIN && SDK_GRAPHICS_USE_DIRECTX_10_1
 
  static SDKResult CreateRenderTargetInitSettings(
    const OpenGLGraphicsDeviceContext& context, RenderTargetInitSettingsSP& settings) throw();
 
  static SDKResult CreateRenderTargetInitSettings(
    const OpenGLGraphicsDeviceContext& context, 
    const SkiaFBOParameters& fbo_parameters, 
    RenderTargetInitSettingsSP& settings) throw();
 
  static SDKResult CreateRenderTargetInitSettings(
    const OpenGLGraphicsDeviceContext& context, 
    const SkiaTextureParameters& texture_parameters, 
    RenderTargetInitSettingsSP& settings) throw();
 
  static SDKResult CreateRenderTargetInitSettings(
    const OSWindow& window, RenderTargetInitSettingsSP& settings) throw();
 
  static SDKResult CreateRenderTargetInitSettings(
    const sdk::vis::scene::ITextureSP& texture, 
    RenderTargetInitSettingsSP& settings) throw();
 
 protected:
  RenderTargetInitSettingsHelper();
  virtual ~RenderTargetInitSettingsHelper();
 
#if defined(SDK_OS_WIN) && defined(SDK_GRAPHICS_USE_DIRECTX_10_1) // Direct2D specific properties
  virtual SDKResult InitWithCommonD2DProperties(
    const D2D1_RENDER_TARGET_PROPERTIES& common_props) throw();
#endif // SDK_OS_WIN && SDK_GRAPHICS_USE_DIRECTX_10_1
 
  virtual SDKResult InitWithOSGraphicsContexts(
    const OpenGLGraphicsDeviceContext& context) throw();
 
  virtual SDKResult SetPropertyImpl(const wchar_t* id, const SDKAny& value) throw();
 
 private:
  RenderTargetInitSettingsHelper(const RenderTargetInitSettingsHelper&);
  void operator=(const RenderTargetInitSettingsHelper&);
 
 private:
  // Number of references
  mutable SDKAtomicRefCount m_ref;
 
  // Properties storage
  typedef std::map<std::wstring, sdk::SDKAnyHandler> PropertiesMap;
  PropertiesMap                                      m_properties;
 
#if defined(SDK_OS_WIN) && defined(SDK_GRAPHICS_USE_DIRECTX_10_1)
  // In case the render target type is RenderTarget2D_Direct2D_DXGI 
  // the references count to given object will be
  // increased in order to hold a strong link to it, due of SDKAny does not
  // counts references for COM objects
  typedef SDKRefPtr<IDXGISurface> DXGISurfaceSP;
  DXGISurfaceSP m_dxgi_surface;
#endif // SDK_OS_WIN && SDK_GRAPHICS_USE_DIRECTX_10_1
};
 
} // namespace gfx
} // namespace sdk 
 
#include <base/inc/sdk_poppack.h>
 
#endif // SDK_2D_RENDER_TARGET_INIT_SETTINGS_HELPER_H_