Package com.ardor3d.example

Annotation Interface Purpose

@Target(TYPE) @Retention(RUNTIME) public @interface Purpose
a description of a class for the RunExamples (and maybe other tools)

  • Element Details

    • localisationBaseFile

      String localisationBaseFile
      Returns:
      The base filename of the localisation properties file to read html descriptions from.
      Default:
      "com/ardor3d/example/i18n/example_descriptions"

    • htmlDescriptionKey

      String htmlDescriptionKey
      Returns:
      The key of the description to load from the localisation properties file.
      Default:
      "com.ardor3d.example.NotSet"

    • thumbnailPath

      String thumbnailPath
      Returns:
      the resource path to a screenshot thumbnail, e.g. /com/ardor3d/example/thumbnails/boxexample.png
      Default:
      "com/ardor3d/example/media/images/ardor3d_white_256.jpg"

    • maxHeapMemory

      int maxHeapMemory
      Default value is 64.
      Returns:
      the value to use for max heap (in MB).
      Default:
      64