Package org.lwjgl.opengl

Class NVSampleLocations

  • public class NVSampleLocations
extends java.lang.Object
    Native bindings to the NV_sample_locations extension.

    This extension allows an application to modify the locations of samples within a pixel used in multisample rasterization. Additionally, it allows applications to specify different sample locations for each pixel in a group of adjacent pixels, which may increase antialiasing quality (particularly if a custom resolve shader is used that takes advantage of these different locations).

    It is common for implementations to optimize the storage of depth values by storing values that can be used to reconstruct depth at each sample location, rather than storing separate depth values for each sample. For example, the depth values from a single triangle can be represented using plane equations. When the depth value for a sample is needed, it is automatically evaluated at the sample location. Modifying the sample locations causes the reconstruction to no longer evaluate the same depth values as when the samples were originally generated. This extension provides a command to "resolve" and store per-sample depth values using the currently programmed sample locations, which allows the application to manage this issue if/when necessary.

    The programmable sample locations are used during rasterization and for evaluation of depth functions during normal geometric rendering. The programmable locations are associated with a framebuffer object rather than an individual depth buffer, so if the depth buffer is used as a texture the texture sampling may be done at the standard sample locations. Additionally, commands that do not render geometric primitives (e.g. ReadPixels, BlitFramebuffer, CopyTexSubImage2D, etc.) may use the standard sample locations to resolve depth functions rather than the programmable locations. If a single depth buffer is used at different times with different sample locations, the depth functions may be interpreted using the current sample locations.

    • Method Detail

      • nglFramebufferSampleLocationsfvNV

        public static void nglFramebufferSampleLocationsfvNV​(int target,
                                                     int start,
                                                     int count,
                                                     long v)
        Unsafe version of: FramebufferSampleLocationsfvNV
        Parameters:
        count - the number of sample locations to modify

      • glFramebufferSampleLocationsfvNV

        public static void glFramebufferSampleLocationsfvNV​(int target,
                                                    int start,
                                                    java.nio.FloatBuffer v)
        Updates the programmable sample locations
        Parameters:
        target - the framebuffer whose programmable sample locations are modified
        start - the index of the first sample location to modify
        v - a pair of floating point values in the range [0,1] for each sample location

      • nglNamedFramebufferSampleLocationsfvNV

        public static void nglNamedFramebufferSampleLocationsfvNV​(int framebuffer,
                                                          int start,
                                                          int count,
                                                          long v)
        Unsafe version of: NamedFramebufferSampleLocationsfvNV
        Parameters:
        count - the number of sample locations to modify

      • glNamedFramebufferSampleLocationsfvNV

        public static void glNamedFramebufferSampleLocationsfvNV​(int framebuffer,
                                                         int start,
                                                         java.nio.FloatBuffer v)
        Updates the programmable sample locations
        Parameters:
        framebuffer - the framebuffer whose programmable sample locations are modified
        start - the index of the first sample location to modify
        v - a pair of floating point values in the range [0,1] for each sample location

      • glResolveDepthValuesNV

        public static void glResolveDepthValuesNV()
        Evaluates depth values for all samples in the current depth buffer (subject to the pixel ownership and scissor tests) and stores each value in the depth buffer. This can be used to ensure that later accesses will use depth values consistent with the sample locations used when the samples were generated. If the current framebuffer has no depth buffer, ResolveDepthValuesNV will have no effect.

      • glFramebufferSampleLocationsfvNV

        public static void glFramebufferSampleLocationsfvNV​(int target,
                                                    int start,
                                                    float[] v)
        Array version of: FramebufferSampleLocationsfvNV

      • glNamedFramebufferSampleLocationsfvNV

        public static void glNamedFramebufferSampleLocationsfvNV​(int framebuffer,
                                                         int start,
                                                         float[] v)
        Array version of: NamedFramebufferSampleLocationsfvNV