org.lwjgl.vulkan.EXTShaderSubgroupVote Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
There is a newer version: 3.3.4
Show newest version
/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.vulkan;

/**
 * This extension adds support for the following SPIR-V extension in Vulkan:
 * 
 * 
 * SPV_KHR_subgroup_vote
 * 
 * 
 * This extension provides new SPIR-V instructions:
 * 
 * 
 * {@code OpSubgroupAllKHR},
 * {@code OpSubgroupAnyKHR}, and
 * {@code OpSubgroupAllEqualKHR}.
 * 
 * 
 * to compute the composite of a set of boolean conditions across a group of shader invocations that are running concurrently (a subgroup). These composite results may be used to execute shaders more efficiently on a {@code VkPhysicalDevice}.
 * 
 * When using GLSL source-based shader languages, the following shader functions from GL_ARB_shader_group_vote can map to these SPIR-V instructions:
 * 
 * 
 * {@code anyInvocationARB}() → {@code OpSubgroupAnyKHR},
 * {@code allInvocationsARB}() → {@code OpSubgroupAllKHR}, and
 * {@code allInvocationsEqualARB}() → {@code OpSubgroupAllEqualKHR}.
 * 
 * 
 * The subgroup across which the boolean conditions are evaluated is implementation-dependent, and this extension provides no guarantee over how individual shader invocations are assigned to subgroups. In particular, a subgroup has no necessary relationship with the compute shader local workgroup -- any pair of shader invocations in a compute local workgroup may execute in different subgroups as used by these instructions.
 * 
 * Compute shaders operate on an explicitly specified group of threads (a local workgroup), but many implementations will also group non-compute shader invocations and execute them concurrently. When executing code like
 * 
 *  * if (condition) {
 *   result = do_fast_path();
 * } else {
 *   result = do_general_path();
 * }
 * 
 * where {@code condition} diverges between invocations, an implementation might first execute {@code do_fast_path}() for the invocations where {@code condition} is true and leave the other invocations dormant. Once {@code do_fast_path}() returns, it might call {@code do_general_path}() for invocations where {@code condition} is false and leave the other invocations dormant. In this case, the shader executes both the fast and the general path and might be better off just using the general path for all invocations.
 * 
 * This extension provides the ability to avoid divergent execution by evaluating a condition across an entire subgroup using code like:
 * 
 *  * if (allInvocationsARB(condition)) {
 *   result = do_fast_path();
 * } else {
 *   result = do_general_path();
 * }
 * 
 * The built-in function {@code allInvocationsARB}() will return the same value for all invocations in the group, so the group will either execute {@code do_fast_path}() or {@code do_general_path}(), but never both. For example, shader code might want to evaluate a complex function iteratively by starting with an approximation of the result and then refining the approximation. Some input values may require a small number of iterations to generate an accurate result ({@code do_fast_path}) while others require a larger number ({@code do_general_path}). In another example, shader code might want to evaluate a complex function ({@code do_general_path}) that can be greatly simplified when assuming a specific value for one of its inputs ({@code do_fast_path}).
 * 
 * 
 * Name String
 * {@code VK_EXT_shader_subgroup_vote}
 * Extension Type
 * Device extension
 * Registered Extension Number
 * 66
 * Revision
 * 1
 * Extension and Version Dependencies
 * 
 * Requires Vulkan 1.0
 * 
 * Contact
 * 
 * Daniel Koch @dgkoch
 * 
 * Last Modified Date
 * 2016-11-28
 * IP Status
 * No known IP claims.
 * Interactions and External Dependencies
 * 
 * This extension requires the SPV_KHR_subgroup_vote SPIR-V extension.
 * This extension requires the GL_ARB_shader_group_vote extension for GLSL source languages.
 * 
 * Contributors
 * 
 * Neil Henning, Codeplay
 * Daniel Koch, NVIDIA Corporation
 * 
 * 
 */
public final class EXTShaderSubgroupVote {

    /** The extension specification version. */
    public static final int VK_EXT_SHADER_SUBGROUP_VOTE_SPEC_VERSION = 1;

    /** The extension name. */
    public static final String VK_EXT_SHADER_SUBGROUP_VOTE_EXTENSION_NAME = "VK_EXT_shader_subgroup_vote";

    private EXTShaderSubgroupVote() {}

}