Struct gdnative::api::PanoramaSky

pub struct PanoramaSky { /* fields omitted */ }

core class PanoramaSky inherits Sky (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

PanoramaSky inherits methods from:

• Sky
• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl PanoramaSky

pub fn new() -> Ref<PanoramaSky, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn panorama(&self) -> Option<Ref<Texture, Shared>>

[Texture] to be applied to the PanoramaSky.

pub fn set_panorama(&self, texture: impl AsArg<Texture>)

[Texture] to be applied to the PanoramaSky.

Methods from Deref<Target = Sky>

pub const RADIANCE_SIZE_1024: i64

pub const RADIANCE_SIZE_128: i64

pub const RADIANCE_SIZE_2048: i64

pub const RADIANCE_SIZE_256: i64

pub const RADIANCE_SIZE_32: i64

pub const RADIANCE_SIZE_512: i64

pub const RADIANCE_SIZE_64: i64

pub const RADIANCE_SIZE_MAX: i64

pub fn radiance_size(&self) -> RadianceSize

The [Sky]'s radiance map size. The higher the radiance map size, the more detailed the lighting from the [Sky] will be.
			See [enum RadianceSize] constants for values.
			[b]Note:[/b] Some hardware will have trouble with higher radiance sizes, especially [constant RADIANCE_SIZE_512] and above. Only use such high values on high-end hardware.

pub fn set_radiance_size(&self, size: i64)

The [Sky]'s radiance map size. The higher the radiance map size, the more detailed the lighting from the [Sky] will be.
			See [enum RadianceSize] constants for values.
			[b]Note:[/b] Some hardware will have trouble with higher radiance sizes, especially [constant RADIANCE_SIZE_512] and above. Only use such high values on high-end hardware.

Trait Implementations

impl Debug for PanoramaSky

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

Formats the value using the given formatter.

impl Deref for PanoramaSky

type Target = Sky

The resulting type after dereferencing.

fn deref(&self) -> &Sky

Dereferences the value.

impl DerefMut for PanoramaSky

fn deref_mut(&mut self) -> &mut Sky

Mutably dereferences the value.

impl GodotObject for PanoramaSky

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for PanoramaSky

fn construct() -> Ref<PanoramaSky, Unique>

impl SubClass<Object> for PanoramaSky

impl SubClass<Reference> for PanoramaSky

impl SubClass<Resource> for PanoramaSky

impl SubClass<Sky> for PanoramaSky