Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- AESContext
- AStar2D
- AStar3D
- AStarGrid2D
- AudioEffectInstance (1)
- AudioSample
- AudioSamplePlayback
- AudioStreamPlayback (5)
- CameraFeed
- CharFXTransform
- ConfigFile
- Crypto
- DTLSServer
- DirAccess
- ENetConnection
- EditorContextMenuPlugin
- EditorDebuggerPlugin
- EditorDebuggerSession
- EditorExportPlatform (6)
- EditorExportPlugin
- EditorExportPreset
- EditorFeatureProfile
- EditorFileSystemImportFormatSupportQuery
- EditorInspectorPlugin
- EditorResourceConversionPlugin
- EditorResourcePreviewGenerator
- EditorResourceTooltipPlugin
- EditorSceneFormatImporter (4)
- EditorScenePostImport
- EditorScenePostImportPlugin
- EditorScript
- EditorTranslationParserPlugin
- EncodedObjectAsID
- EngineProfiler
- Expression
- FileAccess
- GLTFObjectModelProperty
- HMACContext
- HTTPClient
- HashingContext
- ImageFormatLoader (1)
- JavaClass
- JavaObject
- JavaScriptObject
- KinematicCollision2D
- KinematicCollision3D
- Lightmapper (1)
- MeshConvexDecompositionSettings
- MeshDataTool
- MultiplayerAPI (2)
- Mutex
- NavigationPathQueryParameters2D
- NavigationPathQueryParameters3D
- NavigationPathQueryResult2D
- NavigationPathQueryResult3D
- Node3DGizmo (1)
- OggPacketSequencePlayback
- OpenXRAPIExtension
- PCKPacker
- PackedDataContainerRef
- PacketPeer (8)
- PhysicsPointQueryParameters2D
- PhysicsPointQueryParameters3D
- PhysicsRayQueryParameters2D
- PhysicsRayQueryParameters3D
- PhysicsShapeQueryParameters2D
- PhysicsShapeQueryParameters3D
- PhysicsTestMotionParameters2D
- PhysicsTestMotionParameters3D
- PhysicsTestMotionResult2D
- PhysicsTestMotionResult3D
- RDAttachmentFormat
- RDFramebufferPass
- RDPipelineColorBlendState
- RDPipelineColorBlendStateAttachment
- RDPipelineDepthStencilState
- RDPipelineMultisampleState
- RDPipelineRasterizationState
- RDPipelineSpecializationConstant
- RDSamplerState
- RDShaderSource
- RDTextureFormat
- RDTextureView
- RDUniform
- RDVertexAttribute
- RandomNumberGenerator
- RegEx
- RegExMatch
- RenderSceneBuffers (2)
- RenderSceneBuffersConfiguration
- Resource (103)
- ResourceFormatLoader
- ResourceFormatSaver
- ResourceImporter (16)
- SceneState
- SceneTreeTimer
- Semaphore
- SkinReference
- StreamPeer (5)
- SurfaceTool
- TCPServer
- TLSOptions
- TextLine
- TextParagraph
- TextServer (1)
- Thread
- TranslationDomain
- TriangleMesh
- Tween
- Tweener (5)
- UDPServer
- UPNP
- UPNPDevice
- WeakRef
- WebRTCPeerConnection (1)
- XMLParser
- XRInterface (4)
- XRPose
- XRTracker (2)
- ZIPPacker
- ZIPReader
- Animation
- AnimationLibrary
- AnimationNode (6)
- AnimationNodeStateMachinePlayback
- AnimationNodeStateMachineTransition
- AudioBusLayout
- AudioEffect (17)
- AudioStream (10)
- BitMap
- BoneMap
- ButtonGroup
- CameraAttributes (2)
- ColorPalette
- Compositor
- CompositorEffect
- CryptoKey
- Curve
- Curve2D
- Curve3D
- EditorNode3DGizmoPlugin
- EditorSettings
- Environment
- Font (3)
- GDExtension
- GLTFAccessor
- GLTFAnimation
- GLTFBufferView
- GLTFCamera
- GLTFDocument (1)
- GLTFDocumentExtension (1)
- GLTFLight
- GLTFMesh
- GLTFNode
- GLTFPhysicsBody
- GLTFPhysicsShape
- GLTFSkeleton
- GLTFSkin
- GLTFSpecGloss
- GLTFState (1)
- GLTFTexture
- GLTFTextureSampler
- Gradient
- Image
- ImporterMesh
- InputEvent (6)
- JSON
- LabelSettings
- LightmapGIData
- Material (9)
- Mesh (4)
- MeshLibrary
- MissingResource
- MultiMesh
- NavigationMesh
- NavigationMeshSourceGeometryData2D
- NavigationMeshSourceGeometryData3D
- NavigationPolygon
- Noise (1)
- Occluder3D (5)
- OccluderPolygon2D
- OggPacketSequence
- OpenXRAction
- OpenXRActionMap
- OpenXRActionSet
- OpenXRBindingModifier (2)
- OpenXRHapticBase (1)
- OpenXRIPBinding
- OpenXRInteractionProfile
- PackedDataContainer
- PackedScene
- PhysicsMaterial
- PolygonPathFinder
- RDShaderFile
- RDShaderSPIRV
- RichTextEffect
- SceneReplicationConfig
- Script (3)
- Shader (1)
- ShaderInclude
- Shape2D (8)
- Shape3D (9)
- Shortcut
- SkeletonModification2D (7)
- SkeletonModificationStack2D
- SkeletonProfile (1)
- Skin
- Sky
- SpriteFrames
- StyleBox (4)
- SyntaxHighlighter (2)
- Texture (3)
- Theme
- TileMapPattern
- TileSet
- TileSetSource (2)
- Translation (1)
- VideoStream (1)
- VideoStreamPlayback
- VisualShaderNode (62)
- VoxelGIData
- World2D
- World3D
- X509Certificate
- CompressedTextureLayered (3)
- ImageTextureLayered (3)
- PlaceholderTextureLayered (3)
- TextureLayeredRD (3)
Table of contents
-
virtual const func _get_format() -> intImage.Format -
virtual const func _get_height() -> int -
virtual const func _get_layer_data(layer_index: int) -> Image -
virtual const func _get_layered_type() -> int -
virtual const func _get_layers() -> int -
virtual const func _get_width() -> int -
virtual const func _has_mipmaps() -> bool -
const func get_format() -> intImage.Format -
const func get_height() -> int -
const func get_layer_data(layer: int) -> Image -
const func get_layered_type() -> intTextureLayered.LayeredType -
const func get_layers() -> int -
const func get_width() -> int -
const func has_mipmaps() -> bool -
const LAYERED_TYPE_2D_ARRAY = 0 enum LayeredType -
const LAYERED_TYPE_CUBEMAP = 1 enum LayeredType -
const LAYERED_TYPE_CUBEMAP_ARRAY = 2 enum LayeredType -
enum LayeredType
TextureLayered #
is_refcounted, is_instantiable, resource, core, not_builtin_classes
Base class for texture types which contain the data of multiple Images. Each image is of the same size and format.
Base class for ImageTextureLayered and CompressedTextureLayered. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also Texture3D.
Data is set on a per-layer basis. For Texture2DArrays, the layer specifies the array layer.
All images need to have the same width, height and number of mipmap levels.
A TextureLayered can be loaded with ResourceLoader.load.
Internally, Godot maps these files to their respective counterparts in the target rendering driver (Vulkan, OpenGL3).
Members #
Methods #
virtual const func _get_format() -> intImage.Format#
Called when the TextureLayered's format is queried.
virtual const func _get_height() -> int#
Called when the TextureLayered's height is queried.
virtual const func _get_layer_data(layer_index: int) -> Image#
Called when the data for a layer in the TextureLayered is queried.
virtual const func _get_layered_type() -> int#
Called when the layers' type in the TextureLayered is queried.
virtual const func _get_layers() -> int#
Called when the number of layers in the TextureLayered is queried.
virtual const func _get_width() -> int#
Called when the TextureLayered's width queried.
virtual const func _has_mipmaps() -> bool#
Called when the presence of mipmaps in the TextureLayered is queried.
const func get_format() -> intImage.Format#
Returns the current format being used by this texture. See Image.Format for details.
const func get_height() -> int#
Returns the height of the texture in pixels. Height is typically represented by the Y axis.
const func get_layer_data(layer: int) -> Image#
Returns an Image resource with the data from specified layer.
const func get_layered_type() -> intTextureLayered.LayeredType#
Returns the TextureLayered's type. The type determines how the data is accessed, with cubemaps having special types.
const func get_width() -> int#
Returns the width of the texture in pixels. Width is typically represented by the X axis.
const func has_mipmaps() -> bool#
Returns true if the layers have generated mipmaps.
Annotations #
Constants #
const LAYERED_TYPE_2D_ARRAY = 0 enum LayeredType#
Texture is a generic Texture2DArray.
const LAYERED_TYPE_CUBEMAP = 1 enum LayeredType#
Texture is a Cubemap, with each side in its own layer (6 in total).
const LAYERED_TYPE_CUBEMAP_ARRAY = 2 enum LayeredType#
Texture is a CubemapArray, with each cubemap being made of 6 layers.
Constructors #
Enums #
LayeredType#
enum LayeredType {
LAYERED_TYPE_2D_ARRAY = 0,
LAYERED_TYPE_CUBEMAP = 1,
LAYERED_TYPE_CUBEMAP_ARRAY = 2,
}