% WARNING: THIS FILE IS GENERATED BY genSchemaDocs. DO NOT EDIT. % Generated: 03:26PM on February 19, 2026

(Volume)=

Volume

A renderable volume containing one or more volumetric data fields, used to represent a volume effect such as smoke or fire.

Volume inherits from GPrim and inherits GPrim and Imageable schema properties, so volumes are transformable, renderable, can have a material binding, etc.

Volume also contains any number of volumetric fields, specified via relationships to VolumeFieldBase-derived primitives using a namespace prefix of "field". The relationship names, such as "density", are used by the renderer to associate individual fields with the named input parameters on a volume shader.

For example, the following Volume defines a field relationship to an OpenVDBField asset. The field relationship name specifies that the OpenVDB asset contains data that the renderer and volume shader should use to render the optical density ("extinction") of the volume.

def Volume "Volume" (
)
{
    custom rel field:extinction = </Volume/densityVDB>
    uniform token purpose = "render"

    def OpenVDBAsset "densityVDB"
    {
        token fieldName = "density"
        asset filePath = @/vdbdata/smoke_plume.101.vdb@,
        }
    }
}

See {ref}usdVol_working_with_volumes for best practices when working with Volumes.

:depth: 2
:local:
:backlinks: none

(Volume_properties)=

Properties

(Volume_inheritedproperties_Gprim)=

Inherited Properties ({ref}Gprim)

(Volume_doubleSided)=

doubleSided

USD type: bool

Fallback value: False

(Volume_orientation)=

orientation

USD type: token

Fallback value: rightHanded

(Volume_primvars:displayColor)=

primvars:displayColor

USD type: color3f[]

(Volume_primvars:displayOpacity)=

primvars:displayOpacity

USD type: float[]

(Volume_inheritedproperties_Boundable)=

Inherited Properties ({ref}Boundable)

(Volume_extent)=

extent

USD type: float3[]

(Volume_inheritedproperties_Xformable)=

Inherited Properties ({ref}Xformable)

(Volume_xformOpOrder)=

xformOpOrder

USD type: token[]

(Volume_inheritedproperties_Imageable)=

Inherited Properties ({ref}Imageable)

(Volume_proxyPrim)=

proxyPrim

USD type: rel (relationship)

(Volume_purpose)=

purpose

USD type: token

Fallback value: default

(Volume_visibility)=

visibility

USD type: token

Fallback value: inherited