org.lwjgl.vulkan.AMDMemoryOverallocationBehavior 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 allows controlling whether explicit overallocation beyond the device memory heap sizes (reported by {@link VkPhysicalDeviceMemoryProperties}) is allowed or not. Overallocation may lead to performance loss and is not supported for all platforms.
 * 
 * VK_AMD_memory_overallocation_behavior
 * 
 * 
 * Name String
 * {@code VK_AMD_memory_overallocation_behavior}
 * Extension Type
 * Device extension
 * Registered Extension Number
 * 190
 * Revision
 * 1
 * Extension and Version Dependencies
 * 
 * Requires Vulkan 1.0
 * 
 * Contact
 * 
 * Martin Dinkov mdinkov
 * 
 * 
 * 
 * Other Extension Metadata
 * 
 * 
 * Last Modified Date
 * 2018-09-19
 * IP Status
 * No known IP claims.
 * Contributors
 * 
 * Martin Dinkov, AMD
 * Matthaeus Chajdas, AMD
 * Daniel Rakos, AMD
 * Jon Campbell, AMD
 * 
 * 
 */
public final class AMDMemoryOverallocationBehavior {

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

    /** The extension name. */
    public static final String VK_AMD_MEMORY_OVERALLOCATION_BEHAVIOR_EXTENSION_NAME = "VK_AMD_memory_overallocation_behavior";

    /** Extends {@code VkStructureType}. */
    public static final int VK_STRUCTURE_TYPE_DEVICE_MEMORY_OVERALLOCATION_CREATE_INFO_AMD = 1000189000;

    /**
     * VkMemoryOverallocationBehaviorAMD - Specify memory overallocation behavior
     * 
     * Description
     * 
     * 
     * {@link #VK_MEMORY_OVERALLOCATION_BEHAVIOR_DEFAULT_AMD MEMORY_OVERALLOCATION_BEHAVIOR_DEFAULT_AMD} lets the implementation decide if overallocation is allowed.
     * {@link #VK_MEMORY_OVERALLOCATION_BEHAVIOR_ALLOWED_AMD MEMORY_OVERALLOCATION_BEHAVIOR_ALLOWED_AMD} specifies overallocation is allowed if platform permits.
     * {@link #VK_MEMORY_OVERALLOCATION_BEHAVIOR_DISALLOWED_AMD MEMORY_OVERALLOCATION_BEHAVIOR_DISALLOWED_AMD} specifies the application is not allowed to allocate device memory beyond the heap sizes reported by {@link VkPhysicalDeviceMemoryProperties}. Allocations that are not explicitly made by the application within the scope of the Vulkan instance are not accounted for.
     * 
     * 
     * See Also
     * 
     * {@link VkDeviceMemoryOverallocationCreateInfoAMD}
     */
    public static final int
        VK_MEMORY_OVERALLOCATION_BEHAVIOR_DEFAULT_AMD    = 0,
        VK_MEMORY_OVERALLOCATION_BEHAVIOR_ALLOWED_AMD    = 1,
        VK_MEMORY_OVERALLOCATION_BEHAVIOR_DISALLOWED_AMD = 2;

    private AMDMemoryOverallocationBehavior() {}

}