godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/RDPipelineSpecializationCon...

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

21 lines
1.3 KiB
XML
Raw Normal View History

Implement Specialization Constants * Added support to our local copy of SpirV Reflect (which does not support it). * Pass them on render or compute pipeline creation. * Not implemented in our shaders yet.
2021-07-09 19:48:28 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="RDPipelineSpecializationConstant" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Implement Specialization Constants * Added support to our local copy of SpirV Reflect (which does not support it). * Pass them on render or compute pipeline creation. * Not implemented in our shaders yet.
2021-07-09 19:48:28 +00:00
<brief_description>
Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation This brings the overall class reference completion percentage from 87% to 92%. (cherry picked from commit 5056c427d32218e85ad79d51788fa7583d48e293)
2023-03-28 15:32:29 +00:00
Pipeline specialization constant (used by [RenderingDevice]).
Implement Specialization Constants * Added support to our local copy of SpirV Reflect (which does not support it). * Pass them on render or compute pipeline creation. * Not implemented in our shaders yet.
2021-07-09 19:48:28 +00:00
</brief_description>
<description>
Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation This brings the overall class reference completion percentage from 87% to 92%. (cherry picked from commit 5056c427d32218e85ad79d51788fa7583d48e293)
2023-03-28 15:32:29 +00:00
A [i]specialization constant[/i] is a way to create additional variants of shaders without actually increasing the number of shader versions that are compiled. This allows improving performance by reducing the number of shader versions and reducing [code]if[/code] branching, while still allowing shaders to be flexible for different use cases.
This object is used by [RenderingDevice].
Implement Specialization Constants * Added support to our local copy of SpirV Reflect (which does not support it). * Pass them on render or compute pipeline creation. * Not implemented in our shaders yet.
2021-07-09 19:48:28 +00:00
</description>
<tutorials>
</tutorials>
<members>
<member name="constant_id" type="int" setter="set_constant_id" getter="get_constant_id" default="0">
Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation This brings the overall class reference completion percentage from 87% to 92%. (cherry picked from commit 5056c427d32218e85ad79d51788fa7583d48e293)
2023-03-28 15:32:29 +00:00
The identifier of the specialization constant. This is a value starting from [code]0[/code] and that increments for every different specialization constant for a given shader.
Implement Specialization Constants * Added support to our local copy of SpirV Reflect (which does not support it). * Pass them on render or compute pipeline creation. * Not implemented in our shaders yet.
2021-07-09 19:48:28 +00:00
</member>
<member name="value" type="Variant" setter="set_value" getter="get_value">
Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation This brings the overall class reference completion percentage from 87% to 92%. (cherry picked from commit 5056c427d32218e85ad79d51788fa7583d48e293)
2023-03-28 15:32:29 +00:00
The specialization constant's value. Only [bool], [int] and [float] types are valid for specialization constants.
Implement Specialization Constants * Added support to our local copy of SpirV Reflect (which does not support it). * Pass them on render or compute pipeline creation. * Not implemented in our shaders yet.
2021-07-09 19:48:28 +00:00
</member>
</members>
</class>