engineStreamingSetBufferSize
Client-side
Server-side
Shared
Pair: engineStreamingGetBufferSize
Added in 1.6.0 r21874
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
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!
OOP Syntax Help! I don't understand this!
- Method:EngineStreaming.setBufferSize(...)
- Variable: .bufferSize
Syntax
bool engineStreamingSetBufferSize ( int sizeBytes )Required Arguments
- sizeBytes: The streaming buffer size. Must be a positive non-zero number.
Returns
- bool: value
Returns true if there was enough memory to allocate the buffer, false otherwise.
Code Examples
client
This example adds a command that can be used to change the streaming buffer size, and display the previous value.
addCommandHandler("sbs", function(_, sizeMiB) local previousSizeMiB = math.floor(engineStreamingGetBufferSize() / 1024 / 1024) -- Convert Bytes to MiB if tonumber(sizeMiB) then if engineStreamingSetBufferSize(tonumber(sizeMiB) * 1024 * 1024) then -- Convert MiB to Bytes outputChatBox("The streaming buffer size has been changed from " .. previousSizeMiB .. " MiB to " .. sizeMiB .. " MiB") else outputChatBox("Not enough memory!") end else outputChatBox("Please enter a numeric value!") endend, false, false)See Also
Engine Functions
- engineAddClothingModelNew
- engineAddClothingTXDNew
- engineAddImageNew
- engineApplyShaderToWorldTexture
- engineFreeModel
- engineFreeTXDNew
- engineGetModelFlagsNew
- engineGetModelIDFromName
- engineGetModelLODDistance
- engineGetModelNameFromID
- engineGetModelPhysicalPropertiesGroup
- engineGetModelTextureNames
- engineGetModelTextures
- engineGetModelTXDIDNew
- engineGetModelVisibleTime
- engineGetObjectGroupPhysicalProperty
- engineGetPoolCapacityNew
- engineGetPoolDefaultCapacityNew
- engineGetPoolUsedCapacityNew
- engineGetSurfaceProperties
- engineGetVisibleTextureNames
- engineImageGetFileNew
- engineImageGetFilesNew
- engineImageGetFilesCountNew
- engineImageLinkDFFNew
- engineImageLinkTXDNew
- engineImportTXD
- engineLoadCOL
- engineLoadDFF
- engineLoadIFP
- engineLoadIMGNew
- engineLoadTXD
- enginePreloadWorldAreaNew
- engineRemoveImageNew
- engineRemoveShaderFromWorldTexture
- engineReplaceAnimation
- engineReplaceCOL
- engineReplaceModel
- engineRequestModel
- engineRequestTXDNew
- engineResetModelFlagsNew
- engineResetModelLODDistance
- engineResetModelTXDIDNew
- engineResetSurfaceProperties
- engineRestoreAnimation
- engineRestoreCOL
- engineRestoreDFFImageNew
- engineRestoreModel
- engineRestoreModelPhysicalPropertiesGroup
- engineRestoreObjectGroupPhysicalProperties
- engineRestoreTXDImageNew
- engineRestreamNew
- engineRestreamModelNew
- engineRestreamWorldUpdated
- engineSetAsynchronousLoading
- engineSetModelFlagNew
- engineSetModelFlagsNew
- engineSetModelLODDistanceUpdated
- engineSetModelPhysicalPropertiesGroupUpdated
- engineSetModelTXDIDNew
- engineSetModelVisibleTime
- engineSetObjectGroupPhysicalProperty
- engineSetPoolCapacityNew
- engineSetSurfaceProperties
- engineStreamingFreeUpMemory
- engineStreamingGetBufferSizeNew
- engineStreamingGetMemorySizeNew
- engineStreamingGetModelLoadStateNew
- engineStreamingGetUsedMemory
- engineStreamingReleaseModelNew
- engineStreamingRequestModelNew
- engineStreamingRestoreBufferSizeNew
- engineStreamingRestoreMemorySizeNew
- engineStreamingSetBufferSizeNew
- engineStreamingSetMemorySizeNew
- engineStreamingSetModelCacheLimitsNew