EngineStreamingSetBufferSize - Revision history

Azure: previousSize -> previousSizeMiB

2025-07-19T14:31:14Z

previousSize -> previousSizeMiB

← Older revision		Revision as of 14:31, 19 July 2025
Line 19:		Line 19:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler("sbs", function(_, sizeMiB)		addCommandHandler("sbs", function(_, sizeMiB)
	local ~~previousSize~~ = math.floor(engineStreamingGetBufferSize() / 1024 / 1024) -- Convert Bytes to MiB		local previousSizeMiB = math.floor(engineStreamingGetBufferSize() / 1024 / 1024) -- Convert Bytes to MiB
	if tonumber(sizeMiB) then		if tonumber(sizeMiB) then
	if engineStreamingSetBufferSize(tonumber(sizeMiB) * 1024 * 1024) then -- Convert MiB to Bytes		if engineStreamingSetBufferSize(tonumber(sizeMiB) * 1024 * 1024) then -- Convert MiB to Bytes
	outputChatBox("The streaming buffer size has been changed from " .. ~~previousSize~~ .. " MiB to " .. sizeMiB .. " MiB")		outputChatBox("The streaming buffer size has been changed from " .. previousSizeMiB .. " MiB to " .. sizeMiB .. " MiB")
	else		else
	outputChatBox("Not enough memory!")		outputChatBox("Not enough memory!")

Azure: MB -> MiB (Megabytes to Mebibytes)

2025-07-19T14:30:36Z

MB -> MiB (Megabytes to Mebibytes)

← Older revision		Revision as of 14:30, 19 July 2025
Line 18:		Line 18:
	This example adds a command that can be used to change the streaming buffer size, and display the previous value.		This example adds a command that can be used to change the streaming buffer size, and display the previous value.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler("sbs", function(_, ~~sizeMB~~)		addCommandHandler("sbs", function(_, sizeMiB)
	local previousSize = math.floor(engineStreamingGetBufferSize() / 1024 / 1024) -- Convert Bytes to MB		local previousSize = math.floor(engineStreamingGetBufferSize() / 1024 / 1024) -- Convert Bytes to MiB
	if tonumber(~~sizeMB~~) then		if tonumber(sizeMiB) then
	if engineStreamingSetBufferSize(tonumber(~~sizeMB~~) * 1024 * 1024) then -- Convert MB to Bytes		if engineStreamingSetBufferSize(tonumber(sizeMiB) * 1024 * 1024) then -- Convert MiB to Bytes
	outputChatBox("The streaming buffer size has been changed from " .. previousSize .. " MB to " .. ~~sizeMB~~ .. " MB")		outputChatBox("The streaming buffer size has been changed from " .. previousSize .. " MiB to " .. sizeMiB .. " MiB")
	else		else
	outputChatBox("Not enough memory!")		outputChatBox("Not enough memory!")

Azure: Fixed outputChatBox showing the comparison between the previous size and the new one

2025-07-19T14:29:11Z

Fixed outputChatBox showing the comparison between the previous size and the new one

← Older revision		Revision as of 14:29, 19 July 2025
Line 19:		Line 19:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler("sbs", function(_, sizeMB)		addCommandHandler("sbs", function(_, sizeMB)
			local previousSize = math.floor(engineStreamingGetBufferSize() / 1024 / 1024) -- Convert Bytes to MB
	if tonumber(sizeMB) then		if tonumber(sizeMB) then
	if engineStreamingSetBufferSize(tonumber(sizeMB) * 1024 * 1024) then -- Convert MB to Bytes		if engineStreamingSetBufferSize(tonumber(sizeMB) * 1024 * 1024) then -- Convert MB to Bytes
	outputChatBox("The streaming buffer size has been changed from " .. ~~math.floor(engineStreamingGetBufferSize() / 1024 / 1024)~~ .. " MB to " .. sizeMB .. " MB")		outputChatBox("The streaming buffer size has been changed from " .. previousSize .. " MB to " .. sizeMB .. " MB")
	else		else
	outputChatBox("Not enough memory!")		outputChatBox("Not enough memory!")

Azure: corrected outputChatbox -> outputChatBox

2025-06-27T00:48:00Z

corrected outputChatbox -> outputChatBox

← Older revision		Revision as of 00:48, 27 June 2025
Line 21:		Line 21:
	if tonumber(sizeMB) then		if tonumber(sizeMB) then
	if engineStreamingSetBufferSize(tonumber(sizeMB) * 1024 * 1024) then -- Convert MB to Bytes		if engineStreamingSetBufferSize(tonumber(sizeMB) * 1024 * 1024) then -- Convert MB to Bytes
	~~outputChatbox~~("The streaming buffer size has been changed from " .. math.floor(engineStreamingGetBufferSize() / 1024 / 1024) .. " MB to " .. sizeMB .. " MB")		outputChatBox("The streaming buffer size has been changed from " .. math.floor(engineStreamingGetBufferSize() / 1024 / 1024) .. " MB to " .. sizeMB .. " MB")
	else		else
	~~outputChatbox~~("Not enough memory!")		outputChatBox("Not enough memory!")
	end		end
	else		else
	~~outputChatbox~~("Please enter a numeric value!")		outputChatBox("Please enter a numeric value!")
	end		end
	end, false, false)		end, false, false)

Fernando187: Remove obsolete Requirements section

2024-11-07T17:33:40Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:33, 7 November 2024
Line 30:		Line 30:
	end, false, false)		end, false, false)
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.6.0-9.21874\|}}~~

	==See Also==		==See Also==
	{{Engine functions}}		{{Engine functions}}

FileEX at 09:39, 30 June 2024

2024-06-30T09:39:13Z

← Older revision		Revision as of 09:39, 30 June 2024
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool engineStreamingSetBufferSize( ~~number~~ sizeBytes )		bool engineStreamingSetBufferSize( int sizeBytes )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[EngineStreaming]]:setBufferSize\|bufferSize\|engineStreamingGetBufferSize}}		{{OOP\|\|[[EngineStreaming]]:setBufferSize\|bufferSize\|engineStreamingGetBufferSize}}

Pirulax at 23:30, 25 August 2023

2023-08-25T23:30:48Z

← Older revision		Revision as of 23:30, 25 August 2023
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{New feature/item\|3.0160\|1.6.0\|21874\|~~Get~~ the streaming buffer size. The larger it is, the more models can be loaded in one go BUT increases the RAM ['''not''' streaming memory!] usage. Can help with custom IMG loading speed by reducing pop-in.}}		{{New feature/item\|3.0160\|1.6.0\|21874\|Set the streaming buffer size. The larger it is, the more models can be loaded in one go BUT increases the RAM ['''not''' streaming memory!] usage. Can help with custom IMG loading speed by reducing pop-in.}}
	{{Important Note\|'''This function is meant for advanced users only, as it can lead to stability issues'''. Using a very high value might result in more crashes, while using a value too low might lead to frequent pop-in!}}		{{Important Note\|'''This function is meant for advanced users only, as it can lead to stability issues'''. Using a very high value might result in more crashes, while using a value too low might lead to frequent pop-in!}}
	==Syntax==		==Syntax==

Pirulax: Created page with "NOTOC {{Client function}} {{New feature/item|3.0160|1.6.0|21874|Get the streaming buffer size. The larger it is, the more models can be loaded in one go BUT increases the RAM ['''not''' streaming memory!] usage. Can help with custom IMG loading speed by reducing pop-in.}} {{Important Note|'''This function is meant for advanced users only, as it can lead to stability issues'''. Using a very high value might result in more crashes, while using a value too low might le..."

2023-08-25T23:30:17Z

Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0160|1.6.0|21874|Get the streaming buffer size. The larger it is, the more models can be loaded in one go BUT increases the RAM ['''not''' streaming memory!] usage. Can help with custom IMG loading speed by reducing pop-in.}} {{Important Note|'''This function is meant for advanced users only, as it can lead to stability issues'''. Using a very high value might result in more crashes, while using a value too low might le..."

New page

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.6.0|21874|Get the streaming buffer size. The larger it is, the more models can be loaded in one go BUT increases the RAM ['''not''' streaming memory!] usage. Can help with custom IMG loading speed by reducing pop-in.}}
{{Important Note|'''This function is meant for advanced users only, as it can lead to stability issues'''. Using a very high value might result in more crashes, while using a value too low might lead to frequent pop-in!}}
==Syntax==
<syntaxhighlight lang="lua">
bool engineStreamingSetBufferSize( number sizeBytes )
</syntaxhighlight>
{{OOP||[[EngineStreaming]]:setBufferSize|bufferSize|engineStreamingGetBufferSize}}

===Required Arguments===
*'''sizeBytes ''': The streaming buffer size. Must be a positive non-zero number.

===Returns===
True if there was enough memory to allocate the buffer, false otherwise.

==Example==
This example adds a command that can be used to change the streaming buffer size, and display the previous value.
<syntaxhighlight lang="lua">
addCommandHandler("sbs", function(_, sizeMB)
if tonumber(sizeMB) then
if engineStreamingSetBufferSize(tonumber(sizeMB) * 1024 * 1024) then -- Convert MB to Bytes
outputChatbox("The streaming buffer size has been changed from " .. math.floor(engineStreamingGetBufferSize() / 1024 / 1024) .. " MB to " .. sizeMB .. " MB")
else
outputChatbox("Not enough memory!")
end
else
outputChatbox("Please enter a numeric value!")
end
end, false, false)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.6.0-9.21874|}}

==See Also==
{{Engine functions}}