1.81 Screenshot .
1.81.1 Screenshot.Capture .
1.81.2 Screenshot.Create.
1.81.3 Screenshot.IsInProgress .
1.81.4 Screenshot.Succeeded .

Screenshot
Screenshot.Capture
Brief
Start a screen capture.
Definition
boolean Screenshot.Capture(Screenshot shot.
boolean
showScreens = false,
boolean
showOsd = true,
boolean
showLabels = false,
boolean
showChat = false,
boolean
showWatermark = true)
Arguments
shot - the screenshot object to useshowScreens - enable screen rendering for screenshotshowOsd - enable OSD rendering for
screenshotshowLabels - show player labelsshowChat - show player chat bubblesshowWatermark - show PlayStation Flome watermark on
screenshot
Return Values
true if capture is successfully started, or false if an existing screenshot is still capturing
Description
Start a screen capture with the specified options. Note that a true return value does not indicate that the capture has finished, the script must wait
until Screen.IsinProgress returns false. The following arguments must not be changed from their default values without permission from a
PlayStation(Ft)Plome Regional Manager: * showScreens * showLabels * showChat Any screens marked as protected will not be shown regardless
of the value of showScreens. Any changes to screen, OSD or label rendering is temporary and only active for the duration of the screenshot. The
developer should consult their regional SCE manager about the legal ramifications of enabling screen rendering in screenshots. Note that Lua
screens are excepted from this: even if showScreens is false, Lua-created screens will be still be shown, as they are often required to maintain
the look of scene.
Examples
shot = Screenshot.Create()
capturing = shot:Capture(true, true, false, false, true) — everything on except labels and chat,
if (not capturing) then
print('Capture failed’)
end
function OnUpdateO
if (capturing and not shot:IsInProgress() and shot:Succeeded()) then
MediaLibrary.Exportlmage( shot, "Home Screenshot" )
end
end
See Also
• Screenshot.Create
• Screenshot. IsInProgress
• Screenshot.Succeeded
• Screen.IsProtected
Screenshot.Create
Brief
Create a new screenshot object.
Definition
! Screenshot Screenshot.Create ()
Arguments
None
Return Values
A new screenshot object, or nil on failure
Description
Creates a new screenshot object, used to save an image of the current frame buffer contents. Only a limited number of screenshot objects may
exist at once, if this becomes exhausted, nil is returned so you can either fail or keep retrying every frame until another script releases a
Screenshot handle.
Examples
! shot = Screenshot.Create ()
See Also
• Screenshot.Capture
• Screenshot.IsInProgress
• Screenshot.Succeeded
MediaLibrary. Exportlmage
Screenshot. IsInProgress
Brief
Query whether a screen capture is still completing.
Definition
boolean Screenshot.IsInProgress(Screenshot shot)
Arguments
shot - the screenshot object to check
Return Values
true if still capturing, false if finished (either successfully or with an error)
Description
Query whether a screen capture initiated with Screenshot.Capture() has completed. If this returns false an error may also have occurred; check
the value of Screenshot.Succeeded)) to determine this. Once this returns false it is then safe to set the screenshot object to nil if it is no longer
required.
Examples
if (shot:IsInProgress()) then
print('Capturing...')
elseif (shot:Succeeded()) then
— do something with screenshot
end
See Also
Screenshot.Succeeded
Brief
Query whether a screen capture completed successfully.
Definition
boolean Screenshot.Succeeded(Screenshot shot)
Arguments
shot - the screenshot object to check
Return Values
true if capture completed successfully or false if still in progress or encountered an error
Description
Query whether a screen capture initiated with Screenshot.Capture() completed successfully. If the capture is still in progress false will be returned.
Examples
if (shot:Succeeded()) then
MediaLibrary.Exportlmage(shot, "Home Screenshot")
end
See Also
None