java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkSamplerCreateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSamplerCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a newly created sampler.
Description

Mapping of OpenGL to Vulkan filter modes

magFilter values of FILTER_NEAREST and FILTER_LINEAR directly correspond to GL_NEAREST and GL_LINEAR magnification filters. minFilter and mipmapMode combine to correspond to the similarly named OpenGL minification filter of GL_minFilter_MIPMAP_mipmapMode (e.g. minFilter of FILTER_LINEAR and mipmapMode of SAMPLER_MIPMAP_MODE_NEAREST correspond to GL_LINEAR_MIPMAP_NEAREST).

There are no Vulkan filter modes that directly correspond to OpenGL minification filters of GL_LINEAR or GL_NEAREST, but they can be emulated using SAMPLER_MIPMAP_MODE_NEAREST, minLod = 0, and maxLod = 0.25, and using minFilter = FILTER_LINEAR or minFilter = FILTER_NEAREST, respectively.

Note that using a maxLod of zero would cause magnification to always be performed, and the magFilter to always be used. This is valid, just not an exact match for OpenGL behavior. Clamping the maximum LOD to 0.25 allows the λ value to be non-zero and minification to be performed, while still always rounding down to the base level. If the minFilter and magFilter are equal, then using a maxLod of zero also works.

The maximum number of sampler objects which can be simultaneously created on a device is implementation-dependent and specified by the maxSamplerAllocationCount member of the VkPhysicalDeviceLimits structure.

Note

For historical reasons, if maxSamplerAllocationCount is exceeded, some implementations may return ERROR_TOO_MANY_OBJECTS. Exceeding this limit will result in undefined behavior, and an application should not rely on the use of the returned error code in order to identify when the limit is reached.

Since VkSampler is a non-dispatchable handle type, implementations may return the same handle for sampler state vectors that are identical. In such cases, all such objects would only count once against the maxSamplerAllocationCount limit.

Valid Usage
- The absolute value of mipLodBias must be less than or equal to VkPhysicalDeviceLimits::maxSamplerLodBias
- If the VK_KHR_portability_subset extension is enabled, and VkPhysicalDevicePortabilitySubsetFeaturesKHR::samplerMipLodBias is FALSE, mipLodBias must be zero
- maxLod must be greater than or equal to minLod
- If the anisotropic sampling feature is not enabled, anisotropyEnable must be FALSE
- If anisotropyEnable is TRUE, maxAnisotropy must be between 1.0 and VkPhysicalDeviceLimits::maxSamplerAnisotropy, inclusive
- If sampler Y′C_BC_R conversion is enabled and the potential format features of the sampler Y′C_BC_R conversion do not support FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT, minFilter and magFilter must be equal to the sampler Y′C_BC_R conversion’s chromaFilter
- If unnormalizedCoordinates is TRUE, minFilter and magFilter must be equal
- If unnormalizedCoordinates is TRUE, mipmapMode must be SAMPLER_MIPMAP_MODE_NEAREST
- If unnormalizedCoordinates is TRUE, minLod and maxLod must be zero
- If unnormalizedCoordinates is TRUE, addressModeU and addressModeV must each be either SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE or SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER
- If unnormalizedCoordinates is TRUE, anisotropyEnable must be FALSE
- If unnormalizedCoordinates is TRUE, compareEnable must be FALSE
- If any of addressModeU, addressModeV or addressModeW are SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER, borderColor must be a valid VkBorderColor value
- If sampler Y′C_BC_R conversion is enabled, addressModeU, addressModeV, and addressModeW must be SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, anisotropyEnable must be FALSE, and unnormalizedCoordinates must be FALSE
- The sampler reduction mode must be set to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE if sampler Y′C_BC_R conversion is enabled
- If samplerMirrorClampToEdge is not enabled, and if the VK_KHR_sampler_mirror_clamp_to_edge extension is not enabled, addressModeU, addressModeV and addressModeW must not be SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE
- If compareEnable is TRUE, compareOp must be a valid VkCompareOp value
- If either magFilter or minFilter is FILTER_CUBIC_EXT, anisotropyEnable must be FALSE
- If compareEnable is TRUE, the reductionMode member of VkSamplerReductionModeCreateInfo must be SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE
- If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then minFilter and magFilter must be equal
- If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then mipmapMode must be SAMPLER_MIPMAP_MODE_NEAREST
- If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then minLod and maxLod must be zero
- If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then addressModeU and addressModeV must each be either SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE or SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER
- If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then anisotropyEnable must be FALSE
- If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then compareEnable must be FALSE
- If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then unnormalizedCoordinates must be FALSE
- If borderColor is one of BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT, then a VkSamplerCustomBorderColorCreateInfoEXT must be included in the pNext chain
- If the customBorderColors feature is not enabled, borderColor must not be BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT
- If borderColor is one of BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT, and VkSamplerCustomBorderColorCreateInfoEXT::format is not FORMAT_UNDEFINED, VkSamplerCustomBorderColorCreateInfoEXT::customBorderColor must be within the range of values representable in format
- The maximum number of samplers with custom border colors which can be simultaneously created on a device is implementation-dependent and specified by the maxCustomBorderColorSamplers member of the VkPhysicalDeviceCustomBorderColorPropertiesEXT structure
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_SAMPLER_CREATE_INFO
- Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkSamplerBorderColorComponentMappingCreateInfoEXT, VkSamplerCustomBorderColorCreateInfoEXT, VkSamplerReductionModeCreateInfo, or VkSamplerYcbcrConversionInfo
- The sType value of each struct in the pNext chain must be unique
- flags must be a valid combination of VkSamplerCreateFlagBits values
- magFilter must be a valid VkFilter value
- minFilter must be a valid VkFilter value
- mipmapMode must be a valid VkSamplerMipmapMode value
- addressModeU must be a valid VkSamplerAddressMode value
- addressModeV must be a valid VkSamplerAddressMode value
- addressModeW must be a valid VkSamplerAddressMode value
See Also

CreateSampler

Layout
```
 struct VkSamplerCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkSamplerCreateFlags flags();
     VkFilter magFilter();
     VkFilter minFilter();
     VkSamplerMipmapMode mipmapMode();
     VkSamplerAddressMode addressModeU();
     VkSamplerAddressMode addressModeV();
     VkSamplerAddressMode addressModeW();
     float mipLodBias();
     VkBool32 anisotropyEnable();
     float maxAnisotropy();
     VkBool32 compareEnable();
     VkCompareOp compareOp();
     float minLod();
     float maxLod();
     VkBorderColor borderColor();
     VkBool32 unnormalizedCoordinates();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkSamplerCreateInfo.Buffer
An array of VkSamplerCreateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ADDRESSMODEU ADDRESSMODEV ADDRESSMODEW`	The struct member offsets.
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`ANISOTROPYENABLE BORDERCOLOR COMPAREENABLE COMPAREOP FLAGS MAGFILTER MAXANISOTROPY MAXLOD MINFILTER MINLOD MIPLODBIAS MIPMAPMODE PNEXT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE UNNORMALIZEDCOORDINATES`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VkSamplerCreateInfo(java.nio.ByteBuffer container)`	Creates a `VkSamplerCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`addressModeU()`	a `VkSamplerAddressMode` value specifying the addressing mode for U coordinates outside `[0,1)`.
`VkSamplerCreateInfo`	`addressModeU(int value)`	Sets the specified value to the `addressModeU()` field.
`int`	`addressModeV()`	a `VkSamplerAddressMode` value specifying the addressing mode for V coordinates outside `[0,1)`.
`VkSamplerCreateInfo`	`addressModeV(int value)`	Sets the specified value to the `addressModeV()` field.
`int`	`addressModeW()`	a `VkSamplerAddressMode` value specifying the addressing mode for W coordinates outside `[0,1)`.
`VkSamplerCreateInfo`	`addressModeW(int value)`	Sets the specified value to the `addressModeW()` field.
`boolean`	`anisotropyEnable()`	`TRUE` to enable anisotropic filtering, as described in the Texel Anisotropic Filtering section, or `FALSE` otherwise.
`VkSamplerCreateInfo`	`anisotropyEnable(boolean value)`	Sets the specified value to the `anisotropyEnable()` field.
`int`	`borderColor()`	a `VkBorderColor` value specifying the predefined border color to use.
`VkSamplerCreateInfo`	`borderColor(int value)`	Sets the specified value to the `borderColor()` field.
`static VkSamplerCreateInfo`	`calloc()`	Returns a new `VkSamplerCreateInfo` instance allocated with `memCalloc`.
`static VkSamplerCreateInfo.Buffer`	`calloc(int capacity)`	Returns a new `VkSamplerCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkSamplerCreateInfo.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSamplerCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSamplerCreateInfo`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSamplerCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSamplerCreateInfo`	`callocStack()`	Deprecated.
`static VkSamplerCreateInfo.Buffer`	`callocStack(int capacity)`	Deprecated.
`static VkSamplerCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkSamplerCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`boolean`	`compareEnable()`	`TRUE` to enable comparison against a reference value during lookups, or `FALSE` otherwise.
`VkSamplerCreateInfo`	`compareEnable(boolean value)`	Sets the specified value to the `compareEnable()` field.
`int`	`compareOp()`	a `VkCompareOp` value specifying the comparison function to apply to fetched data before filtering as described in the Depth Compare Operation section.
`VkSamplerCreateInfo`	`compareOp(int value)`	Sets the specified value to the `compareOp()` field.
`static VkSamplerCreateInfo`	`create()`	Returns a new `VkSamplerCreateInfo` instance allocated with `BufferUtils`.
`static VkSamplerCreateInfo.Buffer`	`create(int capacity)`	Returns a new `VkSamplerCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkSamplerCreateInfo`	`create(long address)`	Returns a new `VkSamplerCreateInfo` instance for the specified memory address.
`static VkSamplerCreateInfo.Buffer`	`create(long address, int capacity)`	Create a `VkSamplerCreateInfo.Buffer` instance at the specified memory.
`static VkSamplerCreateInfo`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkSamplerCreateInfo.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()`	a bitmask of `VkSamplerCreateFlagBits` describing additional parameters of the sampler.
`VkSamplerCreateInfo`	`flags(int value)`	Sets the specified value to the `flags()` field.
`int`	`magFilter()`	a `VkFilter` value specifying the magnification filter to apply to lookups.
`VkSamplerCreateInfo`	`magFilter(int value)`	Sets the specified value to the `magFilter()` field.
`static VkSamplerCreateInfo`	`malloc()`	Returns a new `VkSamplerCreateInfo` instance allocated with `memAlloc`.
`static VkSamplerCreateInfo.Buffer`	`malloc(int capacity)`	Returns a new `VkSamplerCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkSamplerCreateInfo.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSamplerCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSamplerCreateInfo`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSamplerCreateInfo` instance allocated on the specified `MemoryStack`.
`static VkSamplerCreateInfo`	`mallocStack()`	Deprecated.
`static VkSamplerCreateInfo.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static VkSamplerCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkSamplerCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`float`	`maxAnisotropy()`	the anisotropy value clamp used by the sampler when `anisotropyEnable` is `TRUE`.
`VkSamplerCreateInfo`	`maxAnisotropy(float value)`	Sets the specified value to the `maxAnisotropy()` field.
`float`	`maxLod()`	used to clamp the maximum of the computed LOD value.
`VkSamplerCreateInfo`	`maxLod(float value)`	Sets the specified value to the `maxLod()` field.
`int`	`minFilter()`	a `VkFilter` value specifying the minification filter to apply to lookups.
`VkSamplerCreateInfo`	`minFilter(int value)`	Sets the specified value to the `minFilter()` field.
`float`	`minLod()`	used to clamp the minimum of the computed LOD value.
`VkSamplerCreateInfo`	`minLod(float value)`	Sets the specified value to the `minLod()` field.
`float`	`mipLodBias()`	the bias to be added to mipmap LOD (level-of-detail) calculation and bias provided by image sampling functions in SPIR-V, as described in the Level-of-Detail Operation section.
`VkSamplerCreateInfo`	`mipLodBias(float value)`	Sets the specified value to the `mipLodBias()` field.
`int`	`mipmapMode()`	a `VkSamplerMipmapMode` value specifying the mipmap filter to apply to lookups.
`VkSamplerCreateInfo`	`mipmapMode(int value)`	Sets the specified value to the `mipmapMode()` field.
`static int`	`naddressModeU(long struct)`	Unsafe version of `addressModeU()`.
`static void`	`naddressModeU(long struct, int value)`	Unsafe version of `addressModeU`.
`static int`	`naddressModeV(long struct)`	Unsafe version of `addressModeV()`.
`static void`	`naddressModeV(long struct, int value)`	Unsafe version of `addressModeV`.
`static int`	`naddressModeW(long struct)`	Unsafe version of `addressModeW()`.
`static void`	`naddressModeW(long struct, int value)`	Unsafe version of `addressModeW`.
`static int`	`nanisotropyEnable(long struct)`	Unsafe version of `anisotropyEnable()`.
`static void`	`nanisotropyEnable(long struct, int value)`	Unsafe version of `anisotropyEnable`.
`static int`	`nborderColor(long struct)`	Unsafe version of `borderColor()`.
`static void`	`nborderColor(long struct, int value)`	Unsafe version of `borderColor`.
`static int`	`ncompareEnable(long struct)`	Unsafe version of `compareEnable()`.
`static void`	`ncompareEnable(long struct, int value)`	Unsafe version of `compareEnable`.
`static int`	`ncompareOp(long struct)`	Unsafe version of `compareOp()`.
`static void`	`ncompareOp(long struct, int value)`	Unsafe version of `compareOp`.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`static int`	`nmagFilter(long struct)`	Unsafe version of `magFilter()`.
`static void`	`nmagFilter(long struct, int value)`	Unsafe version of `magFilter`.
`static float`	`nmaxAnisotropy(long struct)`	Unsafe version of `maxAnisotropy()`.
`static void`	`nmaxAnisotropy(long struct, float value)`	Unsafe version of `maxAnisotropy`.
`static float`	`nmaxLod(long struct)`	Unsafe version of `maxLod()`.
`static void`	`nmaxLod(long struct, float value)`	Unsafe version of `maxLod`.
`static int`	`nminFilter(long struct)`	Unsafe version of `minFilter()`.
`static void`	`nminFilter(long struct, int value)`	Unsafe version of `minFilter`.
`static float`	`nminLod(long struct)`	Unsafe version of `minLod()`.
`static void`	`nminLod(long struct, float value)`	Unsafe version of `minLod`.
`static float`	`nmipLodBias(long struct)`	Unsafe version of `mipLodBias()`.
`static void`	`nmipLodBias(long struct, float value)`	Unsafe version of `mipLodBias`.
`static int`	`nmipmapMode(long struct)`	Unsafe version of `mipmapMode()`.
`static void`	`nmipmapMode(long struct, int value)`	Unsafe version of `mipmapMode`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`static int`	`nunnormalizedCoordinates(long struct)`	Unsafe version of `unnormalizedCoordinates()`.
`static void`	`nunnormalizedCoordinates(long struct, int value)`	Unsafe version of `unnormalizedCoordinates`.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkSamplerCreateInfo`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkSamplerCreateInfo`	`pNext(VkSamplerBorderColorComponentMappingCreateInfoEXT value)`	Prepends the specified `VkSamplerBorderColorComponentMappingCreateInfoEXT` value to the `pNext` chain.
`VkSamplerCreateInfo`	`pNext(VkSamplerCustomBorderColorCreateInfoEXT value)`	Prepends the specified `VkSamplerCustomBorderColorCreateInfoEXT` value to the `pNext` chain.
`VkSamplerCreateInfo`	`pNext(VkSamplerReductionModeCreateInfo value)`	Prepends the specified `VkSamplerReductionModeCreateInfo` value to the `pNext` chain.
`VkSamplerCreateInfo`	`pNext(VkSamplerReductionModeCreateInfoEXT value)`	Prepends the specified `VkSamplerReductionModeCreateInfoEXT` value to the `pNext` chain.
`VkSamplerCreateInfo`	`pNext(VkSamplerYcbcrConversionInfo value)`	Prepends the specified `VkSamplerYcbcrConversionInfo` value to the `pNext` chain.
`VkSamplerCreateInfo`	`pNext(VkSamplerYcbcrConversionInfoKHR value)`	Prepends the specified `VkSamplerYcbcrConversionInfoKHR` value to the `pNext` chain.
`VkSamplerCreateInfo`	`set(int sType, long pNext, int flags, int magFilter, int minFilter, int mipmapMode, int addressModeU, int addressModeV, int addressModeW, float mipLodBias, boolean anisotropyEnable, float maxAnisotropy, boolean compareEnable, int compareOp, float minLod, float maxLod, int borderColor, boolean unnormalizedCoordinates)`	Initializes this struct with the specified values.
`VkSamplerCreateInfo`	`set(VkSamplerCreateInfo src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkSamplerCreateInfo`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkSamplerCreateInfo`	`sType$Default()`	Sets the `STRUCTURE_TYPE_SAMPLER_CREATE_INFO` value to the `sType()` field.
`boolean`	`unnormalizedCoordinates()`	controls whether to use unnormalized or normalized texel coordinates to address texels of the image.
`VkSamplerCreateInfo`	`unnormalizedCoordinates(boolean value)`	Sets the specified value to the `unnormalizedCoordinates()` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, FLAGS, MAGFILTER, MINFILTER, MIPMAPMODE, ADDRESSMODEU, ADDRESSMODEV, ADDRESSMODEW, MIPLODBIAS, ANISOTROPYENABLE, MAXANISOTROPY, COMPAREENABLE, COMPAREOP, MINLOD, MAXLOD, BORDERCOLOR, UNNORMALIZEDCOORDINATES
    
    The struct member offsets.
- Constructor Detail
  - VkSamplerCreateInfo
```
public VkSamplerCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkSamplerCreateInfo instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    the type of this structure.
  - pNext
```
public long pNext()
```
    NULL or a pointer to a structure extending this structure.
  - flags
```
public int flags()
```
    a bitmask of VkSamplerCreateFlagBits describing additional parameters of the sampler.
  - magFilter
```
public int magFilter()
```
    a VkFilter value specifying the magnification filter to apply to lookups.
  - minFilter
```
public int minFilter()
```
    a VkFilter value specifying the minification filter to apply to lookups.
  - mipmapMode
```
public int mipmapMode()
```
    a VkSamplerMipmapMode value specifying the mipmap filter to apply to lookups.
  - addressModeU
```
public int addressModeU()
```
    a VkSamplerAddressMode value specifying the addressing mode for U coordinates outside [0,1).
  - addressModeV
```
public int addressModeV()
```
    a VkSamplerAddressMode value specifying the addressing mode for V coordinates outside [0,1).
  - addressModeW
```
public int addressModeW()
```
    a VkSamplerAddressMode value specifying the addressing mode for W coordinates outside [0,1).
  - mipLodBias
```
public float mipLodBias()
```
    the bias to be added to mipmap LOD (level-of-detail) calculation and bias provided by image sampling functions in SPIR-V, as described in the Level-of-Detail Operation section.
  - anisotropyEnable
```
public boolean anisotropyEnable()
```
    TRUE to enable anisotropic filtering, as described in the Texel Anisotropic Filtering section, or FALSE otherwise.
  - maxAnisotropy
```
public float maxAnisotropy()
```
    the anisotropy value clamp used by the sampler when anisotropyEnable is TRUE. If anisotropyEnable is FALSE, maxAnisotropy is ignored.
  - compareEnable
```
public boolean compareEnable()
```
    TRUE to enable comparison against a reference value during lookups, or FALSE otherwise.
    
    Note: Some implementations will default to shader state if this member does not match.
  - compareOp
```
public int compareOp()
```
    a VkCompareOp value specifying the comparison function to apply to fetched data before filtering as described in the Depth Compare Operation section.
  - minLod
```
public float minLod()
```
    used to clamp the minimum of the computed LOD value.
  - maxLod
```
public float maxLod()
```
    used to clamp the maximum of the computed LOD value. To avoid clamping the maximum value, set maxLod to the constant LOD_CLAMP_NONE.
  - borderColor
```
public int borderColor()
```
    a VkBorderColor value specifying the predefined border color to use.
  - unnormalizedCoordinates
```
public boolean unnormalizedCoordinates()
```
    controls whether to use unnormalized or normalized texel coordinates to address texels of the image. When set to TRUE, the range of the image coordinates used to lookup the texel is in the range of zero to the image size in each dimension. When set to FALSE the range of image coordinates is zero to one.
    When unnormalizedCoordinates is TRUE, images the sampler is used with in the shader have the following requirements:
    
    The viewType must be either IMAGE_VIEW_TYPE_1D or IMAGE_VIEW_TYPE_2D.
    
    The image view must have a single layer and a single mip level.
    
    When unnormalizedCoordinates is TRUE, image built-in functions in the shader that use the sampler have the following requirements:
    
    The functions must not use projection.
    
    The functions must not use offsets.
  - sType
```
public VkSamplerCreateInfo sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkSamplerCreateInfo sType$Default()
```
    Sets the STRUCTURE_TYPE_SAMPLER_CREATE_INFO value to the sType() field.
  - pNext
```
public VkSamplerCreateInfo pNext(long value)
```
    Sets the specified value to the pNext() field.
  - pNext
```
public VkSamplerCreateInfo pNext(VkSamplerBorderColorComponentMappingCreateInfoEXT value)
```
    Prepends the specified VkSamplerBorderColorComponentMappingCreateInfoEXT value to the pNext chain.
  - pNext
```
public VkSamplerCreateInfo pNext(VkSamplerCustomBorderColorCreateInfoEXT value)
```
    Prepends the specified VkSamplerCustomBorderColorCreateInfoEXT value to the pNext chain.
  - pNext
```
public VkSamplerCreateInfo pNext(VkSamplerReductionModeCreateInfo value)
```
    Prepends the specified VkSamplerReductionModeCreateInfo value to the pNext chain.
  - pNext
```
public VkSamplerCreateInfo pNext(VkSamplerReductionModeCreateInfoEXT value)
```
    Prepends the specified VkSamplerReductionModeCreateInfoEXT value to the pNext chain.
  - pNext
```
public VkSamplerCreateInfo pNext(VkSamplerYcbcrConversionInfo value)
```
    Prepends the specified VkSamplerYcbcrConversionInfo value to the pNext chain.
  - pNext
```
public VkSamplerCreateInfo pNext(VkSamplerYcbcrConversionInfoKHR value)
```
    Prepends the specified VkSamplerYcbcrConversionInfoKHR value to the pNext chain.
  - flags
```
public VkSamplerCreateInfo flags(int value)
```
    Sets the specified value to the flags() field.
  - magFilter
```
public VkSamplerCreateInfo magFilter(int value)
```
    Sets the specified value to the magFilter() field.
  - minFilter
```
public VkSamplerCreateInfo minFilter(int value)
```
    Sets the specified value to the minFilter() field.
  - mipmapMode
```
public VkSamplerCreateInfo mipmapMode(int value)
```
    Sets the specified value to the mipmapMode() field.
  - addressModeU
```
public VkSamplerCreateInfo addressModeU(int value)
```
    Sets the specified value to the addressModeU() field.
  - addressModeV
```
public VkSamplerCreateInfo addressModeV(int value)
```
    Sets the specified value to the addressModeV() field.
  - addressModeW
```
public VkSamplerCreateInfo addressModeW(int value)
```
    Sets the specified value to the addressModeW() field.
  - mipLodBias
```
public VkSamplerCreateInfo mipLodBias(float value)
```
    Sets the specified value to the mipLodBias() field.
  - anisotropyEnable
```
public VkSamplerCreateInfo anisotropyEnable(boolean value)
```
    Sets the specified value to the anisotropyEnable() field.
  - maxAnisotropy
```
public VkSamplerCreateInfo maxAnisotropy(float value)
```
    Sets the specified value to the maxAnisotropy() field.
  - compareEnable
```
public VkSamplerCreateInfo compareEnable(boolean value)
```
    Sets the specified value to the compareEnable() field.
  - compareOp
```
public VkSamplerCreateInfo compareOp(int value)
```
    Sets the specified value to the compareOp() field.
  - minLod
```
public VkSamplerCreateInfo minLod(float value)
```
    Sets the specified value to the minLod() field.
  - maxLod
```
public VkSamplerCreateInfo maxLod(float value)
```
    Sets the specified value to the maxLod() field.
  - borderColor
```
public VkSamplerCreateInfo borderColor(int value)
```
    Sets the specified value to the borderColor() field.
  - unnormalizedCoordinates
```
public VkSamplerCreateInfo unnormalizedCoordinates(boolean value)
```
    Sets the specified value to the unnormalizedCoordinates() field.
  - set
```
public VkSamplerCreateInfo set(int sType,
                               long pNext,
                               int flags,
                               int magFilter,
                               int minFilter,
                               int mipmapMode,
                               int addressModeU,
                               int addressModeV,
                               int addressModeW,
                               float mipLodBias,
                               boolean anisotropyEnable,
                               float maxAnisotropy,
                               boolean compareEnable,
                               int compareOp,
                               float minLod,
                               float maxLod,
                               int borderColor,
                               boolean unnormalizedCoordinates)
```
    Initializes this struct with the specified values.
  - set
```
public VkSamplerCreateInfo set(VkSamplerCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkSamplerCreateInfo malloc()
```
    Returns a new VkSamplerCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSamplerCreateInfo calloc()
```
    Returns a new VkSamplerCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSamplerCreateInfo create()
```
    Returns a new VkSamplerCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkSamplerCreateInfo create(long address)
```
    Returns a new VkSamplerCreateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSamplerCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSamplerCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkSamplerCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSamplerCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkSamplerCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSamplerCreateInfo.Buffer create(int capacity)
```
    Returns a new VkSamplerCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSamplerCreateInfo.Buffer create(long address,
                                                int capacity)
```
    Create a VkSamplerCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSamplerCreateInfo.Buffer createSafe(long address,
                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
@Deprecated
public static VkSamplerCreateInfo mallocStack()
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkSamplerCreateInfo callocStack()
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static VkSamplerCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkSamplerCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static VkSamplerCreateInfo.Buffer mallocStack(int capacity)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkSamplerCreateInfo.Buffer callocStack(int capacity)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static VkSamplerCreateInfo.Buffer mallocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkSamplerCreateInfo.Buffer callocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
  - malloc
```
public static VkSamplerCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSamplerCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkSamplerCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSamplerCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkSamplerCreateInfo.Buffer malloc(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSamplerCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkSamplerCreateInfo.Buffer calloc(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSamplerCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nmagFilter
```
public static int nmagFilter(long struct)
```
    Unsafe version of magFilter().
  - nminFilter
```
public static int nminFilter(long struct)
```
    Unsafe version of minFilter().
  - nmipmapMode
```
public static int nmipmapMode(long struct)
```
    Unsafe version of mipmapMode().
  - naddressModeU
```
public static int naddressModeU(long struct)
```
    Unsafe version of addressModeU().
  - naddressModeV
```
public static int naddressModeV(long struct)
```
    Unsafe version of addressModeV().
  - naddressModeW
```
public static int naddressModeW(long struct)
```
    Unsafe version of addressModeW().
  - nmipLodBias
```
public static float nmipLodBias(long struct)
```
    Unsafe version of mipLodBias().
  - nanisotropyEnable
```
public static int nanisotropyEnable(long struct)
```
    Unsafe version of anisotropyEnable().
  - nmaxAnisotropy
```
public static float nmaxAnisotropy(long struct)
```
    Unsafe version of maxAnisotropy().
  - ncompareEnable
```
public static int ncompareEnable(long struct)
```
    Unsafe version of compareEnable().
  - ncompareOp
```
public static int ncompareOp(long struct)
```
    Unsafe version of compareOp().
  - nminLod
```
public static float nminLod(long struct)
```
    Unsafe version of minLod().
  - nmaxLod
```
public static float nmaxLod(long struct)
```
    Unsafe version of maxLod().
  - nborderColor
```
public static int nborderColor(long struct)
```
    Unsafe version of borderColor().
  - nunnormalizedCoordinates
```
public static int nunnormalizedCoordinates(long struct)
```
    Unsafe version of unnormalizedCoordinates().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - nmagFilter
```
public static void nmagFilter(long struct,
                              int value)
```
    Unsafe version of magFilter.
  - nminFilter
```
public static void nminFilter(long struct,
                              int value)
```
    Unsafe version of minFilter.
  - nmipmapMode
```
public static void nmipmapMode(long struct,
                               int value)
```
    Unsafe version of mipmapMode.
  - naddressModeU
```
public static void naddressModeU(long struct,
                                 int value)
```
    Unsafe version of addressModeU.
  - naddressModeV
```
public static void naddressModeV(long struct,
                                 int value)
```
    Unsafe version of addressModeV.
  - naddressModeW
```
public static void naddressModeW(long struct,
                                 int value)
```
    Unsafe version of addressModeW.
  - nmipLodBias
```
public static void nmipLodBias(long struct,
                               float value)
```
    Unsafe version of mipLodBias.
  - nanisotropyEnable
```
public static void nanisotropyEnable(long struct,
                                     int value)
```
    Unsafe version of anisotropyEnable.
  - nmaxAnisotropy
```
public static void nmaxAnisotropy(long struct,
                                  float value)
```
    Unsafe version of maxAnisotropy.
  - ncompareEnable
```
public static void ncompareEnable(long struct,
                                  int value)
```
    Unsafe version of compareEnable.
  - ncompareOp
```
public static void ncompareOp(long struct,
                              int value)
```
    Unsafe version of compareOp.
  - nminLod
```
public static void nminLod(long struct,
                           float value)
```
    Unsafe version of minLod.
  - nmaxLod
```
public static void nmaxLod(long struct,
                           float value)
```
    Unsafe version of maxLod.
  - nborderColor
```
public static void nborderColor(long struct,
                                int value)
```
    Unsafe version of borderColor.
  - nunnormalizedCoordinates
```
public static void nunnormalizedCoordinates(long struct,
                                            int value)
```
    Unsafe version of unnormalizedCoordinates.

Class VkSamplerCreateInfo

Description

Mapping of OpenGL to Vulkan filter modes

Note

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, MAGFILTER, MINFILTER, MIPMAPMODE, ADDRESSMODEU, ADDRESSMODEV, ADDRESSMODEW, MIPLODBIAS, ANISOTROPYENABLE, MAXANISOTROPY, COMPAREENABLE, COMPAREOP, MINLOD, MAXLOD, BORDERCOLOR, UNNORMALIZEDCOORDINATES

Constructor Detail

VkSamplerCreateInfo

Method Detail

sizeof

sType

pNext

flags

magFilter

minFilter

mipmapMode

addressModeU

addressModeV

addressModeW

mipLodBias

anisotropyEnable

maxAnisotropy

compareEnable

compareOp

minLod

maxLod

borderColor

unnormalizedCoordinates

sType

sType$Default

pNext

pNext

pNext

pNext

pNext

pNext

pNext

flags

magFilter

minFilter

mipmapMode

addressModeU

addressModeV

addressModeW

mipLodBias

anisotropyEnable

maxAnisotropy

compareEnable

compareOp

minLod

maxLod

borderColor

unnormalizedCoordinates

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create