Diligent Engine API Reference: D:/GitHub/DiligentEngine/DiligentCore/Graphics/GraphicsTools/include/TextureUploader.h Source File

Diligent Engine API Reference

TextureUploader.h
1 /* Copyright 2015-2018 Egor Yusov
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
10 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
11 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF ANY PROPRIETARY RIGHTS.
12 *
13 * In no event and under no legal theory, whether in tort (including negligence),
14 * contract, or otherwise, unless required by applicable law (such as deliberate
15 * and grossly negligent acts) or agreed to in writing, shall any Contributor be
16 * liable for any damages, including any direct, indirect, special, incidental,
17 * or consequential damages of any character arising as a result of this License or
18 * out of the use or inability to use the software (including but not limited to damages
19 * for loss of goodwill, work stoppage, computer failure or malfunction, or any and
20 * all other commercial damages or losses), even if such Contributor has been advised
21 * of the possibility of such damages.
22 */
23
24 #pragma once
25
26 #include "RenderDevice.h"
27 #include "DeviceContext.h"
28
29 namespace Diligent
30 {
31 struct UploadBufferDesc
32 {
33 Uint32 Width = 0;
34 Uint32 Height = 0;
35 Uint32 Depth = 1;
36 TEXTURE_FORMAT Format = TEX_FORMAT_UNKNOWN;
37
38 bool operator == (const UploadBufferDesc &rhs) const
39 {
40 return Width == rhs.Width &&
41 Height == rhs.Height &&
42 Depth == rhs.Depth &&
43 Format == rhs.Format;
44 }
45 };
46
47 class IUploadBuffer : public IObject
48 {
49 public:
50 virtual void WaitForCopyScheduled() = 0;
51 virtual void* GetDataPtr() = 0;
52 virtual size_t GetRowStride() const = 0;
53 virtual size_t GetDepthStride()const = 0;
54 virtual const UploadBufferDesc& GetDesc()const = 0;
55 };
56
57 struct TextureUploaderDesc
58 {
59
60 };
61
62 class ITextureUploader : public IObject
63 {
64 public:
65 virtual void RenderThreadUpdate(IDeviceContext *pContext) = 0;
66 virtual void AllocateUploadBuffer(const UploadBufferDesc& Desc, bool IsRenderThread, IUploadBuffer **ppBuffer) = 0;
67 virtual void ScheduleGPUCopy(ITexture *pDstTexture, Uint32 ArraySlice, Uint32 MipLevel, IUploadBuffer *pUploadBuffer) = 0;
68 virtual void RecycleBuffer(IUploadBuffer *pUploadBuffer) = 0;
69 };
70
71 void CreateTextureUploader(IRenderDevice *pDevice, const TextureUploaderDesc& Desc, ITextureUploader **ppUploader);
72 }
Diligent::TEXTURE_FORMAT
TEXTURE_FORMAT
Texture formats.
Definition: GraphicsTypes.h:244
Diligent::TEX_FORMAT_UNKNOWN
Unknown format.
Definition: GraphicsTypes.h:247
Diligent
Graphics engine namespace.
Definition: AdaptiveFixedBlockAllocator.h:30
Diligent::Uint32
uint32_t Uint32
32-bit unsigned integer
Definition: BasicTypes.h:39