Annotation Type VulkanAPIFunctionType


  • @Target(METHOD)
    @Repeatable(VulkanAPIFunctionsType.class)
    @Retention(RUNTIME)
    public @interface VulkanAPIFunctionType
    An annotation that indicates the original C API function to which the annotated method is analogous. This is useful both for documentation generation and for new users learning the API.
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String vulkanFunction  
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String api  
    • Element Detail

      • vulkanFunction

        java.lang.String vulkanFunction
        Returns:
        The name of the original C API function
      • api

        java.lang.String api
        Returns:
        The API to which this function belongs
        Default:
        "vulkan"