Skip to content

Commit

Permalink
Fixed docu of various interfaces.
Browse files Browse the repository at this point in the history
  • Loading branch information
LukasBanana committed Jul 24, 2020
1 parent d9be88f commit 30ccdb7
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
5 changes: 3 additions & 2 deletions include/LLGL/CommandBuffer.h
Expand Up @@ -241,17 +241,18 @@ class LLGL_EXPORT CommandBuffer : public RenderSystemChild
virtual void GenerateMips(Texture& texture) = 0;

/**
\brief Generates the specified range of MIP-maps for the specified texture.
\brief Generates a range of MIP-maps for the specified texture.
\param[in,out] texture Specifies the texture whose MIP-maps are to be generated.
This texture must have been created with the binding flags BindFlags::Sampled and BindFlags::ColorAttachment.
\param[in] subresource Specifies the texture subresource, i.e. the range of MIP-maps that are to be updated.
\remarks For performance reasons, it is recommended to encode this command outside of a render pass.
Otherwise, render pass interruptions might be inserted by LLGL.
\remarks This function guarantees to generate only the MIP-maps in the specified range (specified by \c subresource).
However, this function may introduce a performance penalty compared to generating MIP-maps using a texture view.
However, this function \e may introduce a performance penalty compared to generating the full MIP chain if texture views are not natively supported by the backend.
It is therefore recommended to use this function only if the range of MIP-maps is significantly smaller than the entire MIP chain,
e.g. only a single slice of a large 2D array texture, and use the primary \c GenerateMips function otherwise.
\see GenerateMips(Texture&)
\see RenderingFeatures::hasTextureViews
*/
virtual void GenerateMips(Texture& texture, const TextureSubresource& subresource) = 0;

Expand Down
3 changes: 1 addition & 2 deletions include/LLGL/PipelineLayout.h
Expand Up @@ -19,8 +19,7 @@ namespace LLGL

/**
\brief Pipeline layout interface.
\remarks An instance of this interface provides all descriptor sets (as called in Vulkan)
or descriptor heaps (as called in Direct3D 12) for graphics and compute pipelines.
\remarks An instance of this interface provides a layout for resource binding in a graphics or compute pipeline.
\see RenderSystem::CreatePipelineLayout
\see GraphicsPipelineDescriptor::pipelineLayout
\see ResourceHeapDescriptor::pipelineLayout
Expand Down
2 changes: 1 addition & 1 deletion include/LLGL/RenderContext.h
Expand Up @@ -38,7 +38,7 @@ class Display;
\brief Render context interface.
\remarks Each render context has its own surface and back buffer (or rather swap-chain) to draw into.
\see RenderSystem::CreateRenderContext
\see CommandBuffer::SetRenderTarget(RenderContext&)
\see CommandBuffer::BeginRenderPass
*/
class LLGL_EXPORT RenderContext : public RenderTarget
{
Expand Down
4 changes: 2 additions & 2 deletions include/LLGL/ResourceHeap.h
Expand Up @@ -19,8 +19,8 @@ namespace LLGL

/**
\brief Resource heap interface.
\remarks An instance of this interface provides a descriptor set (as called in Vulkan)
or descriptor heap (as called in Direct3D 12) for graphics and compute pipelines.
\remarks An instance of this interface provides all descriptor sets (as called in Vulkan)
or descriptor heaps (as called in Direct3D 12) for graphics and compute pipelines.
\see RenderSystem::CreateResourceHeap
\see CommandBuffer::SetResourceHeap
*/
Expand Down
4 changes: 2 additions & 2 deletions include/LLGL/Surface.h
Expand Up @@ -20,10 +20,10 @@ namespace LLGL


/**
\brief The Surface interface is the base interface for Window (on Desktop platforms) and Canvas (on movile platforms).
\brief The Surface interface is the base interface for Window (on Desktop platforms) and Canvas (on mobile platforms).
\remarks Surface provides the minimal required interface for a graphics rendering context,
such as the access to the native handle, information about the content size (i.e. the client area size),
and the ability to adapt for a new video mode or an updated pixel format.
and the ability to adapt for a new video mode or an updated pixel format
(which is required for multi-sampled framebuffers on a WGL context for instance).
\see Window
\see Canvas
Expand Down

0 comments on commit 30ccdb7

Please sign in to comment.