Annotation Interface 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
    String
    vulkanFunction
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    api
     

  • Element Details

    • api

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

    • vulkanFunction

      String vulkanFunction
      Returns:
      The name of the original C API function