summaryrefslogtreecommitdiffstatsci
path: root/src/vkvg_device_internal.h
blob: 46f755ef36888360405b4d693ca2e97fa1e431a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/*
 * Copyright (c) 2018-2022 Jean-Philippe Bruyère <jp_bruyere@hotmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
 * Software, and to permit persons to whom the Software is furnished to do so, subject
 * to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef VKVG_DEVICE_INTERNAL_H
#define VKVG_DEVICE_INTERNAL_H

#include "vkvg_internal.h"
#include "vkvg_fonts.h"

#define STENCIL_FILL_BIT              0x1
#define STENCIL_CLIP_BIT              0x2
#define STENCIL_ALL_BIT               0x3

#define VKVG_MAX_CACHED_CONTEXT_COUNT 2

extern PFN_vkCmdBindPipeline       CmdBindPipeline;
extern PFN_vkCmdBindDescriptorSets CmdBindDescriptorSets;
extern PFN_vkCmdBindIndexBuffer    CmdBindIndexBuffer;
extern PFN_vkCmdBindVertexBuffers  CmdBindVertexBuffers;

extern PFN_vkCmdDrawIndexed CmdDrawIndexed;
extern PFN_vkCmdDraw        CmdDraw;

extern PFN_vkCmdSetStencilCompareMask CmdSetStencilCompareMask;
extern PFN_vkCmdSetStencilReference   CmdSetStencilReference;
extern PFN_vkCmdSetStencilWriteMask   CmdSetStencilWriteMask;
extern PFN_vkCmdBeginRenderPass       CmdBeginRenderPass;
extern PFN_vkCmdEndRenderPass         CmdEndRenderPass;
extern PFN_vkCmdSetViewport           CmdSetViewport;
extern PFN_vkCmdSetScissor            CmdSetScissor;

extern PFN_vkCmdPushConstants   CmdPushConstants;
extern PFN_vkWaitForFences      WaitForFences;
extern PFN_vkResetFences        ResetFences;
extern PFN_vkResetCommandBuffer ResetCommandBuffer;

typedef struct _cached_ctx {
    thrd_t              thread;
    VkvgContext         ctx;
    struct _cached_ctx* pNext;
} _cached_ctx;

typedef struct _vkvg_device_t {
    vkvg_status_t                    status;      /**< Current status of device, affected by last operation */
    VkDevice                         vkDev;       /**< Vulkan Logical Device */
    VkPhysicalDeviceMemoryProperties phyMemProps; /**< Vulkan Physical device memory properties */
    VkPhysicalDevice                 phy;         /**< Vulkan Physical device */
    VkInstance                       instance;    /**< Vulkan instance */
#ifdef VKH_USE_VMA
    void* allocator; /**< Vulkan Memory allocator */
#endif

    VkImageTiling      supportedTiling;   /**< Supported image tiling for surface, 0xFF=no support */
    VkFormat           stencilFormat;     /**< Supported vulkan image format for stencil */
    VkImageAspectFlags stencilAspectFlag; /**< stencil only or depth stencil, could be solved by
                                             VK_KHR_separate_depth_stencil_layouts*/
    VkFormat      pngStagFormat;          /**< Supported vulkan image format png write staging img */
    VkImageTiling pngStagTiling;          /**< tiling for the blit operation */

    mtx_t    mutex;       /**< protect device access (queue, cahes, ...)from ctxs in separate threads */
    bool     threadAware; /**< if true, mutex is created and guard device queue and caches access */
    VkhQueue gQueue;      /**< Vulkan Queue with Graphic flag */

    VkRenderPass renderPass; /**< Vulkan render pass, common for all surfaces */
    VkRenderPass
        renderPass_ClearStencil;      /**< Vulkan render pass for first draw with context, stencil has to be cleared */
    VkRenderPass renderPass_ClearAll; /**< Vulkan render pass for new surface, clear all attacments*/

    uint32_t        references; /**< Reference count, prevent destroying device if still in use */
    VkCommandPool   cmdPool;    /**< Global command pool for processing on surfaces without context */
    VkCommandBuffer cmd;        /**< Global command buffer */
    VkFence fence; /**< this fence is kept signaled when idle, wait and reset are called before each recording. */

    VkPipeline pipe_OVER; /**< default operator */
    VkPipeline pipe_SUB;
    VkPipeline pipe_CLEAR; /**< clear operator */

    VkPipeline pipelinePolyFill; /**< even-odd polygon filling first step */
    VkPipeline pipelineClipping; /**< draw on stencil to update clipping regions */

    VkPipelineCache       pipelineCache;  /**< speed up startup by caching configured pipelines on disk */
    VkPipelineLayout      pipelineLayout; /**< layout common to all pipelines */
    VkDescriptorSetLayout dslFont;        /**< font cache descriptors layout */
    VkDescriptorSetLayout dslSrc;         /**< context source surface descriptors layout */
    VkDescriptorSetLayout dslGrad;        /**< context gradient descriptors layout */

    int hdpi, /**< only used for FreeType fonts and svg loading */
        vdpi;

    VkhDevice vkhDev; /**< old VkhDev created during vulkan context creation by @ref vkvg_device_create. */

    VkhImage           emptyImg;        /**< prevent unbound descriptor to trigger Validation error 61 */
    VkSampleCountFlags samples;         /**< samples count common to all surfaces */
    bool               deferredResolve; /**< if true, resolve only on context destruction and set as source */

    _font_cache_t* fontCache; /**< Store everything relative to common font caching system */

    VkvgContext lastCtx; /**< last element of double linked list of context, used to trigger font caching system update
                            on all contexts*/

    int32_t      cachedContextMaxCount; /**< Maximum context cache element count.*/
    int32_t      cachedContextCount;    /**< Current context cache element count.*/
    _cached_ctx* cachedContextLast;     /**< Last element of single linked list of saved context for fast reuse.*/

#ifdef VKVG_WIRED_DEBUG
    VkPipeline pipelineWired;
    VkPipeline pipelineLineList;
#endif
#if VKVG_DBG_STATS
    vkvg_debug_stats_t debug_stats; /**< debug statistics on memory usage and vulkan ressources */
#endif
} vkvg_device;

#define LOCK_DEVICE                                                                                                    \
    if (dev->threadAware)                                                                                              \
        mtx_lock(&dev->mutex);
#define UNLOCK_DEVICE                                                                                                  \
    if (dev->threadAware)                                                                                              \
        mtx_unlock(&dev->mutex);

bool _device_try_get_phyinfo(VkhPhyInfo* phys, uint32_t phyCount, VkPhysicalDeviceType gpuType, VkhPhyInfo* phy);
bool _device_init_function_pointers(VkvgDevice dev);
void _device_create_empty_texture(VkvgDevice dev, VkFormat format, VkImageTiling tiling);
void _device_get_best_image_tiling(VkvgDevice dev, VkFormat format, VkImageTiling* pTiling);
void _device_check_best_image_tiling(VkvgDevice dev, VkFormat format);
void _device_create_pipeline_cache(VkvgDevice dev);
VkRenderPass _device_createRenderPassMS(VkvgDevice dev, VkAttachmentLoadOp loadOp, VkAttachmentLoadOp stencilLoadOp);
VkRenderPass _device_createRenderPassNoResolve(VkvgDevice dev, VkAttachmentLoadOp loadOp,
                                               VkAttachmentLoadOp stencilLoadOp);
void         _device_setupPipelines(VkvgDevice dev);
void         _device_createDescriptorSetLayout(VkvgDevice dev);
void         _device_wait_idle(VkvgDevice dev);
void         _device_wait_and_reset_device_fence(VkvgDevice dev);
void         _device_submit_cmd(VkvgDevice dev, VkCommandBuffer* cmd, VkFence fence);

bool _device_try_get_cached_context(VkvgDevice dev, VkvgContext* pCtx);
void _device_store_context(VkvgContext ctx);
#endif