transfer_texture.h Source File - ClanLib SDK
Description: transfer_texture.h Source File

transfer_texture.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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** Mark Page
28*/
29
30#pragma once
31
32#include <memory>
33#include "graphic_context.h"
34#include "../Image/image_import_description.h"
35#include "../Image/texture_format.h"
36#include "../Image/pixel_buffer.h"
37
38namespace clan
39{
42
43 class Color;
44 class Point;
45 class PixelBuffer;
46 class PixelFormat;
47 class DataBuffer;
48 class PixelBufferProvider;
49 class TransferTexture_Impl;
50 class SharedGCData_Impl;
51
53 class TransferTexture : public PixelBuffer
54 {
55 public:
57 TransferTexture();
58
62 TransferTexture(std::unique_ptr<PixelBufferProvider> provider);
63
73 TransferTexture(GraphicContext &gc, int width, int height, PixelBufferDirection direction = PixelBufferDirection::data_to_gpu, TextureFormat texture_format = TextureFormat::rgba8, const void *data = nullptr, BufferUsage usage = BufferUsage::stream_draw);
74
81 TransferTexture(GraphicContext &gc, const PixelBuffer &pbuff, PixelBufferDirection direction = PixelBufferDirection::data_to_gpu, BufferUsage usage = BufferUsage::stream_draw);
82
83 ~TransferTexture() override;
84 };
85
87}
clan::Color
Color description class.
Definition color.h:46
clan::DataBuffer
General purpose data buffer.
Definition databuffer.h:42
clan::GraphicContext
Interface to drawing graphics.
Definition graphic_context.h:257
clan::PixelBufferProvider
Element Array Buffer provider.
Definition pixel_buffer_provider.h:42
clan::PixelBuffer
Pixel data container.
Definition pixel_buffer.h:68
clan::PixelBuffer::PixelBuffer
PixelBuffer()
Constructs a null instance.
clan::Point
2D (x,y) point structure - Integer
Definition point.h:62
clan::TransferTexture::TransferTexture
TransferTexture(GraphicContext &gc, const PixelBuffer &pbuff, PixelBufferDirection direction=PixelBufferDirection::data_to_gpu, BufferUsage usage=BufferUsage::stream_draw)
Constructs a GPU Transfer Buffer from an existing pixelbuffer.
clan::TransferTexture::TransferTexture
TransferTexture()
Constructs a null instance.
clan::TransferTexture::~TransferTexture
~TransferTexture() override
clan::TransferTexture::TransferTexture
TransferTexture(GraphicContext &gc, int width, int height, PixelBufferDirection direction=PixelBufferDirection::data_to_gpu, TextureFormat texture_format=TextureFormat::rgba8, const void *data=nullptr, BufferUsage usage=BufferUsage::stream_draw)
Constructs a GPU Transfer Buffer.
clan::TransferTexture::TransferTexture
TransferTexture(std::unique_ptr< PixelBufferProvider > provider)
Constructs a GPU Transfer Buffer.
clan::TextureFormat
TextureFormat
Texture format.
Definition texture_format.h:39
clan::PixelBufferDirection
PixelBufferDirection
Pixel buffer prefered direction.
Definition pixel_buffer.h:58
clan::BufferUsage
BufferUsage
Array Buffer usage enum.
Definition buffer_usage.h:39
clan::TextureFormat::rgba8
@ rgba8
Definition texture_format.h:41
clan::PixelBufferDirection::data_to_gpu
@ data_to_gpu
Use of the pixel buffer is to send data to the gpu.
Definition pixel_buffer.h:60
clan::BufferUsage::stream_draw
@ stream_draw
Definition buffer_usage.h:40
clan
Definition clanapp.h:36