Struct shaderc::CompileOptions
source · [−]pub struct CompileOptions<'a> { /* private fields */ }
Expand description
An opaque object managing options to compilation.
Implementations
Returns a default-initialized compilation options object.
The default options are:
- Target environment: Vulkan
- Source language: GLSL
A return of None
indicates that there was an error initializing
the underlying options object.
Returns a copy of the given compilation options object.
A return of None
indicates that there was an error copying
the underlying options object.
Sets the target enviroment to env
, affecting which warnings or errors
will be issued.
The default is Vulkan if not set.
version
will be used for distinguishing between different versions
of the target environment.
Note that EnvVersion must be cast to u32 when calling set_target_env.
For example: options.set_target_env(shaderc::TargetEnv::Vulkan, shaderc::EnvVersion::Vulkan1_1 as u32);
Sets the target SPIR-V version. The generated module will use this version of SPIR-V. Each target environment determines what versions of SPIR-V it can consume. Defaults to the highest version of SPIR-V 1.0 which is required to be supported by the target environment. E.g. Default to SPIR-V 1.0 for Vulkan 1.0 and SPIR-V 1.3 for Vulkan 1.1.
Sets the source language.
The default is GLSL if not set.
Forces the GLSL language version
and profile
.
The version number is the same as would appear in the #version
directive in the source. Version and profile specified here
overrides the #version
directive in the source code. Use
GlslProfile::None
for GLSL versions that do not define profiles,
e.g., version below 150.
pub fn set_include_callback<F>(&mut self, f: F) where
F: Fn(&str, IncludeType, &str, usize) -> IncludeCallbackResult + 'a,
pub fn set_include_callback<F>(&mut self, f: F) where
F: Fn(&str, IncludeType, &str, usize) -> IncludeCallbackResult + 'a,
Sets the callback for handling the #include
directive.
The arguments to the callback are the name of the source being requested,
the type of include directive (Relative
for #include "foo"
, Standard
for #include <foo>
),
the name of the source containing the directive and the current include depth from the original
source.
The return value of the callback should be Ok
if the source was successfully found,
and an Err
containing some suitable error message to display otherwise. If the result is
Ok
, the resolved_name
of the ResolvedInclude
must be non-empty. All strings returned
from the callback must be convertible to CString
s, i.e. they must not contain the null
character. If these conditions are not met compilation will panic.
Behaviour note: If Err
is returned for a Relative
include request, the callback will be
tried again with Standard
, which is similar to include directive behaviour in C.
Sets the resource limit
to the given value
.
Sets whether the compiler should automatically assign bindings to uniforms that aren’t already explicitly bound in the shader source.
Sets whether the compiler should automatically remove sampler variables and convert image variables to combined image-sampler variables.
Sets whether the compiler should use HLSL IO mapping rules for bindings.
Defaults to false.
Sets whether the compiler should determine block member offsets using HLSL packing rules instead of standard GLSL rules.
Defaults to false. Only affects GLSL compilation. HLSL rules are always used when compiling HLSL.
Sets the base binding number used for for a resource type when automatically assigning bindings.
For GLSL compilation, sets the lowest automatically assigned number. For HLSL compilation, the regsiter number assigned to the resource is added to this specified base.
pub fn set_binding_base_for_stage(
&mut self,
shader_kind: ShaderKind,
resource_kind: ResourceKind,
base: u32
)
pub fn set_binding_base_for_stage(
&mut self,
shader_kind: ShaderKind,
resource_kind: ResourceKind,
base: u32
)
Like set_binding_base
, but only takes effect when compiling the given shader stage.
pub fn set_hlsl_register_set_and_binding(
&mut self,
register: &str,
set: &str,
binding: &str
)
pub fn set_hlsl_register_set_and_binding(
&mut self,
register: &str,
set: &str,
binding: &str
)
Sets a descriptor set and binding for an HLSL register in all shader stages.
Automatically assigns locations to shader inputs and outputs.
pub fn set_hlsl_register_set_and_binding_for_stage(
&mut self,
kind: ShaderKind,
register: &str,
set: &str,
binding: &str
)
pub fn set_hlsl_register_set_and_binding_for_stage(
&mut self,
kind: ShaderKind,
register: &str,
set: &str,
binding: &str
)
Like set_hlsl_register_set_and_binding
, but only takes effect when compiling
the given shader stage.
Sets whether the compiler should enable extension SPV_GOOGLE_hlsl_functionality1.
Sets whether the compiler should invert position.Y output in vertex shader.
Sets whether the compiler generates code for max and min builtins which, if given a NaN operand, will return the other operand. Similarly, the clamp builtin will favour the non-NaN operands, as if clamp were implemented as a composition of max and min.
Adds a predefined macro to the compilation options.
This has the same effect as passing -Dname=value
to the command-line
compiler. If value
is None
, it has the same effect as passing
-Dname
to the command-line compiler. If a macro definition with the
same name has previously been added, the value is replaced with the
new value.
Sets the optimization level to level
.
If mulitple invocations for this method, only the last one takes effect.
Sets the compiler mode to generate debug information in the output.
Sets the compiler mode to suppress warnings.
This overrides warnings-as-errors mode: when both suppress-warnings and warnings-as-errors modes are turned on, warning messages will be inhibited, and will not be emitted as error messages.
Sets the compiler mode to treat all warnings as errors.
Note that the suppress-warnings mode overrides this.