Skip to main content

CubeTexture

Struct CubeTexture 

Source
pub struct CubeTexture(/* private fields */);
Expand description

Cloning is a handle copy.

Implementations§

Source§

impl CubeTexture

Source

pub fn dispose(self)

cubeTexture.dispose() — drops this handle, and nothing more: a texture handle is an Rc, so the renderer frees the GPU side once every handle is gone, at the top of the next render (docs/scene-graph.md, “Identity and eviction”). Dropping the handle does the same; this exists so three.js code ports line for line.

Source

pub fn new(images: Vec<Image>) -> Self

new CubeTexture(): CubeReflectionMapping, ClampToEdgeWrapping, LinearFilter / LinearMipmapLinearFilter, RGBAFormat, UnsignedByteType, NoColorSpace, flipY = false.

Source

pub fn render_target(size: u32, texture_type: TextureType) -> Self

new CubeRenderTarget( size ).texture — six faces of the right shape and no pixels, to be rendered into rather than uploaded.

generateMipmaps is false and both filters are LinearFilter, which is what fromEquirectangularTexture copies off an HDRLoader texture, and what three’s own dump of webgpu_postprocessing_bloom_emissive shows: the 512² cube it converts the 1024×512 HDR into has mipLevelCount: 1.

Source

pub fn set_color_space(&self, color_space: ColorSpace)

texture.colorSpace = value.

Source

pub fn color_space(&self) -> ColorSpace

texture.colorSpace.

Source

pub fn mapping(&self) -> Mapping

texture.mapping.

Source

pub fn set_texture_type(&self, texture_type: TextureType) -> Result<(), Error>

texture.type = HalfFloatType, with the filters and mip policy HDRCubeTextureLoader sets alongside it left to the caller.

Source

pub fn texture_type(&self) -> TextureType

texture.type.

Source

pub fn set_generate_mipmaps(&self, generate_mipmaps: bool)

texture.generateMipmaps = value.

Source

pub fn set_mipmaps(&self, mipmaps: Vec<Vec<Image>>)

texture.mipmaps = [ … ] — hand-authored mip levels, level 1 first.

Each entry is the six faces of one level, in the images order; the page that uses this (webgpu_materials_cubemap_mipmaps) loads each level as its own CubeTexture and assigns texture.mipmaps the list of them after shift()-ing level 0 into images.

Source

pub fn clone_texture(&self) -> Self

texture.clone() — a new texture (new id, so its own GPU resource) over the same decoded faces, carrying every flag across, as Texture.copy() does. Distinct from Clone, which is three.js’ object identity: the same texture under another name.

Source

pub fn set_filters(&self, min_filter: MinFilter, mag_filter: TextureFilter)

texture.minFilter / texture.magFilter.

Source

pub fn gpu_format(&self) -> TextureFormat

WebGPUTextureUtils.getFormat() for RGBAFormat plus the texture’s type: the sRGB transfer function is applied by the GPU on sample, which is why WGSLNodeBuilder.needsToWorkingColorSpace() stays false and no colour-space node appears in the generated WGSL.

HalfFloatType has no sRGB variant and never wants one — the HDR faces are LinearSRGBColorSpace, i.e. the working space itself.

Source

pub fn mip_level_count(&self) -> u32

Textures.getMipLevels(), plus the isCubeTexture correction beside its call site in Textures.updateTexture().

needsMipmaps() is generateMipmaps === true || mipmaps.length > 0, so a texture with hand-supplied levels is mipmapped even with generateMipmaps = false. getMipLevels() then returns mipmaps.length, which for an uncompressed cube counts the mips only — hence if ( texture.isCubeTexture && texture.mipmaps.length > 0 ) options.levels ++, the + 1 for level 0. Nine levels for the angus 256² cube with its eight hand-authored mips, which is what three.js’ own descriptor says.

Source

pub fn size(&self) -> (u32, u32)

( image.width, image.height ) of face 0.

Source

pub fn id(&self) -> usize

texture.id — unique per texture, stable for its lifetime.

Source

pub fn borrow(&self) -> Ref<'_, CubeTextureInner>

The faces and the flags, as Texture::borrow() gives them — enough to assert the upload’s stride, face order and row order without a GPU.

Trait Implementations§

Source§

impl Clone for CubeTexture

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CubeTexture

The id is identity, not content: leaving it out keeps the Debug of a binding description — what examples/dump_wgsl.rs prints beside the WGSL — a function of the texture itself.

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<CubeTexture> for Background

Source§

fn from(texture: CubeTexture) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.