Record Class VkSamplerCreateInfo

java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkSamplerCreateInfo
All Implemented Interfaces:
IPointer, IVkSamplerCreateInfo
@ValueBasedCandidate @UnsafeConstructor public record VkSamplerCreateInfo(@NotNull MemorySegment segment) extends Record implements IVkSamplerCreateInfo

Represents a pointer to a VkSamplerCreateInfo structure in native memory.

Structure

typedef struct VkSamplerCreateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkSamplerCreateFlags flags; // optional
    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;
} VkSamplerCreateInfo;

Auto initialization

This structure has the following members that can be automatically initialized:

  • sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

See Also: