RAMSES Documentation  27.0.130
Information for RAMSES users and developers
BlitPass.h
Go to the documentation of this file.
1 // -------------------------------------------------------------------------
2 // Copyright (C) 2017 BMW Car IT GmbH
3 // -------------------------------------------------------------------------
4 // This Source Code Form is subject to the terms of the Mozilla Public
5 // License, v. 2.0. If a copy of the MPL was not distributed with this
6 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
7 // -------------------------------------------------------------------------
8 
9 #ifndef RAMSES_BLITPASS_H
10 #define RAMSES_BLITPASS_H
11 
13 
14 namespace ramses
15 {
16  class RenderBuffer;
17 
25  {
26  public:
27 
34 
41 
58  status_t setBlittingRegion(uint32_t sourceX, uint32_t sourceY, uint32_t destinationX, uint32_t destinationY, uint32_t width, uint32_t height);
59 
60 
72  void getBlittingRegion(uint32_t& sourceX, uint32_t& sourceY, uint32_t& destinationX, uint32_t& destinationY, uint32_t& width, uint32_t& height) const;
73 
86  status_t setRenderOrder(int32_t renderOrder);
87 
93  int32_t getRenderOrder() const;
94 
102  status_t setEnabled(bool enable);
103 
109  bool isEnabled() const;
110 
114  class BlitPassImpl& impl;
115 
116  protected:
120  friend class SceneImpl;
121 
127  explicit BlitPass(BlitPassImpl& pimpl);
128 
132  virtual ~BlitPass();
133  };
134 }
135 
136 #endif
#define RAMSES_API
Definition: APIExport.h:35
The BlitPass blits contents of one RendeBuffer to another. The source and destination RenderBuffer ob...
Definition: BlitPass.h:25
class BlitPassImpl & impl
Definition: BlitPass.h:114
virtual ~BlitPass()
Destructor of the BlitPass.
status_t setBlittingRegion(uint32_t sourceX, uint32_t sourceY, uint32_t destinationX, uint32_t destinationY, uint32_t width, uint32_t height)
Set the region for blitting from source and destination render buffers. The source and destination re...
int32_t getRenderOrder() const
Get the render order of this blit pass.
status_t setEnabled(bool enable)
Enable/Disable blit pass.
void getBlittingRegion(uint32_t &sourceX, uint32_t &sourceY, uint32_t &destinationX, uint32_t &destinationY, uint32_t &width, uint32_t &height) const
Get the blitting region in source and destination render buffers.
const RenderBuffer & getDestinationRenderBuffer() const
Get the destination render buffer used for blitting.
const RenderBuffer & getSourceRenderBuffer() const
Get the source render buffer used for blitting.
status_t setRenderOrder(int32_t renderOrder)
Set the render order for the blit pass. This order defines the order in which the blit pass is execut...
bool isEnabled() const
Get the enable state of the blit pass.
BlitPass(BlitPassImpl &pimpl)
Constructor for BlitPass.
RenderBuffer can be used with RenderTarget as buffer for writing or with TextureSampler as buffer for...
Definition: RenderBuffer.h:25
The SceneObject is a base class for all client API objects owned by a Scene.
Definition: SceneObject.h:20
The RAMSES namespace contains all client side objects and functions used to implement RAMSES applicat...
Definition: AnimatedProperty.h:15
uint32_t status_t
Status is a handle to the result of an API call.
Definition: RamsesFrameworkTypes.h:26