backend_interface.h

Go to the documentation of this file.

 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>
#include <base/inc/geometry/geometry_base_types_helpers.h>
#include <base/inc/math/matrix4x4.h>
#include "graphic_context_interface.h"
 
#ifndef SDK_VIS_BACKEND_INTERFACE_H_
#define SDK_VIS_BACKEND_INTERFACE_H_
#pragma once
 
namespace sdk {
namespace vis {
namespace scene {
 
FWD_DECL_INTERFACE(IBackendInitialParameters);
FWD_DECL_INTERFACE(IBackendFactory);
FWD_DECL_INTERFACE(IBackend);
FWD_DECL_INTERFACE(IBackendEvents);
FWD_DECL_INTERFACE(IGraphicContext);
FWD_DECL_INTERFACE(ILayerClipping);
FWD_DECL_INTERFACE(ITexture);
FWD_DECL_INTERFACE(ISpriteList);
 
enum BackendType
{
  kBackendType_Window,  
  kBackendType_Texture, 
};
 
enum BackendPropertyIDs
{
  kBackendProperty_BackgroundColor,
 
  kBackendProperty_Width,
 
  kBackendProperty_Height,
 
  kBackendProperty_Texture,
 
  kBackendProperty_ForceResize,
 
  kBackendProperty_UseTextureAntialiasing,
 
  kBackendProperty_UseTextureFiltering,
 
  kBackendProperty_DebugLogging,
 
  kBackendProperty_EraseBackground,
};
 
enum BackendInitialParametersID
{
  kBackendInitialParameter_DeviceWnd,     
  kBackendInitialParameter_DeviceDisplay, 
  kBackendInitialParameter_VisualInfo,    
  kBackendInitialParameter_TextureWidth,  
  kBackendInitialParameter_TextureHeight, 
};
 
static const float kOpaqueLayer_Opacity = -1.0;
 
class IBackendInitialParameters : public sdk::ISDKParameters
{
public:
  // No own methods, only ISDKParameters methods
 
  SDK_IMPLEMENT_IID(IBackendInitialParameters)
  SDK_END_INTERFACE(IBackendInitialParameters)
};
SDK_DECLARE_IID(IBackendInitialParameters)
 
class IBackendFactory : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE CreateBackend(
    BackendType type, GraphicContextType gc_type, 
    const IBackendInitialParametersSP& backend_parameters, 
    const IGraphicContextInitialParametersSP& gc_parameters,
    const IBackendEventsSP& events_handler, IBackendSP& backend) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE IsGraphicContextAvailable(GraphicContextType type) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IBackendFactory)
  SDK_END_INTERFACE(IBackendFactory)
};
SDK_DECLARE_IID(IBackendFactory)
 
class IBackend : public ISDKProperties
{
public:
  virtual BackendType SDK_CALLTYPE GetType() const throw() = 0;
 
  virtual GraphicContextType SDK_CALLTYPE GetGCType() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetGraphicContext(
    IGraphicContextSP& context) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetViewportParams(
    const SDKMatrix4X4& scene_viewport_transform) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE StartDraw() throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE DrawTexture(const ITextureSP& texture, 
    const SDKRectF2D& bounds, const SDKRectF2D& viewport, 
    const SDKMatrix4X4& transform, float opacity, 
    const ILayerClippingSP& clipping) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE DrawSprites(const ITextureSP& texture, 
    const SDKRectF2D& viewport, const SDKMatrix4X4* transforms, SDKUInt64 num, 
    const SDKMatrix4X4& transform, float opacity) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE FinishDraw() throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CopyBits(const SDKRect2D& rect_to_copy,
    const TextureFormat& format, const SDKUInt32& stride_size,
    const TextureStrideOrder& stride_order, const SDKUInt32& bits_size, 
    SDKUInt8* const bits) const throw() = 0;
  
  SDK_IMPLEMENT_IID(IBackend)
  SDK_END_INTERFACE(IBackend)
};
SDK_DECLARE_IID(IBackend)
 
enum BackendEventID
{
};
 
class IBackendEvents : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE OnEvent(
    const BackendEventID& id, const SDKAny* param) throw() = 0;
 
  SDK_IMPLEMENT_IID(IBackendEvents)
  SDK_END_INTERFACE(IBackendEvents)
};
SDK_DECLARE_IID(IBackendEvents)
 
} // namespace scene
} // namespace vis
} // namespace sdk
 
#endif // SDK_VIS_BACKEND_INTERFACE_H_