pub struct CubeTexture(/* private fields */);Expand description
Cloning is a handle copy.
Implementations§
Source§impl CubeTexture
impl CubeTexture
Sourcepub fn dispose(self)
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.
Sourcepub fn new(images: Vec<Image>) -> Self
pub fn new(images: Vec<Image>) -> Self
new CubeTexture(): CubeReflectionMapping, ClampToEdgeWrapping,
LinearFilter / LinearMipmapLinearFilter, RGBAFormat,
UnsignedByteType, NoColorSpace, flipY = false.
Sourcepub fn render_target(size: u32, texture_type: TextureType) -> Self
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.
Sourcepub fn set_color_space(&self, color_space: ColorSpace)
pub fn set_color_space(&self, color_space: ColorSpace)
texture.colorSpace = value.
Sourcepub fn color_space(&self) -> ColorSpace
pub fn color_space(&self) -> ColorSpace
texture.colorSpace.
Sourcepub fn set_texture_type(&self, texture_type: TextureType) -> Result<(), Error>
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.
Sourcepub fn texture_type(&self) -> TextureType
pub fn texture_type(&self) -> TextureType
texture.type.
Sourcepub fn set_generate_mipmaps(&self, generate_mipmaps: bool)
pub fn set_generate_mipmaps(&self, generate_mipmaps: bool)
texture.generateMipmaps = value.
Sourcepub fn set_mipmaps(&self, mipmaps: Vec<Vec<Image>>)
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.
Sourcepub fn clone_texture(&self) -> Self
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.
Sourcepub fn set_filters(&self, min_filter: MinFilter, mag_filter: TextureFilter)
pub fn set_filters(&self, min_filter: MinFilter, mag_filter: TextureFilter)
texture.minFilter / texture.magFilter.
Sourcepub fn gpu_format(&self) -> TextureFormat
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.
Sourcepub fn mip_level_count(&self) -> u32
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.
Sourcepub fn borrow(&self) -> Ref<'_, CubeTextureInner>
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
impl Clone for CubeTexture
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.
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.