Class Info |
|---|
class GraphicsRenderer 图形渲染器类,提供贴图创建、管线创建和缓冲创建等功能。 |
Constructor Name |
|---|
GraphicsRenderer(const GraphicsConfig* graphicsConfig) 构造函数。 |
Qualifier and Type |
Method Name and Description |
|---|---|
virtual FrameBuffer* |
CreateFrameBuffer(const FrameBufferCreateInfo& info) = 0 根据传入的FrameBufferCreateInfo信息,创建FrameBuffer对象。 |
virtual SwapChain* |
CreateSwapChain(const SwapChainCreateInfo& info) const = 0 根据SwapChainCreateInfo信息创建交换链对象。 |
void |
DestroySwapChain(SwapChain* swapChain) const 销毁传入的交换链对象。 |
virtual ShaderStage* |
CreateShaderStage(const ShaderStageCreateInfo& shaderStageInfo) const = 0 根据ShaderStageCreateInfo信息创建ShaderStage对象。 |
void |
DestroyShaderStage(ShaderStage* shaderStage) const 销毁传入的ShaderStage对象。 |
CreateShader(const ShaderCreateInfo& shaderCreateInfo) const = 0 根据ShaderCreateInfo信息创建着色器对象。 |
|
const SwapChain* |
GetDefaultSwapChain() const 获取默认的交换链对象。 |
virtual BufferMemoryBarrier* |
CreateBufferMemoryBarrier(const BufferMemoryBarrierInfo& bufferMemoryBarrierInfo) const = 0 根据BufferMemoryBarrierInfo信息创建缓冲存储屏障对象。 |
virtual TextureMemoryBarrier* |
CreateTextureMemoryBarrier(const TextureMemoryBarrierInfo& textureMemoryBarrierInfo) const = 0 根据TextureMemoryBarrierInfo信息创建图像存储屏障对象。 |
void |
DestroyBufferMemoryBarrier(const BufferMemoryBarrier* bufferMemoryBarrier) const 销毁传入的缓冲存储屏障对象。 |
void |
DestroyTextureMemoryBarrier(const TextureMemoryBarrier* textureMemoryBarrier) const 销毁传入的图像存储屏障对象。 |
virtual Queue* |
CreateQueue(const QueueCreateInfo& queueCreateInfo) const = 0 根据QueueCreateInfo信息创建队列。 |
void |
DestroyQueue(Queue* queue) const 销毁传入的队列对象。 |
const Queue* |
GetDefaultQueue(QueueType queueType = QueueType::GRAPHICS) 根据QueueType获取默认的队列对象,默认为GRAPHICS类型的队列。 |
virtual RenderPass* |
CreateRenderPass(const RenderPassCreateInfo& renderPassCreateInfo) const = 0 根据RenderPassCreateInfo信息创建渲染通道。 |
void |
DestroyRenderPass(RenderPass* renderPass) const 销毁传入的渲染通道对象。 |
virtual Buffer* |
CreateBuffer(const BufferCreateInfo& bufferCreateInfo) const = 0 根据BufferCreateInfo创建数据缓存区。 |
void |
DestroyBuffer(Buffer* buffer) const 销毁传入的数据缓存区对象。 |
virtual Buffer* |
CreateBufferView(const BufferViewCreateInfo& bufferViewCreateInfo) const = 0 根据BufferViewCreateInfo创建数据缓存切片。 |
static GraphicsRenderer* |
CreateGraphicsRenderer(const GraphicsConfig* graphicsConfig) 创建GraphicsRenderer实例。 |
virtual Texture* |
CreateTexture(const TextureCreateInfo& info) const = 0 创建纹理。 |
virtual Texture* |
CreateTextureView(const TextureViewCreateInfo& info) const = 0 根据TextureViewCreateInfo创建纹理。 |
virtual DescriptorSetLayout* |
CreateDescriptorSetLayout(const DescriptorSetLayoutCreateInfo& info) const = 0 创建描述符集布局。 |
virtual DescriptorSet* |
CreateDescriptorSet(const DescriptorSetCreateInfo& info) const = 0 创建描述符集。 |
virtual Pipeline* |
CreatePipeline(const PipelineCreateInfo& createInfo) const = 0 创建管线。 |
virtual Pipeline* |
RequestPipeline(const PipelineCreateInfo& createInfo) const 获取缓存的管线。 |
virtual PipelineLayout* |
CreatePipelineLayout(const PipelineLayoutCreateInfo& info) const = 0 创建管线布局。 |
virtual CommandBuffer* |
CreateCommandBuffer(const CommandBufferCreateInfo& info) = 0 创建命令缓冲。 |
virtual void |
DestroyImage(void* image) const = 0 销毁Image。 |
virtual Sampler* |
CreateSampler(const SamplerCreateInfo& info) const = 0 创建采样器。 |
void |
DestroyTexture(Texture* texture) const 销毁纹理。 |
void |
DestroyPipeline(Pipeline* pipeline) const 销毁管线。 |
void |
DestroyPipelineLayout(PipelineLayout* pipelineLayout) const 销毁管线布局。 |
void |
DestroyShader(Shader* shader) const 销毁着色器。 |
virtual void |
DestroySampler(Sampler* sampler) const = 0 销毁采样器。 |
virtual bool |
Initialize(const void* window) 初始化接口,用于相关资源的加载。 |
virtual void |
反初始化,用于相关资源的卸载。 |
virtual bool |
Resume(const void* winHandle, u32 width, u32 height) 应用从后台切回前台时,恢复系统运行相关资源的接口。 |
virtual void |
Pause() 应用从前台切到后台时,销毁相关资源的接口。 |
virtual void |
WaitDeviceIdle() const = 0 用于等待GPU状态同步的接口。 |
virtual bool |
Submit(const std::vector<CommandBuffer*>& vecCommandBuffers) = 0 提交命令缓冲。 |
virtual bool |
Begin() = 0 开始一帧的绘制,主要是通过交换链获取下一帧图像准备绘制。 |
virtual void |
End() = 0 结束一帧的绘制,主要是对绘制的图像进行提交到交换链的操作。 |
virtual void |
Resize(u32 nWidth, u32 nHeight) 更改窗口大小。 |
virtual const Texture* |
GetDefaultTexture() const = 0 创建默认红色图像。 |
virtual f32 |
GetAspectRatio() const = 0 获取渲染窗口高宽比。 |
virtual u32 |
GetScreenWidth() const = 0 获取屏幕宽度。 |
virtual u32 |
GetScreenHeight() const = 0 获取屏幕高度。 |
virtual bool |
IsSafe(u64 frameNumber) const = 0 判断该帧是否合法。 |
virtual u32 |
GetSwapChainBufferCount() const = 0 获取交换链缓冲个数。 |
bool |
GetInitialized() const 获取当前的状态是否为已经完成初始化。 |
u64 |
GetFrameNumber() const 获取当前的帧计数值。 |
const GraphicsConfig* |
GetGraphicsConfig() const 获取GraphicsConfig。 |
virtual void* |
GetResourceCache() const = 0 获取资源缓冲指针。 |
void |
DestroyCommandBuffer(CommandBuffer* commandBuffer) 销毁命令缓冲区。 |
virtual void |
DestroyDescriptorSetLayout(DescriptorSetLayout* layout) const 销毁描述符集布局对象。 |
virtual void |
DestroyDescriptorSet(DescriptorSet* descriptorSet) const 销毁描述符集对象。 |
Constructor |
|---|
GraphicsRenderer(const GraphicsConfig* graphicsConfig) 构造函数。 |
Parameters
Name |
Description |
|---|---|
graphicsConfig |
相关配置信息。 |
Method |
|---|
virtual FrameBuffer* CreateFrameBuffer(const FrameBufferCreateInfo& info) = 0 根据传入的FrameBufferCreateInfo信息,创建FrameBuffer对象。 |
Parameters
Name |
Description |
|---|---|
info |
Returns
Type |
Description |
|---|---|
返回创建的帧缓冲对象。 |
Method |
|---|
SwapChain* CreateSwapChain(const SwapChainCreateInfo& info) const = 0 根据SwapChainCreateInfo信息创建交换链对象。 |
Parameters
Name |
Description |
|---|---|
info |
Returns
Type |
Description |
|---|---|
返回创建的交换链对象。 |
Method |
|---|
void DestroySwapChain(SwapChain* swapChain) const 销毁传入的交换链对象。 |
Parameters
Name |
Description |
|---|---|
swapChain |
要销毁的交换链对象。 |
Method |
|---|
ShaderStage* CreateShaderStage(const ShaderStageCreateInfo& shaderStageInfo) const 根据ShaderStageCreateInfo信息创建ShaderStage对象。 |
Parameters
Name |
Description |
|---|---|
shaderStageInfo |
Returns
Type |
Description |
|---|---|
返回创建的ShaderStage对象。 |
Method |
|---|
void DestroyShaderStage(ShaderStage* shaderStage) const 销毁传入的ShaderStage对象。 |
Parameters
Name |
Description |
|---|---|
shaderStage |
要销毁的ShaderStage对象。 |
Method |
|---|
Shader* CreateShader(const ShaderCreateInfo& shaderCreateInfo) const = 0 根据ShaderCreateInfo信息创建着色器对象。 |
Parameters
Name |
Description |
|---|---|
shaderCreateInfo |
Returns
Type |
Description |
|---|---|
返回创建的Shader对象。 |
Method |
|---|
const SwapChain* GetDefaultSwapChain() const 获取GraphicsRenderer初始化时创建的默认交换链对象。 |
Returns
Type |
Description |
|---|---|
返回默认的交换链对象。 |
Method |
|---|
virtual BufferMemoryBarrier* CreateBufferMemoryBarrier(const BufferMemoryBarrierInfo& bufferMemoryBarrierInfo) const = 0 根据BufferMemoryBarrierInfo信息创建缓冲存储屏障对象。 |
Parameters
Name |
Description |
|---|---|
bufferMemoryBarrierInfo |
Returns
Type |
Description |
|---|---|
返回BufferMemoryBarrier指针。 |
Method |
|---|
virtual TextureMemoryBarrier* CreateTextureMemoryBarrier(const TextureMemoryBarrierInfo& textureMemoryBarrierInfo) const = 0 根据TextureMemoryBarrierInfo信息创建图像存储屏障对象。 |
Parameters
Name |
Description |
|---|---|
textureMemoryBarrierInfo |
Type |
Description |
|---|---|
返回TextureMemoryBarrier指针。 |
Method |
|---|
void DestroyBufferMemoryBarrier(const BufferMemoryBarrier* bufferMemoryBarrier) const 销毁传入的缓冲存储屏障对象。 |
Parameters
Name |
Description |
|---|---|
bufferMemoryBarrier |
要销毁的缓冲存储屏障对象。 |
Method |
|---|
void DestroyTextureMemoryBarrier(const TextureMemoryBarrier* textureMemoryBarrier) const 销毁传入的图像存储屏障对象。 |
Parameters
Name |
Description |
|---|---|
textureMemoryBarrier |
要销毁的图像存储屏障对象。 |
Method |
|---|
virtual Queue* CreateQueue(const QueueCreateInfo& queueCreateInfo) const = 0 根据QueueCreateInfo信息创建队列对象。 |
Parameters
Name |
Description |
|---|---|
queueCreateInfo |
Returns
Type |
Description |
|---|---|
返回创建的队列对象。 |
Method |
|---|
void DestroyQueue(Queue* queue) const 销毁传入的队列对象。 |
Parameters
Name |
Description |
|---|---|
queue |
要销毁的队列对象。 |
Method |
|---|
const Queue* GetDefaultQueue(QueueType queueType = QueueType::GRAPHICS) 根据QueueType获取默认的队列对象。 |
Parameters
Name |
Description |
|---|---|
queueType |
队列类型,具体请参见QueueType,默认为GRAPHICS。 |
Returns
Method |
|---|
virtual RenderPass* CreateRenderPass(const RenderPassCreateInfo& renderPassCreateInfo) const = 0 根据RenderPassCreateInfo信息创建渲染通道对象。 |
Parameters
Name |
Description |
|---|---|
renderPassCreateInfo |
Returns
Type |
Description |
|---|---|
返回创建的渲染通道对象。 |
Method |
|---|
void DestroyRenderPass(RenderPass* renderPass) const 销毁传入的渲染通道对象。 |
Parameters
Name |
Description |
|---|---|
renderPass |
要销毁的渲染通道对象。 |
Method |
|---|
virtual Buffer* CreateBuffer(const BufferCreateInfo& bufferCreateInfo) 根据BufferCreateInfo创建数据缓存区。 |
Parameters
Name |
Description |
|---|---|
bufferCreateInfo |
Returns
Type |
Description |
|---|---|
返回创建的数据缓存区对象。 |
Method |
|---|
void DestroyBuffer(Buffer* buffer) const 销毁传入的数据缓存区对象。 |
Parameters
Name |
Description |
|---|---|
buffer |
数据缓存区对象。 |
Method |
|---|
virtual Buffer* CreateBufferView(const BufferViewCreateInfo& bufferViewCreateInfo) 根据BufferViewCreateInfo创建数据缓存区切片。 |
Parameters
Name |
Description |
|---|---|
bufferViewCreateInfo |
Returns
Type |
Description |
|---|---|
返回创建的数据缓存区切片对象。 |
Method |
|---|
static GraphicsRenderer* CreateGraphicsRenderer(const GraphicsConfig* graphicsConfig) 创建GraphicsRenderer实例。 |
Parameters
Name |
Description |
|---|---|
graphicsConfig |
创建GraphicsRenderer实例需要的graphicsConfig信息。 |
Returns
Type |
Description |
|---|---|
返回创建的GraphicsRenderer对象。 |
Method |
|---|
virtual Texture* CreateTexture(const TextureCreateInfo& info) const 根据TextureCreateInfo创建纹理。 |
Parameters
Name |
Description |
|---|---|
info |
Returns
Type |
Description |
|---|---|
返回创建的纹理对象。 |
Method |
|---|
virtual Texture* CreateTextureView(const TextureViewCreateInfo& info) const 根据TextureViewCreateInfo创建纹理。 |
Parameters
Name |
Description |
|---|---|
info |
Returns
Type |
Description |
|---|---|
返回创建的纹理对象。 |
Method |
|---|
virtual Pipeline* CreatePipeline(const PipelineCreateInfo& createInfo) const = 0 根据PipelineCreateInfo创建管线。 |
Parameters
Name |
Description |
|---|---|
createInfo |
管线的创建信息。 |
Returns
Type |
Description |
|---|---|
返回创建的管线。 |
Method |
|---|
virtual PipelineLayout* CreatePipelineLayout(const PipelineLayoutCreateInfo& Info) const = 0 根据PipelineLayoutCreateInfo创建管线布局。 |
Parameters
Name |
Description |
|---|---|
Info |
管线布局的创建信息。 |
Returns
Type |
Description |
|---|---|
返回创建的管线布局。 |
Method |
|---|
virtual DescriptorSetLayout* CreateDescriptorSetLayout(const DescriptorSetLayoutCreateInfo& info) const = 0 根据DescriptorSetLayoutCreateInfo创建描述符集布局。 |
Parameters
Name |
Description |
|---|---|
info |
描述符集布局的创建信息。 |
Returns
Type |
Description |
|---|---|
返回创建的描述符集布局。 |
Method |
|---|
virtual DescriptorSet* CreateDescriptorSet(const DescriptorSetCreateInfo& info) const = 0 根据DescriptorSetCreateInfo创建管线布局。 |
Parameters
Name |
Description |
|---|---|
info |
描述符集的创建信息。 |
Returns
Type |
Description |
|---|---|
返回创建的描述符集。 |
Method |
|---|
virtual Pipeline* RequestPipeline(const PipelineCreateInfo& createInfo) const 根据PipelineCreateInfo信息获取缓存的Pipeline。 |
Parameters
Name |
Description |
|---|---|
createInfo |
Pipeline的创建信息。 |
Returns
Method |
|---|
virtual CommandBuffer* CreateCommandBuffer(const CommandBufferCreateInfo& info) = 0 根据CommandBufferCreateInfo创建命令缓冲。 |
Parameters
Name |
Description |
|---|---|
info |
Returns
Type |
Description |
|---|---|
返回创建的命令缓冲。 |
Method |
|---|
virtual void DestroyImage(void* image) const = 0 销毁Image。 |
Parameters
Name |
Description |
|---|---|
image |
要销毁的image。 |
Method |
|---|
virtual Sampler* CreateSampler(const SamplerCreateInfo& info) const = 0 根据SamplerCreateInfo创建采样器。 |
Parameters
Name |
Description |
|---|---|
info |
Returns
Type |
Description |
|---|---|
返回创建的采样器。 |
Method |
|---|
void DestroyTexture(Texture* texture) const 销毁纹理。 |
Parameters
Name |
Description |
|---|---|
texture |
要销毁的纹理。 |
Method |
|---|
void DestroyPipeline(Pipeline* pipeline) const 销毁管线。 |
Parameters
Name |
Description |
|---|---|
pipeline |
要销毁的管线对象。 |
Method |
|---|
void DestroyPipelineLayout (PipelineLayout* pipelineLayout) const 销毁管线布局。 |
Parameters
Name |
Description |
|---|---|
pipelineLayout |
要销毁的管线布局。 |
Method |
|---|
void DestroyShader(Shader* shader) const 销毁着色器。 |
Parameters
Name |
Description |
|---|---|
shader |
要销毁的着色器。 |
Method |
|---|
virtual void DestroySampler(Sampler* sampler) const = 0 销毁采样器。 |
Parameters
Name |
Description |
|---|---|
sampler |
要销毁的采样器。 |
Method |
|---|
virtual bool Initialize(const void* window) 初始化接口,用于相关资源的加载。 |
Parameters
Name |
Description |
|---|---|
window |
初始化对应的窗口信息。 |
Returns
Type |
Description |
|---|---|
bool |
初始化的结果。
|
Method |
|---|
virtual bool Resume(const void* winHandle, u32 width, u32 height) 应用从后台切回前台时,恢复系统运行相关资源的接口。 |
Parameters
Name |
Description |
|---|---|
winHandle |
窗口句柄。 |
width |
窗口的宽度。 |
height |
窗口的高度。 |
Returns
Type |
Description |
|---|---|
bool |
执行结果。
|
Method |
|---|
virtual bool Submit(const std::vector<CommandBuffer*>& vecCommandBuffers) = 0 提交命令缓冲。 |
Parameters
Name |
Description |
|---|---|
vecCommandBuffers |
命令缓冲集合。 |
Returns
Type |
Description |
|---|---|
bool |
提交命令缓冲结果。
|
Method |
|---|
virtual bool Begin() = 0 开始一帧的绘制,主要是通过交换链获取下一帧图像准备绘制。 |
Returns
Type |
Description |
|---|---|
bool |
执行结果。
|
Method |
|---|
virtual void Resize(u32 nWidth, u32 nHeight) 更改窗口大小。 |
Parameters
Name |
Description |
|---|---|
nWidth |
窗口的宽度。 |
nHeight |
窗口的高度。 |
Method |
|---|
virtual const Texture* GetDefaultTexture() const = 0 获取默认红色图像。 |
Returns
Type |
Description |
|---|---|
返回创建好的默认红色图像指针。 |
Method |
|---|
virtual f32 GetAspectRatio() const = 0 获取渲染窗口高宽比。 |
Returns
Type |
Description |
|---|---|
f32 |
当前窗口的高宽比。 |
Method |
|---|
virtual u32 GetScreenWidth() const = 0 获取屏幕宽度。 |
Returns
Type |
Description |
|---|---|
u32 |
当前窗口的宽。 |
Method |
|---|
virtual u32 GetScreenHeight() const = 0 获取屏幕高度。 |
Returns
Type |
Description |
|---|---|
u32 |
当前窗口的高。 |
Method |
|---|
virtual bool IsSafe(u64 frameNumber) const = 0 判断该帧是否合法。 |
Parameters
Name |
Description |
|---|---|
frameNumber |
帧索引。 |
Returns
Type |
Description |
|---|---|
bool |
返回是否合法。
|
Method |
|---|
virtual u32 GetSwapChainBufferCount() const = 0 获取交换链缓冲个数。 |
Returns
Type |
Description |
|---|---|
u32 |
返回交换链缓冲个数。 |
Method |
|---|
bool GetInitialized() const 获取当前的状态是否为已经完成初始化。 |
Returns
Type |
Description |
|---|---|
bool |
是否初已经始化。
|
Method |
|---|
u64 GetFrameNumber() const 获取当前帧的计数值。 |
Returns
Type |
Description |
|---|---|
u64 |
当前帧的计数值。 |
Method |
|---|
const GraphicsConfig* GetGraphicsConfig() const 获取GraphicsConfig。 |
Returns
Type |
Description |
|---|---|
GraphicsConfig* |
返回GraphicsConfig指针。 |
Method |
|---|
void DestroyCommandBuffer(CommandBuffer* commandBuffer) 销毁命令缓冲区。 |
Parameters
Name |
Description |
|---|---|
commandBuffer |
要销毁的CommandBuffer对象。 |
Method |
|---|
virtual void DestroyDescriptorSetLayout(DescriptorSetLayout* layout) const 销毁描述符集布局对象。 |
Parameters
Name |
Description |
|---|---|
layout |
要销毁的DescriptorSetLayout对象。 |
Method |
|---|
virtual void DestroyDescriptorSet(DescriptorSet* descriptorSet) const 销毁描述符集对象。 |
Parameters
Name |
Description |
|---|---|
descriptorSet |
要销毁的DescriptorSet对象。 |