rojo/.cursor/rules/roblox/reference/engine/classes/Texture.yaml
2026-02-02 12:08:47 -06:00

157 lines
5.2 KiB
YAML

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
name: Texture
type: class
memory_category: GraphicsTexture
summary: |
Applies a repeating image texture to the face of a parent `Class.BasePart`.
description: |
A `Class.Texture` object applies a repeating image texture to the face of a
parent `Class.BasePart`. The affected face is dependent on the
`Class.Texture.Face|Face` property. Unlike `Class.Decal|Decals`, the texture
applied by a `Class.Texture` will repeat when the parent `Class.BasePart` is
resized, with the size of the repeating textures determined by the
`Class.Texture.StudsPerTileU|StudsPerTileU` and
`Class.Texture.StudsPerTileV|StudsPerTileV` properties.
The applied image texture is determined by its
`Class.Texture.ColorMapContent|ColorMapContent` property. For details on how
to upload images, see
[asset management](../../../projects/assets/index.md#asset-management).
For more information, review
[textures and decals](../../../parts/textures-decals.md). See also:
- `Class.Decal` for non-repeating surface images.
- `Class.MeshPart.TextureContent` to apply an image texture to a
`Class.MeshPart`.
- `Class.SurfaceGui` to apply an `Class.ImageLabel` or `Class.ImageButton` to
an in-experience 3D object.
code_samples: []
inherits:
- Decal
descendants: []
tags: []
deprecation_message: ''
properties:
- name: Texture.OffsetStudsU
summary: |
Determines the offset in studs of the rendered texture's horizontal
coordinate.
description: |
This property determines how far the rendered texture is offset on the
horizontal axis, in studs, as visualized
[here](../../../parts/textures-decals.md#offset-textures).
See also `Class.Texture.OffsetStudsV|OffsetStudsV`.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Appearance
serialization:
can_load: true
can_save: true
capabilities:
- Basic
- name: Texture.OffsetStudsV
summary: |
Determines the offset in studs of the rendered texture's vertical
coordinate.
description: |
This property determines how far the rendered texture is offset on the
vertical axis, in studs, as visualized
[here](../../../parts/textures-decals.md#offset-textures).
See also `Class.Texture.OffsetStudsU|OffsetStudsU`.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Appearance
serialization:
can_load: true
can_save: true
capabilities:
- Basic
- name: Texture.StudsPerTileU
summary: |
Sets the horizontal size, in studs, of the tiled image applied by the
`Class.Texture`.
description: |
Sets the horizontal size, in studs, of the tiled image applied by the
`Class.Texture`.
Larger values for this property will lead to the `Class.Texture` appearing
larger, and repeating less frequently. Unlike with `Class.Decal|Decals`,
the size of the repeated image is unaffected by the dimensions of the
`Class.BasePart`. Instead, resizing the `Class.BasePart` only increases
the number of times the texture repeats.
Note that this property can be set to very low values, but not zero. Also
note that the horizontal/vertical distinction is relative to the parent
`Class.BasePart` axis; therefore the `Class.Texture` will rotate along
with the `Class.BasePart`.
See also `Class.Texture.StudsPerTileV|StudsPerTileV`.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Appearance
serialization:
can_load: true
can_save: true
capabilities:
- Basic
- name: Texture.StudsPerTileV
summary: |
Sets the vertical size, in studs, of the tiled image applied by the
`Class.Texture`.
description: |
Sets the vertical size, in studs, of the tiled image applied by the
`Class.Texture`.
Larger values for this property will lead to the `Class.Texture` appearing
larger, and repeating less frequently. Unlike with `Class.Decal|Decals`,
the size of the repeated image is unaffected by the dimensions of the
`Class.BasePart`. Instead, resizing the `Class.BasePart` only increases
the number of times the texture repeats.
Note that this property can be set to very low values, but not zero. Also
note that the horizontal/vertical distinction is relative to the parent
`Class.BasePart` axis; therefore the `Class.Texture` will rotate along
with the `Class.BasePart`.
See also `Class.Texture.StudsPerTileU|StudsPerTileU`.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Appearance
serialization:
can_load: true
can_save: true
capabilities:
- Basic
methods: []
events: []
callbacks: []