Struct SCNTechnique 

pub struct SCNTechnique { /* private fields */ }

Available on crate feature SCNTechnique only.

SCNTechnique represents a rendering process that may require multiple passes.

A technique is generally initialized from a Property List file. It can be set to any object that conforms to the SCNTechniqueSupport protocol.

See also Apple’s documentation

Implementations

impl SCNTechnique

pub unsafe fn techniqueWithDictionary( dictionary: &NSDictionary<NSString, AnyObject>, ) -> Option<Retained<SCNTechnique>>

Creates and returns a technique instance initialized with the specified dictionary.

Parameter dictionary: The dictionary representation of the technique.

The format of the dictionary is described below. Quoted strings can be any name of your choice. Tags are defined below. The passes are executed sequentially as specified in the “sequence” section. The definition of each pass is within the “passes” section. A pass may have inputs/outputs that reference targets or symbols defined in the “targets” and “symbols” section. The entries of the “symbols” section can be set/get and animated with SCNTechnique’s APIs below.

{ sequence: [“Pass1”, “Pass2”, …], passes: { “Pass1”: { outputs: <outputs

inputs: <inputs

draw: program: metalVertexShader: metalFragmentShader: colorStates: //optional depthStates: //optional stencilStates: //optional cullMode: //optional blendStates: //optional viewport: //optional pointOfView: //optional samples: //optional excludeCategoryMask: //optional includeCategoryMask: //optional }, “Pass2” : { […] } } symbols: { “symbol A”: { } […] } targets: { “target A”: { } […] },

//optional

bundle: <bundleIdentifier

, metalLibraryName: <metalLibraryName , }

<outputs

: The possible (and optional) keys with their possible associated values are: color: a string referencing a color render target. See . depth: a string referencing a depth render target. See . stencil: a string referencing a stencil render target. See .

<inputs

: The inputs are listed in a dictionary. The keys are the uniform name as specified in the program of this pass. The values can be a single string referencing a symbol or a semantic or a target OR a dictionary with the following structure:

{ target: ,

//optional: minificationFilter: linear, nearest magnificationFilter: linear, nearest mipFilter: linear, nearest, none wrapS: clamp, repeat, clampToBorder, mirror wrapT: clamp, repeat, clampToBorder, mirror wrapP: clamp, repeat, clampToBorder, mirror maxAnisotropy: a number }

(See SCNMaterialProperty for more documentation and default values of these optional parameters.)

A string referencing a target (i.e an entry in the top level “targets” dictionary) or one of the special strings below: COLOR The render target that represents that main color fragments that will be displayed on the screen ultimately. DEPTH The render target that represents that main depth fragments.

can be one of the following strings: DRAW_SCENE: render the entire scene DRAW_QUAD: render a fullscreen quad DRAW_NODE: render a node and its sub-tree. The node is specified by setting its name as the value for the key “node”.

Name of a program (a vertex shader + a fragment shader) located in the application bundle. The vertex shader must have the extension “vsh” and the fragment shader “fsh”.

Name of a METAL function to use as the vertex shader.

Name of a METAL function to use as the fragment shader.

A dictionary with the following optional keys: “clear” a boolean specifying whether the color target should be cleared or not “clearColor” a string specifying the clear color as 4 float (“red green blue alpha”), or the string “sceneBackground” to clear with the scene background color.

A dictionary with the following optional keys: “clear” a boolean specifying whether the depth target should be cleared or not “enableWrite” a boolean specifying whether writing to depth should be enabled or not. “enableRead” a boolean specifying whether reading from depth should be enabled or not. “func” a string specifying depth function to use. See for the possible values.

A dictionary with the following optional keys: “clear” a boolean specifying whether the stencil target should be cleared or not “enable” a boolean specifying whether writing to stencil should be enabled or not. “behavior” a dictionary describing the stencil behavior of the front face, or of both faces if no backFaceBehavior is specified. See for the format of this dictionary. “backFaceBehavior” a dictionary describing the behavior of the back face. See for the format of this dictionary.

A dictionary with the following optional keys: “depthFail” a string specifying the operation to do if the depth test fails. See for the possible values. “fail” a string specifying the operation to do if the stencil test fails. See for the possible values. “pass” a string specifying the operation to do if the stencil test passes. See for the possible values. “function” a string specifying the stencil test. See for the possible values. “readMask” a uint8_t number specifying a mask that is ANDed with both the reference value and the stored stencil value when the test is done “writeMask” a uint8_t number specifies a bit mask to enable and disable writing of individual bits in the stencil planes “referenceValue” a uint8_t number specifies the reference value for the stencil test. The initial value is 0.

A string specifying a stencil operation. It can be one of the following: keep, zero, replace, increment, decrement, invert, incrementWrap, decrementWrap

A string specifying a comparison function. It can be one of the following: never, always, equal, notEqual, less, lessEqual, greater, greaterEqual

A dictionary with the following optional keys: “enable” a boolean number specifying if the blending should be enabled or not. defaults to true. “colorSrc” a string specifying a blend mode. See “colorDst” a string specifying a blend mode. See “alphaSrc” a string specifying a blend mode. See “alphaDst” a string specifying a blend mode. See “colorOp” a string specifying a blend operation. See “alphaOp” a string specifying a blend operation. See In no Blend states are specified, then the blending is turned off.

A string specifying a blend mode. It can be one of the following: zero, one, srcColor, oneMinusSrcColor, srcAlpha, oneMinusSrcAlpha, dstColor, oneMinusDstColor, dstAlpha, oneMinusDstAlpha, constantColor, oneMinusConstantColor, constantAlpha, oneMinusConstantAlpha, alphaSaturate.

A string specifying a blend operation. It can be one of the following: add, substract, reverseSubstract, min, max.

A string specifying a cull mode. It can be one of the following: front, none, back.

A string specifying the viewport as 4 float.

A integer value representing a node category mask (see SCNNode’s categoryBitMask). if the key “excludeCategoryMask” is not specified then it defaults to 0. if the key “includeCategoryMask” is not specified then it defaults to all bits set. The DRAW_SCENE command will then render nodes that validate the following test (node.categoryBitMask & includeCategoryMask) & & !(excludeCategoryMask & node.categoryBitMask).

The name of a node, or “self” to reference the owner of the technique if any.

The number of samples (multisampling) used to render the pass.

A dictionary with the following optional keys and their possible associated values:

semantic: vertex, normal, color, texcoord, tangent, time, modelViewProjectionTransform, modelViewTransform, modelTransform, viewTransform, projectionTransform, normalTransform, modelViewProjectionInverseTransform, modelViewInverseTransform, modelInverseTransform, viewInverseTransform, projectionInverseTransform, normalInverseTransform

type: float, vec2, vec3, vec4, mat4, int, ivec2, ivec3, ivec4, mat3, sampler2D, none. Every types can also be an array of the given type by adding [N] where N is the number of elements in the array.

image: name of an image located in the application bundle. (only valid when type is sampler2D)

if a semantic is set, no type is required. Note that with Metal shaders you should not provide any semantic. Instead simply declare a struct in you shader and add the members you need named as specified in SceneKit/scn_metal.

For example for a per-node semantic:

struct MyStruct { float4x4 modelTransform; float4x4 modelViewProjectionTransform; }; then in your function add an argument that must be named “scn_node” to get the members automatically filed with node semantics (see the documentation in scn_metal).

A dictionary with the following optional keys and their possible associated values:

type: a string specifying the type of the render target. It can be one of the following: color, depth, stencil format: a string specifying the format of the render target. It can be:

• for color targets (if not specified defaults to the framebuffer’s pixel format)
• r8
• r16 // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• r16f
• r32f // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• rg8 // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• rg16
• rg16f // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• rg32f // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• rgba8 // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• rgba16 // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• rgba16f // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• rgba32f
• rgba (deprecated)
• for depth targets
• depth16 // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• depth24
• depth32f // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• for combined depth and stencil targets:
• depth24Unorm_stencil8 // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9
• depth32Float_stencil8 // Available since macOS 13, iOS 16, tvOS 16 and watchOS 9 scaleFactor: a float value (encapsulated in a NSNumber) that controls the size of the render target. Defaults to 1, which means 1x the size of the main viewport. size: a string with the format %dx%d that controls the size of the render target. persistent: a boolean that tells if this target should persist from one frame to the next. It permits to create temporal effects suchs as motion blur. Defaults to NO.

<bundleIdentifier

An optional bundle identifier to load metal programs from

<metalLibraryName

An optional metal library name to load metal programs from. The metallib file is located from the default or specified bundle using NSBundle pathForResource:ofType:.

Safety

dictionary generic should be of the correct type.

pub unsafe fn techniqueBySequencingTechniques( techniques: &NSArray<SCNTechnique>, ) -> Option<Retained<SCNTechnique>>

Creates and returns a technique by sequencing the passes from the specified techniques.

Parameter techniques: The techniques to sequence.

The passes from “techniques” are executed sequentially. The symbols and targets are merged. This allows to use the same uniform ad targets across multiple techniques.

pub unsafe fn handleBindingOfSymbol_usingBlock( &self, symbol: &NSString, block: SCNBindingBlock, )

Available on crate features SCNNode and SCNRenderer and SCNShadable and block2 only.

Sets the block to call at render time to bind the value for the specified symbol of the receiver.

Parameter symbol: The name of the symbol to bind a value for.

Parameter block: The block to call to bind the specified symbol.

The block will be called at every frame for every pass referencing the specified symbol.

Safety

block must be a valid pointer or null.

pub unsafe fn dictionaryRepresentation( &self, ) -> Retained<NSDictionary<NSString, AnyObject>>

Returns the dictionary representation of the technique.

pub unsafe fn objectForKeyedSubscript( &self, key: &AnyObject, ) -> Option<Retained<AnyObject>>

Safety

key should be of the correct type.

pub unsafe fn setObject_forKeyedSubscript( &self, obj: Option<&AnyObject>, key: &ProtocolObject<dyn NSCopying>, )

Safety

• obj should be of the correct type.
• key should be of the correct type.

pub unsafe fn library(&self) -> Option<Retained<ProtocolObject<dyn MTLLibrary>>>

Available on crate feature objc2-metal and non-watchOS only.

The Metal library to use to load the Metal programs specified in the technique description. Defaults to nil which corresponds to the default Metal library.

pub unsafe fn setLibrary( &self, library: Option<&ProtocolObject<dyn MTLLibrary>>, )

Available on crate feature objc2-metal and non-watchOS only.

Setter for library.

impl SCNTechnique

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for SCNTechnique

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for SCNTechnique

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<SCNTechnique> for SCNTechnique

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for SCNTechnique

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNTechnique

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNTechnique

const NAME: &'static str = "SCNTechnique"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<SCNTechnique as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for SCNTechnique

type Result = SCNTechnique

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for SCNTechnique

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for SCNTechnique

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for SCNTechnique

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for SCNTechnique

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNTechnique

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSCopying for SCNTechnique

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for SCNTechnique

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for SCNTechnique

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNTechnique

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for SCNTechnique

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl SCNAnimatable for SCNTechnique

unsafe fn addAnimation_forKey( &self, animation: &ProtocolObject<dyn SCNAnimationProtocol>, key: Option<&NSString>, )

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Adds and runs an animation

unsafe fn addAnimationPlayer_forKey( &self, player: &SCNAnimationPlayer, key: Option<&NSString>, )

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Add an animation player.

unsafe fn removeAllAnimations(&self)

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Remove all animations.

unsafe fn removeAllAnimationsWithBlendOutDuration(&self, duration: CGFloat)

where Self: Sized + Message,

Available on crate features SCNAnimation and objc2-core-foundation only.

Smoothly remove all animations.

unsafe fn removeAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Remove the animation with the given identifier.

unsafe fn removeAnimationForKey_blendOutDuration( &self, key: &NSString, duration: CGFloat, )

where Self: Sized + Message,

Available on crate features SCNAnimation and objc2-core-foundation only.

Smoothly remove the animation with the given identifier.

unsafe fn animationKeys(&self) -> Retained<NSArray<NSString>>

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Returns an array containing the keys of all animations currently attached to the receiver.

unsafe fn animationPlayerForKey( &self, key: &NSString, ) -> Option<Retained<SCNAnimationPlayer>>

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Returns the animation player with the given identifier

unsafe fn removeAnimationForKey_fadeOutDuration( &self, key: &NSString, duration: CGFloat, )

where Self: Sized + Message,

👎Deprecated

Available on crate features SCNAnimation and objc2-core-foundation only.

Smoothly remove the animation with the given identifier.

unsafe fn animationForKey( &self, key: &NSString, ) -> Option<Retained<CAAnimation>>

where Self: Sized + Message,

👎Deprecated

Available on crate feature SCNAnimation and crate feature objc2-quartz-core and non-watchOS only.

Returns the animation with the given identifier

unsafe fn pauseAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setPaused:] instead

Available on crate feature SCNAnimation only.

Pause the animation with the given identifier.

unsafe fn resumeAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setPaused:] instead

Available on crate feature SCNAnimation only.

Resume the animation with the given identifier.

unsafe fn setSpeed_forAnimationKey(&self, speed: CGFloat, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setSpeed:] instead

Available on crate features SCNAnimation and objc2-core-foundation only.

Update the animation speed of the animation with the given identifier.

unsafe fn isAnimationForKeyPaused(&self, key: &NSString) -> bool

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer paused] instead

Available on crate feature SCNAnimation only.

Returns whether the animation for the specified identifier is paused.

impl DowncastTarget for SCNTechnique

impl Eq for SCNTechnique