All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

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 flags to stext:Vk*PipelineCreateInfo and {@link VkPipelineCacheCreateInfo} structures with the aim of improving the predictability of pipeline creation cost. The goal is to provide information about potentially expensive hazards within the client driver during pipeline creation to the application before carrying them out rather than after.
 * 
 * 
Background

 * 
 * 
Pipeline creation is a costly operation, and the explicit nature of the Vulkan design means that cost is not hidden from the developer. Applications are also expected to schedule, prioritize, and load balance all calls for pipeline creation. It is strongly advised that applications create pipelines sufficiently ahead of their usage. Failure to do so will result in an unresponsive application, intermittent stuttering, or other poor user experiences. Proper usage of pipeline caches and/or derivative pipelines help mitigate this but is not assured to eliminate disruption in all cases. In the event that an ahead-of-time creation is not possible, considerations should be taken to ensure that the current execution context is suitable for the workload of pipeline creation including possible shader compilation.

 * 
 * 
Applications making API calls to create a pipeline must be prepared for any of the following to occur:

 * 
 * 
    
 * 
  • OS/kernel calls to be made by the ICD
    • 
 * 
  • Internal memory allocation not tracked by the {@code pAllocator} passed to {@code vkCreate*Pipelines}
    • 
 * 
  • Internal thread synchronization or yielding of the current thread’s core
    • 
 * 
  • Extremely long (multi-millisecond+), blocking, compilation times
    • 
 * 
  • Arbitrary call stacks depths and stack memory usage
    • 
 * 

 * 
 * 
The job or task based game engines that are being developed to take advantage of explicit graphics APIs like Vulkan may behave exceptionally poorly if any of the above scenarios occur. However, most game engines are already built to “{@code stream}” in assets dynamically as the user plays the game. By adding control by way of {@code VkPipelineCreateFlags}, we can require an ICD to report back a failure in critical execution paths rather than forcing an unexpected wait.

 * 
 * 
Applications can prevent unexpected compilation by setting {@link #VK_PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT} on stext:Vk*PipelineCreateInfo{@code ::flags}. When set, an ICD must not attempt pipeline or shader compilation to create the pipeline object. The ICD will return the result {@link #VK_PIPELINE_COMPILE_REQUIRED_EXT PIPELINE_COMPILE_REQUIRED_EXT}. An ICD may still return a valid {@code VkPipeline} object by either re-using existing pre-compiled objects such as those from a pipeline cache, or derivative pipelines.

 * 
 * 
By default {@code vkCreate*Pipelines} calls must attempt to create all pipelines before returning. Setting {@link #VK_PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT} on stext:Vk*PipelineCreateInfo{@code ::flags} can be used as an escape hatch for batched pipeline creates.

 * 
 * 
Hidden locks also add to the unpredictability of the cost of pipeline creation. The most common case of locks inside the stext:vkCreate*Pipelines is internal synchronization of the {@code VkPipelineCache} object. {@link #VK_PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT} can be set when calling {@link VK10#vkCreatePipelineCache CreatePipelineCache} to state the cache is externally synchronized.

 * 
 * 
The hope is that armed with this information application and engine developers can leverage existing asset streaming systems to recover from "just-in-time" pipeline creation stalls.

 * 
 * 
VK_EXT_pipeline_creation_cache_control

 * 
 * 

 * 
Name String

 * 
{@code VK_EXT_pipeline_creation_cache_control}

 * 
Extension Type

 * 
Device extension

 * 
Registered Extension Number

 * 
298

 * 
Revision

 * 
3

 * 
Extension and Version Dependencies

 * 
    
 * 
  • Requires Vulkan 1.0
    • 
 * 

 * 
Contact

 * 

 * 

 * 
 * 
Other Extension Metadata

 * 
 * 

 * 
Last Modified Date

 * 
2020-03-23

 * 
IP Status

 * 
No known IP claims.

 * 
Contributors

 * 
    
 * 
  • Gregory Grebe, AMD
    • 
 * 
  • Tobias Hector, AMD
    • 
 * 
  • Matthaeus Chajdas, AMD
    • 
 * 
  • Mitch Singer, AMD
    • 
 * 
  • Spencer Fricke, Samsung Electronics
    • 
 * 
  • Stuart Smith, Imagination Technologies
    • 
 * 
  • Jeff Bolz, NVIDIA Corporation
    • 
 * 
  • Daniel Koch, NVIDIA Corporation
    • 
 * 
  • Dan Ginsburg, Valve Corporation
    • 
 * 
  • Jeff Leger, QUALCOMM
    • 
 * 
  • Michal Pietrasiuk, Intel
    • 
 * 
  • Jan-Harald Fredriksen, Arm Limited
    • 
 * 

 * 

 */
public final class EXTPipelineCreationCacheControl {

    /** The extension specification version. */
    public static final int VK_EXT_PIPELINE_CREATION_CACHE_CONTROL_SPEC_VERSION = 3;

    /** The extension name. */
    public static final String VK_EXT_PIPELINE_CREATION_CACHE_CONTROL_EXTENSION_NAME = "VK_EXT_pipeline_creation_cache_control";

    /** Extends {@code VkStructureType}. */
    public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_CREATION_CACHE_CONTROL_FEATURES_EXT = 1000297000;

    /**
     * Extends {@code VkPipelineCreateFlagBits}.
     * 
     * 
Enum values:

     * 
     * 
    
     * 
  • {@link #VK_PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT}
    • 
     * 
  • {@link #VK_PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT}
    • 
     * 

     */
    public static final int
        VK_PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT = 0x100,
        VK_PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT           = 0x200;

    /**
     * Extends {@code VkResult}.
     * 
     * 
Enum values:

     * 
     * 
    
     * 
  • {@link #VK_PIPELINE_COMPILE_REQUIRED_EXT PIPELINE_COMPILE_REQUIRED_EXT}
    • 
     * 
  • {@link #VK_ERROR_PIPELINE_COMPILE_REQUIRED_EXT ERROR_PIPELINE_COMPILE_REQUIRED_EXT}
    • 
     * 

     */
    public static final int
        VK_PIPELINE_COMPILE_REQUIRED_EXT       = 1000297000,
        VK_ERROR_PIPELINE_COMPILE_REQUIRED_EXT = 1000297000;

    /** Extends {@code VkPipelineCacheCreateFlagBits}. */
    public static final int VK_PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT = 0x1;

    private EXTPipelineCreationCacheControl() {}

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy