Struct SCNProgram 

#[repr(C)]
pub struct SCNProgram { /* private fields */ }

Available on crate feature SCNShadable only.

A SCNProgram lets you specify custom shaders to use when rendering materials.

See also Apple’s documentation

Implementations

impl SCNProgram

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

Creates and initialize a program instance.

pub unsafe fn vertexShader(&self) -> Option<Retained<NSString>>

Determines the receiver’s vertex shader.

pub unsafe fn setVertexShader(&self, vertex_shader: Option<&NSString>)

Setter for vertexShader.

pub unsafe fn fragmentShader(&self) -> Option<Retained<NSString>>

Determines the receiver’s fragment shader.

pub unsafe fn setFragmentShader(&self, fragment_shader: Option<&NSString>)

Setter for fragmentShader.

pub unsafe fn tessellationControlShader(&self) -> Option<Retained<NSString>>

Determines the receiver’s tessellation control shader. Tessellation shaders require OpenGL Core Profile.

pub unsafe fn setTessellationControlShader( &self, tessellation_control_shader: Option<&NSString>, )

Setter for tessellationControlShader.

pub unsafe fn tessellationEvaluationShader(&self) -> Option<Retained<NSString>>

Determines the receiver’s tessellation evaluation shader. Tessellation shaders require OpenGL Core Profile.

pub unsafe fn setTessellationEvaluationShader( &self, tessellation_evaluation_shader: Option<&NSString>, )

Setter for tessellationEvaluationShader.

pub unsafe fn geometryShader(&self) -> Option<Retained<NSString>>

Determines the receiver’s geometry shader. Geometry shaders require OpenGL Core Profile.

pub unsafe fn setGeometryShader(&self, geometry_shader: Option<&NSString>)

Setter for geometryShader.

pub unsafe fn vertexFunctionName(&self) -> Option<Retained<NSString>>

Determines the receiver’s vertex function name.

The name of the vertex function (for Metal programs).

pub unsafe fn setVertexFunctionName( &self, vertex_function_name: Option<&NSString>, )

Setter for vertexFunctionName.

pub unsafe fn fragmentFunctionName(&self) -> Option<Retained<NSString>>

Determines the receiver’s fragment function name.

The name of the fragment function (for Metal programs).

pub unsafe fn setFragmentFunctionName( &self, fragment_function_name: Option<&NSString>, )

Setter for fragmentFunctionName.

pub unsafe fn handleBindingOfBufferNamed_frequency_usingBlock( &self, name: &NSString, frequency: SCNBufferFrequency, block: SCNBufferBindingBlock, )

Available on crate features SCNNode and SCNRenderer and block2 only.

Sets the block to call at render time to bind the buffer of the specified symbol of the receiver’s program.

Parameter name: The name of the buffer to bind.

Parameter frequency: The frequency at which the block has to be invoked. Can be per frame, per node or per geometry or material. See SCNBufferBindingBlock above.

Parameter block: The block that binds the buffer.

This method can only be used with Metal based programs.

pub unsafe fn isOpaque(&self) -> bool

Determines the receiver’s fragment are opaque or not. Defaults to YES.

pub unsafe fn setOpaque(&self, opaque: bool)

Setter for isOpaque.

pub unsafe fn setSemantic_forSymbol_options( &self, semantic: Option<&NSString>, symbol: &NSString, options: Option<&NSDictionary<NSString, AnyObject>>, )

Associates a SceneKit semantic to a symbol.

Parameter semantic: The SceneKit semantic to associate to the specified symbol.

Parameter symbol: A symbol from the program source code.

Parameter options: An optional dictionary. See the ‘Semantic options’ above.

Associates semantics handled by the SceneKit runtime to a symbol from the program. Supported semantics are listed in SCNGeometry.h and SCNNode.h.

pub unsafe fn semanticForSymbol( &self, symbol: &NSString, ) -> Option<Retained<NSString>>

Retrieves the SceneKit semantic associated to a symbol from the program source code.

Parameter symbol: A symbol from the program source code.

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn SCNProgramDelegate>>>

Determines the receiver’s delegate

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn SCNProgramDelegate>>, )

Setter for delegate.

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

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

Specifies the Metal library to use to locate the function names specified above.

If set to nil the default library is used. Defaults to nil.

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

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

Setter for library.

impl SCNProgram

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 SCNProgram

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNProgram

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNProgram> for SCNProgram

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNProgram

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNProgram

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNProgram

const NAME: &'static str = "SCNProgram"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<SCNProgram 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 SCNProgram

type Result = SCNProgram

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

impl Debug for SCNProgram

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

Formats the value using the given formatter.

impl Deref for SCNProgram

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNProgram

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 SCNProgram

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNProgram

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSCopying for SCNProgram

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 SCNProgram

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 SCNProgram

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNProgram

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 SCNProgram

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

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

impl DowncastTarget for SCNProgram

impl Eq for SCNProgram