Package apple.metal

Class MTLSamplerDescriptor

  • All Implemented Interfaces:
    NSCopying, NSObject
    public class MTLSamplerDescriptor
extends NSObject
implements NSCopying
    MTLSamplerDescriptor A mutable descriptor used to configure a sampler. When complete, this can be used to create an immutable MTLSamplerState.

    • Constructor Detail

      • MTLSamplerDescriptor

        protected MTLSamplerDescriptor​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        public static org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(java.lang.String key)

      • new_objc

        public static java.lang.Object new_objc()

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • compareFunction

        public long compareFunction()
        [@property] compareFunction Set the comparison function used when sampling shadow maps. The default value is MTLCompareFunctionNever.

      • copyWithZone

        public java.lang.Object copyWithZone​(org.moe.natj.general.ptr.VoidPtr zone)
        Specified by:
        copyWithZone in interface NSCopying

      • label

        public java.lang.String label()
        [@property] label A string to help identify the created object.

      • lodAverage

        public boolean lodAverage()
        [@property] lodAverage If YES, an average level of detail will be used when sampling from a texture. If NO, no averaging is performed. lodAverage defaults to NO. This option is a performance hint. An implementation is free to ignore this property.

      • lodMaxClamp

        public float lodMaxClamp()
        [@property] lodMaxClamp The maximum level of detail that will be used when sampling from a texture. The default value of lodMaxClamp is FLT_MAX. Clamp values are ignored for texture sample variants that specify an explicit level of detail.

      • lodMinClamp

        public float lodMinClamp()
        [@property] lodMinClamp The minimum level of detail that will be used when sampling from a texture. The default value of lodMinClamp is 0.0. Clamp values are ignored for texture sample variants that specify an explicit level of detail.

      • magFilter

        public long magFilter()
        [@property] magFilter Filter option for combining texels within a mipmap level the sample footprint is smaller than a pixel (magnification). The default value is MTLSamplerMinMagFilterNearest.

      • maxAnisotropy

        public long maxAnisotropy()
        [@property] maxAnisotropy The number of samples that can be taken to improve quality of sample footprints that are anisotropic. The default value is 1.

      • minFilter

        public long minFilter()
        [@property] minFilter Filter option for combining texels within a mipmap level the sample footprint is larger than a pixel (minification). The default value is MTLSamplerMinMagFilterNearest.

      • mipFilter

        public long mipFilter()
        [@property] mipFilter Filter options for filtering between two mipmap levels. The default value is MTLSamplerMipFilterNotMipmapped

      • normalizedCoordinates

        public boolean normalizedCoordinates()
        [@property] normalizedCoordinates. If YES, texture coordates are from 0 to 1. If NO, texture coordinates are 0..width, 0..height. normalizedCoordinates defaults to YES. Non-normalized coordinates should only be used with 1D and 2D textures with the ClampToEdge wrap mode, otherwise the results of sampling are undefined.

      • rAddressMode

        public long rAddressMode()
        [@property] rAddressMode Set the wrap mode for the R texture coordinate. The default value is MTLSamplerAddressModeClampToEdge.

      • sAddressMode

        public long sAddressMode()
        [@property] sAddressMode Set the wrap mode for the S texture coordinate. The default value is MTLSamplerAddressModeClampToEdge.

      • setCompareFunction

        public void setCompareFunction​(long value)
        [@property] compareFunction Set the comparison function used when sampling shadow maps. The default value is MTLCompareFunctionNever.

      • setLabel

        public void setLabel​(java.lang.String value)
        [@property] label A string to help identify the created object.

      • setLodAverage

        public void setLodAverage​(boolean value)
        [@property] lodAverage If YES, an average level of detail will be used when sampling from a texture. If NO, no averaging is performed. lodAverage defaults to NO. This option is a performance hint. An implementation is free to ignore this property.

      • setLodMaxClamp

        public void setLodMaxClamp​(float value)
        [@property] lodMaxClamp The maximum level of detail that will be used when sampling from a texture. The default value of lodMaxClamp is FLT_MAX. Clamp values are ignored for texture sample variants that specify an explicit level of detail.

      • setLodMinClamp

        public void setLodMinClamp​(float value)
        [@property] lodMinClamp The minimum level of detail that will be used when sampling from a texture. The default value of lodMinClamp is 0.0. Clamp values are ignored for texture sample variants that specify an explicit level of detail.

      • setMagFilter

        public void setMagFilter​(long value)
        [@property] magFilter Filter option for combining texels within a mipmap level the sample footprint is smaller than a pixel (magnification). The default value is MTLSamplerMinMagFilterNearest.

      • setMaxAnisotropy

        public void setMaxAnisotropy​(long value)
        [@property] maxAnisotropy The number of samples that can be taken to improve quality of sample footprints that are anisotropic. The default value is 1.

      • setMinFilter

        public void setMinFilter​(long value)
        [@property] minFilter Filter option for combining texels within a mipmap level the sample footprint is larger than a pixel (minification). The default value is MTLSamplerMinMagFilterNearest.

      • setMipFilter

        public void setMipFilter​(long value)
        [@property] mipFilter Filter options for filtering between two mipmap levels. The default value is MTLSamplerMipFilterNotMipmapped

      • setNormalizedCoordinates

        public void setNormalizedCoordinates​(boolean value)
        [@property] normalizedCoordinates. If YES, texture coordates are from 0 to 1. If NO, texture coordinates are 0..width, 0..height. normalizedCoordinates defaults to YES. Non-normalized coordinates should only be used with 1D and 2D textures with the ClampToEdge wrap mode, otherwise the results of sampling are undefined.

      • setRAddressMode

        public void setRAddressMode​(long value)
        [@property] rAddressMode Set the wrap mode for the R texture coordinate. The default value is MTLSamplerAddressModeClampToEdge.

      • setSAddressMode

        public void setSAddressMode​(long value)
        [@property] sAddressMode Set the wrap mode for the S texture coordinate. The default value is MTLSamplerAddressModeClampToEdge.

      • setTAddressMode

        public void setTAddressMode​(long value)
        [@property] tAddressMode Set the wrap mode for the T texture coordinate. The default value is MTLSamplerAddressModeClampToEdge.

      • tAddressMode

        public long tAddressMode()
        [@property] tAddressMode Set the wrap mode for the T texture coordinate. The default value is MTLSamplerAddressModeClampToEdge.

      • setSupportArgumentBuffers

        public void setSupportArgumentBuffers​(boolean value)
        [@property] supportArgumentBuffers true if the sampler can be used inside an argument buffer

      • supportArgumentBuffers

        public boolean supportArgumentBuffers()
        [@property] supportArgumentBuffers true if the sampler can be used inside an argument buffer

      • borderColor

        public long borderColor()
        [@property] borderColor Set the color for the MTLSamplerAddressMode to one of the predefined in the MTLSamplerBorderColor enum.

      • setBorderColor

        public void setBorderColor​(long value)
        [@property] borderColor Set the color for the MTLSamplerAddressMode to one of the predefined in the MTLSamplerBorderColor enum.