Skip to main content

Module view

Module view 

Source

Modules§

composition
Resolution of per-camera CompositingSpace requests.
visibility
window

Structs§

ColorGrading
Configures filmic color grading parameters to adjust the image appearance.
ColorGradingGlobal
Filmic color grading values applied to the image as a whole (as opposed to individual sections, like shadows and highlights).
ColorGradingSection
A section of color grading values that can be selectively applied to shadows, midtones, and highlights.
ColorGradingUniform
The ColorGrading structure, packed into the most efficient form for the GPU.
ExtractedView
Describes a view in the render world.
ExtractedWindow
NoIndirectDrawing
Add this component to a camera to disable indirect mode.
PostProcessBindGroupCache
Caches the bind groups for each main textures used when making a post processing effect
PostProcessBindGroupCacheBuilder
Used to create a PostProcessBindGroupCache
PostProcessWrite
RenderExtractedShadowMapVisibleEntities
The entities that the CPU has determined are visible from a single shadow-casting light.
RenderExtractedVisibleEntities
The entities that the CPU has determined are visible from a single view or subview.
RenderExtractedVisibleEntitiesClass
The entities that the CPU has determined are visible from a single view or subview, for a single VisibilityClass.
RenderShadowLodOrigin
A resource, part of the render world, that stores the resolved origin for LOD selection for shadow maps of point and spot lights.
RenderShadowMapVisibleEntities
Collection of entities visible from a single light.
RenderVisibilityRangePlugin
A plugin that enables RenderVisibilityRangess, which allow entities to be hidden or shown based on distance to the camera.
RenderVisibilityRanges
Stores information related to VisibilityRanges in the render world.
RenderVisibleEntities
Stores a list of all entities that are visible from a single view or subview, as well as the change lists.
RenderVisibleEntitiesClass
Stores a list of all entities that are visible from a single view for a single VisibilityClass, as well as the change lists.
ResolveCompositingSpaces
The system set that writes ResolvedCompositingSpace. It runs in RenderSystems::CreateViews after sort_cameras. Readers in CreateViews should order after this set.
ResolvedCompositingSpace
The compositing space a camera view actually uses this frame, written by resolve_composition_spaces.
RetainedViewEntity
An identifier for a view that is stable across frames.
SurfaceData
ViewDepthStencilTexture
ViewPlugin
ViewTarget
ViewTargetAttachments
Contains OutputColorAttachment used for each target present on any view in the current frame, after being prepared by prepare_view_attachments. Users that want to override the default output color attachment for a specific target can do so by adding a OutputColorAttachment to this resource before prepare_view_targets is called.
ViewUniform
ViewUniformOffset
ViewUniforms
VisibilityExtractionSystemParam
A system parameter that goes on any render-world system that needs to extract entities into RenderVisibleEntities.
WindowRenderPlugin

Enums§

DebandDither
Enables a debanding shader that applies dithering to mitigate color banding in the final image for a given Camera entity.
Msaa
Component for configuring the number of samples for Multi-Sample Anti-Aliasing for a Camera.
Tonemapping
Optionally enables a tonemapping shader that attempts to map linear input stimulus into a perceptually uniform image for a given Camera entity.

Constants§

COLOR_TARGET_FORMAT_MASK_BITS
Mask bits (5-bit) for use in pipeline key bitfields.
VISIBILITY_RANGES_STORAGE_BUFFER_COUNT
We need at least 4 storage buffer bindings available to enable the visibility range buffer.

Traits§

CreatePostProcessBindGroup

Functions§

cleanup_view_targets_for_resize
clear_view_attachments
Clears the view target OutputColorAttachments.
collect_visible_cpu_culled_entities
Updates the RenderVisibleEntities and RenderShadowMapVisibleEntities components with the contents of the RenderExtractedVisibleEntities and the RenderExtractedShadowMapVisibleEntities components respectively.
composites_fullscreen
Whether a camera composites over the previous camera’s output and covers the whole render target. Decides membership in a compositing stack.
create_surfaces
Creates window surfaces.
extract_visibility_ranges
Extracts all VisibilityRange components from the main world to the render world and inserts them into RenderVisibilityRanges.
need_surface_configuration
prepare_view_attachments
Prepares the view target OutputColorAttachment for each view in the current frame.
prepare_view_targets
prepare_view_uniforms
prepare_windows
(re)configures window surfaces, and obtains a swapchain texture for rendering.
resolve_composition_spaces
Writes each camera view’s ResolvedCompositingSpace. Runs in ResolveCompositingSpaces.
texture_format_from_code
Decode a 5-bit code back into a TextureFormat.
texture_format_to_code
Encode a TextureFormat as a 5-bit code for use in pipeline key bitfields.
write_render_visibility_ranges
Writes the RenderVisibilityRanges table to the GPU.

Type Aliases§

VisibilityExtractionNoCpuCullingChangedQuery
The query, part of VisibilityExtractionSystemParam, that searches for entities with NoCpuCulling that might have changed visibility.