Skip to content

Commit 75c9562

Browse files
update Open Source Docs from Roblox internal teams
1 parent 19eb62d commit 75c9562

File tree

2 files changed

+70
-75
lines changed

2 files changed

+70
-75
lines changed

content/en-us/reference/engine/classes/CaptureService.yaml

Lines changed: 41 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -58,21 +58,6 @@ methods:
5858
thread_safety: Unsafe
5959
capabilities: []
6060
writeCapabilities: []
61-
- name: CaptureService:GetDeviceInfo
62-
summary: ''
63-
description: ''
64-
code_samples: []
65-
parameters: []
66-
returns:
67-
- type: Dictionary
68-
summary: ''
69-
tags: []
70-
deprecation_message: ''
71-
security: None
72-
thread_safety: Unsafe
73-
capabilities:
74-
- InternalTest
75-
writeCapabilities: []
7661
- name: CaptureService:PromptSaveCapturesToGallery
7762
summary: |
7863
Prompts the user to save specified captures to their gallery.
@@ -149,47 +134,6 @@ methods:
149134
thread_safety: Unsafe
150135
capabilities: []
151136
writeCapabilities: []
152-
- name: CaptureService:StopVideoCapture
153-
summary: |
154-
Ends a video capture initiated by
155-
`Class.CaptureService:StartVideoCaptureAsync()|StartVideoCaptureAsync()`.
156-
description: |
157-
This method ends a video capture that was started by the
158-
`Class.CaptureService:StartVideoCaptureAsync()|StartVideoCaptureAsync()`
159-
method.
160-
code_samples: []
161-
parameters: []
162-
returns:
163-
- type: ()
164-
summary: ''
165-
tags: []
166-
deprecation_message: ''
167-
security: None
168-
thread_safety: Unsafe
169-
capabilities: []
170-
writeCapabilities: []
171-
- name: CaptureService:TakeCapture
172-
summary: ''
173-
description: ''
174-
code_samples: []
175-
parameters:
176-
- name: onCaptureReady
177-
type: Function
178-
default:
179-
summary: ''
180-
- name: captureParams
181-
type: Dictionary
182-
default: nil
183-
summary: ''
184-
returns:
185-
- type: ()
186-
summary: ''
187-
tags: []
188-
deprecation_message: ''
189-
security: None
190-
thread_safety: Unsafe
191-
capabilities: []
192-
writeCapabilities: []
193137
- name: CaptureService:StartVideoCaptureAsync
194138
summary: |
195139
Initiates a video capture recording.
@@ -246,6 +190,47 @@ methods:
246190
thread_safety: Unsafe
247191
capabilities: []
248192
writeCapabilities: []
193+
- name: CaptureService:StopVideoCapture
194+
summary: |
195+
Ends a video capture initiated by
196+
`Class.CaptureService:StartVideoCaptureAsync()|StartVideoCaptureAsync()`.
197+
description: |
198+
This method ends a video capture that was started by the
199+
`Class.CaptureService:StartVideoCaptureAsync()|StartVideoCaptureAsync()`
200+
method.
201+
code_samples: []
202+
parameters: []
203+
returns:
204+
- type: ()
205+
summary: ''
206+
tags: []
207+
deprecation_message: ''
208+
security: None
209+
thread_safety: Unsafe
210+
capabilities: []
211+
writeCapabilities: []
212+
- name: CaptureService:TakeCapture
213+
summary: ''
214+
description: ''
215+
code_samples: []
216+
parameters:
217+
- name: onCaptureReady
218+
type: Function
219+
default:
220+
summary: ''
221+
- name: captureParams
222+
type: Dictionary
223+
default: nil
224+
summary: ''
225+
returns:
226+
- type: ()
227+
summary: ''
228+
tags: []
229+
deprecation_message: ''
230+
security: None
231+
thread_safety: Unsafe
232+
capabilities: []
233+
writeCapabilities: []
249234
events:
250235
- name: CaptureService.CaptureBegan
251236
summary: |

content/en-us/reference/engine/classes/GenerationService.yaml

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,17 @@ memory_category: Instances
44
summary: |
55
Service that allows developers to generate 3D objects from text prompts.
66
description: |
7-
`GenerationService` allows developers to generate 3D objects from text
8-
prompts. Mesh generation is a two step process:
7+
`GenerationService` enables you to generate 3D objects from text prompts using
8+
Roblox's Cube 3D foundation model. This enables the generation of objects like
9+
environmental props in-experience.
10+
11+
You can control the output by providing an optional `Datatype.Vector3` to the
12+
`SuggestedSize` parameter. Rather than simply rescaling the result, this
13+
parameter guides the model during the creation process, influencing it to
14+
create a mesh that attempts to match the proportions and size of your
15+
specified bounding box.
16+
17+
Mesh generation is a two step process:
918
1019
1. `Class.GenerationService:GenerateMeshAsync()|GenerateMeshAsync()` starts
1120
the mesh generation process using a text prompt and other required
@@ -31,10 +40,10 @@ description: |
3140
`Class.EditableMesh` content and only on the client, it is not replicated to
3241
any other clients.
3342
34-
The following code samples illustrate this design pattern. See
35-
[this demo experience](https://www.roblox.com/games/86571743597273/Mesh-Generation-Template)
36-
for a more detailed example (click the **⋯** button and **Edit in
37-
Studio**).
43+
See
44+
[this demo experience](https://www.roblox.com/games/108838517877898/SuggestedSize-Generation-Template)
45+
for a more detailed example including usage of the `SuggestedSize` option
46+
(click the **⋯** button and **Edit in Studio**).
3847
code_samples:
3948
- GenerationService-ServerSideMeshGeneration
4049
- GenerationService-ClientSideMeshGeneration
@@ -64,14 +73,14 @@ methods:
6473
6574
**Error Codes**
6675
67-
| Error | Description | Recommended developer action |
68-
| -------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
69-
| Rate limit exceeded | The maximum number of mesh generations has been exceeded for the minute. | Wait until the rate limit resets. |
70-
| Moderation failed | The mesh generation was flagged for moderation. | Review and modify the prompt to ensure it adheres to Roblox's moderation guidelines. |
71-
| Internal server error | An unexpected issue occurred on the server. | Retry the request later or check server status for issues. |
72-
| Character limit exceeded | The input prompt length for this generation request exceeded the limit. | Reduce the number of characters in the `Prompt` string of the `input` dictionary. |
73-
| Service overloaded | The service is overloaded. | Retry the request later. |
74-
| Size dimensions must be greater than 0 | Invalid size provided. | Change the size to above `0`. |
76+
| Error | Description | Recommended developer action |
77+
| ------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
78+
| Rate limit exceeded | The maximum number of mesh generations has been exceeded for the minute. | Wait until the rate limit resets. |
79+
| Moderation failed | The mesh generation was flagged for moderation. | Review and modify the prompt to ensure it adheres to Roblox's moderation guidelines. |
80+
| Internal server error | An unexpected issue occurred on the server. | Retry the request later or check server status for issues. |
81+
| Character limit exceeded | The input prompt length for this generation request exceeded the limit. | Reduce the number of characters in the `Prompt` string of the `input` dictionary. |
82+
| Service overloaded | The service is overloaded. | Retry the request later. |
83+
| Size dimensions must all be greater than 0 | Invalid size provided. | Change the size to above `0`. |
7584
code_samples: []
7685
parameters:
7786
- name: inputs
@@ -92,11 +101,12 @@ methods:
92101
summary: |
93102
A dictionary for additional generation options to influence the
94103
result. The following key is supported:
95-
96-
- `SuggestedSize` — Optional `Datatype.Vector3` representing a size
97-
guide for the generated asset. The service will attempt to create a
98-
model with a size and proportion similar to the provided
99-
`Datatype.Vector3`. This does not guarantee the final output size.
104+
105+
- `SuggestedSize` — Optional
106+
`Datatype.Vector3` representing a size guide for the generated asset.
107+
The service will attempt to create a model with a size and proportion
108+
similar to the provided `Datatype.Vector3`. This does not guarantee
109+
the final output size.
100110
- name: intermediateResultCallback
101111
type: Function?
102112
default:

0 commit comments

Comments
 (0)