compute_buffer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "api_compute.h"
33 #include <memory>
34 #include "../Core/Math/vec4.h"
35 #include "../Display/Image/buffer_usage.h"
36 
37 namespace clan
38 {
41 
42 class PixelBuffer;
43 class VertexArrayBuffer;
44 class ElementArrayBuffer;
45 class Texture;
46 class RenderBuffer;
47 class ComputeContext;
48 class ComputeBuffer;
49 class ComputeBuffer_Impl;
50 
52 class CL_API_COMPUTE ComputeBuffer
53 {
56 public:
58  ComputeBuffer();
59 
64  ComputeBuffer(ComputeContext &context, int size, BufferAccess access = access_read_write, bool alloc_host_pointer = false);
65 
66  ~ComputeBuffer();
67 
68  static ComputeBuffer from_pixel_buffer(ComputeContext &context, PixelBuffer &pixel_buffer, BufferAccess access = access_read_only);
69  static ComputeBuffer from_vertex_buffer(ComputeContext &context, VertexArrayBuffer &vertex_buffer, BufferAccess access = access_read_only);
70  static ComputeBuffer from_element_buffer(ComputeContext &context, ElementArrayBuffer &element_buffer, BufferAccess access = access_read_only);
71  static ComputeBuffer from_texture(ComputeContext &context, Texture &texture, int mipmap_level = 0, BufferAccess access = access_read_only);
72  static ComputeBuffer from_render_buffer(ComputeContext &context, RenderBuffer &render_buffer, BufferAccess access = access_read_only);
74 
77 public:
79  bool is_null() const { return !impl; }
80 
82  void throw_if_null() const;
84 
87 public:
89 
92 private:
93  std::shared_ptr<ComputeBuffer_Impl> impl;
94 
95  friend class ComputeKernel;
96  friend class ComputeCommandQueue;
97  friend class ComputeCommandQueue_Impl;
99 };
100 
101 }
102 
Compute buffer.
Definition: compute_buffer.h:52
Definition: buffer_usage.h:57
Vertex Array Buffer.
Definition: vertex_array_buffer.h:47
Texture object class.
Definition: texture.h:104
Pixel data container.
Definition: pixel_buffer.h:69
Definition: buffer_usage.h:59
bool is_null() const
Returns true if this object is invalid.
Definition: compute_buffer.h:79
Compute program kernel object.
Definition: compute_kernel.h:47
Compute command queue.
Definition: compute_command_queue.h:50
Element Array Buffer.
Definition: element_array_buffer.h:47
BufferAccess
Array Buffer access enum.
Definition: buffer_usage.h:55
Interface to compute operations.
Definition: compute_context.h:44
Render-buffer object class.
Definition: render_buffer.h:48