{
  "404.html": {
    "href": "404.html",
    "title": "404 - Page or File Not Found | Stride Docs",
    "summary": "404 - Page or File Not Found Oh no, this is embarrassing \uD83D\uDE48! The page you're looking for doesn't exist or has been moved to another address. If you think the address should be valid, let us know. document.getElementById(\"invalid-address\").innerHTML = window.location.href;"
  },
  "ReleaseNotes/ReleaseNotes-1.10.html": {
    "href": "ReleaseNotes/ReleaseNotes-1.10.html",
    "title": "Xenko 1.10 release notes | Stride release notes",
    "summary": "Xenko 1.10 release notes Highlights Xenko 1.10β improves stability and performance and introduces changes in the asset serialization. Tool performance This release comes packed with several performance improvements, especially in the Game Studio and Asset Compiler. We've rewritten how assets are loaded in the scene editor, resulting in a faster and smoother loading in the background, as well as reduced memory usage. We've made various improvements to the Asset Compiler startup time (important since we start multiple Asset Compilers to process FBX files). Also various key importers, such as the FBX importers, weren't scaling well with lots of polygons. The Content Bundle packing (run at the end of the Asset Compiler) can now work incrementally. Before, if you had several gigabytes of data but only changed a small asset, compilation was fast but saving the new bundle took a long time at the end of the build. This operation should be almost instant now. Unique GUID inside an asset While not a breaking change, we've introduced a new paradigm in our asset infrastructure, implying that any identifiable object (ie any object that implements IIdentifiable interface) must have a unique identifier in the asset containing it. This constraint makes it easier to handle internal references inside an asset. Since it wasn't enforced before, the first time you open an existing project with version 1.10, you might see warnings stating that the identifiers of some objects have been rewritten (especially entity components and scripts). This is expected and should be harmless. The warnings shouldn't appear the next time you open the project. Changelog Version 1.10.0-beta Release date 2017/3/9 Enhancements Animation The additive animation asset has been removed. Animation assets now support both regular and additive clips. Check the animation documentation for details You can now specify start and end frames for animation clips. The animation framerate can be changed in the Game Settings asset. Actual data is still saved and used in seconds PlayingAnimations is no longer visible in design time The API for the animation component has changed. See the documentation or create an AnimationStart pre-built script for a quick look Various bug fixes General Content packaging in bundles is now incremental in Debug and Release. It drastically improves iteration time when making small changes then re-running a game with many or large assets. AppStore configuration will do a full rebuild Asset compilation should have better startup time and be faster when spawning sub-processes (used by FBX) FBX import for meshes with lots of triangles was extremely slow due to unoptimized access to edge data FBX asset compilation would sometimes fail because the data limit on WCF was too low Removed unecessary hashing of assemblies when building assets Assets (YAML) now supports multiline strings properly Game Studio In the Scene and Prefab editors, asset loading is now async, much faster, and more memory-friendly You can now right-click a prefab instance and select \"Select prefab in asset view\" Improved keyboard navigation in tree views (eg solution explorer, scene hierarchy): left arrow goes to parent node, right arrow goes to first child (when on a node) Nodes of the entity tree in the scene/prefab editors automatically expand when children are added Graphics Improved SetViewport (which has a separate count from render target count) Added SetScissorRectangle (note: viewport and scissors only work well for first viewport) #521 Vulkan: SwapChain clearing wasn't passing validation layer Forward+ light culling wasn't working well if projection matrix was off-center (ie VR) RenderDocPlugin assembly lets you automatically load RenderDoc and capture inside editor (using /RenderDoc flag) or game Cluster lighting wasn't working on OpenGL and OpenGL ES due to unimplemented UpdateSubresource for 3D textures Navigation Debug overlay inside of the Game Studio is now slightly transparent Particles ShapeBuilder API has been updated. Custom shape builder implementations have to be upgraded accordingly Bugs fixed General C# \"fixed\" arrays didn't work due to IL changes Connection Router sometimes couldn't restart properly due to adb child process keeping the parent process port open Game Studio When importing an effect log, it often ended up in the wrong package. It's now created in the currently active package Keyboard input often got stuck in the Game Studio (especially annoying when moving) Script editor often crashed on saving or creation. Several related issues fixed Mouse cursor could disappear during drag-and-drop operations #385 and #546 Changing the layout type in the UI editor could make Game Studio crash #547 Fix several issues related to folders in Scene and Prefab editors (renaming, copy/paste, undo/redo) Fix a rare crash with the clipboard when another application is using it Fix a crash that could occur when removing an item from certain types of collections Fix input of Windows device name (CON, NUL, COM1) as folder names Assets Assets that contain multiple identifiable objects with the same Id now go through a fixup pass at load to re-generate unique ids Make sure we generate new Ids for such objects after manipulations such as copy/pasting, duplicating, etc When a property of an asset was overridden (from the archetype or from a prefab) to a value equivalent to the default value of the property, the override information was lost after reloading The deserialization of some types from an asset file could fail due to impropert type and assembly resolving Animations wouldn't import when the skeleton used for the animation had missing or extra bones Some texture compression pairs which failed before now attempt a two-step conversion to create the target output format FBX importer now ignores empty string names during mesh importing Several crash issues fixed in the Assimp importer SDF fonts and msdfgen have been upgraded to handle overlapping contours Graphics Material culling wasn't applied properly Multi Render Target info wasn't kept when doing multithread rendering with multiple command lists Ambient lighting didn't update after the last Ambient Light had been removed from the scene Fix possible shadow map hole between cascades, at specific viewing angles when using blending Navigation TryFindPath would return a valid path even if the starting and ending point weren't connected Version 1.10.1-beta Release date 2017/3/13 Bugs fixed Game Studio Fix a concurrency problem that could make the Game Studio crash while loading or updating assets in the Scene Editor Version 1.10.2-beta Release date 2017/3/14 Bugs fixed Game Studio Fix additional concurrency problems that could make the Game Studio crash while loading or updating assets in the Scene Editor"
  },
  "ReleaseNotes/ReleaseNotes-1.4.html": {
    "href": "ReleaseNotes/ReleaseNotes-1.4.html",
    "title": "Xenko 1.4 release notes | Stride release notes",
    "summary": "Xenko 1.4 release notes Highlights Renaming The engine has been renamed Xenko. Here is our new logo, be sure to remember it! The following changes have been introduced during the renaming and will be automatically applied to your project when opening it in the Game Studio. All occurrences of ‘Paradox’ in code, shaders and configuration files are replaced with ‘Xenko’ Package and asset files, previously having a .pdx* file extension, now have a .xk* extension Xenko SDK is now located using the SiliconStudioXenkoDir environment variable instead of SiliconStudioParadoxDir In addition, the new Visual Studio integration will not recognize old installations or projects that were not upgraded, and vice versa. New documentation system We are aware our documentation isn't where we need it to be yet, so we've decided to take some steps to move things faster. In order to do this, we have migrated our documentation to DocFX. The new system should provide better readability and more consistent formatting. It also allows us to more easily edit and upload separate documentation for each version of Xenko. The documentation has its own repository on GitHub: https://github.com/SiliconStudio/xenko-docs Everybody in the community can now share information by adding edits which will help us to continually improve the documentation. To edit documentation, just click the “Improve this Doc” button available on every page of the documentation, and submit us pull requests. With your help, we hope to improve the community's experience with Xenko since this will allow people to share information at a faster pace. Of course, the Xenko dev. team will also be adding more to the documentation as well. More info on that coming soon! PDB debugging You can now step into Xenko's engine source code. The code will automatically be fetched from GitHub. The process is simple. All you need to do is open Visual Studio options, go to Debugging > General, and check “Enable Source Server Support”: Sprite Studio (breaking change) The XML format used to import models and animation has been updated to use the latest version of Sprite Studio, instead of the legacy exporter format used previously. With this new format, we recommend that you copy your whole Sprite Studio project (all files are needed) into the RawAssets folder of your Xenko project. Please refer to the sample game for details. Version 1.4.0-beta Release date: 2015/12/01 Enhancements Editor Main color is now blue instead of purple. Better management of recent project list, especially when working with multiple versions of Xenko. Assets Assets were previously versioned individually, but from now on they will more closely match Xenko versions. This will allow package-wide asset upgrades, easier plugin support, and copy-paste support between different Xenko versions. We've switched the compiler from a per-app domain model to a per-process model (similar to MSBuild.exe), to avoid any issues related to environment variables, current working directory and unaware C++ code with static that might be used. Issues fixed Editor Fixed an issue when inserting an asset into the scene hierarchy Fixed an issue when renaming a folder in the solution explorer Properly set the value of the ‘SolutionDir’ variable when building a game from the studio Engine Fixed an issue with shadows for spot lights that were using orthographic projection instead of perspective. Assets Fixed the asset compilation crash when Xenko installation path contains the ‘##’ character. Allow asset names to contains the ‘.’ period character Known Issues iOS has an outstanding crash issue after a few second, especially on recent devices (iPhone 6s). This is currently under investigation."
  },
  "ReleaseNotes/ReleaseNotes-1.5.html": {
    "href": "ReleaseNotes/ReleaseNotes-1.5.html",
    "title": "Xenko 1.5 release notes | Stride release notes",
    "summary": "Xenko 1.5 release notes Highlights Skeleton asset A new Skeleton asset (*.xkskel) has been introduced. Both models and animations now hold a reference to a skeleton. This allows to reuse the same skeleton definition in multiple assets and to retarget models and animations to different skeletons. Skeletons can be created alongside other assets, when importing an FBX file or other model format. Root motion support for models, cameras, lights, etc. Animations now apply root motion if they have no skeleton, or the ‘Root Motion’ property is enabled on the animation asset. The animation will then move the entity itself, instead of the skeleton's root bone. This is especially useful to import animations of lights, cameras or unskinned models, without the need to bind them to the bones of a skeleton. The FBX importer will now also import animations of various camera parameters (near-plane, far-plane, field of view) and apply them to the CameraComponent of the animated entity. More properties may be supported in the future. New animation update system The animation system now internally uses a new UpdateEngine to update objects. This allows us to animate arbitrary properties of entities, while accessing them in a highly efficient way. It will be the foundation for a future animation curve editor inside the GameStudio. The new ‘Animated Properties’ sample demonstrates how to create animations of any property from a script. Simple Profiling system It is now possible to visualize profiling information of all the game systems and custom profilers directly within your running games. To get started, use the Game Profiler built-in script, attach it to an entity and when the game is running press LCtrl-LShift-P. Physic debug shapes at runtime It is now possible to enable the rendering of physics collider shapes during runtime. The debug shapes are normal entities and they must be enabled for each physics shape that requires it. The best way to start with this feature is to use the Physics Shapes Render built-in script and attach the script to any entity that has a Physics Component and when the game is running press LCtrl-LShift-P. Asset View The Asset view has been improved to help you better organize and manage your assets. New ‘view options’ menu The view options are gathered in a single menu accessible from the asset view toolbar. You can display all the assets in the current folder only, in the current folder and its sub-folder. The third option let you display the assets and the sub folders. You can also sort your assets by name, order, type or modification date. New asset filter bar With the new asset filter bar, you can filter your assets by name, tag, type or a combination of those. Each ‘filter tag’ can be disabled by a single click or removed from the active filters. To add a filter, type in the filter bar and matching filters will be displayed. Click on the one you want to add it to the list of active filters. Only the assets matching the active filters will be displayed in the asset view. Note that type filters are inclusive, while name and tag filters are exclusive. Folder support in asset view If the ‘Assets and folder in selected folder’ options is selected, the first level of sub-folder will be displayed in the asset view. You can drag and drop assets inside them. You can also copy/paste complete folder structure. Copy-paste assets with their dependencies You have now the ability to copy assets with their dependencies. To do that use the new entry ‘Copy with dependencies’ from the asset view context menu, or press Ctrl+Shift+C. For example, if you copy/paste a model with its dependencies, you will get a copy of this model along with a copy of all its dependencies (skeleton, materials, textures) Border and Center support in sprite sheet editor For ‘Sprite2D’ sprites, you can move the position of the center by selecting the icon in the toolbar of the sprite editor. Grab and move the cross to the desired position. For ‘UI’ sprites, you can change the borders by selecting the icon in the toolbar of the sprite editor. You can then resize each border (left, top, right and bottom) separately in the same way as the texture region, by grabbing and moving one of them. Note that the icon lets you ‘lock’or ‘unlock’ the sprite borders while resizing the texture region. New built-in scripts We added a few more built-in scripts with this release such as an FPS camera script and First player controller script. To use them, just click on “New Asset”, “Script source code”, select the desired script and attach it to an adequate entity. Precompiled Sprite Fonts Font rights are quite restrictive and it is quite common that only some persons of the project have access to the font files. This was preventing some people to build the game. To solve this problem, we created a new type of asset, the precompiled sprite fonts. It is an asset taking as input an image and containing all the glyph information required to render the set of character specified. Inside your games you can used it exactly like a standard sprite font. To generate a precompiled sprite font, the owner of the original font file just have to right click on an existing static font and choose “Generate Precompiled Font”. Version 1.5.4-beta Release date: 2016/03/03 Issues fixed Fix a certification issue remaining for Windows Universal Apps. Fix a problem with the selection of the Graphic Profile on INTEL graphic cards. Version 1.5.3-beta Release date: 2016/02/18 Issues fixed Fix a problem in the package upgrade erasing the content of shader and effect files. Fix a crash in the resolution of invalid relative paths preventing to load the project in the editor. Do not add pillar boxes when resizing the window of a landscape game under Windows 10 but readjust the size of the buffer. Replace the MS Mincho font by an embedded free font in samples (The font is not available on every systems) Version 1.5.2-beta Release date: 2016/01/15 Issues fixed Assets Added the missing XenkoDefaultFont required by the profiler system. The convex hull generation is now working along with the new Skeleton Asset. Engine Fix problem occurring with debugging async functions (local variable gone, namespace ignored, step over broken). Fix the issues preventing from passing Windows 10 store certification. Add support for proper resizing in Windows Universal Apps. Game Studio Fix issues with the displayed values of rotations changing after validation. iOS The Connection Router script required to compile shaders on iOS devices has been fixed. Enhancements Assets Skybox compilation does not require a DX11 GPU anymore. We added DX10 support to ensure GameStudio works fine with less recent GPUs as well. Engine Add support for OpenGLES devices that do not support packed depth-stencil-formats. Game Studio Add the possibility to edit the 3 components of a vector simultaneously. Version 1.5.1-beta Release date: 2015/12/22 Issues fixed Engine Fix LLVM AOT compilation in release configuration for iOS Game Studio Fix a possible crash when using types with no base type in scripts (##342) Fix double-click on folder in asset picker window Fix settings of default IDE reset to null when it shouldn't. Fix the problem of the texture thumbnail not updating when modify the content of the source file. Creating an asset with a template can be properly undone. (##343) Version 1.5.0-beta Release date: 2015/12/17 Enhancements Launcher Add a ‘reconnect’ button, in case the launcher was started in offline mode. Game Studio The asset creation menu always displays all possible assets to create, and switches to a proper location when the currently selected location is invalid for the chosen asset type. Improve animation thumbnail and preview. Automatically detect and use the corresponding model. Improve asset filtering in the asset view. Filter tag can be added, disabled or removed at any time. Folders are displayed in the asset view. Assets can be sorted by last modification date. Add ability to copy/paste assets with their dependencies. Improve the sprite sheet editor. Resizing borders or moving the texture region behaves correctly, especially when reaching the borders of the image. Background outside of the selected texture region can be darkened. Sprite sheet preview can be displayed while the sprite sheet is being edited. Change message dialog style. Some confirmation dialogs (e.g. deleting an asset) can be disabled in the settings (under Interface/Ask confirmation…). Games Use the application icons as window icon on windows Use AssamblyProductAttribute.Product as window title on windows Graphics Add support for Gif load and jpeg save for Android Add the possibility to load images and textures as sRGB Add a static field in GraphicDevice to be able to get the current graphic platform Add optimized native code in SpriteBatch Engine Use Color4 instead of Color in sprite components. Add support for toot motion on the TransformComponent Expose AnimationComponent.PlayingAnimations to the editor to be able to set entity initial animation easily. Make connection to editor for shader compilation fail if there is no connection back within 5 seconds UI Add a tint color to the UI ImageElement. Issues fixed Assets Fix compiler regression that was taking more than 5s to complete compilation of assets Fix the log message displaying the name of missing referenced assets during asset compilation Fix crash in the asset compilation when Xenko installation path contains a '##' character. Fix shadow asset remaining after resolving asset naming collision. Engine Prevent an exception to be thrown at each frame when the Model property of a ModelComponent is null. Use the ShaderProfile from GameSettings instead of the graphic device level as it is likely the profile used to compile shaders at build time. Game Studio Fix a crash when trying to fetch the target asset of a reference that is null. Fix a bug in the edition of SpriteFont properties that was preventing to properly use system font Fix thumbnails of SpriteFont when using system font. Fix a crash when duplicating an entity in the scene editor. Fix renaming issue when duplicating an entity in the scene editor. Fix the problem dark thumbnails for textures in HDR mode. Fix gizmo settings not saved/reloaded properly. Fix copy/paste of folders in the solution explorer. Fix a crash in the sprite sheet editor when a source image was modified in an external editor. Fix a potential crash when the texture region is outside of the image. Fix a bug preventing to create a frame in the sprite editor when dropping a file. Fix a bug preventing to drop asset in an empty folder. Fix error when attempting to import animation from a model that doesn't have any. Fix incorrect size of full screen window when screen resolution has changed. Fix package dependency issue when removing a dependent package. Rendering Fixed disappearing shadows due to wrong cascade distance calculation Known Issues iOS has an outstanding crash issue after a few second on ARM64 iPhones. This is currently under investigation."
  },
  "ReleaseNotes/ReleaseNotes-1.6.html": {
    "href": "ReleaseNotes/ReleaseNotes-1.6.html",
    "title": "Xenko 1.6 release notes | Stride release notes",
    "summary": "Xenko 1.6 release notes Highlights Prefabs Prefabs allow you to assemble entities into building blocks and easily reuse them in any of your scenes. Changes to your prefabs will be reflected on all instances (as long as properties are not overridden). We even took the concept one step further to empower our users, by having prefabs within prefabs, as well as the possibility to use only part of a prefab when you instantiate it. And of course, removing or rearranging a few entities won't break your prefab synchronization! Archetypes You can now use any asset as an archetype for another asset. When you change a property of the archetype, the new value will be automatically propagated to all the derived assets, unless you specifically override them. Archetypes can be used with most asset types. Particles You can now create and edit particle systems directly in the Xenko Game Studio. Particles are deeply integrated in the game engine and leverage the powerful effect system and its high level of customization. While there are still several features on the roadmap, the current implementation is sufficient for most games. The ability to customize almost all aspects of the particle engine allows you to add features tailored to your game's specific needs. Feel free to visit our particle documentation. Features The particle engine supports many features out of the box: Render particles as different shapes like billboards, 3D oriented quads or your own custom implementation Powerful force fields which offer more control than simple attractors and repulsors Collisions Animated attributes such as size, color, rotation Flip books, UV animation and support for the Xenko Shading Language Ribbons and trails renderers added to the engine. Check out our tutorial for more details. Modular system All aspects of particle systems are broken down into individuals modules like spawners, initializers and updaters, and each of these modules is easily tweakable and customizable. Check out the samples and the Xenko documentation for a detailed walk-through. Curve Editor The Game Studio now also comes with a built-in curve editor. For now only the particle engine uses curve animation. In the future, it will also power our property animation system and our storyboard system. New Graphics Engine Most of our graphics pipeline, both low-, medium- and high-level, has been almost completely rewritten, and should be ready for the future. The low-level API has been changed to more closely resemble DirectX 12 and Vulkan. For a list of breaking changes, please see below. The high-level pipeline has been completely reworked, to achieve the following goals, most of which we will tackle in the upcoming releases: Introduce a clean and extensible architecture to easily build new graphics features on (hoping to soon add a Forward+ renderer, IBL light probes, RLR, etc.) New medium-level layer: lightweight RenderFeature, RenderStage, RenderObject, etc. Easy for users to write small customizations (by implementing RenderFeatures) Allow multi-threading of all parts of the pipeline Make optimal use of next-gen graphics APIs Reduce the amount of \"magic\" done by the effect system to increase performance Minimize work by taking better advantage of different update frequencies (PerView, PerMaterial, PerLighting, etc.) Take advantage of new API (first class support for Pipeline State Objects, Descriptor Sets, etc.) Stay tuned for technical details and performance evaluation in the near future! Direct3D 12 Direct3D 12 has been added as a new build target. While still experimental, it already supports all parts of our rendering pipeline. You can try it by changing the ‘Preferred Graphics Platform’ in the ‘Rendering Settings’ of your ‘Game Settings’ asset. Better OpenGL support Our OpenGL renderer has been improved and should behave much better (shadows, PBR, etc.). Also, we now deliver OpenGL and OpenGL ES on Windows as build targets. You can also try them by changing the ‘Preferred Graphics Platform’ in the ‘Rendering Settings’ of your ‘Game Settings’ asset. Scripts are now components So far, there could only be one component per type on an Entity. This was quite cumbersome, especially for scripts, which had to be stored inside the ScriptComponent.Scripts list. It also resulted in many special cases to make them work in the editor (i.e. references between scripts, assembly reloading, etc.). Now multiple components of a type are allowed. This affects scripts and physics components, and can be used for custom components for which more than one instance is sensible. We hope this makes your life easier! Event system We added a simple event system that will allow your script to easily communicate with each other. Check out the EventKey<> and EventReceiver<> classes. You can create an EventKey from your sender scripts and consume events using EventReceiver from other scripts. Game Settings overrides The Game Settings asset has been improved: You can now have different settings depending on the platform or GPU. For example, you might want to set different off-screen resolutions for your game on Android depending on the GPU model. Or you could use one of our new Direct3D12, OpenGL or OpenGL ES renderers on Windows. Version 1.6.7-beta Release date: 2016/06/09 Enhancements Game Studio Don't wait for editor initialization before showing the editor window. This should prevent editor layouts from suddendly switching without notice, especially when opening a big scene. Save the list of opened editors more often (everytime a new editor is opened). Before it was only saved when editing the Game Studio properly and thus the list would not be saved when a crash occurred. Issues fixed Graphics D3D12: Static sampler didn't properly set comparison func and border, resulting in broken shadow maps OpenGL ES: Improved texture format supports depending on OpenGL ES version and extension presents (esp. for float texture on ES2) OpenGL ES: EXT_sRGB doesn't seem to properly work on Adreno 4xx, but since it is usually available through ES3 context, we use that first when available OpenGL: AMD GPU driver didn't like the fact there was no #version in the Copy GLSL shader OpenGL: Even though we use SDL, image loading now uses same code as WinForms/WPF (since SDL_image loading code is not implemented yet) Assets AssetCompiler was caching assemblies so that they could be modified while running. This feature is only useful in development and was making thing both slower and causing too long path issues, it has therefore been disabled for end-user install (#410) Engine Added missing XenkoDefaultFont root asset in default package, this makes the profiler system work again out of the box. Game Studio Fix a crash that could occurs when loading a project that contains broken paths to resource files Prevent the Game Studio process to keep running when a fatal problem occurs during the loading Particles Bug fix where two or more child entities concurrently try to update their parent entity's transform matrix. Version 1.6.6-beta Release date: 2016/05/27 Enhancements Game Studio Don't force opening the default scene every time the Game Studio is started (except for new project). The default scene will only open if it was the case during the last session (same behavior as any other editor). Issues fixed Game Studio Fix an issue preventing to save editor layout when the history of projects reach the maximum size (currently 20 projects). Material Selection mode (which allows you to pick a material by clicking directly on the mesh area) was broken. Engine Changed how OpenGL ES expected vs actual version is handled; this should fix various issues related to context creation on Android and also code targeting older OpenGL should be more consistent across devices. There was some issues for GPU resource disposal that might have lead to incorrect state (might fix some issues when closing scenes in the editor). ShadowMaps across multiple RenderViews were not working properly (same shadow map texture can be reused but in fact was not). Improved the engine's behavior when mobile apps require to handle multiple orientations. Particles Fixed an issue where non-uniform scaling and rotation on the entities resulted in wrong rotation of the particle system. Currently only uniform scaling is supported. Version 1.6.5-beta Release date: 2016/05/17 Enhancements Game Studio When an image is added to a sprite sheet, the texture region is now sized to the whole image by default. The dialog asking for assembly reloading only pops up when the Game Studio has focus. The dialog asking to save script only pops up for a script created from inside the Game Studio. Issues fixed Engine Fix negative index parameter of SpriteFromSheet.GetSprite throwing an exception. Negative index now circles around the collection of sprites (e.g. -1 return the last sprite). If a background component was enabled and then disabled, it would still render. MSAA rasterizer state was enabled even when not needed (with level 0 so it didn't affect much, except subtle differences in tessellation tests). Removed a ThrowNotImplementedException in OnSoundControllerListChanged, re-implemented the missing part. Made non generic EventKey and EventReceiver consume bool instead of byte Fix a possible crash in PhysicsColliderShape Compose Fix culling of shadows casters when no shadow receivers are present Game Studio Fix issues in the sprite editor cache keeping old version of images after their source file had been changed. Fix issues in the sprite editor tool that sized incorrectly the texture region, borders or center. When closing editor, there was a NullReferenceException in the Gizmo System. Fix a crash when using audio and sound assets. Fix a crash when trying to copy the crash report itself. Fix a crash when adding scripts to entities Version 1.6.4-beta Release date: 2016/04/28 Issues fixed Fix an issue in the rotation editor when decomposing the rotation matrix into Euler angles. Some information were missing in the new GPU crash report Version 1.6.3-beta Release date: 2016/04/27 Enhancements Game Studio Some manipulations with a multi-selection of entities are now faster. Improve prefab thumbnails Display an helper message in the curve editor on how to add a keyframe when the curve is empty Improved crash report so that we have more information about previous exceptions when GPU fails Android Allow dynamic device orientation switching (desired orientations must be selected from Visual Studio) iOS Allow dynamic device orientation switching (desired orientations must be selected from Visual Studio) Bumped minimum iOS version requirement from 6.0 to 7.0 Made some internal classes public to allow fine control of Game start-up by overriding them (experimental) Issues fixed Game Studio Fix an issue in the sprite editor preventing to properly edit newly added frames Fix a cache issue in the sprite editor preventing to the magic wand to work properly after modifying a source image externally (#389) Fix a crash that could occur when manipulating the Materials of a model component in the scene editor Fix a crash when loading projects with Audio related components/assets Fix a crash that might occur when closing an editor Fix an issue when asset compiler was failing but not properly returning error. As a result, it was easy to run into issue like running the game once and keep it in background (lock files), editing, and when running it again it would still use the older compiled assets. Lights and camera gizmo were improperly scaled Rendering Camera now ignore scaling when computing view matrix Made various types public instead of internal, so that user can easily extend the rendering pipeline by themselves EffectValidator was failing on effects without any permutation values (#378) Added a debugger proxy for the new ParameterCollection MSAA parameters are now properly forwarded to the main swap chain. Note that it still can't be used in RenderFrame until MSAA targets are properly resolved. Particles Fix an issue with particles ignoring camera groups when rendering (#380). Fix a crash when Spawner's duration and delay were both 0 (#384). Android The Activity is not destroyed anymore when changing device orientation iOS Fixed a native library dependency issue that prevented Xamarin Incremental build to work properly (There is still a possibly Xamarin side bug preventing this feature to work properly) Animation engine custom IL code was not working with latest Xamarin AOT, this is now fixed Built-in Scripts Fixed PlayerController script to reflect physics component changes Version 1.6.2-beta Release date: 2016/04/04 Issues fixed Game Studio The Sprite editor was not properly working anymore due to a regression in 1.6.1-beta Referencing an entity inside its own script was crashing the Game Studio Fix a concurrency issue that could make the Game Studio crash occasionally Tooltip with no text were displayed above some properties Graphics Fix a potential issue in the lighting code Version 1.6.1-beta Release date: 2016/03/30 Enhancements Particles Ribbons and trails renderers added to the engine. Check out our tutorial for more details. Game Studio Add statistics on asset usage in the references panel. Edition of a string key (e.g. animation key name) can be done inline. Improve performance of the curve editor. To ease edition of a vector compute curve in the curve editor, other components are also displayed. Textboxes in property grid display their content in tooltip. Allow to see the property of an asset while it is open in its editor Samples and new games now have resource files in an \"Resources\" folder instead of \"RawAssets\" Physics Added proper entity offset in CharacterComponent Teleport. Added utility method Ended in Collision, to avoid writing do/while constructs. Issues fixed Game Studio Fix memory leaks happening when opening and closing scene editor repeatedly Fix frequent crash on GameStudio startup because of a thread race condition when setting up file systems Fix issue on tree views that sometimes selected the same item more that once, resulting in incorrect property display on property grid. Fix issue with maximized window size on multi-monitor system (#361) Fix resetting value of a rotation in the property grid. Fix save, undo and redo not working on curve editor when the window is in floating mode (was already working when docked). Fix zooming issue in curve editor. Fix particles not being rendered in thumbnails and asset preview. Fix shaders not being reloaded dynamically on shader code file save. Fix disappearing Physics Gizmos Fix missing settings in NewGame Restored different color for trigger collider shapes in debug renderer. Fix a crash occurring when closing a scene or prefab editor, or closing the GameStudio itself Fix an issue when modifying members of structures in the property grid Prevent the property grid to be cleared when switching from a selection of asset to a selection of entities Graphics Structs can now be used in shaders. Switched light shaders to use them Improve EffectReflection API Fix many issues related to fullscreen switching and alt-enter is now fully supported. Fix reflection of array texture types (#369) Add missing CommandList.SetBlendFactor() method Engine Various memory leaks fixed Remote effect compilation was broken when done with another computer the game was built with Used effect notification was failing when shaders were using custom permutation keys Fix Entity.EnableAll ignored argument, you can now use this method properly. Physics Fixed CylinderColliderShape issues with Scaling. Version 1.6.0-beta Release date: 2016/03/15 How to upgrade Simply open your older projects with new version of GameStudio. It will probably fail to compile your assemblies since API changed little bit, but you can still continue. Then, save back your project in GameStudio. You now can open your project with Visual Studio and try to fix your game code with latest API changes. Enhancements Assets Engine The KeyedSortedList now implements ICollection instead of IList and is more consistent with CollectionDescriptor. Game Studio Support for prefabs, add a prefab editor Create derived assets and support property inheritance Added a curve editor to edit animation curve Layout is saved on a solution basis. When reloading a project, Game Studio will try to present the same layout and reopen all assets that were edited (this include scenes, prefabs and sprite sheets). Add a confirmation dialog to enable saving newly created script automatically. Add a confirmation dialog to enable reloading modified assemblies automatically. This is necessary for the script to appear in the list of components that can be added to an entity. Physics gizmos are shown by default. Preview of an asset can be displayed even if this asset is being edited. Project folder can be opened in Windows explorer from the launcher with right-clicking. Properties of derived asset are displayed in gray, unless they are overridden. In this case they are displayed in bold. Rework scene initialization in the scene editor: the scene will be available almost immediately, and content (model, etc.) will be streamed in as soon as they are (asynchronously) loaded. The entity fixup wizard has been removed. Now when an entity is deleted, all references to it or to one of its component is reset to null. The gizmo and camera menus are now displayed in the top-right corner. Entity hierarchy is synchronized (automatically expanded) with the selected entity in the scene. Graphics New D3D12 renderer (experimental) New Windows OpenGL and OpenGL ES renderers (experimental) Rewrote most of the low- and high-level graphics code to have better performance and better take advantage of new graphics APIs Properly separated rendering in 4 phases: Collect (collect & cull), Extract (copy data from scene to renderers), Prepare (prepare cbuffer data & heavy computations), Draw (emit draw calls) Introduced concepts of RenderFeature (entry point for extending rendering), RenderStage (effect selection), RenderView and RenderObject Render sorting logic can now be customized (culling will be soon too) Low-level API has been rewritten to match better new API: CommandList, DescriptorSet, DescriptorHeap, PipelineState, etc. Introduced concept of RendererProcessor which are responsible for pushing component data to rendering Many other changes, that will soon be covered in documentation Input Improved GamePad event management to resemble the keyboard API. Issues fixed Game Studio Fix Scripts thumbnail generation during project launch. Fix Settings window sharing columns layout with property grid (#341). Fix default IDE settings incorrectly reset to null. Fix a crash occurring when duplicating an object quickly after selecting it. Fix an issue with the message box incorrectly resizing. Tooltips are always visible even if the control (menu, button…) is disabled. Fix several issues with undo/redo. Fix drag and drop of components into properties Sometimes the Game Studio was not asking to save when closed with some changes in a project. Fix some issues related to folders in scene editor. Redo does not re-open asset picker anymore. Graphics Tangents generation was invalid and might have resulted in various swaps Physics Improved collision detection reliability Fixed collision filter groups Fixed enable/disable component behavior Breaking changes Graphics Extending rendering is quite different from before. Please check SpaceEscape and other samples to have a better idea while we prepare documentation. Many methods of GraphicsDevice have been split off into a second class: CommandList Added objects such as PipelineState, DescriptorSet and DescriptorHeap to better match new graphics API Game now contains a GraphicsContext which gives access to the current CommandList GraphicsDevice.BackBuffer and GraphicsDevice.DepthStencilBuffer are gone. Use GraphicsDevice.Presenter.BackBuffer to access the actual backbuffer. In addition to RenderContext, there is now a RenderDrawContext. Some methods have been changed to expect the latter. ParameterCollection has been rewritten to be much more memory and performance efficient (data is now stored directly in buffers). Transferring values from application to shaders and computation of effect permutations used to be done through various inefficient ParameterCollection overrides. This should now be done using RenderFeatures. Physics PhysicsComponents are now split into 3 different types (Rigidbody, Character, StaticCollider) which can be added multiple times in an entity. PhysicsElements are now removed, including the Collider, Rigidbody and Character classes. They now are merged into the new components. Known Issues Sometimes duplicate contacts are detected by the physics engine"
  },
  "ReleaseNotes/ReleaseNotes-1.7.html": {
    "href": "ReleaseNotes/ReleaseNotes-1.7.html",
    "title": "Xenko release notes 1.7 | Stride release notes",
    "summary": "Xenko release notes 1.7 Highlights Rendering Forward+ Xenko now features Practical Clustered Shading, a technique similar to Forward+ rendering. It allows you to use many point and spot lights at the same time. You will gain more control over the lighting of your scene by adding lights wherever they are needed. It also works with transparent objects out of the box, just like ordinary forward rendering does. If your game requires Direct3D10+ (or equivalent OpenGL), this will be the default setting - no changes needed! As a bonus, you'll see a decrease in compilation times and the number of shader permutations. We also took this opportunity to rewrite most of our lighting code for improved performance and extensibility. Vulkan Vulkan joins our happy family of graphics platforms! Experimental support has also been added for Windows and Linux. Android will follow soon. Together with Direct3D12 and the recent overhaul of our rendering pipeline, this is another step toward preparing Xenko for the next generation of graphics. Stay tuned for performance improvements and hard numbers in the near future. Try running your project on Vulkan by selecting it as the Preferred Graphics Platform in the Rendering Settings of your Game Settings asset. GameStudio Improvements Simplified Asset Creation The workflow to create assets has been simplified! The new menu for asset creation contains multiple templates for each type of asset. You can now import assets from files more directly. With Xenko's efficient search function, creating assets should be faster and easier than ever! Camera Preview We've updated GameStudio's camera preview to now display only the camera currently selected. It also now displays the borders and the camera's name making it easier to see the camera and it's settings. Drag & Drop Assets into the Property Grid So far, you could drag & drop assets into your scene or the tree view. New in this release, components can now be added to entities just by dragging & dropping matching assets into the property grid. Drag & Drop scripts You can also drag & drop scripts directly into the scene, tree view and property view: Linux Linux users rejoice! Linux is now a supported platform of Xenko among Windows, Android, iOS, and more! All you need is a PC running Linux Ubuntu 16.04 x64 or equivalent with a video card supporting OpenGL 4.2 or Vulkan 1.0. Mono or .NET Core (which need to be installed separately) will be powering your game. In order to use the Linux platform, check Linux from the list of platforms in the GameStudio then compile. Deployment to a remote Linux box is done via SSH when running your project from GameStudio. To know more about our Linux support, read the Linux documentation Audio We've rewritten our Audio engine! While most changes are internal, the public API has improved, and we are still working to make it great! The SoundEffect and SoundMusic classes have been consolidated into Sound, also SoundEffectInstance is now SoundInstance. Sound formats are now converted using FFmpeg. Because of these updates, the range of supported formats has also improved. Under the hood, the CELT codec (part of Opus) is now being used. We're delighted to say that performance has since skyrocketed! Music can now be mixed and crossfaded while streaming and decompressing directly from disk. Xenko's API now builds on OpenAL for Linux/macOS/iOS, on OpenSLES for Android and on XAudio2 for Windows platforms. How To Upgrade This section explains how to migrate a project from version 1.6.x to version 1.7.x. UIComponent VirtualResolution property has been renamed to Resolution VirtualResolutionMode property has been renamed to ResolutionStretch ISpriteProvider The properties of type Sprite have been changed to properties of type ISpriteProvider. Currently two implementations of ISpriteProvider are available: SpriteFromSheet for use with a SpriteSheet (i.e. a collection of Sprite) SpriteFromTexture for use with a single Texture To upgrade where a single Sprite was previously used cast the assignment with the following (SpriteFromTexture provides a convenient explicit converter from Sprite). var button = new Button { PressedImage = (SpriteFromTexture)new Sprite(Content.Load<Texture>(\"ImageButtonPressed\")) } To upgrade where a sprite from a SpriteSheet was previously used: Create a new SpriteFromSheet and provide a reference to the SpriteSheet instance and the corresponding frame index. var button = new Button { PressedImage = new SpriteFromSheet { Sheet = sprites, CurrentFrame = sprites.FindImageIndex(\"ButtonPressed\") } } For convenience, we provide a helper method which does exactly the same: SpriteFromSheet.Create(sprites, \"ButtonPressed\"). To change the CurrentFrame (which now only exists in SpriteFromSheet), a cast is required: var provider = Entity.Get<SpriteComponent>().SpriteProvider as SpriteFromSheet; if (provider != null) provider.CurrentFrame = SomeIndex; SoundEffect (Instance) and SoundMusic to Sound(Instance) Kindly note that there is no more SoundMusic. Instead, you should now use Sound and SoundInstance for any kind of sound. From the game studio, you can now set compression ratio, spatialization or you have the option to stream the sound directly from disk. You now need a SoundInstance to play a sound, the helper methods in Sound were convenient but a bit confusing. You can still assign Sound assets to Scripts like before: public Sound MySound; private SoundInstance mySoundInstance; Also note, the way you use them has changed. Before: MySound.Play(); After: mySoundInstance = MySound.CreateInstance(); mySoundInstance.Play(); Lastly, you no longer have to register (AddListener/RemoveListener) AudioListenerComponent from your code anymore. Breaking changes Audio Removed DistanceScale and DopplerScale since internally not all the backends were supporting it ( we might add it back in the future as a global factor if needed) DynamicSoundEffectInstance has been removed, you can now use DynamicSoundSource to stream your custom sound sources. Works on every platform Removed SoundEffect, SoundEffectInstance, SoundMusic. Please use Sound and SoundInstance instead of all kind of sounds Removed AddListener, RemoveListener from AudioSystem Many Methods that had SoundEffect or SoundMusic in the signature now have just Sound, e.g. AudioEmitterComponent.AttachSound UI Font size has been completely changed to pixel height. Existing sprite font assets will be updated automatically Properties of type Sprite have been changed to properties of type ISpriteProvider Changelog Version 1.7.0-Beta Release date: 2016/07/01 Enhancements General Debug locals were not displaying properly in some cases due to Mono.Cecil processing. This has been fixed and should now work properly. Audio You can now change the Pitch/Speed of a SoundInstance! Added master volume control in AudioEngine (AudioEngine.MasterVolume) Particles This release brings many improvements to the particle engine. You can now create lightning and laser effects thanks to the arc position initializers and ability to follow two target points Child particles support and attribute inheritance added, allowing one emitter's particles to follow and inherit attributes from another emitter's particles Child ribbon particle samples showing how to create wispy particle trails in a single effect Soft edge particles allow you to smooth out the billboard edges when rendering particles close to opaque objects More spawner types, including Burst, On-Hit and a few other conditional ones Color updater now uses a Color4 curve Game Studio The selection history feature has been rewritten. It is now shared by all editors and the asset view. The buttons to navigate the selection history have been moved to the property grid The re-import operation has been replaced by a \"Update asset from source\" which directly applies the changes from the source to the asset without displaying the import UI. (For skeleton, model, sprite studio assets...) Dropping a large number of files to import is now a lot faster The notification when the sources of some assets have changed is now a dialog message instead of a notification popup on the corner of the screen You can now drag & drop assets directly into the Property Grid to create components UI Signed Distance Field sprite font asset type added, allowing users to create sharp, scalable fonts which can be easily resized at runtime at no extra cost Added support for EditText on Windows 10, Windows Store and Windows Phone platforms Assets The internal YAML format of the SceneAsset and PrefabAsset has been updated to be more generic regarding asset composite. The tracking of source files for assets, in particular, has been improved and fixed Graphics Added a way to keep a constrained aspect ratio in Render Camera, and automatically have pillarboxes/letterboxes when there are screens with different ratios Added the concept of \"LogicalGroup\" to easily do partial updates of constant buffer and resources Improved OpenGL support: texture buffers, more texture formats, debug markers, etc. Unified OpenTK: we now compile our own OpenTK for Windows, iOS and Android. This means our OpenGL renderer code is now unified and should have fewer bugs Camera is not affected anymore by scaling Implemented the required changes to allow rendering to Oculus Rift devices. Also, we have already begun including the native interfaces in the API for the Oculus Rift SDK. See the VR documentation for more information. Input Added a helper method InputManager.TransformPosition to allow you to transform input events in the case of multiple viewports. Issues fixed Game Studio Undo/redo has been fixed in a lot of scenarios GameStudio layout issue when creating a new game with the same name as a previous (but deleted) game Issue preventing a newly created script to be marked as saved Regression introduced in 1.6.5 where the texture region of a sprite was not correctly resized when the source image had been changed Compilation errors occurring when creating a project with a dash character in its name. Additional checks have been added to replace illegal characters in script names Multiple cases where modifications of a prefab were not propagated to the instances of this prefab Preserve Nodes that were working improperly Tracking changes in source images in the sprite sheet editor Some scenarios where thumbnails never complete to build Improved name collision handling when creating/importing assets Issues with the selection of entities in the scene editor (some entities remained selected from the property grid point of view even after being unselected from the tree view) Some windowing issues when multiple modal dialogs are displayed in the wrong order, preventing to close them Several crashes occurring when modifying properties of entities Drag'n'drop issues where it was sometimes hard to drag the correct asset or entity Version 1.7.1-Beta Release date: 2016/07/04 Enhancements Increase the speed when manipulating entities that comes from prefabs Issues fixed Fix scene editor not refreshing when changing properties of a component that was added just before Fix audio engine creation on Windows 7 32bits zlib1.dll was missing and preventing to use SDF fonts Fix the rotation over time updater for particle systems Fix the camera preview that wasn't properly handling when adding or removing the camera component Version 1.7.2-Beta Release date: 2016/07/09 Enhancements Error messages added when fonts fail to load. Add new identification scheme for Linux deployement Slightly faster initialization of projects in the Game Studio Issues fixed Fix issue making compute curve properties display improperly in the Game Studio. Fix upgrade of assets that had SourceKeepSideBySide set to true Fix a serialization issue with scenes that are using prefabs Fix a potential crash that could occur when navigating through the selection history Fix border thickness in UI did not take opacity into account Fix copy of glslangValidator Fix depth-stencil state of GameProfilingSystem Version 1.7.3-Beta Release date: 2016/07/16 Enhancements Prevent unidentified exception to occur when the camera is not set in the graphics compositor Issues fixed Fix the property grid that was malfunctioning after certain types of operation Fix updates from prefab that were sometimes not propagated to the instances of this prefab Fix thumbnails of source code asset that were not properly generated sometimes DDS now properly set header flags when saving cubemaps Version 1.7.4-Beta Hotfix release (critical crash in editor) Version 1.7.5-Beta Release date: 2016/07/21 New features Effects can now be compiled directly by the runtime without needing an attached developer computer with Connection Router. This is still quite slow (and will be optimized later), but at least it solves many problem caused by the previous workflow. You can still go back to the previous mode in the \"package properties\" (right-click on the package in solution explorer), and setting the \"Remote Compiler\" Enhancements Faster startup time (serialization code is initialized and JIT-ed more lazily) Compatible with latest Xamarin iOS Alpha (symbols are static-linked, so unused P/Invoke needs to be removed) Issues fixed Some fonts were not working properly with the new Signed Distance Field feature (#436) Green and blue channels were inverted in the color curve editor Version 1.7.6-Beta Release date: 2016/07/22 New fatures In the Sprite component, you can now choose the sampler between linear, point (nearest) and anisotropic (#409) Issues fixed Default SpriteBatch and others precompiled shaders were missing integer precision, resulting shader links error on iOS Particles: Ribbons geometry can now be split, useful to emit multiple separate groups of particles D3D11: Check if QueryInterface of DebugDevice actually worked (sometimes it doesn't, i.e. when using RenderDoc) Various fixes for additive animation Fixed wrong exception text in AudioLayer initialization Version 1.7.7-Beta Release date: 2016/07/29 New features FBX: Added PivotPosition in ModelAsset (in case it is not properly centered) Engine: Added an experimental \"DebugConsoleSystem\" to easily display text (API might change) Issues fixed GameStudio: Undo was not working properly for the first change (due to the undo flag not being properly reset) GameStudio: Some asset change notifications were not sent properly in case of undo/redo GameStudio: Entity focus was not working in some cases GameStudio: Fix EntityComponent reloading after assembly reload GameStudio: Picking in GameStudio was not working properly with some AMD cards GameStudio: String could not be used on the value side of a dictionary (in property grid) Audio: Only create one audio engine, even if multiple game are started FBX: Fix some cases where a material was not properly set Various bugfixes Version 1.7.8-Beta Release date: 2016/08/05 New features Greatly improved performance when building assets (esp. when no changes) and loading Visual Studio solution; it was due to wildcard patterns in our build target files, forcing MSBuild to list files recursively Serialization code is now lockless for the hot path (faster startup) Graphics profile are now cached on D3D, making it faster to open new 3D windows in the GameStudio Issues fixed Physics bugfixes & optimizations (don't process bone when disabled, and disabled in editor) SDL2.dll was missing when targeting OpenGL Vulkan: sometimes texture pixel size was not properly computed, resulting in invalid Texture CPU readback Fixed a crash when creating new packages D3D12: pipeline state was not properly reset on ClearState & CommandList resets D3D12: rewrote texture and buffer initial data upload, which was failing on AMD hardware D3D12: optimizations to avoid calling unecessary state changes Version 1.7.9-Beta Release date: 2016/08/05 Note: emergency bugfix for 1.7.8 release, which was not properly copying native libraries. Known Issues Sometimes duplicate contacts are detected by the physics engine. On Linux, when switching the underlying Graphics Platform, rendering will not occur. Delete the cache, local and roaming folder on the Linux host and restarting the game should fix the issue. Linux Mono has some troubles with the new effect compiler (since 1.7.5-Beta). Please use the \"remote compiler\" in the \"package properties\" (right-click on the package in solution explorer), or use Linux CoreCLR in the meantime."
  },
  "ReleaseNotes/ReleaseNotes-1.8.html": {
    "href": "ReleaseNotes/ReleaseNotes-1.8.html",
    "title": "Xenko 1.8 release notes | Stride release notes",
    "summary": "Xenko 1.8 release notes Highlights Xenko release 1.8 introduces three major new features along with several relevant enhancements to existing features. We are proud to be able to offer you our new UI Editor, enhanced performance via our newly multithreaded engine with Vulkan support and our new Prefab Model. Also, for your cutting edge rendering needs, we now support SSAO and cel (toon) shading! UI Editor This release introduces new UI assets along with a brand-new UI editor, so that you can create amazing UI directly from the Game Studio! The UI editor provides a full WYSIWYG experience. You can author the whole visual tree of your UI, edit the properties of each UI element (such as layout, background color, etc.) and preview its rendering. Two new assets are available: UI Page asset: represents a typical tree of UI elements that can assigned to the UI Component of an entity in the scene or prefab editor. UI Library asset: represents a collection of UI trees (similar to prefabs) that can be reused by other UI Pages. Both have runtime equivalents. UIComponent now expects a UI Page. A UI Library is useful to create or edit UI at runtime. And since it is built on the same system as archetypes and prefabs, you can easily create shared UI parts, override some properties and have changes propagating automatically. Performance Multithreading Many computationally intensive systems have been multithreaded. Expect a major increase in performance and better scaling to correspond with the size of your game! We have observed up to 6 times higher frame rates for heavily CPU bound scenes so far (on a typical 4-core CPU). Parallelized code includes many EntityProcessors and almost every part of our recently rewritten rendering pipeline. On Vulkan and Direct3D12 this includes also recording of drawing command lists, giving them an edge over the other APIs. Developers can find classes and utilities for concurrent programming in the SiliconStudio.Core.Threading namespace, e.g. Dispatcher.For(), which resemble the Task Parallel Library, but are more lightweight and tailored for work performed every frame in a game's update loop. Over time, we will look into multithreading more parts of the engine, including independent subsystems, such as different phases of the RenderSystem and Scripts. Prefab Model The Prefab Model is a new type of Model asset that generates an optimized baked and merged single model from a prefab. It merges meshes together by material and vertex layout. You can easily go from thousands of draw calls to one or two draw calls. To use it, just create a new Prefab Model asset from the Game Studio and assign a prefab to it. Make sure that the base prefab is just containing static entities as only ModelComponent types are merged. Rendering SSAO Ambient Occlusion was added to the list of post-processing effects. The current technique implements Scalable Ambient Obscurance. It exposes a variety of options, including number of tap samples, intensity, tap radius and back buffer size. It is currently part of the post-effect pipeline, but will later move to the lighting pipeline for more realistic rendering. Cel Shading Cel shading (or Toon shading) is now available as a rendering model with both Diffuse and Specular rendering options. The default implementation limits the light product to binary or 3-cuts discrete levels. You can also reference a ramp texture for better artistic control. How To Upgrade UI The UIComponent RootElement property has been replaced with the Page property. It now expects an instance of the UIPage type. Scripts that were setting the RootElement property need to be updated: // previous code (will not compile) var grid = new Grid(); var component = Entity.Get<UIComponent>(); component.RootElement = grid; // new code var grid = new Grid(); var component = Entity.Get<UIComponent>(); component.Page = new UIPage { RootElement = grid }; Due to the slight API and behavior changes made to UI system, you might have to adapt some other part of your code. For example: var text = new TextBlock(); var canvas = new Canvas(); canvas.Children.Add(text); var position = new Vector3(0.0f, 1.0f, 0.0f); // previously setting this attached property will also set Canvas.UseAbsolutePositionPropertyKey to false automatically text.DependencyProperties.Set(Canvas.RelativePositionPropertyKey, position); // now you need to set it explicitly text.DependencyProperties.Set(Canvas.UseAbsolutePositionPropertyKey, false); // note that using extension methods is the recommended way, and does all of that in a more concise way: text.SetCanvasRelativePosition(position); Changelog Version 1.8.0-Beta Release date: 2016/08/31 Enhancements General Added a DebugConsoleSystem to be able to print basic debug information in game. Added Utility methods FindChild and FindRoot to Entity. Animation blend trees can now be created in script. The AnimationBlend pre-built script shows how to do it easily Updated Roslyn to 1.3.2 Assets Yaml scene files now encode entity and component references in a much more compact way Yaml serialization order is now following class declaration order Audio Game studio side: added hard limits in Compression ratio, also now it is using a slider. Added SetRange in SoundInstance to be able to set play range, it also enables seeking. Added Position property in SoundInstance to be able to know the position in time of your playing instance. Added PlayAndForget to AudioEmitterSoundController to play many instances of the same sound rapidly. Added RequestedAudioDevice in AudioSystem to allow game code to select audio devices (Windows only for now). AudioEmitterComponent now contains a dictionary of sounds that can be used from the emitter, those can be set from the Game Studio directly! Game Studio sound preview now uses the internal engine, this means that you can directly preview the compression rate! Graphics CommandList can now compiled and executed Constant Buffers are now uploaded in a single GPU Buffer and set with offsets on platform/API that support this mode D3D12: reduced number of API calls Game Studio About Page accessible from Menu-->Help-->About. Input Added preliminary controller vibration support with Input.SetGamePadVibration Particles Particle rendering now uses the improved multithreaded pipeline, significantly speeding up the vertex buffer building. Samples Several samples have been removed. Particles and Physics samples have been greatly reduced and merged into only two, which allows the user to check more features with a single sample. Issues fixed Physics Procedural models can now be used as a source to generate convex hull shapes. We are now using the github version of Bullet Physics and actively cooperating with the project. Fixed ColliderShape cached matrices computation. Game Studio Credential dialog will now save the credential settings when closing. Credential dialog will not appear if you checked \"Do not ask again\". Fix hang when launching a Linux game remotely. Breaking changes UI The UIComponent expect a UI Page in place of the previous Root Element property. Most dependency properties were changed into regular C# properties, except the ones that are attached properties (such as the Column and Row attached property of a Grid). In desktop, TouchMove event is also raised when no mouse button are pressed. Default style of the UI has been removed. Audio Remove Play with boolean argument from SoundInstance, instead the same behavior will be achieved by using PlayExtended or Play. Rename IsLooped into IsLooping. Deprecated: GetSoundController, AttachSound, AttachSounds, DetachSound, DetachSounds. Please add sounds now from the AudioEmitterComponent Physics Collision.Contacts is now an HashSet so access by index is not possible anymore, please use foreach or iterate them instead. VR Add audio, status and re-center support for Oculus Rift. Linux Fix Mono issue with the new effect compiler (introduced in 1.7.5-Beta). No need to enable the \"remote compiler\" anymore in the \"package properties\". Version 1.8.1-Beta Release date: 2016/09/09 Enhancements Game Studio Current selection in the UI editor can be changed from the context menu. This is especially useful to select an element that is covered by another. Add snapping when moving or resizing a element in the UI editor. Issues fixed Fix a compilation issue with Prefab Models using other Prefab Models to be compiled Fix and improve edition of Generics and Composition Nodes for Shader class nodes in materials Game Studio Fix a potential NullReferenceException when validating a range value in the property grid. Creation of derived asset (ArcheType) for UI page or UI library are not supported, but were still allowed. Fix an issue with message box that returned a wrong value when the user chose to close it instead of clicking on one of its button. This could result in data loss when asked to save the project upon closing the Game Studio. Remove incorrect GPL headers in script templates, e.g. BasicCameraController (#457). Display error message in credential dialog when remote location does not exist instead of reporting invalid credentials. Linux Fix failure when compiling shaders for the Vulkan backend on the remote host. Particles Particles materials refactored, significantly improving memory performance. Samples Fix samples were depending on the wrong version of Xenko. Version 1.8.2-Beta Release date: 2016/09/21 Enhancements Game Studio Improve snapping when moving or resizing an element in the UI editor: moved element will be \"attracted\" by the parent container bounds or siblings like magnets. This should ease aligning elements with one another. Auto adjust alignment property when moving to left/right (resp. top/bottom) edge of the parent container. The single root of a UI page can be removed and a new one can be added instead. Improve responsiveness of the Game Studio. Issues fixed Game Studio Fix magic wand tool not working inside the sprite region. Fix an issue when removing the single root of a UI page. Fix some user operations that were taking a very long time to be executed. Fix a crash when setting materials in a model component. Physics Fix some memory leaks. Samples Fix some scripts that were depending on C# level 6 features. Version 1.8.3-Beta Release date: 2016/10/07 Enhancements Editor Creating a Prefab from a group of entities will name it after the first entity More relevant messages displayed now when assets are not found Physics Add a new Jump method which supports an arbitrary jump vector. Add NormalizedDistance to HitResult. Add a version of RaycastPenetrating ( and shape sweep ) that accepts a group and filters accordingly. Add optional offsets to convex hull shapes. Make Move method obsolete, the new method to use from now is SetVelocity which internally applies the simulation fixed time step. Change Character controller's max slope default value to 45 degrees Issues fixed Engine Fix calculation of bounding boxes of skinned meshes. Fix culling mode for meshes with negative scale. Disable bloom, light streaks and lens flares when the bright-pass is disabled. Fix an issue with Event system and scheduling. Physics Fix debug shape rendering of static colliders when those colliders are forced to move Fix debug shape rendering of enabled/disabled entities. Fix issues with Jumping Fix transformation propagation of dynamic bodies when in a skeleton. Serialization Fix an issue in SharpYaml preventing generic types to be properly serialized. For instance List can now be used from a script. Known Issues On Linux, when switching the underlying Graphics Platform, rendering will not occur or fail. Delete the cache, local and roaming folder on the Linux host and restarting the game should fix the issue."
  },
  "ReleaseNotes/ReleaseNotes-1.9.html": {
    "href": "ReleaseNotes/ReleaseNotes-1.9.html",
    "title": "Xenko 1.9 beta release notes | Stride release notes",
    "summary": "Xenko 1.9 beta release notes Highlights Xenko 1.9 Beta introduces several major new features along with several relevant enhancements to existing features. We are excited to offer three new game templates to speed up your game design time, a brand new script editor as well as expanded copy-paste functionality. The last major new feature is our new Navigation Mesh system. Game Templates We have added several templates packed with a lot of functionality to help you kickstart your games. Choose from: First Person Shooter Third Person Platformer Top-View RPG All of them come with basic camera and player functionality found in most games of their respective genres. They also have many production-quality assets so you can easily try different features on your own. In addition to the game templates, the New Game project now includes optional packages with all the assets we used to build the samples. Unlike the game templates which are trimmed down, the optional packages include ALL assets, including some which are not used by any Xenko sample. Script Editor To ease friction from switching back and forth between the Game Studio and your IDE, we’ve built a new Script Editor. Relying fully on Visual Studio is no longer necessary because you can now edit your code directly within the Game Studio itself. You’ll get full syntax highlighting, auto-completion, live diagnostics and even the ability to auto-reload C# files and projects that changed on your hard drive due to changes in your external editor (e.g., Visual Studio). In fact, expect: Highlight, auto-completion and live diagnostics is available in the Xenko API, your own game code and libraries that you use Auto-reload C# scripts and C# project changes that happened in the background A Visual Studio like experience for all your code editing! We had some help from Microsoft’s .NET compiler, Roslyn, so Xenko users will also receive the full benefit of all the latest features of .NET. Adding a Rosyln-based Script Editor makes it easier to keep up with the latest C# updates. Using the Xenko Script Editor is fairly straightforward. Just follow these steps: Create a new project/game in Game Studio Add a script in Game Studio Edit the script in Game Studio C# scripts saved on Visual Studio side (or any text editor, for that matter) will automatically be updated in Game Studio without reloading. Same goes for project changes (.csproj): new scripts will appear automatically upon saving. GameStudio will automatically listen for file changes on the hard drive and update them live, or ask you what to do in case of conflicts. Under the hood, Rosyln is the underlying technology that can process your Xenko source code. But we didn’t stop there! We were fortunate to find AvalonEdit, which provided us what we wanted for the visual appearance of the UI aspect of the Xenko script editor. We also integrated RoslynPad, which connects Roslyn and AvalonEdit together. Navigation Meshes In Xenko 1.9β, you can create a navigation mesh powered by Recast and Detour with real-time feedback directly in the Xenko GameStudio! The navigation mesh is especially useful for RPGs or top-down strategy games, as you can use it to guide characters through complex scenes. The real-time feedback makes it easy to adjust and conveniently customize AI movement and the dimensions of the navigation mesh itself. The green outline of Xenko’s Navigation Mesh shows where the AI comes into play and where the colliders are set. In the videos, you can see how the AI navigates the level using the logic within the navigation mesh, and how the colliders will automatically be set in real-time. Of course, you can script AI movement manually, too. Copy & Paste Functionality Expanded In the past we only supported copy and pasting of assets, but now you can copy-paste pretty much anything in the Game Studio. Any entities in a scene are now copyable, as well as any sprites of a sprite sheet, UI elements, or even a single property in the property grid! For instance, you can copy a list and perform any of the following operations. Insert it into another list at various positions, for example: Copy and insert into the list (by pasting at a list item level).* Copy and append to a list, for example, append it to the end of the list. Copy and replace the whole list. A bit more difficult to explain, but perhaps easier to show than write about is copy and replace at an item level. This action (shown in the video below) will remove the item (at its position in the list) and insert the copied ones starting at the same position of the item in the list. In our example below, the copy replace starts from Item 2 in List 2: Some information about copying entities and prefabs: An entire hierarchy of entities can be copied from one scene or prefab to another scene or prefab. Prefab instance will keep their reference to the source prefab as illustrated in the following example: The prefab “MyHero” is copied into the scene. Links to the prefab are maintained. It is also possible to copy a component from an entity and paste it into another entity. Any absolutely any property that can be serialized can be copied. You can copy something from one scene to another scene, from a sub-element in one scene to another scene and even from a scene to a text file, back and forth as needed. You can also copy simple values in the property grid (e.g., primitives such as int, vector3, string…) between separate Game Studio instances if that is something you find practical and useful. Here’s an example of copying between scripts and transform entities in the GameStudio Property Grid: .NET Standard Starting with Xenko 1.9, shared Game assemblies will be created using .NET Standard rather than PCL. It offers many advantages: much better API surface for the developer, improved forward and backward compatibility, reduced fragmentation, finer-grained modularity of the framework, easier to write cross-platform apps, more frequent updates, etc. Newly created applications will target .NET Standard 1.4, but users are of course free to target a different version. Also, your existing PCL projects will still work as is, but we recommend you to update your projects to .NET Standard! Assembly Reloading Iterating on code is very important. So far, Xenko was supporting changes in scripts: as soon as you saved any C# file, Game Studio was offering to recompile and reload the assembly with the updated scripts. If there is an error loading the type, you can still edit other part of the asset, save it back while preserving the parts that could not be loaded. In this version, we generalized the approach so that any type embedded in your assets can be reloaded! As a result, you can now implement your own classes for anything you want directly in your game or plugin assemblies, and keep editing them without restarting the Game Studio. This includes renderers, material features, and will soon be extensively used in new assets. Breaking changes Windows Phone and Windows Store Removed Windows Phone and Windows Store platforms are both removed. Please use the newer Universal Windows Apps (UWP) instead. This platform was previously known as Windows 10. Projects will be automatically upgraded to reflect this change. Also, we renamed preprocessor definition SILICONSTUDIO_PLATFORM_WINDOWS_RUNTIME into SILICONSTUDIO_PLATFORM_UWP. .NET Standard The switch to .NET Standard for newly created projects implies that: Runtime .NET framework requirement when distributing your projects is bumped from .NET 4.5 to .NET 4.6.1. You need Visual Studio 2015 to open and compile newly created projects You can upgrade older projects to use .NET Standard using Visual Studio 2015 Update 3 (in project properties) From version 1.9, we don't install prerequisites to compile PCL projects anymore. If you have somebody in your team still working on a project created with a previous version of Xenko on a fresh PC, please make them install Xenko 1.8 so that it installs the proper prerequisites (even if the project has been updated to a newer version of Xenko). Asset Serialization We changed how we serialize asset in YAML. We introduced new concepts that improve how we can track overrides between an archetype or a prefab and assets/entities inheriting from it. Although everything happens \"under the hood\", this is a actually a heavy change that might impact the upgrading of your project. We removed asset upgrading for projects made with version 1.3 and below (released more than a year ago). It is possible that you experience some issues when upgrading a project made with versions 1.4 to 1.7, but you should properly be able to upgrade any project that uses version 1.8. However a few cases are not supported: Dependency Properties of UI elements that are overridden from an UI library will be reset during upgrade. Therefore, properties such as Grid Column and Row will have to be manually restored. Some case of overriden materials in the material list of ModelComponent might be improperly upgraded. Dropping Support for Windows Store 8.1 and Windows Phone 8.1 To properly support the .NET Standard 1.4 and offer our developers a more up-to-date and robust API, we decided to drop support for Windows Store 8.1 and Windows Phone 8.1 platforms. As Microsoft seems to be focusing on Universal Windows Platform (UWP), we’ve also decided it was best to refocus on more pertinent and relevant platforms for Xenko users. UWP was introduced with Windows 10, and a whole range of devices already support it. Of course, you are free to stick with Xenko 1.8 in case you have a project targeting one of those two platforms -- we know this is a big change, and we will make every effort to help our developers with this transition. We apologize for the inconvenience, and aim to bring you a top-notch .NET user experience! Just as a reminder, we already support Universal Windows Platform (UWP) on x86, x64 and ARM as of Xenko 1.8, which means games and apps developed with Xenko can be deployed on a whole range of Microsoft devices, including Xbox One. Until 1.9, this platform was named Windows10 in Xenko, but we took the liberty to rename it UWP to better match the official naming. Changelog Version 1.9.0-beta Release date 2016/11/24 Enhancements General From now on, new projects are created as .NET Standard projects rather than PCL projects. NuGet restore is automatically run on projects having a project.json file Bumped FBX SDK to 2017.0.1 Mesh importing now supports ByEdge smoothing which was previously ignored. If you notice any difference with vertex normals for your models please check your FBX export settings. Prerequisites installer will ask for UAC once instead of many times, and perform a silent installation for all of the prerequisites. Game Studio Previously, when an EntityComponent (i.e. script) couldn't be loaded because game or plugin assembly didn't compile properly, we kept a Yaml representation of it so that it could be saved or reloaded after a code fix. Now we allow it to happen anywhere, so that you can use and/or implement custom classes for any type of the engine in your game/plugin. Improve asset logs and errors to properly display failure/warning icon on all assets, including the one with icon-style thumbnails. Improve loading/refreshing of assets in the scene editor. Asset editors will display a * in the tab name when an asset is dirty. Add editor for C# source code. C# files and .csproj files are automatically reloaded as they are modified on hard drive (using a Yes, Yes to All, No, No to All dialog). C# files have their own undo/redo stack Add a Save All button that saves both assets and source code files. The Game Studio now uses AvalonDock as docking system Improve DPI support (#454 and #470) Assets Asset YAML serialization has been changed to handle overrides in collection in a better way. More scenario of overrides are now supported. SharpYaml has been integrated into our codebase as SiliconStudio.Core.Yaml. Most of the duplicated types have been merged back in the SiliconStudio.Core.Reflection. Assets don't use a ~Base section nor a ~BasePart. Change Asset.Id to be of an AssetId type rather than Guid, to avoid invalid comparisons with other kind of ids. Remove the Properties member of Package. Introduce a new assembly Assets.Quantum Overrides of properties is now handled using Quantum instead of ShadowObject. Remove the asset diff/merge classes. Engine DataSerializers are now generated in a file with .pdb information, so that the user can debug them. Add Local offsets to procedural models. EntityComponent now implements IIdentifiable and has an Id property. Audio Add SetRange support to AudioEmitterSoundController Improve compilation speed of audio files Materials Normal maps now have the option to Invert Y, supporting both textures where the green component is facing up or down Particles Minor optimizations around vertex buffer building Add StopEmitters() method to the particle system, which prevents new particles from spawning without pausing the entire system Physics Add Cone collider shape. Replace float with AngleSingle for MaxSlope of character controllers. Issues Fixed General UWP platform now uses UniversalWindowsPlatform 5.2.2 (was previously 5.0.0). Game Studio Fix many issues with property overrides. Fix many issues when setting/overriding materials in ModelComponent. Asset logs were not properly sent forward to editor, resulting in an empty log for all assets. Sometimes there was a deadlock when compiling effects due to the way we were using the thread pool and task continuations. Fix performance issue that could occur when duplicating entities with the same name many times. Fix 'Rename' menu entry when right-clicking a folder of the scene editor. Fix crashes in the UI editor that could occur when deleting or moving an element. Fix crashes in sprite sheet editor that could occur when deleting, duplicating or moving sprites. Fix sort order of assets in the asset view. Assets Fix tangents of imported meshes, when transforms are negative along some axes Engine Several issues with spot lights were fixed, including shadow maps Fix flickering of some materials when no ambient light is present Fix an issue on OpenGL that caused low frame rates when using post effects, due to blocking GPU-readback Animation Fix a bug where an empty animation clip caused a crash Version 1.9.1-beta Release date 2016/11/29 Issues fixed Game Studio Moving or renaming an asset that has overridden properties (eg. a scene using prefabs) was loosing override information once saved. Engine Normal maps issue fixed where z-component was wrongly assumed to be 1 (it's now equal to sqrt(1 - x^2 - y^2)) Depth of Field halo around foreground objects issue resolved Samples Missing normal maps on some samples have been restored Version 1.9.2-beta Release date 2016/12/13 Enhancements Game Studio Maintaining ALT key down when dropping a prefab into a scene won't create a container entity for the prefab instance. Creation of prefabs from entities that are already instances of other prefabs and contains overridden properties will maintain prefab links and overrides in the newly created prefab. Issues fixed Game Studio Duplicating an entity that was linked to a prefab was not maintaining the prefab link to the copy in some scenarios. Adding a new or existing package to a solution was causing a crash. Fix hashing of source files to detect if an source file has changed. Adding a component that requires unicity to a prefab when one of the instance already had an instance of this prefab was crashing. Fix a crash that could occurs when removing an animation or a sound from an Animation Component or an Audio Emitter Component while the Game Studio was still compiling the asset. Render stages are now properly re-evaluated when a property affecting rendering is modified (eg. casting shadows, adding transparency to a material...) Fix insert position when dropping multiple assets into a scene at the same time Fix opening a scene from a package project that is not a game was crashing. Fix a crash that was occurring when adding a new Override in the GameSettings asset Fix an issue when copy/pasting a component that requires unicity to an entity that already has one. Now the user will be correctly prompted whether this component should be replaced by the copy. Fix incorrect filter list of asset types in the asset view. Engine Fix an issue in the code detecting when a second component of the same type is added to an entity that should accept only one component of that type. Spotlights with shadows bug fix where multiple spotlights would reference the wrong shadowmap. Normal maps property names changed and some shader crashes fixed. Fix compressed normal maps having different signedness on different platforms; they are now always unsigned Fix Z component of normal maps when Scale & Offset is enabled Fix NaN values in normal mapping which caused glitches in post effects Fix shadow map range computation that caused parts of the scene not to be lit Reenable shadow cascade blending when automatic depth range computation is enabled and reduce the region of blending Fix invalid IL that prevented building UWP apps in release mode Version 1.9.3-beta Release date 2017/1/11 Enhancement Game Studio Maintaining ALT key down while moving an entity to a different parent will now keep its absolute position/orientation/scale Display the current version of Xenko in the Project Selection window Add more logging messages when creating a new project Improve tab header presentation, allow to see all open editors at once Engine Animation: UpdateEngine (used by animation system to update values) will skip updating values if target is an array or list (i.e. list of bones) whose size is not big enough. This was previously leading to memory corruption. Issues fixed Game Studio Fix issues with collection properties in the property grid. Fix an issue where thumbnail backgrounds get dark when in Gamma rendering pipeline. Fix some broken cases when clearing the archetype of an asset Fix a crash when dropping an object into the viewport Fix many crashes and issues occurring when moving or duplicating entities and folders in the entity tree of a scene or a prefab Fix some issues with selection of entities Fix issues with some pane of the editor not being visible while they were checked as visible in the View menu Prevent TreeViews to change scroll position when selecting an item if they were scrolled to another position while they didn't have the focus Fix properties that were all grayed when selecting multiple objects. Fix a case where Script assets would not open in the external text editor. Particles Fix a bug where Edge and Center definitions for trail shape renderer were swapped Fix a bug where None for particle material still displays color Physics Fix 2D boxes shapes collisions. Fix drawing of Characters debug shapes at run-time. Throwing if mass is negative. Fixed an issue with scaling and single collider shapes Audio Fix XAudio audio clipping when sounds were not looped. Fix OpenSLES multiple play of non looped sound. Improvements Game Studio Normal maps and Grayscale textures will now appear as 3-channel textures in the thumbnails and the preview. Connection Router Due to the way adb was spawning a daemon process, connection router port was locked due to socket handle inheritability. This is now properly disabled. Known Issues On Linux, when switching the underlying Graphics Platform, rendering will not occur or fail. Delete the cache, local and roaming folder on the Linux host and restarting the game should fix the issue. Performance issues on mobile (being worked on) On iOS if Enable device-specific builds is toggled on (from the project properties) it won't be possible to debug game code. Please manually select the architecture of your device from the Advanced tab to speed up your development."
  },
  "ReleaseNotes/ReleaseNotes-2.0.html": {
    "href": "ReleaseNotes/ReleaseNotes-2.0.html",
    "title": "Xenko 2.0 release notes | Stride release notes",
    "summary": "Xenko 2.0 release notes Highlights Scene hierarchy and scene streaming Working with scenes has become more flexible. Instead of a single scene, your game can now use a hierarchy of scenes to organize entities into levels, areas or layers, and let teams collaborate on them more efficiently. Game Studio displays child scenes together with their parent. Individual scenes can be loaded, unload, locked and moved around. When running your game, the default scene set in your game settings is loaded as the root scene and can be used to store persistent entities. More scenes can be dynamically loaded and unloaded from scripts and added as child scenes. var childScene = Content.Load<Scene>(\"myChildScene\"); SceneSystem.SceneInstance.RootScene.Children.Add(childScene); To get started, take a look at the new built-in SceneStreamingScript. It demonstrates background scene loading when passing through trigger volumes. You can now use a scene's Offset to move its entities both at design time and runtime. The ChildSceneComponent has been removed. We encourage all entities to be managed by a single entity manager and rendered by a single graphics compositor. Virtual reality Enabling VR is now as simple as a single click! Xenko's clustered forward rendering, with its multisample anti-aliasing, makes it ideal for VR. Xenko uses a single API for every device, with native support for Oculus and HTV Vive (more devices coming very soon). Xenko comes with a VR game sample that shows you how to implement VR gameplay, including environment interaction and teleportation: Save valuable time by visualizing and testing VR directly from the scene editor: Global illumination with light probes Light probes capture the lighting at the position you place them. They simulate indirect light, the effect of light bouncing off surfaces and illuminating other surfaces. They can make a dramatic difference to the mood and appearance of your scene. Light probes can be placed freely and are processed per pixel. This means you can use them not only on small dynamic objects, but also large or static objects (until we have light maps for those!). Last but not least, you can now very easily capture a DDS cubemap from current camera position in editor, for use as a diffuse or specular skybox light. Light shafts Xenko now supports shadow map-based light shafts for directional lights. Our implementation uses ray-marching rather than post effects, making the shaft visible and cool-looking even if the light source isn't visible. Graphics compositor The graphics compositor is now a separate asset. Rendering parameters (such as VR) and post effect parameters can be tweaked in just a few clicks. This is just the first step towards making the graphics compositor easy to customize and extend. Stay tuned for more changes in future releases! Improved Visual Studio experience We now have full support for Visual Studio 2017! Xenko Visual Studio extension now supports Visual Studio 2017 Game Studio recognizes Visual Studio 2017 Games can use C# 7.0, and our script editor can recognize C# 7.0 and offer C# 7.0 refactoring thanks to Roslyn (you need to make your solution VS2017+ for it to work) Our internal AssemblyProcessor which perform various operations on generated assemblies can now work with portable PDB (as generated by .NET Standard projects) Programmers working with Xenko often go back and forth between Game Studio and Visual Studio. To make their lives easier, we made a few key improvements to the Xenko Visual Studio extension: You can now open the current solution in Game Studio directly from Visual Studio. Syntax highlighting didn't behave well when switching theme. Previously, when assets are compiling, MSBuild didn't report any progress until finished. It now displays information, warnings and errors while it compiles. Also, our whole build infrastructure and script editor is now based on the latest version of MSBuild 2017 and Roslyn. Supporting the new VS2017 Project System with .NET Standard is just a few steps away! Faster and lighter In order to provide a better experience for users, we've been working hard on various fronts to make the editor smoother and more responsive. This is still a work in progress and expect regular improvements. Also, the package size is almost three times smaller, resulting in much faster download and install time. Breaking changes Backward compatibility Xenko 2.0 supports project upgrades only for projects created with Xenko 1.10 Beta. If you want to upgrade a project made with an older version, update it to Xenko 1.10 first. Visual Studio support Xenko 2.0 supports Visual Studio 2015 and Visual Studio 2017 as IDEs. Visual Studio 2013 and earlier versions are no longer supported. When upgrading a project from earlier version, in its .csproj file, set ToolsVersion=\"14.0\" as the minimum required version. Navigation All compontents related to navigation have been moved to their own SiliconStudio.Xenko.Navigation assembly and namespace. Graphics Compositor Previously, rendering pipeline was customized by magic IPipelinePlugin at runtime. This was very hard to control. Now, most of the pipeline configuration happens at design time in the new Graphics Compositor asset. RenderFrame is gone. Renderer are typically declaring and allocating render targets. Known issues On Linux, when switching the underlying Graphics Platform, rendering doesn't occur or fail. To fix the problem, delete the cache, local, and roaming folders on the Linux host and restart the game. Performance issues on mobile (being worked on) On iOS, if Enable device-specific builds is toggled on (from the project properties), it's not possible to debug game code. To speed up your development manually select the architecture of your device from the Advanced tab. Live scripting has been temporarily disabled Changelog Version 2.0.0.2 — 25 April 2017 Improvements General Added VR game template Game Studio and actual runtime game now share the same build cache. This should speed up build times. Build dependencies are managed by a new system that greatly simplify copying and deployment. This should later benefit plugins and user projects when exposed to the user Game Studio Improved how internal objects of an asset can be referenced Improved keyboard navigation in tree views (eg entity hierarchy in scene and prefab editors) Improved scrolling in tree views Improved drag and drop performance Entities can now be dragged and dropped from one scene to another Exceptions in the embedded game of a scene editor no longer crash Game Studio and can be recoverable Components of vectors can now be edited independently when using multi-selection Camera navigation now uses a different key set: Alt + left mouse button - orbit Mouse wheel - zoom Right mouse button - spin camera Middle mouse button - pan Right + middle mouse buttons - camera hover Added camera speed slider The \"New game\" template has been touched up \"Save\" and \"Save all\" have been merged into just \"Save\" Navigation mesh overlay visibility can now be toggled per group Scripts can now be closed without saving and opened again later Script undo history now persists after closing a script Added ability to capture a DDS cubemap from current editor camera position. When viewing vertex streams, normals are now in 0..1 range instead of -1..1. Also, it is now possible to view normals in both world and tangent space Assets Texture assets are now split into color, normal and grayscale subtypes Replaced SkyboxUsage enum on SkyboxAsset with a boolean IsSpecularOnly Improved robustness and error reporting on invalid Yaml when opening assets Engine Added support for splash screens (they show only in release builds) Audio Added HRTF binaural audio support for Windows (10+) Graphics Added MSAA support Added custom MSAA resolving filters Shadow cascade calculation is now more stable Multiple render targets now have better support Point lights can now cast shadows SkyboxComponent has been removed and the functionality moved into the LightComponent and BackgroundComponent BackgroundComponent now accepts cubemap textures as an input D3D11: Shaders that are compatible shares the same bytecode, avoiding extra state changes. OpenGL: Implemented UpdateSubresource for 3D textures Particles Additive rotation no longer has a default value of 1 radian; it's now 0 Initializers and updaters no longer add particle fields when disabled Physics Reworked collisions filtering to improve performance Navigation Bounding boxes can now be placed in the scene Navigation meshes can now be generated/updated at runtime TryFindPath now returns false instead of crashing if no navigation mesh is loaded Navigation mesh layer indexes have been replaced with groups VR Unique device-agnostic API Oculus Rift support (HMD and controllers) Vive support (HMD and controllers) Bug fixes Game Studio Naming project libraries now avoids collisions Invalid characters in the project name are now filtered out correctly and don't prevent the project compiling Changing gizmo sizes no longer causes the slider to jump Switching between gizmos no longer crashes the scene editor Asset copy/paste now works better Thumbnail behavior is now more stable Fixed leaking of deleted assets or entities when navigating through the selection history Fixed renaming assets undo/redo Renaming an asset no longer closes its editor Fixed reparenting assets with Alt key (maintains world position) Fixed many problems related to manipulation of entities from prefabs Fixed many problems related to moving entities in the scene hierarchy The property grid now properly handles multi-selection Fixed many problems related to properties overridden from Prefabs or from Archetypes Fixed many problems related to copy/paste in the property grid Fixed some cases where Create prefab from selection wasn't properly linking the selected entities to the newly created prefab Fixed several problems when manipulating the model or materials in a ModelComponent, especially when the entity is inherited from a prefab The material highlighting button now works properly Assets that failed to save now prevent Game Studio from closing and losing your changes Sprites can be selected again in the scene editor Undoing/redoing creation or removal of script assets now works correctly Setting a translation snap of 0 now works as expected Light gizmos correctly update when changing the light type Typing the URL to a reference in an asset picked now works as expected Keys were often stuck (especially annoying when moving around), this is fixed Assets Fixed an issue when asset compilation was failing due to WCF message size between slave asset builder being too big Engine Fixed right Shift key detection in WinForms The Start method of scripts is now always called before the Update method of any SyncScript in the same frame SyncScripts no longer cause crashes when scheduled from a different thread Scripts are no longer started or updated if another script removes them from the scene in the same frame ImageElements are now properly displayed when using a SpriteFromTexture Graphics Orthographic views no longer display broken shadows Shadows no longer disappear when viewed exactly vertically Cascade blending no longer causes holes in shadows Tesselated objects now cast shadows Normal-mapped object lighting is now correct when non-uniform scaling is applied Using unbound vertex streams in shaders no longer causes crashes Bright post effects are now more stable VR now shares shadows and culling for each eye Clustered lighting now works with multiple render views Fixed RGB/HSV color conversions Fixed engine exit when using RenderDoc profiling Fixed Multisample Quality Level for MSAA textures Tesselation and displacement mapping no longer cause rendering errors in the editor Renamed MSAALevel into MultisampleCount Physics Removing and re-adding entities no longer causes crashes in certain situations Version 2.0.1.1 — 28 April 2017 Bug fixes Game Studio Fixed a potential crash when enabling VR in the editor and opening multiple scenes/prefabs Prevents to drag and drop an entity that depends on a prefab into it (or an ancestor prefab) that would have created a cyclic reference and crashed the editor Fixed an issue with automatic assembly reload Engine Fixed a crash when computing light probes Build Fixed a possible issue when compiling a game that targets iOS and the right Xamarin version cannot be found Version 2.0.2.1 — 8 June 2017 Improvements Game Studio Visual Studio version picker now shows the installation nickname to easily differentiate when multiple instances are installed side by side Add the concept of active scene in the scene editor. Dropping an asset to the scene view will an entity add to the currently active scene instead of the root scene Graphics VR: Added a CopyMirror option to control if VR rendering is copied back to current render target Shaders: StructuredBuffer were being declared before their struct type; ordering should now be correct Bug fixes Game Studio Color Picker was behaving strangely due to some RGB to HSV conversion issues Global store.config was preventing Game Studio to find Xenko installation #576 Fix a crash that occurs when replacing a sprite in the property grid of a spritesheet Fix some string comparison that were using the current locale of the system, causing issues with some language such as Turkish Prevent modal windows from being minimized Restore some missing sliders in the property grid (that were replaced by a plain text box), review ranges and step values for most of them Fix a potential crash at serialization when a script had a null reference to another Entity or EntityComponent (and some other similar scenarios) Partial fix of the property grid template for entity component references Fix an issue with the property grid template used to edit char properties VR Fix runtime crash when adding twice the same VR device API in the required API list OpenVR: camera was rotating around world center instead of camera center when a rotation was applied on entity Graphics Fixed point lights not casting shadows from objects that have tessellation enabled Fixed a bug where some lights would not render #586 Android Fix a memory allocation that could make a game crash at startup on certain devices. Others Connection Router was not running properly if the Game Studio of that Xenko version didn't run first Add *.lock.json pattern to generated .gitignore file (when creating a project) Version 2.0.3.1 — 24 July 2017 Extend closure time of the promotion to 11:30am, January 1st, 2018 (UTC+09:00). Version 2.0.4.1 — 23 August 2017 Fix an issue with latest Visual Studio and MSBuild (15.3) #617 related to msbuild #2369."
  },
  "ReleaseNotes/ReleaseNotes-2.1.html": {
    "href": "ReleaseNotes/ReleaseNotes-2.1.html",
    "title": "Xenko 2.1 release notes | Stride release notes",
    "summary": "Xenko 2.1 release notes 12 September 2017 Highlights Local reflections Xenko 2.1 introduces local reflections. When you enable this post effect, the scene is reflected in glossy materials. You can enable and customize local reflections in the graphics compositor on the post effects properties. For details, see Local reflections. Clear coat shading Xenko 2.1 includes a clear-coat material template that uses physically-based rendering to simulate vehicle paint. Clear-coat shading has several advantages over creating the effect manually with material layers: layers are blended based on distance increased performance improved visualization You can add a predefined clear coat material from the Asset view under Add asset > Material. For details, see Clear coat shading. Thin glass materials You can now render thin glass materials such as windshields. The diffuse color controls the tint of the glass and how much light is blocked (darker colors block more light). You can add a predefined Glass material from the Asset view under Add asset > Material. Improved light shafts You can now use light shafts with any kind of light that casts shadows (ie point lights, directional lights, or spot lights). You can also use them with multiple shadow cascades. Additionally, Game Studio now displays light shaft bounding volumes in the scene editor, so you can easily see the areas where light shafts are created. To show or hide navigation light shaft bounding volumes, in the scene editor toolbar, open the gizmo options menu and use the Light shaft bounding volumes checkbox. The LightShaftComponent settings have been simplified and now have settings to control quality and performance. For details, see Light shafts. Texture streaming Xenko now supports streaming for textures. This significantly decreases the time it takes to load a game or scene, uses less memory, and makes your game easier to scale. Streaming is enabled for textures by default. You can find the option in the texture properties under Format. You can also set the global Streaming settings in Game settings. For details, see Streaming. Render masks You can now set which render groups a camera renders under Graphics Compositor > Entry points > Render masks. For example, you can have a model be visible to Camera A but invisible to Camera B. For details, see Render groups and masks. Improved profiler The Game Profiler script now displays more information and is easier to use. You can now: profile GPU information switch between CPU, GPU, and FPS-only results with F1 sort the result pages by Name or Time with F2 change how frequently the profiler gets and displays new results with - / + jump to a results page with the number keys, or move forward and backwards with F3 and F4 set parameters in Game Studio: For details, see Profiling. Debug text You can now display debug text at runtime. For more information, see Debug text. Rewritten input system The input system has been rewritten to track different input devices and allow for better extensibility. Allows detection of added/removed devices through events on the InputManager New device interfaces such as IMouseDevice, IKeyboardDevice, IGameController High-level IGamePadDevice replaces the gamepad functionality, with support for XInput Lower-level IGameControllerDevice allows access to numbered buttons/axes Automatic detection of plugged-in/removed controllers Support for different keyboard layouts and IME for text input Access to resolution and absolute coordinates for mouse/pointer devices KeyEvent now has a RepeatCount member, indicating how many times the key has been repeated while being held down For details, see Input. Improved Direct3D 12 support To support graphics functionalities on every platform, we've implemented missing features for the DirectX 12 rendering backend: compute and tessellation shaders unordered access views for textures and buffers structured buffers For more details, see the Changelog below. Improved environment fresnel Fresnel describes how light is reflected depending on the angle the material is viewed from. Typically, high angles are more reflective. Previously, Xenko used an imprecise polynomial approximation to compute the fresnel for environment lighting (such as cubemaps), resulting in a bigger-than-expected white outline. Xenko now defaults to a precomputed BRDF environment lookup texture that matches our default lighting equations (GGX Schlick). This produces much more accurate rendering. Japanese documentation The documentation is now available in Japanese. To switch languages, use the Language button in the top-right of the documentation site. Breaking changes Input system Renamed PointerState to PointerEventType Changed the members of PointerEventType: Down has been renamed to Pressed Move has been renamed to Moved Up has been renamed to Released Cancel has been renamed to Canceled Out has been removed; use Canceled instead Renamed InputManager.ActivatedGestures to InputManager.Gestures Changed checking support for sensors using Sensor.IsSupported to InputManager.Sensor != null (where Sensor is the name of the sensor you're checking) The HasDown/Pressed/ReleasedMouseButtons() functions on the InputManager are now properties Removed GetGamePad(); use IGamePadDevice.State to acquire a gamepad state To obtain a gamepad, use InputManager.GamePads, InputManager.GetGamePadByIndex(index) or use the InputManager.DeviceAdded/Removed events Removed GamePadState.IsConnected; use the InputManager.DeviceAdded/Removed events or check the value returned by InputManager.GetGamePadByIndex(index) != null Moved IsPadButtonDown/Pressed/Released() to the IGamePadDevice as IGamePadDevice.IsButtonDown/Pressed/Released() Moved the SetGamePadVibration() function to the IGamePadDevice Locking the mouse with InputManager.LockMousePosition() no longer automatically hides the cursor; use IGame.IsMouseVisible for this Removed PointerEvent.PointerType; use PointerEvent.Device is IMouseDevice to check if the event came from a mouse Removed PointerEvent.IsPrimary Renamed PointerId on PointerEvent to Id Renamed State on PointerEvent to EventType and its type to PointerEventType Removed KeyEvent.Type; to check if this was a pressed or released event, use the boolean KeyEvent.IsDown MouseWheelDelta is now -1 or 1 per scroll unit instead of -120 or 120 Removed MultiTouchEnabled on the InputManager; multi-touch is always enabled Light shafts Removed ExtinctionFactor and ExtinctionRatio to simplify the light shaft component Engine Renamed DebugConsoleSystem to DebugTextSystem Now default RenderStageSelector select all entity groups Known issues On Linux, when switching the underlying graphics platform, rendering doesn't occur or fail. To fix the problem, delete the cache, local, and roaming folders on the Linux host and restart the game On iOS, if Enable device-specific builds is on (set in the project properties), it's not possible to debug game code. To speed up development, manually select the architecture of your device from the Advanced tab Performance issues on mobile (being worked on) Live scripting has been temporarily disabled Changelog Version 2.1.0.3 - 12 September 2017 Enhancements General Updated the list of third-party libraries and sorted by editor and runtime dependencies Game Studio Reviewed and rewritten editor text (menus, button labels, tooltips and so on) Removed redundant dialog boxes Improved directional light gizmo visuals Improved translation gizmo design. Translation planes now always face the camera Reduced graphical glitches and optimized navigation mesh overlay rendering Removed special character restriction on string keys for dictionaries Changed the default color of the clear frame for better prefab editing Added a mark for the origin in the scene and prefab editor Added wireframe bounding volume for light shafts Added a context menu entry in the asset view to copy an asset's URL Allowed mixed document orientation in the dock panel Assets Updated to latest version of DirectXTex Improved the computation of dependencies between assets leading to faster build and thumbnails generation Changed how root parts of hierarchical assets (prefab, scene, UI) are referenced and serialized (direct references instead of Guids) Engine Added render group mask on the SceneCameraRenderer to cull entities per camera Improved the game profiler (reduced performance impact, improved UX & visual, etc) Added a profiling key to the script component for user script profiling Added streaming support for textures. Added support for GPU queries. Graphics FXAA Quality was crashing in many cases, because the value doesn't work with all numbers between 10 and 39. It's now exposed as two controls: a Dithering combobox and a Quality slider Improved MSAA depth buffer resolving Minor shader fixes Added option for random texture sampling to texture maps Enabled shadow casting for transparent materials Added IsAlphaCutoff option in sprite component Added swap function to Texture to swap the content of two textures Direct3D 12 Command List implementations for Dispatch, ClearReadWrite, Copy, CopyMultisample, CopyCount Resource state transitions fixes Resource barriers batching Added proper ClearValue setup for render targets and depth stencil buffers Added DX12 Debug Layer filter for irrelevant warnings Added support for: compute pipeline support tessellation compute, hull, domain and geometry shaders unordered access views for textures and buffers structured buffers staging textures and buffers Input Added AbsoluteMousePosition information to the InputManger. Improved gamepad support (new devices supported, improved API, runtime detection, etc.) Add interpreted key and IME input support Navigation Changed the default size of new navigation mesh bounding volumes to (1,1,1) Android Modify application context creation to allow use of external display UWP Implemented support for CoreWindow. Disabled for the moment Bugs fixed Game Studio Live update of the directional, point and spot light gizmo color wasn't working Enabling/disabling light shaft bounding volume components now works as intended Added \"Fix references\" dialog when removing directories with assets Corrected lots of English mistakes Fixed lots of issues with copy and paste (and replace). Notably it is now possible to copy entities from a scene and child scene at the same time. Fixed issues with \"Create library from selection\" in the UI editor Made the GameStudio crash in some rare cases where exceptions could leave a project in a corrupted state Fixed various isues in the UI editor when moving elements in the hierarchy Fixed issues with thumbnails generation Fixed issues with the anchor of a child scene Assets Asset compilation of huge FBX was sometimes ending in timeout Fixed normals, tangents and bitangents NaN values happening during model import Engine Fixed various memory leaks, especially when destroying a game Clustered lighting code was buggy when rendering to multiple views Fixed sprite bounding box and frustum culling calculation Fixed texture and buffer memory calculations accessible from GraphicsDevice Removed obsolete ChildSceneComponent class Graphics Fixed bug with grid ignoring depth with MSAA enabled Added support for nointerpolation/noperspective in Xenko shaders Fixed various problems with black artifacts in the shaders (NaNs and invalid normals) Light shafts now work as expected when using self-overlapping bounding volumes Fixed light probes applying previous environment light twice when there are no light probes Material specular map IsEnergyConservative now properly taken into account Fixed transparent materials shadows Fixed transparent and alpha cut off materials shadows Fixed two-sided and flipped material shading Fixed mipmap counting Physics Fixed capsule shape orientation"
  },
  "ReleaseNotes/ReleaseNotes-3.0.html": {
    "href": "ReleaseNotes/ReleaseNotes-3.0.html",
    "title": "Xenko 3.0 release notes | Stride release notes",
    "summary": "Xenko 3.0 release notes August 2, 2018 Highlights Xenko is now a MIT community-based opensource project! You read that right. Xenko 3.0 is out now, released under the permissive MIT License. From now on, you can use and modify Xenko completely free — whether you're a professional, a student, or just looking for a new hobby. This includes the runtime and editor. Silicon Studio no longer supports Xenko, but members of the Xenko team will continue to work on it as part of the community. We encourage people to help us and contribute to the project. If interested, join us on GitHub. We are really excited to see what people will come up with! Thanks for supporting Xenko! New project system Both Xenko itself and users project are now built on top of the new project system. It means your game csproj are now simpler as ever, with only a PackageReference to Xenko. This makes package restore, upgrade and selection much more convenient. Opening a project with a non-installed version of Xenko should work out of the box too, as long as Xenko launcher is installed. Longer down the road, the plan is to split Xenko further into separate packages such as Xenko.Graphics, Xenko.Physics and Xenko.Editor (and possibly host them directly on nuget.org). Video It is now possible to add video to your games. Note that this feature is not completely tested and supported on all platforms, but we decided to include it anyway and tune it later to not delay the MIT release further. Skin and Hair rendering Skin and hair rendering are now possible with Xenko. Skin rendering is based on subsurface scattering, and hair rendering is based on Kajiya-Kay and Scheuermann models. Same as video, this feature might still need some improvements and tuning, but we decided to not delay the MIT release further. Breaking changes Xenko namespace changes Lot of namespace changes to decouple the namespace from SiliconStudio: SiliconStudio.Xenko renamed Xenko SiliconStudio.Core and SiliconStudio.* renamed Xenko.Core Projects should automatically be updated, but we recommend you making a backup of your project before, and double check everything is good after the upgrade. New project system Game project will be recreated with the new project system. This should happen automatically but you might need a few tweaks afterwise (i.e. readjust Build Action on certain csproj items). Changelog Android Fix calls to OnPause and OnResume when the application is put on background/foreground. Fix regex used to check version of android ndk. Android.Tests Fix crash when launching test activity from test launcher. Animation Add the possibility to import animation curves of custom attributes present in FBXs. AssemblyProcessor Generate serialization code directly with Cecil Look into interfaces contained in base classes when generating ListUpdateRevolver registration code. Removed iOS workarounds (calli generics and unbox) Support PinnedType Use ILRepack from NuGet AssetCompiler Install target redirect on first build, and improve path detection Show URL of asset in case of exceptions in Command Assets Add the possibility to not to merge meshes of a model without skeleton to benefit of culling. Add the possibility to use a model without animation as reference of a diff animation clip. Automatically track source code changes (DefaultItems) Factorize SoundAssetCompiler for future use (video) Fixed Assets.Tests nuget packages/app.config Introduce `IAssetWithSource` interface to unify `AssetWithSource` with other kind of assets having a source (e.g. `ModelAsset`). Move Sound asset classes into `Media` namespace Package upgrader for BackgroundComponent.Is2D Sound: Use ShellHelper to call ffmpeg Assets.Compiler Reorganized remote builder in Assets.CompilerApp rather than BuildEngine.Common Assets.Editor Remove deleted resx from csproj Assets.Model Added mechanism to customize models during asset compilation. Audio Various improvements (courtesy of Pierre and Jonathan) Audio.Tests Temporarily remove 4 channels sounds (fails with ffmpeg) Test not compiling since SoundPlayState => PlayState renaming Audio/Video Detect FFMpeg errors Build Add explicit TargetFramework to project files Added DataMemberIgnore on LocalReflections.DebugModes to avoid serialization mismatch Added props/targets redirection for NuGet consumption Added System.ValueTuple (temporary fix until we switch to PackageReference for Xenko itself) Bumped Windows 10 SDK to 10.0.16299.0 Change explicit TargetFrameworkVersions to TargetFramework Convert to PackageReference Define the TargetFramework for tooling assemblies Delete all packages.config and includes Disable native build during design-time build Explicitly include Microsoft.NET.Sdk props/targets for a few more projects that were not compiling correctly Explicitly include Microsoft.NET.Sdk props/targets to be able to override some values Fill list of files to cleanup only when running the clean target Fix compilation of shader related projects Fix CoreCLR build Fix language targets for WPF projects Fix OutputPath Fix package build Fix skybox not working with compressed cubemaps. Fix some project builds Fixed incremental build (still not perfect, waiting for more info on https://github.com/dotnet/project-system/issues/3157) Fixed unit test and package builds If SiliconStudioCompilerTargetsEnable is set to false, override LanguageTargets to an empty one Include *.cs files that are not in the project directory List resource folders explicitly in .xkpkg Make Xenko Native .cpp/.h file globbing faster by ignoring obj/bin folders More cleanup Moved sources from sources/common subdirectory to sources so that everything is at the same level Override SiliconStudioXenkoOutputPath even if set Remove *.CSharp.targets imports Remove default comments Remove many unnecesssary properties Remove Microsoft.Common.props imports Remove most attributes from AssemblyInfo.cs Remove obsolete files Remove references to default framework assemblies Remove some redundant Compile item updates Remove ToolsVersions Remove unnecessary *.cs file includes Remove unnecessary xml directives Removed CoreFX Removed LZMA compression (better to be directly supported at NuGet level?) Removed SiliconStudio.Presentation.SampleApp (not used) Removed unused SharpDiff Removed unused SharpDX.Mathematics from deps (using NuGet version already) Removed unused SQLite Revert samples to not use new csproj system for now Revert unit tests to old system for now Run AssemblyProcessor right before assembly is copied rather than during CoreCompile (which happens during Visual Studio loading) Setup proper AssemblyName for packageinstall assemblies Setup target for cpp (respecting SiliconStudioCompilerTargetsEnable) SiliconStudioXenkoReplaceVersionInfo target was not working properly with new build system Simplify ProjectReferences Switch to new csproj system for games Switch to nuget version for Mono.Options Switch to nuget version for Mono.TextTemplating Tests projects now have a Service in csproj with latest VS update Update *.cs files with additional properties, instead of including Update .gitignore for launchSettings.json Update build instructions Update embedded resources instead of including Update project file headers Updated LLVM to 5.0.1 (avoid some issues with \"terminate\" missing symbol on UWP, which should resolve to std::terminate) Updated THIRD PARTY.md to reflect usage of DocFX rather than SharpDoc Upgrade to new csproj format Use MSBuild 15.5 from MyGet Use Windows SDK v10.0 instead of v8.1 for d3dcompiler_47.dll Various improvements/fixes for the new project system Workaround for https://github.com/xamarin/xamarin-android/issues/1235 (Android resources not being properly merged in incremental build) Workaround for solution dependencies with incomptable frameworks: https://github.com/Microsoft/msbuild/issues/2661#issuecomment-338808156 BuildEngine Tests: fix build since SlaveBuilderPath has been removed Cecil Protect against null reference exception when there is no yields in async method Update to latest Cecil + ILRepack Core Remove unnecessary constraint on generic parameters of extension methods `DisposeBy` and `RemoveDisposeBy`. Core.Tests Disable when building with CoreCLR or if SiliconStudioSkipUnitTests is set Fixed csproj so that it properly builds CrashReport Turned into a shared project Deps Removed unused lzma.exe Removed unused NuGet libraries (using PackageReference instead) Update checkout scripts. Update version of ffmpeg to from 3.3 to 3.4. Editor Change editor build directory to project Cache directory even in Dev mode. Remove fallback folder property from the settings (misleading). correct lens flare display attribute FindTemplates according to current session (or default package if no session loaded) Fix NullReference crash when asset is mising the DisplayAttribute. Update localization files. Update localization files. Also updated some comments. Updated to CodeAnalysis 2.4.0 and RoslynPad 1.0.4 (from NuGet) Engine Add a flag to be able to force the engine to update the animation evaluator cache (useful when updating clip channel values at runtime). Add getter to AnimationProcessor in order to be able to access AnimationClipResult. Added texture projection to light spots (courtesy of Mirsad) AnimationBlender: Implement blending for type Float1. Change log level of ffmpeg to `fatal`. `error` level can display recoverable errors. Clamping the normal.z value to (0, 1) to prevent NaN result from sqrt(). Code cleanup. Delay the initialization of the shader parsers to first usage instead of first shader loaded (significantly reduce the load time in case no shader need to be compiled). Fix LightShafts with shadowmap transmittance Fix several crashes and multi-threading issues happening when modelNodeLinkComponents is targeting a model not in its parent hierarchy. Implement interface ICollectorHolder in ScriptComponent to be able to automatically dispose objects during the script Cancel method. Minor cleanup Move ModelNodeLinkProcessor before TransformProcessor to avoid to have the first frame where the transformation is not updated. NotNull and cosmetic improvements Removed some unused code/files Return the created PlayingAnimations when adding a new AnimationClip for convenience and consistency with other play functions. Streaming: Added a new DoNotStream option Support moving entity inside scene UpdateEngine: look for member updater coming from base classes before falling back on custom resolver. ExecServer Remove LoaderOptimization.MultiDomain FBX Switch to FBX SDK 2018.1.1 FBX.Importer Optimize calculation of Quaternion from XYZ rotation keyframe. Game Add the possibility to render the splash screen as a double view for VR games. GameStudio Remove expiration General Removed bunch of unused files and fixed some license headers Graphics Add support for panorama 2D textures to skybox asset. Add ViewDimension property on Texture. Adjust code accordingly so that the engine behaves properly on View textures. Added a cast in SubsurfaceScatteringBlur.cs. Added a check to see if the MaterialIndices buffer is used before overwriting \"allTargets[1]\". Added a comment in MaterialHairLightAttenuationFunctionDirectional.xksl. Added a comment. Added a first version of the MeshHairRenderStageSelector class. Added an exception. Added comments. Added NotNull Added PCF for SSS thickness. Refactored the PCF code. Renamed \"CalculateThickness()\" to \"FilterThickness()\". Added some casts to fix shader errors. Added support for cavity & occlusion maps in the hair shading model. Added support for choosing which normals to use for the directional light attenuation for hair. Moved a computation from the GPU to the CPU. Added support for configuring the scattering kernel parameters. Refactored the scattering kernel generation. Added support for fake shadowing. Added support for per-material scattering kernels and scattering profiles. Added support for resizing the material array for the SSSS post process. Refactored the code. Added support for up to 256 scattering kernels in the SSS post-process by storing the kernels in a buffer. Added the missing multiplication by the diffuse color for the scattering. Added two editor-tunable (not yet integrated) parameters for the SSS transmittance. Baked a calculation into the SSS scattering kernel so it doesn't have to be executed in the post-process. Based the SSS shading model on the diffuse lambert one instead of the CelShading one. Removed redundant files. Cleaned up some spotlight code. Cleaned up the \"SubsurfaceScatteringBlur\" class. Cleaned up the SSS transmittance profile and scattering kernel generation code. Cleaned up the SSSS post-process shader. Correctly integrated the depth-stencil resolve for hair and transparent objects. Defined default values for properties and simplified the code. Fed the proper NdotL term into certain functions. Little refactoring. Applied shadows to the specular reflections. Finalized the indirect specular hair lighting for now. Fix 2D texture skybox shader compilation crash with graphics API level < 10 Fix D3D12 build Fixed a bug causing the shadow map offset to be calculated incorrectly for certain light directions. Fixed a bug causing the shadow map pixel thickness streams variable not to be set. Fixed a bug in the SSS post-process which caused the scattering kernel to become distorted in non-square viewports. Fixed a bug inside of ShadowMapReceiverSpot.xksl. Fixed a bug which caused NaN with the Scheuermann approximation shading mode. Cleaned up and commented the hair shaders. Fixed a copy-paste error. Fixed a Mizuchi bug in the indirect hair lighting. Fixed back face rendering for opaque hair geometry. Removed debug code. Refactored the hair-specific code in MeshPipelineProcessor. Fixed new, minor shader compilation errors. Fixed some SSS thickness calculation artifacts by supply the correct, world space normals instead of object space normals. Fixed some stuff in the hair rendering code and cleaned it up. Fixed SSS thickness calculation for spotlights. Fixed the bug which causes the thickness to fade to 1.0 and not 0.0 at the border of shadow maps. Fixed the cavity map integration for the hair shading and removed the obsolete cavity parameter. Fixed the incorrect force to renderbuffer for all FBO attachments. Refactored the code. Fixed the issue with the constant buffers + mixins that are included multiple times per hair shader. Refactored the hair rendering code. Further cleaned up the SSSS shaders. Got rid of the circular dependency between SubsurfaceScatteringBlur and SubsurfaceScatteringRenderFeature. Hid the \"Enabled\" property of the MSAAResolver in a safer way. Implemented \"FilterThickness()\" for lights without PCF shadows. Implemented a debug mode for the hair shading. Implemented a list to choose different types of scattering profiles from for SSS (WIP). Implemented a more accurate offset for the SSS thickness filtering to greatly reduce the artifacts around object edges. Implemented a new extension point in \"MaterialSurfaceLightingAndShading\" and \"IMaterialSurfaceShading\". Implemented a PipelineProcessor for hair and disabled the hair-specific code in MeshPipelineProcessor. Implemented cascade blending for the thickness calculation using directional shadow maps. Implemented deduplication for the scattering parameter array in the SubsurfaceScatteringRenderFeature to save space in the array. Refactored the code. Implemented force-disable of MSAA on iOS, so it compiles. Implemented MSAA for Desktop OpenGL. Fixed the MSAAResolver serialization. Implemented MSAA for OpenGL ES. Simplified and optimized some OpenGL code. Implemented new diffuse and specular shading models for the hair based on the default shading model implementations. Implemented preliminary in-shader scattering profile generation and precomputed scattering profile support. Implemented proper support for fake shadowing, shadowing and scattering. Some refactoring. Combined duplicate code. Added more parameters. Moved some range checks to CPU. Implemented scattering strength writing to alpha channel, so the post-process can sample it. Implemented scattering support for point lights and improved other thickness calculation things. Implemented support for changing the hair shading model. Refactored the shaders. Temporarily disabled support for noise textures. Replaced \"Texture\" properties with \"IComputeColor\". Updated userdocs and summaries. Implemented support for changing the render mode of the SSS post-process from within the editor. Implemented support for orthographic and perspective projections for SSS. Got rid of the \"DepthFalloffStrength\" parameter. Implemented support for SSS strength maps. Implemented the \"SubsurfaceScatteringSettings\" class and hardcoded the sample count for now. Integrated it into the dependent classes. Implemented the first version of the SSS transmittance lighting as a new shading model. Implemented the new streams variable \"meshNormalWS\" and integrated it in the hair shading and SSS. Implemented the Separable Subsurface Scattering post process as a new ImageEffect. Implemented the SSSS strength map using ComputeColor for more artistic freedom and proper mip map selection. Implemented two new parameters for controlling the specular noise textures for hair shading. Commented out unused code. Improved the jittering in the SSSS post-process shader and refactored it a little. Improved the SSS material array and index generation for the post-process. Improved the SSS thickness filtering artifacts by calculating a better normal offset. Included the MeshHairRenderStageSelector class in the project. Increased the allowed number of digits for the hair specular strength to three. Integrated correct, world space normals for the SSS transmittance calculation. Integrated optional kernel size jittering to break the banding artifacts. Improved the rotation randomization. Removed some obsolete code. Integrated screen space scattering kernel generation. Replaced the \"Quality\" parameter with \"SampleCount\". Integrated support for generating a subsurface scattering material index buffer that is consumed by the SSSS post process. Integrated the editor-tunable parameters for the shading model. Implemented transmittance support for PCF shadows. Little code simplification. Little refactoring in the specular hair model feature. Made \"SpriteBase.xksl\" always write zero to all render targets in order to prevent uninitialized framebuffer regions (to prevent having an SSS material index in the sky). Made all the materials write to the SSS material index buffer. Made it possible to enable/disable the SSS material deduplication. Cleaned up and commented code. Made multisampling get disabled when OpenGL ES 2 is being used. Added logging for adjustments of the multisampling level. Made the opaque hair geometry render using the \"Opaque\" RenderStage and removed the \"HairOpaque\" RenderStage from ForwardRenderer. Made the specular hair lighting get attenuated by alpha, so transparent regions don't exhibit specular reflections. Made the SSS post-process get skipped if no scattering materials are visible. Made the SSSS post-process work accurately for non-square viewports too. Refactored the code. Disabled the debug shader code. Fixed the inverted clip space coordinates. Made the Transparency material feature get ignored if hair shading is on to prevent issues. Minor refactoring in the hair code. Moved SSS mixins to a subfolder. Moved the \"MaterialHairSurfaceData\" structure to the specular hair shader because it's only needed there now. Renamed \"MaterialHairSurfaceData.xksl\" to \"MaterialHairShared.xksl\". Moved the angle conversion to the CPU side. Moved the definition of the screen space scattering kernel (for SSSS) out of the shader. Moved the hair shader mixin code files to the correct subfolders. Renamed some shaders and classes. Moved the hair shader mixin code into subfolders for better overview. Moved the SSSS post processing code to the correct folder within the project. OpenGL: Fix regression where depth textures used as SRV were created as render buffers rather than textures. Ported and integrated most of the Mizuchi diffuse and specular hair shading functions. Implemented editor parameters. Readded missing SpriteBatch.bytecodeSRgb.Vulkan.Level_9_1.cs Refactored fake shadowing into a drop down option with accompanying parameters. Removed obsolete code. Refactored hair direction (tangent/bitangent) and shadowing/scattering options into drop down options with accompanying parameters. Removed obsolete code. Refactored the code. Refactored the hair rendering code. Adjusted properties. Implemented \"GetHashCode()\" for all hair classes. Removed obsolete code. Replaced float4 with float3 in shaders. Refactored the hair shaders. Implemented overrides for PrepareForLightingAndShading and integrated support for noise maps using ComputeColor. Refactored the HairRenderFeature class. Multithreaded some code. Refactored the simplified the MSAAResolver class. Made the MSAAResolver stay always on to get rid of redundant code and to make the editor settings more obvious. Refactored the SSS thickness calculation shader code. Refactored the SSSS material array generation, so the material array gets allocated only once at startup and from then on gets modified only. Refactoring and cleanup. Removed duplicate and redundant code. Refactoring. Got rid of duplicate code. Slightly changed the environmental lighting. Implemented the option for the shading model using an enum. Reimplemented the hair \"tag\" as a ParameterKey so hair meshes can get filtered out correctly. Updated the RenderStageSelectors. Reimplemented the hair rendering using the new multipass feature. Fixed some hair shading issues. Reimplemented the specular environmental lighting using IMaterialSpecularMicrofacetEnvironmentFunction. Reimplemented the SSS as a separate material feature. Removed obsolete material parameters. Remove unused built-in shader bytecode Removed a commented out line of debug code. Removed a project include. Removed an obsolete line of code. Removed dead code. Removed obsolete code from \"MaterialSurfaceShadingDiffuseHair.xksl\". Removed obsolete hair render stages from \"ForwardRenderer\". Removed obsolete hair rendering code. Removed obsolete shader code. Updated comments. Moved the \"AfterLightingAndShading()\" shader extension point. Removed redundant hair shading code. Removed some obsolete code from \"MaterialSurfaceShadingSpecularHair.xksl\". Removed the \"MaterialSurfaceShadingSharedHairKeys\" class and replaced its \"IsHair\" parameter with \"PassID\". Removed the \"override\" keyword from \"FilterThickness()\". Removed the manual PCF thickness filtering code after confirming that there's no visual difference compared to taking one interpolated sample. Removed the obsolete Fresnel, Visibility and Distribution mixins & properties from the hair model feature. Removed the scattering kernel parameters from Material.cs and stored them using material parameters instead. Some refactoring & bugfixing. Removed unused includes from the cel shading shaders and removed duplicate code. Removed unused parameters from \"LightDirectionalShadowMapRenderer.cs\". Removed unused parameters from \"LightSpotShadowMapRenderer.cs\". Renamed \"MaterialHairLightAttenuationFunctionDefault\" to \"MaterialHairLightAttenuationFunctionDirectional\". Renamed a parameter of the SSSS post process. Renamed some SSS classes and shaders. Changed the way the scattering strength map is handled. Renamed the property \"Fake shadowing function\" to \"Light attenuation function\" and added comments. Replaced IComputeColor with IComputeScalar for the hair noise maps. Separated out the scattering kernel as an additional setting, independent of of the scattering profile. Simplified the code using existing streams variables. Implemented the \"UseTangent\" setting. Added explanations and numerical ranges for properties. Simplified the PCF shadow and thickness code. Simplified the shadow map thickness filtering code. Specified correct numerical ranges for the SSS shading model parameters and added userdocs and summaries. Made it possible to change SSS parameters without waiting for a shader recompilation. Temporarily disabled the \"scatteringWidths\" array for the SSSS post process. Implemented a discard for materials with a material index of zero. Temporary integration of hair rendering using three render passes (opaque, transparent back, transparent front), which exhibits flickering. Update source to match new material pass API Updated an outdated comment about MSAA support. Updated comments in SSS code. Updated the SSS \"Translucency\" default value so it matches the one of the SSSS demo & Mizuchi. Graphics.Tests Bump gold image version (skybox compression changes) Importer.FBX Add support for partial animation of a vectors (use default value instead of 0 for component missing animation curves). Input Add missing keyboard key mapping for Android. Android: Fix issue with PointerPressed/Released list being constantly empty (update was performed twice). Various fixes for orientation sensor on Android (courtesy of Pierre) VirtualButton: add IsDown/Pressed/Released methods. Create VirtualButton.Pointer classes. Make constructors protected so that types can be inherited. Improve code. Input.Tests Fix compilation issues. Install Removed Portable Library from prerequisites Removed unused BuildTools_MSBuildNuget.msi Launcher Adapted to support new nuget packages Fix self-upgrading since switch to NuGet 4.0 Fixed with new build system Reorganize settings (no more store.config, because we might have Xenko from package install rather than Launcher) and better detection of dev packages on server side Misc Cherry-pick manu/nuget3 branch Fixed the Engine project file. Resolved the merge conflict on the file \"SiliconStudio.Xenko.Engine.csproj\". Revert \"[Build] Override SiliconStudioXenkoOutputPath even if set\" Revert \"[Skin/Hair] Hide Hair/Skin parameters until working properly\" Updated the year in the copyright notice. MSBuild Improved MSBuild detection to use installed version rather than local nuget copy MSBuildLocator: Run it only if MSBuild assemblies not detected (they might be loaded if ran as part of MSBuild) Updated from 15.5.180 to 15.6.82 Native Compute XenkoNativeOutput.Link only when OutputPath is properly computed (inside a target) OpenGL Fix for \"Requested renderbuffer is neither a render target nor a depth/stencil attachment.\" issue when using post effects of openGL. Package Readded tools folder (needed for packageinstall.exe) Packages Download report and package installer fixed with NuGet 4.0 Removed potential future namespace collision Various improvements to make new nuget system works better Physics Fix crash in physics engine when collider shapes are removed from the scene and unloaded during the same frame. Prerequisites Readd Microsoft.Net.Component.4.6.1.TargetingPack to MSBuild prerequisites Presentation Remove an InvalidCastException in AssetFromFileTemplateGenerator Preview Fix the texture preview in the case the texture has no alpha channel. Rendering Add EyeIndex and EyeCount shader variable information via new GlobalVR shader. Add support for panoramic 2D texture as 3D input of BackgroundComponent. Add the possibility to select sprite blending mode from the Game Studio. Fix black screen rendering issue when post effects are used without VR texture mirroring. Improve FastTextRenderer robustness. Reallocate buffer when maximum number of character is exceeded. Resource ranges were mixed up with data ones when computing satrt offsets Skin: remove declaration of SV_Target* when unused, and use another mechanism to detect if material index MRT is needed Temporal AA (Velocity Buffer courtesy of Guus) Samples Fix compilation of the VR sample. SceneEditor Add debug physic shape for infinite planes. Do not ignore depth while writing the physics gyzmo. Scripts Removed deadlock between ScriptSourceFileAssetViewModel.DocumentId and UpdateAssetFromSource (can't seem to reproduce XK-5104) When creating a script, \"do you want to save\" dialog didn't do what it was supposed to do Serialization Fixed missing generic info when initializing parent serializer Shaders Explicitly qualify Annotations namespace to avoid future conflicts with Xenko.Core.Annotations namespace. Removed glsl-optimizer (causing some issues on Android) Removed potential future namespace collision SharpDX Updated to NuGet version 4.0.1 Skin Additional changes to work with new MRT system Skin/Hair Added package upgrader for effect log (new generic parameter for directional light shadow caster) Compute transmittance is now set in the light shadow parameters Hide Hair/Skin parameters until working properly Improve package upgrader to work on any xkeffectlog file (instead of just the default one) Skybox Upgrader for SkyboxShaderCubemap renaming in effectlog Store Changed how package paths are detected Streaming Fix crash happening when a texture was simultaneously used as background and video target. Templates Moved ProjectTemplateGeneratorHelper.cs to Xenko.Assets Tests Bumped packages Bumped packages & adjusted package upgrader version check TexTool Fix Rescaling of 16bits pixel single channel textures. UpdateEngine Added path resolve for ParameterCollection/ParameterKey Userdocs rename glossiness -> gloss, more natural English update skybox asset and background component labels and userdocs Video Added SharpDX.MediaFoundation to UWP projects Added support for video rendering (Windows and Android only for now) Added Video assembly to unit tests Ensure that the video file format is mp4 on windows. Fix #ifdef preprocessing instructions in ffmpeg files and make assembly graphics API dependant. Keep in sync with feature branch Strip away STEREO3D side_data information when present during video compilation on window. Video/Audio Keep in sync with feature branch VisualStudio Fix project references VR Add implementation of Recenter for DummyDevice and OpenVR. Follow orientation sensor (courtesy of Pierre) VSPackage Fix vsix build with new csproj system Yaml.Tests Fix unit tests using EmbeddedResources Changelog Version 3.0.0.4 — 25 August 2018 Reactivate Linux platform support #17 SourceLink support: Visual Studio downloads Xenko debug source code on demand #79 Windows Mixed Reality support for UWP #85 Fix GameStudio crashing when editing files with the simple code editor #110 GameStudio: New dark Theme and glyph icons #4 #50"
  },
  "ReleaseNotes/ReleaseNotes-3.1.html": {
    "href": "ReleaseNotes/ReleaseNotes-3.1.html",
    "title": "Xenko 3.1 release notes | Stride release notes",
    "summary": "Xenko 3.1 release notes November 11th, 2019 Highlights Xenko 3.1 loves NuGet! Xenko was always a big proponent of NuGet: since first version, Xenko was distributed as a NuGet package. However, due to limitations (hello packages.config and project.json!), we were leveraging NuGet more as a distribution medium than proper NuGet packages: Xenko 3.0 is still a monolithic single package and it would not work out of the box when referenced from Visual Studio without using Xenko Launcher and Game Studio. Xenko 3.0 paved the way by making Xenko compatible with the new project system (game projects were referencing Xenko using a PackageReference). Today, Xenko 3.1 brings Xenko as a set of smaller NuGet package, each containing one assembly, with proper dependencies: As a result, it is now possible to create a game project that references only the packages you want. Here are a few examples of \"core\" packages: Xenko.Engine: allows you to use core engine runtime (including its dependencies) Xenko.Core.Assets.CompilerApp: compile assets at build time Xenko.Core.Mathematics or Xenko.Graphics: yes, if you want to make a custom project only using Xenko mathematics or graphics API without the full Xenko engine, you can! Xenko.Core.Assets, Xenko.Presentation or Xenko.Quantum: all those piece of tech being used to build Xenko tooling are also available for reuse in other projects. Nothing prevents you from generating assets on the fly too! Then, various parts of the engine are distributed as optional packages: Xenko.Physics Xenko.Particles Xenko.UI Xenko.SpriteStudio Xenko.Video If you don't reference those packages, they won't be packaged with your game either. In many situations, it results in a smaller packaged game and improved startup time. Also, you are free to replace those functionalities with alternative libraries. Xenko assets are also distributed as part of package NuGet packages have a xenko folder containing Xenko assets. As a result, user are able to generate nuget package containing Xenko assets out of the box from Visual Studio and publish them on NuGet for general consumption. Package layout: following best NuGet practices Previously Xenko references were added to the project using custom targets. New packages are now be layout as NuGet/Visual Studio expects them, in folders like lib/net45 and lib/monodroid10. We still have a few custom MSBuild targets but reduced them to minimum. Xenko Packages are now distributed on nuget.org With all those changes, it makes sense to stop distributing Xenko on our custom nuget server and use nuget.org instead. This will greatly reduce friction to try Xenko (any project would work out of the box in Visual Studio). This might also make our launcher completely optional in the long run. Xenko tooling resolves assemblies dynamically using NuGet API Tools such as GameStudio or Asset Compiler are distributed as NuGet packages. However, it won't bundle Xenko Runtime, which will simply be encoded as dependency. When running those tools, they are resolving Xenko runtime assemblies directly in the NuGet cache. This allows for distributing those tools as very small and easy-to-upgrade packages, avoiding file duplications. This is similar to what dotnet-cli is doing with deps file. This brings lot of technical challenges but should allow us in the future to be more flexible in the future to load the exact runtime and plugins that the user project reference rather than the one hardcoded with the tool. Future: plugin support for editor Xenko 3.1 editor will still be monolithic: editor support for UI, SpriteStudio, Video and other optional modules will be hardcoded. However, the target is to get rid of them as soon as possible, and treat them as what they are: plugins. Full switch to .NET Standard Xenko supports .NET Standard for most of its runtime assemblies. Xenko games can run on .NET Core for both Windows and Linux. Tutorials Xenko now has a tutorial section in the documentation! The first project “C# Beginner”, demonstrates 12 beginner programming concepts. Users will be able to select the tutorial template when creating a new Xenko project to practice and experiment with the code. Additionally, the code used in the project is directly referenced by the new documentation section which explains each individual tutorial level. The amount of tutorials, as well as intermediate and advanced tutorials, will be extended/added from now on. BulletSharp update Eideren worked on updating our old custom modified version of BulletSharp (the wrapper library we use for our physics engine). Things should be much easier to maintain from now on. Changelog This release also contains numerous improvements, bugfixes and new translations. Here is the full changelog in all its glory: Alex (1): Fixed spelling error in Quaternion.cs view commit Allan Nordhøy (9): Added translation using Weblate (Norwegian Bokmål) view commit Added translation using Weblate (Norwegian Bokmål) view commit Added translation using Weblate (Norwegian Bokmål) view commit Added translation using Weblate (Norwegian Bokmål) view commit Translated using Weblate (Norwegian Bokmål) view commit Translated using Weblate (Norwegian Bokmål) view commit Translated using Weblate (Norwegian Bokmål) view commit Translated using Weblate (Norwegian Bokmål) view commit Translated using Weblate (Norwegian Bokmål) view commit Andrea Aruta (6): Added translation using Weblate (Italian) view commit Added translation using Weblate (Italian) view commit Added translation using Weblate (Italian) view commit Translated using Weblate (Italian) view commit Translated using Weblate (Italian) view commit Translated using Weblate (Italian) view commit Charles Woodhill (1): [UI/INPUT] Expose mouseOverElement view commit Christian Georgiev (2): Added translation using Weblate (Macedonian) view commit Translated using Weblate (Macedonian) view commit Cody Lee (4): Added issue templates for bugs and feature requests (#327) view commit Moved pull_request_template.md to correct location view commit Removed any pluralization of the word question in the question_request.md for consistency view commit Updated CONTRIBUTING.md and added a 'submitting changes' section view commit Daniel Keenan (2): Change the ObjectToTypeName value converter to give prettier C# names. (#400) view commit [GameStudio] Improve \"Add component\" button usability. (#411) view commit Dominik Jančík (6): Initial SDL Finger Multitouch support view commit Removed lastCtrl field view commit FingerSDL GUID view commit FingerSDL PointerID generator view commit Renamed FingerSDL to PointerSDL view commit SDL Touch>Mouse synth. disabled when PointerSDL is used view commit Eideren (55): Include nuget to proj view commit Straightforward changes view commit Potentially harmful changes view commit Minor proj update view commit Matrix conversion fix view commit Main conversion done, next up the rest of the CharacterComponent view commit Character component, waiting on bullet wrapper for the rest view commit Static mesh base view commit Static Mesh: Update shape factories view commit [Core] ThreadPool: shutdown idle threads (#302) view commit [Samples] Misc camera controller fixes (#359) view commit Fix for #422 view commit Revert nugget view commit [Bullet] Update libs view commit [Bullet] Update projects mapping view commit [Bullet] Remove bullet refs within mathematics view commit Merge branch 'master' into bulletsharp_nuget view commit [Bullet] Rely on our bullet for math conversions view commit [Bullet] Finish height field mappings view commit [Physics] Remove unused enum and previous namespace import for inlining view commit [Bullet] Update all platforms to latest libs view commit [Physics] Reduced physics test allocations (#443), cleaned up Simulation view commit [Physics] Implement ignore collision between two specific components view commit [Physics] In-editor static mesh collider view commit [Physics] Avoid duplicate allocations for colliders based on models view commit [Physics] Fix initial collider scaling view commit [Misc] Exception prone basic functions view commit [Transform] Deal with ChildrenCollection todo view commit Merge branch 'master' into bulletsharp_nuget view commit [Physics] Use asset cloner for shape desc view commit Merge remote-tracking branch 'origin/master' into bulletsharp_nuget view commit [Physics] Replace ColliderShapes' TrackingCollection view commit [Physics] Replace Rigidbody's hacky delegate usage view commit [Physics] Rollback unused serialization workaround view commit [Physics] Cleanup RigidbodyComponent view commit [Physics] Clarify comments in StaticMeshColliderShape view commit [Physics] Fix #463 view commit [Physics] Fix very large meshes throwing view commit [Physics] Expose Capsule's readonly data view commit [Physics] Provide read access to collider shape's data view commit [Physics] Split static mesh collider into new PR view commit [Physics] Fix ShapeSweeps output view commit [Physics] Provide public access to callbacks' recycle and buffer view commit [Physics] Clarify bullet lib's usage and sources view commit [Editor] Fix orbit editor camera stutter view commit [Editor] Re-order code execution view commit [SceneManagement] Assign Entity.sceneValue before firing events view commit [Camera] Fix processor's cameraSlotsDirty not being reset after process view commit [SceneManagement] Fix loop skipping items when collection is modified view commit Avoid unnecessary alloc view commit Deal with Add(), sub-optimal implementation view commit [Threading] ThreadPool refactor, reduce allocation, fix wrong argument view commit Move PooledDelegateHelper outside lock view commit Swap task factory view commit [GameSystems] Fix removing systems not clearing it from update and draw view commit Eric Tuvesson (1): Assets Compiler Support MSBuild Toolset Version 16.0 (#421) (fixes #420) view commit Félix Dion-Robidoux (1): Update BACKERS.md view commit Hyperpred (1): Remove cast to Game in AudioSystem (#472) view commit Jarrett Robertson (1): Fixed issue with scene instance using the wrong collection in for loop count view commit Louies (10): Added translation using Weblate (Chinese (Traditional)) view commit Added translation using Weblate (Chinese (Traditional)) view commit Added translation using Weblate (Chinese (Traditional)) view commit Added translation using Weblate (Chinese (Traditional)) view commit Translated using Weblate (Chinese (Traditional)) view commit Translated using Weblate (Chinese (Traditional)) view commit Translated using Weblate (Chinese (Traditional)) view commit Translated using Weblate (Chinese (Traditional)) view commit Translated using Weblate (Chinese (Traditional)) view commit Translated using Weblate (Chinese (Traditional)) view commit Lucifer (8): Added translation using Weblate (Chinese (Simplified)) view commit Added translation using Weblate (Chinese (Simplified)) view commit Added translation using Weblate (Chinese (Simplified)) view commit Added translation using Weblate (Chinese (Simplified)) view commit Translated using Weblate (Chinese (Simplified)) view commit Translated using Weblate (Chinese (Simplified)) view commit Translated using Weblate (Chinese (Simplified)) view commit Translated using Weblate (Chinese (Simplified)) view commit Mario Guerra (10): Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Moustafa khalil (1): Update README.md view commit Nicolas Musset (10): [Localization] Update extraction script view commit [Localization] Update extracted strings view commit [Localization] Update Japanese view commit [Localization] Add French view commit [Build] Update solution and project view commit [Localization] Fix build for path containing spaces (#381) view commit [Presentation] Bugfix/int3 editor (#387) (fixes #383) view commit [General] Simplify editor and presentation project files view commit [General] Fixup rule for .xaml.cs files view commit Update .gitattributes view commit Oscar Sanchez (9): Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Phr00t (2): [Graphics] Vulkan: add support for R10G10B10A2_UNorm and R11G11B10_Float view commit [Input] Fix mouse VirtualButtons view commit Polymo (1): Translated using Weblate (German) view commit Robin Hübner (2): [Physics] correct userdoc for convex hull collider parameters. (#382) (fixes #372) view commit Make SDL window user resizable. view commit Rui Mendes (3): Added translation using Weblate (Portuguese) view commit Added translation using Weblate (Portuguese (Brazil)) view commit Translated using Weblate (Portuguese) view commit Scorp-121 (4): Added translation using Weblate (Russian) view commit Added translation using Weblate (Russian) view commit Added translation using Weblate (Russian) view commit Added translation using Weblate (Russian) view commit Scorp121 (10): Translated using Weblate (Russian) view commit Translated using Weblate (Russian) view commit Translated using Weblate (Russian) view commit Translated using Weblate (Russian) view commit Translated using Weblate (Russian) view commit Translated using Weblate (Russian) view commit Translated using Weblate (Russian) view commit Translated using Weblate (Russian) view commit Translated using Weblate (Russian) view commit Translated using Weblate (Russian) view commit SleepyMode (1): [Mathematics] Fixes for Color/ColorRGBA float/byte mismatches (#258) (fixes #251) view commit Swann Martinet (2): Translated using Weblate (French) view commit Translated using Weblate (French) view commit Tebjan Halm (6): Quick fix as suggested by @xen2 in chat to avoid crash in shader compiler (#343) view commit Added translation using Weblate (German) view commit Translated using Weblate (German) view commit Resetting shader key scope for multi pass materials (#456) view commit added xenko-community-project to README.md (#514) view commit Fix DataBaseFileProvider cast (#538) view commit Virgile Bello (510): [Design] VisualStudio.Project doesn't need a reference to Solution anymore view commit [Assets] Package can now also represent a csproj + package (only new game creation is working) view commit [Assets] Removed AssetItem.SourceProject view commit [Assets] Move assets to Assets folder for now view commit [Assets] Fix project loading view commit [Assets] Simplified Package.Profiles into Package.Profile view commit [Assets] Removed PackageProfile.ProjectReferences view commit [Assets] Removed PackageProfile.Name view commit [Assets] Allow creation of samples (as long as they don't use external packages) view commit [Assets] Added the concept of Package container (project or standalone) view commit [Assets] Turned Session.Packages into a readonly collection view commit [Assets] Properly process dependency graph using remote info to perform package upgrades before downloading nuget packages view commit [Assets] Removed LocalDependencies and fixed TemplateSampleGenerator view commit [Assets] Fix platform update view commit [Assets] AssetCompiler now works against .csproj view commit [Assets] Fixed asset compiler get-graphics-platform view commit [Assets] Fix view models to allow selection as current project view commit [Assets] Properly regenerate platforms for sample templates view commit [Assets] Ignore assets from executable projects (computed automatically) view commit [Templates] Moved template packs assets from Assets/Shared to Assets view commit [Assets] NewGameTemplateGenerator: assets were loaded twice, resulting in issues later with cloned AssetItem (fix asset packs) view commit [Templates] Simplify platform projects view commit [Templates] Moved templates packges asset folders from Assets/Shared to Assets and removed intermediate solution folders view commit [Assets] Adjust PackageProfile.ResourceFolders during package upgrade view commit [Templates] Sample Templates now works (asset packs are now ProjectReference and their assets are properly copied during template generation) view commit [Assets] Properly get namespace from project view commit [Assets] Fix CodeViewModel to use ProjectCodeViewModel view commit [Assets] Fix platform updates view commit [Assets] Rearranged templates for the new xkpkg = csproj change (note: project delete is broken) view commit [Assets] Package.Profile is now properly deserialized by discarding default value view commit [Assets] Removed PackageProfile.Platform view commit [Build] Make sure Package.Id stays is in sync with .sln one view commit [Assets] Removed Package.Id view commit [Assets] Removed PackageProfile view commit [Assets] Stop adding default folders in Package ctor view commit [Assets] Reunified ProjectState and PackageState view commit [Assets] Moved Package.Save() to PackageContainer.Save() view commit [Assets] Avoid creating .xkpkg for projects without one in the first place (use implicit one instead) view commit [Assets] Rework package dependencies view commit [Assets] Also support loading sln with new csproj Guid view commit [Assets] Support Packing and consuming simple NuGet packages with Xenko assets view commit [Assets] New game template: set current project to Windows view commit [Assets] Simplified NuGet package restore (only happens during PreLoadPackageDependencies) view commit [Assets] Update Code library template to match others view commit [Targets] Stop using XenkoDir.cache file during build view commit [Build] Bump to 3.1.0.1 view commit [Assets] Store pendingPackageUpgrades in PackageSession view commit Merge remote-tracking branch 'origin/master' into onecsproj_onexkpkg2 view commit Merge branch 'master' into onecsproj_onexkpkg2 view commit [Assets] Process dependencies for RootAssets in view model view commit [Assets] Made !file and !directory tags mandatory in Yaml for easier dependency analysis view commit [Assets] Temporary fixes for root assets and default scene opening view commit [Assets] Pack assets using actual package data rather than hardcoded rules view commit [Build] Reorganize build system (WIP) view commit [Build] NuGetAssemblyResolver WIP view commit [Engine] Move default assets to individual assemblies rather than global Xenko.xkpkg view commit [Assets] Compiler: can now properly compile existing projects view commit [Launcher] Fix launcher build view commit [Editor] Temporarily moved game studio shaders to Engine, until we have proper design-time package references view commit Merge branch 'master-3.0' into onecsproj_onexkpkg2 view commit [Build] Use RuntimeIdentifier to separate graphics API runtimes view commit [Build] Improved cross compilation view commit [Build] Renamed XenkoRuntime into XenkoNETRuntime view commit [Build] Added XenkoRuntime flag view commit [Assets] project.Type evaluation needs to be done after package are restored view commit [Assets] Reorganized templates view commit [Assets] Fix package upgrader view commit [SpriteStudio] Added templates view commit [Assets] Properly find ffmpeg.exe and msdfgen.exe view commit [Assets] Move VHACD to Assets assembly and properly bundle C# wrapper view commit [Assets] Compiler: use thread-safe version of NuGet (when writing lock file) view commit [Deps] Switched to NuGet version of Xceed.Wpf.Toolkit/Datagrid/AvalonDock view commit [Build] Bump to .NET 4.7.2 view commit [Build] Adjust bindings for System libraries with 4.7.2 changes view commit [Deps] Xenko.Metrics and Xenko.CrashReport are now packaged with NuGet view commit [Build] Lot of adjustments for new NuGet resolver system (incl ConnectionRouter, VS Package, etc...) view commit [Samples] Moved samples from Xenko.Assets.Presentation to a dedicated project to have faster rebuild view commit [Assets] Some improvements so that unit tests can compile view commit [Assets] Some improvements so that unit tests can compile view commit [Build] Removed XenkoDir environment variable view commit [Assets] Fixed templates to have proper assembly names and namespaces view commit [Build] Readded support for UWP view commit [Build] Readded support for Android view commit [Build] Readded support for iOS view commit [Build] Optimized ProjectReferences view commit [Build] Check Visual C++ Runtime is properly installed as part of build targets view commit [Build] Added Xenko.PackageInstaller to Xenko.GameStudio view commit [Build] Use \"XenkoPlatforms\" to specify which platforms to build view commit [NuGet] Upgrade to 4.9 and use RestoreRunner to have faster noop restore on second run view commit [Tests] Fix build of some test projects view commit [Build] Also deletes .nupkg.metadata on package auto deploy (https://github.com/NuGet/Home/wiki/Nupkg-Metadata-File) view commit [Build] Make sure user projects are always built so that compiler app is checking assets again (until we feed \"fast up to date\" with proper inputs/outputs) view commit [Assets] Make sure to explicitly include Xenko.Core for its targets until VS2019 enables it by default (https://github.com/NuGet/Home/issues/6091[#](https://github.com/xenko3d/xenko/issues/)issuecomment-438073285) view commit [Assets] Don't include package targets when evaluating project files view commit [Assets] Order windows executable project first in solution files (sln) so that VS uses them as startup project by default view commit [Build] Added some docs related to new build system view commit Merge remote-tracking branch 'origin/master' into onecsproj_onexkpkg2 view commit [Build] Fix iOS solution view commit [Build] Moved PackAssets task in Xenko.Core.Tasks view commit [Build] Use PackAssets as an exe rather than a Tasks so that MSBuild doesn't lock the files (annoying when rebuilding) view commit [NuGet] Log everything view commit [NuGet] Restore inside assembly resolver to avoid deadlock and rewrote logging code view commit [Build] Only build default graphics platform when opeining sln unless we explicitly set XenkoGraphicsApiDependentBuildAll view commit [NuGet] Perform nuget resolve only for entry assembly view commit [Assets] Better resolution of project platform (needed so that windows project is auto selected) view commit [Build] Fix build when choosing a single graphics API view commit [NuGet] Add dev store before trying to restore packets view commit [Build] Removed Xenko.xkpkg view commit [Build] Moved PackageUpdateVersionTask to a separate assembly to simplify build view commit [Build] Unify version management in a single file (except for samples which will be versioned separately) view commit Merge remote-tracking branch 'origin/master-3.0' view commit [Build] Added package details view commit [Build] Output nupkg in bin\\packages view commit [Build] Xenko.Samples.Templates: add missing dependency view commit [NuGet] If restore failed, try to kill known blocking processes (Connection Router, CompilerApp, etc...) view commit [NuGet] Improve logging if restore failed view commit [Build] Remove non-existing files from Xenko.sln view commit [NuGet] Use SourceCacheContext to avoid ArgumentException view commit [Build] Sign dll/exe when building package view commit [Build] Also sign Launcher executables view commit [Build] Escape/Unescape XenkoPlatforms for properly passing info from Xenko.build to targets view commit [Build] Package build improvements view commit [Build] Package build improvements (part 2) view commit [Build] Signing tool was mistakently always enabled view commit [Build] Package build improvements (part 3) view commit [Setup] Update to Advanced Installer 15.5.1 view commit [Build] Remove invalid character from Xenko.build view commit [Build] Fix Linux Vulkan build view commit [Build] Added bin/packages/.gitignore file view commit [Build] Fix restore phase in Xenko.build view commit [Build] Removed Xenko.SamplesBootstrapper and fixed Xenko.Samples.Tests view commit [Samples] Fixed Xenko.Shaders.Tests view commit [Build] Use active build configuration rather than forcing Debug view commit [Build] Stop using Bin\\Windows for unit tests view commit [NuGet] Couldn't resolve EnvDTE.dll view commit [Assets] Don't try to load vcxproj as package view commit [Samples] PhysicsSample: Update for Vector3 Gravity view commit [Tests] Xenko.Assets.Tests: Don't compile assets view commit [Tests] Fixed some unit tests view commit [Tests] Fixed folder for gold image view commit [Launcher] Ignore server-side dev packages view commit [Assets] Fixed TestBasicPackageCreateSaveLoad view commit [Assets] Package upgrade is now working for 3.0 projects view commit [NuGet] Update to NuGet 4.9.1 view commit [Launcher] Ignore invalid NuGet sources (404, 401, etc...) view commit [VSPackage] Fix build of test project view commit [Launcher] Bump to 3.0.1 view commit [Assets] User can now create GameSettings freely (need to display warning if nothing matching expected name?) view commit [CompilerApp] Removed unused GetGraphicsPlatform code view commit [Build] Removed obsolete target files view commit [Build] Xenko.build now properly build Launcher view commit [Build] Switching unit tests to new targets view commit [VSPackage] Fix Xenko.build targets view commit [Build] Clean packages before full package build view commit [GameStudio] Asset editors close button is back view commit [Graphics] Removed PreferredGraphicsPlatform from RenderingSettings view commit [VSPackage] Fix build when using multiple XenkoPlatforms view commit [Build] Adjust package versioning so that NuGetVersion doesn't contain build metadata view commit [Native] Explicitly require related Assembly when loading native library (we can't use GetCallingAssembly as it might be wrong due to optimizations) view commit [Native] PreloadLibrary: Use type rather than assembly (to avoid use of GetTypeInfo() everywhere) view commit [GameStudio] About page: added markdown files to package view commit [Launcher] Few fixes so that launcher properly separate view commit [GameStudio] About page: display version with build metadata view commit [Build] Force cross-targeting if there is multiple RuntimeIdentifiers view commit [Launcher] Stay compatible with Xenko 1.x/2.x view commit [Build] Properly fix how RuntimeIdentifier is used for multi graphics API per platform view commit [Assets] Solution file was generated with empty DefaultVisualStudioVersion view commit [OpenTK] Use win7 runtime rather than win view commit [Assets] Made DefaultVisualStudioVersion public again view commit [Build] Properly forward XenkoGraphicsApiDependentBuildAll view commit [Build] Workaround: Remove RuntimeIdentifier from Solution references (https://github.com/onovotny/MSBuildSdkExtras/issues/139) view commit [Assets] Make sure solution/project path use backslashes view commit [Particles] Remove ambiguities in data member order view commit [Assets] Keep solution folders, just remove package info view commit [Assets] Improve package upgrade when there is no ProjectReference view commit [Samples] Updated samples view commit [Samples] Removed Xenko.Navigation where not needed view commit [Samples] Removed Xenko.Physics where not needed view commit [Assets] Make sure implicit packages have IsDirty set to false when loaded view commit [Assets] Fix asset upgrade view commit [GameStudio] Fixed template samples generator to work with updated project format view commit [Samples] Updated with 3.1 (step 2) view commit [Samples] Keep Xenko.Particles for now, until we have better extensibility in Graphics Compositor view commit [Assets] Allow some assets to be non-referenceable (asset name collision is allowed in this case because they exist only at compile-time). This is used for scripts, otherwise they can't have same name as an asset. view commit [Assets] PackAssets: skip excluded files view commit [Settings] Remove the !file when serializing setting keys view commit [Build] Package necessary WindowsAPICodePack assemblies with Xenko.Core.Presentation.Dialogs view commit [Build] XenkoPlatform was not properly set for Linux platforms view commit [Assets] PackageUpgrader: react to multiple package names (to support renames and/or package splits in multiple parts) view commit [GameStudio] Improve default asset selection to match opened asset editors view commit [Assets] Compiler: Move default asset build path to obj\\xenko\\assetbuild view commit [Build] Changed dev/beta versioning to permit upgrading between interleaved dev and beta releases (betaXX.YYYY format with XX = asset version and YYYY = git height) view commit [Build] Generate ref folder for all platforms (otherwise Android/iOS/UWP might fallback to ref/netstandard2.0 of Linux) view commit [Build] Fix Android build due to lack of NuGetRuntimeIdentifier view commit [Templates] Remove the _Game from sample templates view commit [Build] Adjust PackageVersion for sample templates according to XenkoOfficialBuild rather than XenkoPackageBuild view commit Updated BACKERS.md view commit [Launcher] Display source in tooltip for Xenko downloads view commit [VSPackage] Various fixes so that shader highlighting/goto works view commit [Build] Updated UWP to use uap10.0.16299 view commit [UWP] Simplified some code (can now use Thread and other newer API) view commit [Build] Hide Microsoft.NETCore.UniversalWindowsPlatform from references and update build doc view commit [Build] Fix Xenko.Shaders.Tests name view commit [Assets] New Game template was not properly copying asset package files view commit [GameStudio] Use same build folder for game studio as for actual game build view commit [Templates] Fixed Linux template view commit [Templates] Fixed UWP template view commit [Build] Use win instead of win7 runtime identifier view commit [Templates] Additional fix for Linux template view commit [Templates] Linux: adjust default runtime identifier view commit [Launcher] Various fixes for downloading and error reporting view commit [Launcher] Bump to 3.0.4 (3.0.3 was built with incorrect source changes) view commit [VSPackage] Fix NuGet assembly resolve (avoid infinite loop) and handle properly non-Xenko solutions (fixes #298) view commit [Editor] Properly report solution load/save exception to log view commit [Reflection] Rewrote part of AssemblyContainer to handle deferred loading view commit [Build] Updated to MSBuild.Sdk.Extras version 1.6.65 (compatible with VS2019) view commit [Build] Use $(RoslynTargetsPath) rather than $(MSBuildBinPath)\\Roslyn (which doesn't work with VS2019) view commit Change link+badge for chat from gitter to discord view commit [Build] Use netstandard2.0 version of OpenTK view commit [Build] Switch to netstandard2.0 wherever possible for the runtime view commit [Build] Switch game projects to use netstandard2.0 view commit [Build] Fix Windows+Linux build view commit [Build] Hide Microsoft.NETCore.UniversalWindowsPlatform from references and update build doc view commit [Build] Fixed build of RenderDocPlugin view commit [Build] Additional fixes for single 3d graphics API build mode view commit [Templates] Patching of TargetFramework section is now forcing netstandard2.0 view commit [Templating] Switch to latest version of Mono.TextTemplating (t4) and add reference to netstandard view commit [Build] Various fixes for .NET Standard build view commit [Build] Bump Android SDK version from 5.0 to 8.1 (Google Play recent requirement for new app and .NET Standard 2.0 also requires 8.0+) view commit [Build] Force references to be added only for direct and explicit package references view commit [Build] Properly forward XenkoGraphicsApi when building a single graphics platform view commit [Build] Make sure to override RuntimeIdentifiers on UWP otherwise it builds all CPU versions and result in write conflicts view commit [Build] Use \"any\" instead of \"win\" view commit [Build] Make sure \"win\" is the default when building a netstandard2.0 reference (to make sure a RID-specific project always use RID) view commit [Build] Define output path (otherwise using a Platform might override them) view commit [Build] Properly setup RuntimeIdentifier if it was not a Graphics-API-specific one view commit [Build] Pack Xenko assets as part of NuGet packaging view commit [Build] Fix the NuGet publish build file view commit [Build] Removed unnecessary solution references view commit [Build] Properly compute & restrict RuntimeIdentifier for ProjectReference view commit [Build] Better detection of default RuntimeIdentifiers view commit [Build] Fix RuntimeIdentifiers detection for graphics API mode view commit [Build] Adjust RuntimeIdentifier and XenkoPlatform detection view commit [Launcher] Remove custom Http code and decrease concurrency (which might be problematic since our packages are bigger than average) view commit [Launcher] Switch from gitter to discord view commit Updated BACKERS.md view commit [Launcher] Bump to 3.0.5 view commit Update Crowdin configuration file view commit Update Crowdin configuration file view commit [Launcher] Skip unlisted packages, and don't use cache view commit [Launcher] Also use normal output data for error output of PackageInstall.exe view commit [Physics] Enable PhysicsShapesRenderingService only if there is a IGraphicsDeviceService view commit Update BACKERS.md view commit Merge remote-tracking branch 'origin/master-3.0' view commit [Physics] Add comment for PhysicsShapesRenderingService creation view commit [Build] Added option XenkoPublishSkipSamplesTemplates view commit [Build] Adjust platform detection (broken for multiplatform) and preparations for OSX view commit [Build] Additional fixes for computing runtime identifiers view commit [Build] Further fixes for computing runtime identifiers view commit [Build] Run Visual C++ checks only on .NET Framework MSBuild view commit [Build] Additional setup for macOS build view commit Merge pull request #323 from Kryptos-FR/feature/l10n view commit [Build] Native: Generate only x64 for macOS (.NET Core only supports x64) view commit [Graphics] Update to SDL 2.0.9 view commit [Graphics] SDL: Load from proper directory view commit [Shaders] Added macOS glslangValidator view commit [Shaders] Vulkan: Add \"NoSampler\" to reflection view commit [Core.IO] Disable LockFile code from macOS (not supported) view commit [Core] Copy native libs for more platforms, and only if CopyLocalLockFileAssemblies is not set to false view commit [Build] macOS: Update NativePath to latest version view commit [Graphics] Update SharpVulkan (works on OSX and easier to access NativeHandle) view commit [Graphics] macOS: Added MoltenVK view commit [GameStudio] Added project template for macOS view commit [Localization] Use $(RoslynTargetsPath) rather than $(MSBuildBinPath)\\Roslyn (which doesn't work with VS2019) view commit [Samples] Templates: Added Cache to list of ignored folders (can be leftover from build during previous Xenko versions) view commit [Graphics] macOS: Updated MoltenVK view commit [Assets] PackAssets: Use proper asset path when computing resources relative paths (fixes #326) view commit [VSPackage] Upgrade version to 3.0.3. Add support for VS2019. New release needed since RestoreHelper.cs was updated (fixes #324) view commit Update license for 2019 view commit Update BACKERS.md view commit [Build] Copy .xml and .pdb from NuGet package references when using new csproj format view commit [VSPackage] Run VSIX installer only for VS2017+ (fixes #332) view commit [Build] Use latest version of Windows 10 SDK view commit [Build] Update requirements view commit [Build] Publish was not properly copying native libs and compiled assets (fixes #331 and #334) -- thanks to jazzay for the initial implementation view commit [VSPackage] Make ProjectReference between Commands and Package private so that it doesn't exist as a NuGet dependency view commit [VSPackage] Add TODO for restore log view commit [Build] Native: use vcxproj directly to avoid TRK0005: Failed to locate: \"link.exe\" or \"cl.exe\" (fixes #337) view commit [Build] Properly include install-prerequisites.exe next to Xenko.GameStudio packageinstall.exe view commit [Install] Prerequisites installer: improve error reporting and retries (i.e. UAC not clicked) when installing Visual Studio or Build Tools view commit [Install] Prerequisites: Update to VC++ 2017 prerequisites view commit [Install] Prerequisites: Add \".NET Core 2.1 development tools\" to list of Visual Studio prerequisites view commit [Install] Prerequisites: Improve Visual Studio detection/update mechanism view commit Update BACKERS.md view commit [GameStudio] Switch to Roslyn 2.10 view commit [Assets] PackAssets: properly copy RootAssets (fixes #347) view commit [Assets] Perform null check before upgrading PackageProfile view commit [Assets] PackageSession: Properly fallback to AssemblyName if PackageId is not set view commit [Assets] Remove asset upgrader code for versions before 3.0 view commit Explain how CLA is to be signed. view commit Update BACKERS.md view commit [Build] NuGetVersion reported to TeamCity was wrong view commit [VR] Fix UWP build (#213) view commit [Build] Add XenkoBuildDoc parameter to force TargetFramework even if not specified (seems necessary for older version of Roslyn used in docfx) view commit [GameStudio] Add missing RoslynPad assemblies in the composition context view commit [GameStudio] Allow drag & dropping of read-only assets (as long as they wouldn't be modified) view commit [GameStudio] CodeLibrary projects were not properly initialized (assets couldn't be created) view commit [Build] Sign packageinstall.exe view commit [Build] Include RoslynPad assemblies with Xenko.Assets.Presentation package view commit Update ContributorLicenseAgreement.md view commit [Build] Unlocking C# 7.3! view commit [Core.Design] AssemblyContainer: Process deps.json files (fixes #365, fixes #342) view commit Merge branch 'master-3.0' view commit [Physics] Fix ColliderShapeAsset upgraders (was previously enclosed in XENKO_SUPPORT_BETA_UPGRADE) view commit Merge remote-tracking branch 'origin/master-3.0' view commit Merge remote-tracking branch 'origin/master-3.0' view commit [Build] Add option -NoSymbols to nuget push view commit [Graphics] D3D: add support for using typeless textures view commit [Reflection] AssemblyContainer: return already loaded assemblies if AssemblyName matches rather than loading new one (it seems that assembly is requested several times because we are not loading in the proper load context) view commit [Build] runtime.json: fix spacing view commit [Build] Added new CPU-specific variants to runtime.json (#370) view commit [Build] Bumped LLVM to 7.0.1 view commit [Render] Decouple RenderParticleEmitter from ECS view commit [Render] Decouple RenderUIElement from ECS view commit [Render] Decouple RenderMesh and others from ECS view commit [Rendering] Remove various dependencies from lighting code to LightComponent view commit [Rendering] Removed SceneInstance dependency from rendering code view commit [Rendering] Removed dependency from VisibilityGroup to ShadowMapRenderView view commit [Rendering] LightSkybox: Removed obsolete comment view commit [Rendering] Moved RenderGroup class to Rendering namespace view commit [Rendering] PostFX: remove dependency to CameraComponent view commit [Rendering] ShadowMapRenderer: remove unused nested class view commit [Rendering] ForceAspectRatioSceneRenderer: Made default aspect ratio local to remove dependency to CameraComponent view commit [Engine] Moved IndexingDictionary to Xenko.Core view commit [Rendering] EffectSystem: Remove dependency to Game class and move EffectCompilationMode in the same namespace view commit [Rendering] EffectSystem: Moved CreateEffectCompiler in a separate static class outside of Rendering code view commit [Rendering] Made ForwardLightingRenderFeature not dependent on LightProcessor anymore view commit [Rendering] Made LightProbe code not dependent on LightProbeProcessor anymore view commit [Rendering] Made LightShafts independent from LightShaftProcessor view commit [Rendering] Fixed RenderContext.GetCurrentCamera() tag owner view commit [Streaming] Removed dependency on Engine.Game view commit [Rendering] Splitted most of low-level rendering code into a new Xenko.Rendering assembly view commit [SpriteStudio] Fixes for SpriteStudio to work properly again view commit [Rendering] Make Xenko.Rendering platform-specific view commit [TextTemplating] T4: use a custom version of Mono.TextTemplating, including https://github.com/xen2/t4/commit/0d0b6db3ca3aba82fd7597951be2361265043e5e view commit [Serializaton] Bump format version (Rendering split) view commit [Build] Bump to beta02 view commit [Build] Fix .usrdoc generation and copy (fixes #377) view commit [NuGet] Remove deleted xenko sources during startup to avoid restore failures (fixes #338) view commit Merge remote-tracking branch 'weblate/master' view commit [Localization] Added Russian as a supported language view commit [Localization] Added a few missing important translations (which were omitted for ApplicationCommands) view commit [CrashReport] Bumped crash report to 1.0.1 (force HTTPS), anonymize reports and make sure it doesn't conflict with NuGetAssemblyResolver view commit [Localization] Updated po files view commit [Build] Regenerated sln (which were invalid since Xenko.Rendering was added) view commit [Samples] Removed reference to RenderContext.SceneInstance (fixes #386) view commit Merge remote-tracking branch 'weblate/master' view commit Merge remote-tracking branch 'weblate/master' view commit [Localization] Only generated when building Release, and added Russian in Xenko.Editor view commit [Localization] Added support for German and Spanish view commit [Localization] Rearranged targets so that localization code is unified view commit Merge remote-tracking branch 'weblate/master' view commit [Localization] Added support for Chinese (Simplified) view commit [Setup] Don't delete top level installation folder if not empty (esp. if it was installed in a root folder containing other programs by mistake!) view commit [Launcher] Use cache but always refresh it, even when installing. view commit [Launcher] Set LauncherApp as default project view commit [Launcher] Bump to 3.0.6 view commit [Templates] Fix version in reference to Xenko.Samples.Templates package view commit [Rendering] Add Sprite to rendering only if it's enabled view commit [Rendering] Properly register Xenko.Rendering in AssemblyRegistry (fixes #409 and fixes #410) view commit Update BACKERS.md view commit Merge remote-tracking branch 'weblate/master' view commit [GameStudio] Fast-reloading for types such as Material and Texture were not working as expected, forcing a full model reload on every edit view commit [GameStudio] Fix for fast-reloading view commit [GameStudio] Rewrote and simplified code for fast reloading (also support cases such as material layers properly now) view commit [GameStudio] AvalonDock: Fix a bug in AvalonDock 3.4.0 which sets CanClose to false once a LayoutAnchorable is dragged into a new floating window or a new pane. view commit [Physics] CleanContacts was working on previousFrameContacts rather than currentFrameContacts, resulting in warnings \"Pair not present\". Thanks @EternalTamago for the fix! (fixes #88) view commit Update BACKERS.md view commit [Graphics] D3D11: Begin/End were not reentrant because of how Query were used (#427 #428) view commit Merge remote-tracking branch 'origin/master-3.0' view commit [Audio] Encode little bit longer to compensate for encoding delay (fixes #350) view commit [Build] Make sure _XenkoGenerateDependencies runs in all situations (otherwise unit tests won't work) view commit [Build] Make sure _XenkoGenerateDependencies runs also for C++ projects view commit [Build] Readjust _XenkoGenerateDependenciesAfterBuild target/comments view commit [Build] Unit tests: use proper xunit.console.exe depending on x86 or x64 view commit [Tests] Fix sample games unit tests view commit [Samples] Fix Sprite Studio demo (missing reference to SpriteStudio runtime) view commit [Editor] Preview View Model was not properly removing event handlers (fixes #438) view commit [Launcher] Improve log/error message in an attempt to investigate #310 view commit [NuGet] Switch to NuGet 5.0 view commit [Build] Require VS2019 instead of VS2017 to take advantage of new NuGet buildTransitive feature view commit [Build] Removed obsolete props files view commit [Build] Update NuGet.exe to 5.0 view commit [Build] Update build instructions view commit [VSPackage] Update to new AsyncPackage and upgrade/cleanup unecessary PackageReference view commit [Build] Bump MSBuild.Sdk.Extras to 2.0.24 view commit Merge remote-tracking branch 'origin/master' into vs2019 view commit [AssemblyProcessor] Fix a case where ImportReference was not called for GetTypeFromHandle(). Bumped Cecil to NuGet 0.10.3 rather than custom one. view commit [Assets] Added a new KeepReferences flag to AssetCloner view commit [Build] Stop detecting Android NDK version using folder name (latest VS2019 uses \"ndk-build\" folder name without version) view commit [Build] VS2019 now understand WindowsTargetPlatformVersion being set to 10.0 rather than a specific version. Also bump PlatformToolset to v142 view commit [Build] Converted some design-time libraries to .NET Standard 2.0 view commit Revert \"[AssemblyProcessor] Fix a case where ImportReference was not called for GetTypeFromHandle(). Bumped Cecil to NuGet 0.10.3 rather than custom one.\" view commit [AssemblyProcessor] Fix a case where ImportReference was not called for GetTypeFromHandle(). view commit [Assimp] Added error details if something went wrong (and test if scene is null to avoid NullReferenceException). view commit Merge remote-tracking branch 'weblate/master' view commit [Build] Reorganized targets to more easily choose multiple graphics platforms at once. view commit [Build] Bumped sln to use VS2019+ view commit Revert \"[Build] Reorganized targets to more easily choose multiple graphics platforms at once.\" view commit [Build] Reorganized targets to more easily choose multiple graphics platforms at once. view commit [Build] Removed deprecated Android armeabi CPU architecture (fixes #461) view commit [Vulkan] Back buffer: add missing ViewType parameter (2D) when creating back buffer view commit [Build] Android: Bump TargetSdkVersion to API level 27 (matches VS2019 install and TargetFrameworkVersion set in csproj) view commit [Launcher] NuGet: 1 hour timeout instead of 100 seconds as a workaround for https://github.com/NuGet/Home/issues/8120 (fixes #310) view commit [Launcher] Bump to 3.0.8 view commit Revert \"[Assimp] Updated assimp to official 4.1.0 and updated references in projects (closes #458)\" view commit [Build] Removed armeabi libraries to completely fix #461 (fixes #470) view commit [Build] Android: unify all minSdkVersion to 16 and targetSdkVersion to 27 (fixes #469) view commit [VSPackage] Bump to 3.0.5 view commit [Physics] Renamed NewShapeFromDesc to CreateShape view commit [Launcher] Allow to select Xenko version view commit [Build] Bumped Cecil to NuGet 0.10.4 rather than custom one. view commit [Physics] Update README.md with new BulletSharpPInvoke repo location view commit Merge pull request #289 from Eideren/bulletsharp_nuget view commit [Physics] Fix typo in PhysicsEngineFlags.ContinuosCollisionDetection (fixes #152) view commit [Build] Properly copy back IntDir/OutDir to IntermediateOutputPath/OutputPath for C++ project view commit [Input] Fix SDL key mapping for 0 and 1 view commit [Build] Updated editorconfig to contain VS2019 default style (which we use in Xenko) view commit [Build] XenkoContent: do not include in NuGet package as Content view commit [Graphics] Compare InputElements length before comparing elements view commit [Graphics] Remove unecessary GraphicsDevice.ThreadCount view commit [SDL] AppActivated and AppDeactivated were reverted view commit [Vulkan] Fix validation for texture upload view commit [Vulkan] Update glslang to 7.11.3214 (May 2019) view commit [Vulkan] PipelineState: Entry point name could be GC before used view commit [Vulkan] PipelineState: Properly set PrimitiveRestartEnable view commit Revert \"[Graphics] Vulkan: add support for R10G10B10A2_UNorm and R11G11B10_Float\" view commit [Vulkan] Fixed memory barriers for Clear functions view commit [Vulkan] UpdateSubresource: Fixed memory barrier view commit [Vulkan] Fixed mixup between Clear DSV and RT view commit [Build] Android: Updated to NDK r19 (with proper version check) and remove our custom libc++abi (first step for #460 and #379) view commit [Build] Android: Avoid \"error MSB4044: The \"FilterAssemblies\" task was not given a value for the required parameter \"DesignTimeBuild\".\" with latest Xamarin.Android view commit [Audio] Android: Updated OpenSLES header (which were incompatible with arm64 due to SLuint32 mapping to long instead of int) (fixes #379) (fixes #460) view commit [Setup] Upgraded Visual C++ prerequisites to latest VS2019 ones view commit [Assimp] Properly copy Xenko.Assimp.*.dll (fixes #465) view commit Merge remote-tracking branch 'weblate/master' view commit [Build] Android: Workaround for https://github.com/onovotny/MSBuildSdkExtras/issues/174 view commit [Build] Transformed Xenko.Core.BuildEngine into a .NET Standard assembly view commit [Build] NETStandard: Switch from AssemblyBuilder.DefineDynamicAssembly view commit [Build] NETStandard: Remove unnecessary using view commit [Quantum] Renamed Index into NodeIndex to avoid clash with future System.Index view commit [Build] NETStandard: Remove unnecessary using view commit [Assets] Switch from implicit project to explicit project if necessary (fixes #442) view commit [Build] Switched to MSBuild.Sdk.Extras version 2.0.41 view commit [Build] Doc: Copy .xml file in ref folder view commit Revert \"[Build] Switched to MSBuild.Sdk.Extras version 2.0.41\" view commit [Build] Moved Microsoft.NETCore.Platforms reference from Xenko.Graphics to Xenko.Core (otherwise scenarios like referencing only Xenko.Core with win-x64 doesn't work) view commit [VSPackage] Syntax highlighting service was not properly registered asynchronously (fixes #651651) view commit [VSPackage] Fix Xenko detection view commit [VSPackage] Bump version to 3.0.6 view commit [Build] Replaced to for shaders/effects view commit [VSPackage] Add a launchSettings.json with proper parameters for easier debugging view commit [Input] SDL: fix OemPlus/Minus mapping (thanks nes) view commit [UI] Fix comment view commit [Vulkan] Fix some memory barriers in CommandList.Copy and CopyRegion view commit [Vulkan] CommandList: Don't use ImageView.Null in DescriptorImageInfo view commit [Streaming] Load a few initial mipmaps for streamed texture (otherwise they start as completely uninitialized: bad for rendering, and causes crash on Vulkan) view commit [Shaders] Fixed precompiled shader code generation view commit [Shaders] Added ElementType info to reflection for buffers/textures view commit [Vulkan] Properly store info if a texel buffer need to be integer or float. view commit [Shaders] Make sure NoSampler is added before computing list of resource groups (otherwise it ends up having no location attribute) view commit [Input] Fixed copyrights view commit [VSPackage] Fix Xenko version detection to work not only with nuget packages but also solution projects, so that it works with Xenko solution itself. view commit Merge remote-tracking branch 'weblate/master' view commit [Localization] Added Italian view commit [Localization] Added info in doc on how to translate and add new language. view commit [Build] Remove the -beta02 version suffix view commit [Shaders] D3D: Properly copy ElementType when duplicating resource binding per stage (fixes #515) view commit [Samples] Updated to 3.1.0.1 view commit [Setup] PackageInstall: check if VS Installer needs an update, and if yes try to do it automatically view commit [Build] Temporary workaround for .NET Core 3.0 new runtime identifier system (credits go to Solr for finding this fix) view commit [NuGet] Rewrote how assembly resolver is ordering assemblies found in nuget packages (there was a bug where it could select net46 instead of net461, resulting in crash) view commit [Build] Moved Xenko.Samples.Templates version in a single unified location to simplify future maintenance view commit [Setup] PackageInstall: Check VS Installer update if any workload needs to be installed (two UAC, but probably better than an error and extra step) view commit [Build] Bumped MSBuild.Sdk.Extras to 2.0.54 view commit [Build] Updated codesign certificates view commit [Build] Android: Use AssemblyName rather than RootNamespace for Resource class otherwise it might clash between some assemblies (i.e. Xenko and Xenko.Engine) --> view commit Revert \"[Build] Remove the -beta02 version suffix\" and bump samples accordingly view commit [Build] Use default RuntimeIdentifier for default GraphicsApi, so that even if our custom RuntimeIdentifier are not merged properly, everything still work. view commit [Build] Removed previous workaround for https://github.com/NuGet/Home/issues/7351 view commit [Build] Bump NuGet.exe to 5.3.0 view commit [Build] Improved behavior of XenkoGraphicsApiDependentBuildAll view commit Merge branch 'runtimeid_fixes' into master-3.1 view commit [Build] Android: Fix NDB platform versions view commit [Graphics] Updated SharpDX to 4.2.0 view commit [UpdateEngine] AssemblyProcessor was generating invalid ldftn for virtual/interface calls (causing crashes with .NET Core 3). Switch to ldvirtftn for those instead. view commit [Graphics] Update D3D12 code for SharpDX 4.2.0 view commit [Build] AssemblyProcessor task need to change identity on each change otherwise we can run into https://github.com/microsoft/msbuild/issues/663[#](https://github.com/xenko3d/xenko/issues/)issuecomment-310530046 view commit [Graphics] Streamed compressed texture could end up having their initial texture size not multiple of 4, resulting in error at runtime loading. Skip these cases for now. view commit [Fonts] Fix how matrix is computed and compute realVirtualResolutionRatio depending on actual requestedFontSize (fixes #314) (fixes #364) view commit [Fonts] Dynamic fonts: use virtual resolution (otherwise real size changes on every camera move and requests new character, esp. if UI is in 3D) view commit [Fonts] Do not alter fontSize view commit [Fonts] Turned various internal parameters from ref to in (C# 7.2) view commit [Fonts] Turned various internal parameters from ref to in (C# 7.2) (missing file) view commit [Build] Added a trailing slash at the end of PackageOutputPath (maybe necessary since latest VS2019?) view commit Revert \"[Build] Add XenkoBuildDoc parameter to force TargetFramework even if not specified (seems necessary for older version of Roslyn used in docfx)\" view commit [Build] Separated XenkoGraphicsApis into one list per platform (otherwise we can't really control properly and risk overriding a platform with nothing) (fixes #544) view commit [Build] Remove GetSolutionConfigurationContents hack (which was necessary for WinStore/WinPhone port) (this allows command line build for Android/iOS #543) view commit [Build] Remove the -beta02 version suffix and bump samples accordingly view commit Updated BACKERS.md view commit WaldiS (3): Added translation using Weblate (Polish) view commit Translated using Weblate (Polish) view commit Translated using Weblate (Polish) view commit WhyPenguins (1): Add output merger UAV binding. (#478) view commit Yuuki terumi (5): Added translation using Weblate (Spanish) view commit Added translation using Weblate (Spanish) view commit Added translation using Weblate (Spanish) view commit Added translation using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit dfkeenan (5): Allow spaces in TargetDir when building LauncherApp project. view commit Update Roadmap url to github projects. view commit Add tooltip status text for link buttons. view commit Add patreon link to launcher. view commit Remove AnswerHub link from launcher. view commit ioc (1): Fix broken link to Teamcity Android build in ReadMe view commit joreg (1): VR tracker support (#213) view commit meriaizen86 (3): Translated using Weblate (Spanish) view commit Translated using Weblate (Spanish) view commit Update XenkoDefaultSplashScreen.xktex view commit pansan (1): Translated using Weblate (Chinese (Simplified)) view commit phr00t (2): Make alpha optional in Color4 view commit [UI] don't invalidate text UI if we set it to the same thing view commit rgawry (1): Translated using Weblate (Polish) view commit ssantos (1): Translated using Weblate (German) view commit tebjan (4): [Assimp] Updated assimp to official 4.1.0 and updated references in projects (closes #458) view commit [Assimp] Updated assimp to official 4.1.0 and updated references in projects (closes #458) view commit fixed null pointer exceptions in render features view commit removing a package did not fire an event, so all related assets where still in the dependency manager view commit xwellingtonx (1): Fix editor resizing and to insert auto hide minimum size (fixes #189 and #190) view commit 陈宇航 (1): Translated using Weblate (Chinese (Simplified)) view commit Generated using git shortlog origin/master-3.0..origin/master-3.1 -w0,0,0 --pretty=format:\"* %s [view commit](https://github.com/xenko3d/xenko/commit/%H)\" | sed -r \"s/#([[:digit:]]*)/[#\\1](https:\\/\\/github.com\\/xenko3d\\/xenko\\/issues\\/\\1)/g\""
  },
  "ReleaseNotes/ReleaseNotes-4.0.html": {
    "href": "ReleaseNotes/ReleaseNotes-4.0.html",
    "title": "Stride 4.0 Release notes | Stride release notes",
    "summary": "Stride 4.0 Release notes February 1st, 2021 Xenko is now Stride! The Xenko game engine has been renamed to Stride. From now on, all source code, blogs, and tutorials will use the name ‘Stride’ instead of ‘Xenko’. Here is the new logo: More details available on the dedicated blog post Voxel Cone Tracing GI Thanks to a substantial contribution from Sean Boettger and sponsored by David Jeske, Stride now supports Voxel Cone Tracing GI! Here it is in action: As you can see, there are many customizations and settings available in the editor: There's a documentation page explaining how to set up the project with Voxel Cone Tracing GI. Here's the original forum post and pull request. Thanks again for this great contribution! .NET 5 Stride editor and toolchain is now running with .NET 5! Runtime has been working with .NET Core for a few versions already. This allows us to have scripts and custom assets in a project targetting .NET Standard 2.1 or .NET 5. If you have scripts or custom assets in a .NET Framework project rather than a .NET Standard project, you can still choose between .NET 5 and .NET Framework within the launcher: The framework will also be displayed in the Game Studio toolbar for easier identification while both coexist. .NET Framework version can be considered deprecated and will likely be removed in a future release (likely 4.1) to allow us to take full advantage of C# 8.0 and soon-to-come C# 9.0. We also expect dropping .NET Framework and supporting only .NET 5 will greatly simplify our installation process since we won't depend on specific workloads or packages of Visual Studio being installed anymore. This was a recurring issue with our users. Flexible GPU Instancing Aka geometry instancing. Thanks to another big community contribution sponsored by vvvv, Stride now supports GPU instancing per model. The nice thing about it is, that it plays together with the entity-component system: Simply add an Instancing component to an entity with a model. Then you can choose between 3 ways of how you generate the instances: EntityTransform, uses the transformation of other entities with an Instance component. This allows you to add components like physics, audio, etc. to each instance. UserArray, for providing an array of matrices via script UserBuffer, for providing a structured buffer (GPU resource) of matrices via script UserArray and UserBuffer even allow you to specify how the matrix is multiplied with the parent transformation. It even works with skinning: Picking individual instances in Game Studio works as well and selects the entity with the respective Instance component. There are also two new entity templates for easy setup: An example project that shows the new features can be found here: StrideTransformationInstancing Graphics API: different selection mechanism + Vulkan improvements There's been a big overhaul on Stride build system to make Graphics API selection work in a more future-proof way. It was previously relying on the custom RuntimeIdentifier being set in the solution. This didn't work very well because it was completely orthogonal to the existing RuntimeIdentifier, and sometimes not having good fallbacks. From now on, the user project will use StrideGraphicsApi in the .csproj project file to specify the graphics API. We hope to expose this in the editor later. We also took the opportunity to improve the state of Vulkan renderer (thanks to a switch to Vortice.Vulkan bindings from Amer Koleci) and automatize graphics unit tests, currently running for D3D11 and Vulkan. It's still a work in progress so expect more in future releases. Documentation & Tutorials The first 10 C# beginner tutorials are recorded and uploaded to the official Stride Youtube channel. You check out the playlist here. These videos are the video equivalent of the existing online documentation for the C# beginner template tutorials and the 'new project' template when creating a new project from the Stride launcher. The C# beginner series should be fully recorded by the end of July 2020. After those videos are done, Jorn will put his focus on the C# Intermediate project template. Here a is work in progress screenshot on the raycasting tutorial: New Developers are Welcome! The Stride GitHub repository has more closed pull requests than open issues. This is a good sign! But in order to move faster and adapt to new technologies, we would be very happy to see more new talents in our friendly and professional developer community. There are several good reasons to join us: Writing engine code in C# is fun and quite productive Stride users will work with what you create We are happy to help, should you get stuck You can learn a lot, the Stride code base is very professional and has high-quality standards An open-source contribution is a great addition to your portfolio No matter whether you (or someone you know) can contribute documentation updates, UI improvements, bug fixes, or new rendering technologies, we welcome everyone!"
  },
  "ReleaseNotes/ReleaseNotes-4.1.html": {
    "href": "ReleaseNotes/ReleaseNotes-4.1.html",
    "title": "Stride 4.1 Release notes | Stride release notes",
    "summary": "Stride 4.1 Release notes July 16th, 2022 Stride contributors are proud to announce a new release now running on .NET 6 supporting the latest C# 10. That means you can now head to the download page and start developing your games using the latest .NET technologies. Improvements Summary Here's a non-exhaustive list of new improvements: .NET 6 support and VS 2022 plugin Stride 4.1 leverages the power of .NET 6 Support for C# 10 Dithered shadows for semi-transparent materials Physics constraints Bullet constraints wrapped around in easy to use functionality Editor gizmos for physics constraints Physics performance optimization ACES tonemaping Fog image effect Outline image effect Improved editor gizmos C# Intermediate tutorials project This Open Collective sub-project was successfully funded by the community. All related video recordings are available on Stride's Youtube channel and the tutorials page in the documentation will also be update to reflect the new project. Many more minor fixes and quality of life improvements Fixed sample game Simpler Procedural Model creation New math signatures (1122, 1121, 1090) Dispatcher/threadpool improvements Ambient Occlusion quality improvement And many other fixes Dithered shadows for semi-transparent materials Produces semi-transparent shadows by poking more and more holes in the shadow map based on the transparency of the object, shadow map filtering will blur those holes with their neighbor which will result in those partially opaque pixels. Physics constraints Stride's physics system Bullet comes with a set of constraints for you to use in your projects. These constraints are now all visible inside the editor, previewing the constraints using various editor gizmo. For more information on all the types of constraints, you can read up about them in the Stride documentation or watch the video below. Physics optimizations Retrieving collision and contact information was previously done by re-testing all components for collisions, which, as one might expect, led to awful performance for physics heavy scenes (could take up to and above 90% of the frame). Contacts are now lazily evaluated to reduce overhead when nothing ends up reading them. Users can now read and iterate over all collisions through Simulation.CurrentCollisions. Improved editor gizmos The old gizmos weren't very nice to look at, so this feature makes them look better and more user-friendly. It also changes how the rotation gizmo works and adds scale planes to the scale gizmo. This feature also updates the text on the CameraOrientationGizmo to be XYZ instead of right/left. Still prefer the old text instead of the XYZ coordinate? Don't worry, there's a setting under the viewport settings that swaps it back to the old text. ![Rotation](https://i.imgur.com/W4zIf7J.png =400x160) Intermediate tutorials One of the first Open Collective sub-projects is the intermediate C# tutorials project. After discussion in community meetings and with various contributors donating directly to this project, the amount for this project to be included in Stride quickly became a realization. With Stride 4.1, you will be able to select the C# intermediate tutorials project as a new template project. The template project contains (at the moment of writing) 11 topics that every developer will want to have a look at. UI basics Collision triggers Raycasting Projecting and Unprojecting Async(hronous) scripts Scene loading Animation basics Audio First person camera Third person camera Navigation Each tutorial has a video tutorial accompanying it, which can be found on Stride's Youtube channel. Below you can find the full playlist. Known Issues Integrated C# Editor The transition to .NET6 unfortunately broke the help tooltips and the code completion of integrated C# code editor. But we decided to accept it for now, as everyone is using a proper C# editor anyways, such as Visual Studio, Rider or Visual Studio Code. The reason for the error is that RoslynPad, the underlaying library, also needs an update or fix. We'll adress this in one of the upcoming minor version releases. A little help We, contributors, believe that Stride can help .NET game developers make the games they want with ease using their favorite languages. We want to make sure Stride offers the most comfortable environment for developing games, and this takes time and effort. Since the free and open-source release of Stride, the community has been growing slowly, so we have decided to open a fund to reward developers for any contribution they make to Stride. We set up an Open Collective page to manage our funds and allocate money for features that the community would like to see implemented. We have various bounties for bug fixes and features (Vulkan support, decals, morph targets, and many others). If you have or know someone with the skills to tackle those bounties, please reach out to us through the respective GitHub tickets. You can also contact us through our discord server or on GitHub to propose new bounties. Contributors Many thanks to all the contributors who have donated their time and skill by adding features, fixing bugs, managing the build pipelines, adding documentation, and reviewing PRs. Financial contributors Also, a huge thanks to the individuals and companies who contributed financially to our Open Collective! ORE System with a diamond sponsorship xen2 Core contributor that donated a large portion of the previous Patreon back through Open collective vvvv A visual live-programming environment for easy prototyping and development. It is designed to facilitate the handling of large media environments with physical interfaces, real-time motion graphics, audio and video that can interact with many users simultaneously. vvvv uses Stride Vašo Mitchel Albertz Bill Ideonella Soul Rider najak3d Eideren Jorn Aggror Marian Dziubiak Youness KAFIA David Thunderclown Christian Clavet Marko Viitanen Aaron Disibio z16 Incognito Walter Hulsebos TheKeyblader James Rinker ztl Bruno Garcia BanditRevolver EmmX SeleDreams Vignette Longplay Games Redberd36"
  },
  "ReleaseNotes/ReleaseNotes-4.2.html": {
    "href": "ReleaseNotes/ReleaseNotes-4.2.html",
    "title": "Stride 4.2 Release notes | Stride release notes",
    "summary": "Stride 4.2 Release notes February 6th, 2024 Stride contributors are thrilled to announce the release of Stride 4.2, now fully compatible with .NET 8 and leveraging the latest enhancements in C# 12. This release brings significant improvements in performance, stability, and developer experience. Read the full blog post here: Announcing Stride 4.2 A massive thank you to the open-source Stride community for your dedicated contributions. This release saw over 75 contributions from more than 22 amazing contributors, each playing a crucial role in making Stride 4.2 a reality. Other releases since the last major release 4.2.1.2485: October 2025 4.2.1.2442: August 2025 4.2.0.2381: March 2025 4.2.0.2374: February 2025 4.2.0.2293: January 2025 4.2.0.2282: December 2024 4.2.0.2232: September 2024 4.2.0.2188: June 2024 4.2.0.2122: March 2024 What's new in Stride 4.2 Stride 4.2 includes numerous enhancements and improvements. Here’s what to expect: .NET 8 Integration: Stride 4.2 is now fully aligned with .NET 8, harnessing its performance improvements and efficiency gains for game development. This means faster execution times, reduced memory footprint, and access to the latest C# features, making your development smoother and more efficient. Learn more C# 12 Features: With C# 12, Stride users can write cleaner, more concise code thanks to new language features. These improvements reduce boilerplate and enhance readability. Discover C# 12 Changed Assimp Binding to Silk.Net.Assimp: This update transitions the asset compiler's binding from C++/CLR to Silk.Net.Assimp, a move that not only simplifies the codebase but also paves the way for asset compilation on non-Windows systems, broadening Stride's accessibility. See the pull request Migration NET6+ and More gettextnet#2: Stride's commitment to staying current with .NET versions continues, ensuring compatibility and leveraging the stability and features of the latest .NET environment across all aspects of the engine. Check out the update Enable Multiple Profiler Consumers and Add a Timeline/Tracing Profiler: This enhancement introduces a profiler with chrome://tracing output format, significantly improving the debugging and performance tuning process by allowing for a more granular analysis of game performance. Explore the feature Feature: Add Support for F# and VB Project Types: Stride now welcomes developers using F# and Visual Basic, offering support for code-only projects in these languages. This opens up Stride to a broader audience. Learn about F# and VB support Stride Diagnostics Analyzer: This new tool provides immediate feedback within your IDE, identifying potential compatibility issues with Stride's serialization system. It's about making your development process smoother and helping you catch and resolve issues faster. Discover how it works, the docs page and here is the pull request. OpenVR Handle Custom Resolution Specified by the User Through VR Settings: Enhancing VR development, this update allows developers to specify custom resolutions for VR projects, optimizing performance and visual quality for various VR devices. See the details Editor Enhancements: Dynamic Snapping for Selected Objects: This feature introduces dynamic snapping while transforming objects, improving precision and workflow efficiency within the Stride Editor. Dynamic snapping PR Animation Stack Selection for FBX Imports: Stride now allows you to select specific animations from a stack when importing FBX files, giving you more control over the assets you bring into your projects. Learn more Automatic Asset Copying to Resources Directory: To streamline asset management, the editor can now automatically copy imported assets to the project's Resources directory, ensuring your assets are always where they need to be. See how it works What's Changed in Details Fixed Exception Caused By Privacy Policy URL in Crash Reporter by @MeharDT in https://github.com/stride3d/stride/pull/1878 docs: add acastrodev as a contributor for code by @allcontributors in https://github.com/stride3d/stride/pull/1886 docs: add SVNMLR as a contributor for design by @allcontributors in https://github.com/stride3d/stride/pull/1887 docs: add JeromyWalsh as a contributor for code by @allcontributors in https://github.com/stride3d/stride/pull/1888 docs: add parhamgholami as a contributor for design by @allcontributors in https://github.com/stride3d/stride/pull/1889 Fix missing OpenGLES texture formats. by @Basewq in https://github.com/stride3d/stride/pull/1898 field typo by @IXLLEGACYIXL in https://github.com/stride3d/stride/pull/1900 [Editor] Improve Cameracontrol in Editor by @SVNMLR in https://github.com/stride3d/stride/pull/1879 [XML Comment] Minor updates on EFlags in CollisionFilterGroups.cs by @VaclavElias in https://github.com/stride3d/stride/pull/1910 Fixes the issue where projects were disappearing from the launcher by @acastrodev in https://github.com/stride3d/stride/pull/1880 Fix typo in translations generation by @Ethereal77 in https://github.com/stride3d/stride/pull/1916 Handle importing meshes with duplicate material names by @adrsch in https://github.com/stride3d/stride/pull/1920 [Native] - Implement some existing C++ methods in C# by @Jklawreszuk in https://github.com/stride3d/stride/pull/1896 [Launcher] Prevent launcher automatically closing when offline by @Eideren in https://github.com/stride3d/stride/pull/1912 Small refactoring changes in Stride.GameStudio by @Jklawreszuk in https://github.com/stride3d/stride/pull/1741 Remove MSBuild.Extras from project by @Jklawreszuk in https://github.com/stride3d/stride/pull/1895 [Editor] Allow drag and drop of EntityComponent by @Eideren in https://github.com/stride3d/stride/pull/1921 Add editor settings for the camera speed increase/decrease hotkeys by @adrsch in https://github.com/stride3d/stride/pull/1927 docs: add adrsch as a contributor for code by @allcontributors in https://github.com/stride3d/stride/pull/1930 Let the user set the default Bullet gravity vector in PhysicsSettings by @adrsch in https://github.com/stride3d/stride/pull/1928 Migrate Irony.GrammarExplorer to net 6.0 by @Jklawreszuk in https://github.com/stride3d/stride/pull/1932 [Core] Enable multiple profiler consumers and add a timeline/tracing profiler by @froce in https://github.com/stride3d/stride/pull/1788 [Build] Fixed an errors in the build pipeline associated with having a space in the user name by @Fydar in https://github.com/stride3d/stride/pull/1941 fix(graphics): Stop FastTextRenderer VB clobbering by @froce in https://github.com/stride3d/stride/pull/1954 Update SSH.NET to 2023.0.0 by @WojciechNagorski in https://github.com/stride3d/stride/pull/1951 [Build] Fix Android build error by @froce in https://github.com/stride3d/stride/pull/1949 [Docs] Use XML documentation lists by @Fydar in https://github.com/stride3d/stride/pull/1948 [Editor] Remove some windows dependencies in editor libraries by @Kryptos-FR in https://github.com/stride3d/stride/pull/1908 parse numbers in NumericTextBox using CurrentCulture by @Schossi in https://github.com/stride3d/stride/pull/1811 Xml comments fixing 1 by @VaclavElias in https://github.com/stride3d/stride/pull/1918 [Presentation] Reduce allocations when parsing number in NumericTextBox by @Kryptos-FR in https://github.com/stride3d/stride/pull/1955 [Sample] Replace deprecated GetServiceAs calls by @Eideren in https://github.com/stride3d/stride/pull/1943 Fix compiling assets in Android build by @Basewq in https://github.com/stride3d/stride/pull/1905 Removed all references to $(SolutionDir) from build artifacts by @JeromyWalsh in https://github.com/stride3d/stride/pull/1894 [Serialization] Fix diverging rules for editor and runtime serialization of fields and properties by @Eideren in https://github.com/stride3d/stride/pull/1875 feat(extension): Rename launcher buttons for clarity by @acastrodev in https://github.com/stride3d/stride/pull/1872 Stride Diagnostics Analyzer by @IXLLEGACYIXL in https://github.com/stride3d/stride/pull/1864 Fix Building by @MaximilianEmel in https://github.com/stride3d/stride/pull/1956 [Math] Add a couple of helpers for Vectors by @ch3mbot in https://github.com/stride3d/stride/pull/1769 Fix #1769 and introduce an optional argument to specify a different r… by @Kryptos-FR in https://github.com/stride3d/stride/pull/1964 [Github] Update pull request template to ensure users tried out their changes by @Eideren in https://github.com/stride3d/stride/pull/1965 Fixed small xml docs mistake by @Doprez in https://github.com/stride3d/stride/pull/1976 Revert \"[Editor] Remove some windows dependencies in editor libraries (#1908)\" by @Eideren in https://github.com/stride3d/stride/pull/1980 [AssemblyProcessor] Fixed packing path. by @Basewq in https://github.com/stride3d/stride/pull/1987 [Core] Make object id more performant by @IXLLEGACYIXL in https://github.com/stride3d/stride/pull/1957 [Docs] Move bounty paragraph to a more prominent spot by @Eideren in https://github.com/stride3d/stride/pull/1984 [Readme] Some additional info for building Stride from source by @tebjan in https://github.com/stride3d/stride/pull/1988 [Docs] Update PropertiesDemo.cs by @Eideren in https://github.com/stride3d/stride/pull/1991 Fix failing to load data/db/index file on non-Win desktop platforms by @Jklawreszuk in https://github.com/stride3d/stride/pull/1995 [Shaders] Fixes EffectValueDescription.DefaultValue for negative values by @azeno in https://github.com/stride3d/stride/pull/1990 [Editor] Re-introduce workaround for missing input while navigating by @Eideren in https://github.com/stride3d/stride/pull/1897 [Build] Fix native library loading picking up invalid files by @Basewq in https://github.com/stride3d/stride/pull/1999 Fixes OpenXR by @MaximilianEmel in https://github.com/stride3d/stride/pull/1911 [Breaking] Scoping generic extension methods by @Fydar in https://github.com/stride3d/stride/pull/1959 Add information about Irony.GrammarExplorer project by @Jklawreszuk in https://github.com/stride3d/stride/pull/2007 [VR] Remove framecap from VR sample by @Eideren in https://github.com/stride3d/stride/pull/2002 Bump Newtonsoft.Json from 12.0.3 to 13.0.1 in /sources/metrics/Stride.Metrics by @dependabot in https://github.com/stride3d/stride/pull/1539 [OpenVR] Handle custom resolution specified by the user through VR settings by @Eideren in https://github.com/stride3d/stride/pull/2000 Update NuGet libraries to 6.4.2 by @manio143 in https://github.com/stride3d/stride/pull/2017 Let the user pick which animation stack to import in an fbx by @adrsch in https://github.com/stride3d/stride/pull/1977 Fixes OpenGL by @MaximilianEmel in https://github.com/stride3d/stride/pull/2023 Update dotnet 8 by @Doprez in https://github.com/stride3d/stride/pull/1616 [Native] - Implement IsXInputDevice method in C# by @Jklawreszuk in https://github.com/stride3d/stride/pull/1926 Rollback changes to Stride.Native.targets and add StrideNative.cpp by @Kryptos-FR in https://github.com/stride3d/stride/pull/2047 Use central package management by @Kryptos-FR in https://github.com/stride3d/stride/pull/2045 [Build] Use central package management - missed a couple of projects by @Kryptos-FR in https://github.com/stride3d/stride/pull/2052 [Profiling] Fix performance regression in FastTextRenderer by @Eideren in https://github.com/stride3d/stride/pull/2058 [Project] GitIgnore Rider cache/user config by @Eideren in https://github.com/stride3d/stride/pull/2062 [Build] Fix build following changes from #2045 by @Eideren in https://github.com/stride3d/stride/pull/2061 Replace net 6 leftovers by @Jklawreszuk in https://github.com/stride3d/stride/pull/2038 updated missed dotnet 6 reference in readme by @Doprez in https://github.com/stride3d/stride/pull/2051 [Math] Relax constraints on arguments passed as ref across math types by @Eideren in https://github.com/stride3d/stride/pull/2044 fix(fbx import): Prevent zero-length tangents/normals (partial fix for #325) by @froce in https://github.com/stride3d/stride/pull/2066 [Editor] Fix NuGet.Frameworks failing to load causing RoslynPad to break by @Eideren in https://github.com/stride3d/stride/pull/2075 [Native] Undo lightprobe-related code removal by @Jklawreszuk in https://github.com/stride3d/stride/pull/2077 Fix extension by @Doprez in https://github.com/stride3d/stride/pull/2064 [Build] Move Directory.Packages.props by @Kryptos-FR in https://github.com/stride3d/stride/pull/2055 Fix Typos in XML docs by @Doprez in https://github.com/stride3d/stride/pull/2091 Contributors A heartfelt thank you to all the contributors who have played a significant role in this release: @MeharDT @Basewq @Doprez @IXLLEGACYIXL @SVNMLR @VaclavElias @acastrodev @Ethereal77 @adrsch @Jklawreszuk @Eideren @Fydar @froce @Kryptos-FR @Schossi @MaximilianEmel @ch3mbot @tebjan @JeromyWalsh @azeno @WojciechNagorski @manio143 New Contributors We are especially excited to welcome the following new contributors to Stride with the 4.2 release. Your contributions are greatly appreciated! @adrsch made their first contribution in https://github.com/stride3d/stride/pull/1920 @froce made their first contribution in https://github.com/stride3d/stride/pull/1788 @Fydar made their first contribution in https://github.com/stride3d/stride/pull/1941 @WojciechNagorski made their first contribution in https://github.com/stride3d/stride/pull/1951 @Schossi made their first contribution in https://github.com/stride3d/stride/pull/1811 @MaximilianEmel made their first contribution in https://github.com/stride3d/stride/pull/1956 @ch3mbot made their first contribution in https://github.com/stride3d/stride/pull/1769 Stride 4.2 Feature Overview F# and Visual Basic Integration A pivotal PR has enabled F# and Visual Basic support for game development in Stride. This feature is currently limited to a code-only approach. Detailed insights and tutorials will be provided in upcoming blog posts. We will use the Stride Community Toolkit [WIP], with further details to be covered in a separate post. Below is a simple example of rendering a capsule using F#: open Stride.CommunityToolkit.Engine; open Stride.CommunityToolkit.ProceduralModels; open Stride.Core.Mathematics; open Stride.Engine; let game = new Game() let Start rootScene = game.SetupBase3DScene() game.AddProfiler() |> ignore let firstBox = game.CreatePrimitive(PrimitiveModelType.Capsule); firstBox.Transform.Position <- new Vector3(0f, 2.5f, 0f) firstBox.Scene <- rootScene [<EntryPoint>] let main argv = game.Run(start = Start) 0 The equivalent Visual Basic example: Imports Stride.CommunityToolkit.Engine Imports Stride.CommunityToolkit.ProceduralModels Imports Stride.Core.Mathematics Imports Stride.Engine Module Program Private game As New Game() Sub Main() GameExtensions.Run(game, Nothing, AddressOf StartGame) End Sub Private Sub StartGame(rootScene As Scene) game.SetupBase3DScene() game.AddProfiler() Dim entity = game.CreatePrimitive(PrimitiveModelType.Capsule) entity.Transform.Position = New Vector3(0, 8, 0) entity.Scene = rootScene End Sub End Module These examples showcase how F# and Visual Basic can be utilized in Stride. The Stride Community Toolkit provides a set of helpers and extensions designed to enhance your experience with the Stride Game Engine. Fixes Although there have been many fixes, we'd like to point some of them out: Runtime rasterized fonts are broken #1750 Game Studio doesn't reload sub projects after changes #1703 Changing the comparison project related and not UPath related #1704 Translations fix #1717 C# Beginner Tutorial Build Errors #1652 Can not create \"C# Beginner\" project #1650 Also good to know Although not directly tied to Release 4.2, we have some more big things going on. For instance to our website and documentation. We also had another community meeting to address all those new members. Website and documentation revamped and build process updated Contributor section moved to docs Community meeting October 2023 Acknowledgements We extend our heartfelt gratitude for all the hard work and donations we have received. Your generous contributions significantly aid in the continuous development and enhancement of the Stride community and projects. Thank you for your support and belief in our collective efforts."
  },
  "ReleaseNotes/ReleaseNotes.html": {
    "href": "ReleaseNotes/ReleaseNotes.html",
    "title": "Stride 4.3 release notes | Stride release notes",
    "summary": "Stride 4.3 release notes November 14th, 2025 Stride contributors are thrilled to announce the release of Stride 4.3, now fully compatible with .NET 10 and leveraging the latest enhancements in C# 14. This release brings significant improvements in performance, stability, and developer experience. Read the full blog post here: Announcing Stride 4.3 A massive thank you to the open-source Stride community for your dedicated contributions. What's new in this release Stride 4.3 includes numerous enhancements and improvements. Here’s what to expect: .NET 10 Integration: Stride 4.3 is now fully aligned with .NET 10, harnessing its performance improvements and efficiency gains for game development. This means faster execution times, reduced memory footprint, and access to the latest C# features, making your development smoother and more efficient. Learn more C# 14 Features: With C# 14, Stride users can write cleaner, more concise code thanks to new language features. These improvements reduce boilerplate and enhance readability. Discover C# 14 What has changed since Stride 4.2 Bepu physics integration Adding support for Bepu Physics, a ridiculously fast physics engine written entirely in C#. Having both a game and physics engine in the same ecosystem reduces the cost of maintaining and improving it, the overhead that we may incur when communicating between the two APIs, and the barrier to entry for contributors. Bullet is still the default physics engine, and we welcome any contribution towards it, but our efforts will be focused on Bepu from now. The integration is effectively done, with Bepu's feature set now being slightly ahead of Bullet's. Have a look at this page if you want to migrate to Bepu. Vulkan compute shader support Vulkan graphics backend has been modified to support compute shaders, the shader compiler has also been modified to support computer shader generation for GLSL. User-defined Assets Introducing Custom Assets, a way to define and store data which can be referenced across multiple components, scenes and through other assets. The asset compiler also gives you the ability to build more complex systems like custom file importers. Ongoing efforts to build projects from Linux and Apple desktops Stride can build games under Windows to target the different devices we support, but building directly from those devices was not supported up till now. We've introduced a couple of changes to improve on that front: Replacing our custom C++/CLI FBX importer with Assimp Fixing the asset compiler to run on all desktop OSes Many build-system refactors to move toward fully cross-platform development Building VHACD for Linux Adjust FreeImage and DirectXTex for all platforms Some work is still required on this front, but simpler projects can now be built from those platforms. Efficient API to manipulate meshes Vertex buffers do not have a standardized layout, each mesh may have its own specific layout and data type it uses for its vertices. Some have blend weights, or tangents, while others only have positions - they may also use different data types, for example Half4 positions, 4byte color ... We added in two helpers in VertexBufferHelper and IndexBufferHelper to provide a standardized way to read and write to those buffers. Open project with Rider and VSCode from the GameStudio While any IDE can open and build Stride projects, the editor button to open said project only had special handling for Visual Studio. Jklawreszuk added support for Rider and VSCode. Interface processor Stride has a component processors, a user-defined class which can collect and process all components of a given type in the running game. It is also known as the System part of the ECS acronym. The new flexible processing system provides more type safety, and the ability to process components by their interfaces. You could, for example, implement a custom update callback any component could receive through this API. And more minor changes HDR Rendering Support for D3d/Windows User-defined gizmos Haptic feedback integration for VR runtimes API for OpenXR Passthrough Fixes Although there have been many fixes, we'd like to point some of them out: Major performance improvements, particularly for graphics and UI Multiple fixes improving Vulkan, OpenGL, games under Linux and OpenXR stability And fixes for edge cases when reloading assemblies in the game studio Also good to know We are already hard at work on a bunch of ongoing projects for version 4.4 and beyond; Continuing work to allow for building games from other platforms Converting our Windows-only GameStudio to cross-platform through Avalonia We welcome anyone willing to contribute to this project over Here - just have to make sure to add a comment to one of the unassigned issues you want to work on Improvements to shader compilation, reducing in-game hangs while building shader permutations. Here More work on D3d12 and Vulkan as we slowly transition away from D3d11 Changelog for this release \uD83C\uDF89 New features fix: Add mouse wheel delta to virtual button by Acissathar in #2946 \uD83E\uDDE0 Core chore: Update to dotnet 10 by Eideren in #2888 refactor: Use CollectionsMarshal.SetCount to resize lists by azeno in #2945 \uD83D\uDD28 Build chore: Move bepu asset compilation to Stride.Assets by Eideren in #2963 chore: Update dependencies to .Net10 by Eideren in #2966 \uD83D\uDCC4 Docs fix: Typo in InstancingEntiyTransform by Acissathar in #2951 fix: Update MSBuild path for Visual Studio 2026 by ModxVoldHunter in #2961 chore: Change disk space requirement from 14 GB to 19 GB by VaclavElias in #2968 \uD83C\uDFA8 Graphics fix: Rollback regression introduced through #2798 wrt lightprobes by Eideren in #2949 fix: Regression in mesh bounds calculation introduced through #2858 by johang88 in #2952 fix: Ensure cached data is up to date when models are mutated by Eideren in #2936 feat: Match constructors between Index and VertexBufferHelper and improve documentation by Eideren in #2941 ⌨️ Input fix: Adds touch support to Winforms based GameForm by joreg in #1664 ⚙️ Physics docs: fix incorrect documentation from pr #2930 by Eideren in #2943 fix: Removal of self while running OnSimulationUpdate by Eideren in #2954 \uD83D\uDD04 Serialization fix: Instantiate() behavior for Prefab and Entity references by Eideren in #2914 Contributors A heartfelt thank you to all the contributors who have played a significant role in this release. New contributors We are especially excited to welcome the following new contributors to Stride with the 4.3 release. Your contributions are greatly appreciated! ModxVoldHunter in #2961 New contributors since 4.2 C0dingSteve in #2847 MEEMexe in #2871 ferafiks in #2845 Kreblc3428 in #2873 Acissathar in #2902 rmtttt in #2925 laske185 in #2674 MikhailArsentevTheSecond in #2728 hoelzl in #2755 kutal10 in #2792 ClamEater14 in #2593 net2cn in #2598 Nicogo1705 in #2571 ourabigdev in #2582 kopffarben in #2482 Feralnex in #2494 TranquilAbyss in #2518 levifmorais in #2546 tymokvo in #2339 Arc-huangjingtong in #2357 minktusk in #2345 timcassell in #2373 dloe in #2257 wrshield in #2272 soorMSWE in #2280 MechWarrior99 in #2258 kristian15959 in #2294 YerkoAndrei in #2307 ComputerSmoke in #2169 timconner in #2183 Acknowledgements We extend our heartfelt gratitude for all the hard work and donations we have received. Your generous contributions significantly aid in the continuous development and enhancement of the Stride community and projects. Thank you for your support and belief in our collective efforts."
  },
  "ReleaseNotes/ReleaseNotesNext.html": {
    "href": "ReleaseNotes/ReleaseNotesNext.html",
    "title": "Stride Release notes | Stride release notes",
    "summary": "Stride Release notes February 6th, 2024 What's new This release includes numerous enhancements and improvements. Here’s what to expect: GitHub Pull Request Guidelines The GitHub Pull Request Guidelines offer comprehensive instructions for crafting pull requests (PRs) that facilitate an efficient review and merge process by the Stride team. These guidelines detail the use of a template that prompts contributors to provide a succinct summary of changes, an in-depth description, any related issues, the motivation behind the changes, the types of changes made, and a thorough checklist to ensure comprehensive testing. Additionally, the guidelines outline the process for prefixing PR titles based on specific labels, categorizing PRs for organizational clarity, and the approach to squashing commits when necessary. A significant focus is also placed on the importance of updating documentation, including API documentation and the user manual, to reflect the latest changes. Feature 2 Feature 3 Feature 4"
  },
  "ReleaseNotes/index.html": {
    "href": "ReleaseNotes/index.html",
    "title": "Stride 4.3 release notes | Stride release notes",
    "summary": "Stride 4.3 release notes November 14th, 2025 Stride contributors are thrilled to announce the release of Stride 4.3, now fully compatible with .NET 10 and leveraging the latest enhancements in C# 14. This release brings significant improvements in performance, stability, and developer experience. Read the full blog post here: Announcing Stride 4.3 A massive thank you to the open-source Stride community for your dedicated contributions. What's new in this release Stride 4.3 includes numerous enhancements and improvements. Here’s what to expect: .NET 10 Integration: Stride 4.3 is now fully aligned with .NET 10, harnessing its performance improvements and efficiency gains for game development. This means faster execution times, reduced memory footprint, and access to the latest C# features, making your development smoother and more efficient. Learn more C# 14 Features: With C# 14, Stride users can write cleaner, more concise code thanks to new language features. These improvements reduce boilerplate and enhance readability. Discover C# 14 What has changed since Stride 4.2 Bepu physics integration Adding support for Bepu Physics, a ridiculously fast physics engine written entirely in C#. Having both a game and physics engine in the same ecosystem reduces the cost of maintaining and improving it, the overhead that we may incur when communicating between the two APIs, and the barrier to entry for contributors. Bullet is still the default physics engine, and we welcome any contribution towards it, but our efforts will be focused on Bepu from now. The integration is effectively done, with Bepu's feature set now being slightly ahead of Bullet's. Have a look at this page if you want to migrate to Bepu. Vulkan compute shader support Vulkan graphics backend has been modified to support compute shaders, the shader compiler has also been modified to support computer shader generation for GLSL. User-defined Assets Introducing Custom Assets, a way to define and store data which can be referenced across multiple components, scenes and through other assets. The asset compiler also gives you the ability to build more complex systems like custom file importers. Ongoing efforts to build projects from Linux and Apple desktops Stride can build games under Windows to target the different devices we support, but building directly from those devices was not supported up till now. We've introduced a couple of changes to improve on that front: Replacing our custom C++/CLI FBX importer with Assimp Fixing the asset compiler to run on all desktop OSes Many build-system refactors to move toward fully cross-platform development Building VHACD for Linux Adjust FreeImage and DirectXTex for all platforms Some work is still required on this front, but simpler projects can now be built from those platforms. Efficient API to manipulate meshes Vertex buffers do not have a standardized layout, each mesh may have its own specific layout and data type it uses for its vertices. Some have blend weights, or tangents, while others only have positions - they may also use different data types, for example Half4 positions, 4byte color ... We added in two helpers in VertexBufferHelper and IndexBufferHelper to provide a standardized way to read and write to those buffers. Open project with Rider and VSCode from the GameStudio While any IDE can open and build Stride projects, the editor button to open said project only had special handling for Visual Studio. Jklawreszuk added support for Rider and VSCode. Interface processor Stride has a component processors, a user-defined class which can collect and process all components of a given type in the running game. It is also known as the System part of the ECS acronym. The new flexible processing system provides more type safety, and the ability to process components by their interfaces. You could, for example, implement a custom update callback any component could receive through this API. And more minor changes HDR Rendering Support for D3d/Windows User-defined gizmos Haptic feedback integration for VR runtimes API for OpenXR Passthrough Fixes Although there have been many fixes, we'd like to point some of them out: Major performance improvements, particularly for graphics and UI Multiple fixes improving Vulkan, OpenGL, games under Linux and OpenXR stability And fixes for edge cases when reloading assemblies in the game studio Also good to know We are already hard at work on a bunch of ongoing projects for version 4.4 and beyond; Continuing work to allow for building games from other platforms Converting our Windows-only GameStudio to cross-platform through Avalonia We welcome anyone willing to contribute to this project over Here - just have to make sure to add a comment to one of the unassigned issues you want to work on Improvements to shader compilation, reducing in-game hangs while building shader permutations. Here More work on D3d12 and Vulkan as we slowly transition away from D3d11 Changelog for this release \uD83C\uDF89 New features fix: Add mouse wheel delta to virtual button by Acissathar in #2946 \uD83E\uDDE0 Core chore: Update to dotnet 10 by Eideren in #2888 refactor: Use CollectionsMarshal.SetCount to resize lists by azeno in #2945 \uD83D\uDD28 Build chore: Move bepu asset compilation to Stride.Assets by Eideren in #2963 chore: Update dependencies to .Net10 by Eideren in #2966 \uD83D\uDCC4 Docs fix: Typo in InstancingEntiyTransform by Acissathar in #2951 fix: Update MSBuild path for Visual Studio 2026 by ModxVoldHunter in #2961 chore: Change disk space requirement from 14 GB to 19 GB by VaclavElias in #2968 \uD83C\uDFA8 Graphics fix: Rollback regression introduced through #2798 wrt lightprobes by Eideren in #2949 fix: Regression in mesh bounds calculation introduced through #2858 by johang88 in #2952 fix: Ensure cached data is up to date when models are mutated by Eideren in #2936 feat: Match constructors between Index and VertexBufferHelper and improve documentation by Eideren in #2941 ⌨️ Input fix: Adds touch support to Winforms based GameForm by joreg in #1664 ⚙️ Physics docs: fix incorrect documentation from pr #2930 by Eideren in #2943 fix: Removal of self while running OnSimulationUpdate by Eideren in #2954 \uD83D\uDD04 Serialization fix: Instantiate() behavior for Prefab and Entity references by Eideren in #2914 Contributors A heartfelt thank you to all the contributors who have played a significant role in this release. New contributors We are especially excited to welcome the following new contributors to Stride with the 4.3 release. Your contributions are greatly appreciated! ModxVoldHunter in #2961 New contributors since 4.2 C0dingSteve in #2847 MEEMexe in #2871 ferafiks in #2845 Kreblc3428 in #2873 Acissathar in #2902 rmtttt in #2925 laske185 in #2674 MikhailArsentevTheSecond in #2728 hoelzl in #2755 kutal10 in #2792 ClamEater14 in #2593 net2cn in #2598 Nicogo1705 in #2571 ourabigdev in #2582 kopffarben in #2482 Feralnex in #2494 TranquilAbyss in #2518 levifmorais in #2546 tymokvo in #2339 Arc-huangjingtong in #2357 minktusk in #2345 timcassell in #2373 dloe in #2257 wrshield in #2272 soorMSWE in #2280 MechWarrior99 in #2258 kristian15959 in #2294 YerkoAndrei in #2307 ComputerSmoke in #2169 timconner in #2183 Acknowledgements We extend our heartfelt gratitude for all the hard work and donations we have received. Your generous contributions significantly aid in the continuous development and enhancement of the Stride community and projects. Thank you for your support and belief in our collective efforts."
  },
  "api/Stride.Animations.AnimationBlendOperation.html": {
    "href": "api/Stride.Animations.AnimationBlendOperation.html",
    "title": "Enum AnimationBlendOperation | Stride API",
    "summary": "Enum AnimationBlendOperation Namespace Stride.Animations Assembly Stride.Engine.dll Describes the type of animation blend operation. [DataContract] public enum AnimationBlendOperation Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"Additive\", null)] Add = 1 Add operation. [Display(\"Linear blend\", null)] LinearBlend = 0 Linear blend operation."
  },
  "api/Stride.Animations.AnimationBlender.BlendType.html": {
    "href": "api/Stride.Animations.AnimationBlender.BlendType.html",
    "title": "Enum AnimationBlender.BlendType | Stride API",
    "summary": "Enum AnimationBlender.BlendType Namespace Stride.Animations Assembly Stride.Engine.dll [DataContract] public enum AnimationBlender.BlendType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Blit = 0 Float1 = 2 Float2 = 3 Float3 = 4 Float4 = 5 Object = 1 Quaternion = 6"
  },
  "api/Stride.Animations.AnimationBlender.Channel.html": {
    "href": "api/Stride.Animations.AnimationBlender.Channel.html",
    "title": "Struct AnimationBlender.Channel | Stride API",
    "summary": "Struct AnimationBlender.Channel Namespace Stride.Animations Assembly Stride.Engine.dll [DataContract] public struct AnimationBlender.Channel Inherited Members ValueType.Equals(object) ValueType.GetHashCode() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BlendType public AnimationBlender.BlendType BlendType Field Value AnimationBlender.BlendType IsUserCustomProperty public bool IsUserCustomProperty Field Value bool Offset public int Offset Field Value int PropertyName public string PropertyName Field Value string Size public int Size Field Value int Methods ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name."
  },
  "api/Stride.Animations.AnimationBlender.html": {
    "href": "api/Stride.Animations.AnimationBlender.html",
    "title": "Class AnimationBlender | Stride API",
    "summary": "Class AnimationBlender Namespace Stride.Animations Assembly Stride.Engine.dll Performs animation blending. For now, all AnimationClip must target the same skeleton. public sealed class AnimationBlender Inheritance object AnimationBlender Extension Methods UnsafeUtilities.As<T>(object?) Methods Blend(CoreAnimationOperation, float, AnimationClipResult, AnimationClipResult, AnimationClipResult) public static void Blend(CoreAnimationOperation blendOperation, float blendFactor, AnimationClipResult sourceLeft, AnimationClipResult sourceRight, AnimationClipResult result) Parameters blendOperation CoreAnimationOperation blendFactor float sourceLeft AnimationClipResult sourceRight AnimationClipResult result AnimationClipResult Compute(List<AnimationOperation>, ref AnimationClipResult) Computes the specified animation operations. public void Compute(List<AnimationOperation> animationOperations, ref AnimationClipResult result) Parameters animationOperations List<AnimationOperation> The animation operations to perform. result AnimationClipResult The optional result (if not null, it expects the final stack to end up with this element). CreateEvaluator(AnimationClip) public AnimationClipEvaluator CreateEvaluator(AnimationClip clip) Parameters clip AnimationClip Returns AnimationClipEvaluator ReleaseEvaluator(AnimationClipEvaluator) public void ReleaseEvaluator(AnimationClipEvaluator evaluator) Parameters evaluator AnimationClipEvaluator"
  },
  "api/Stride.Animations.AnimationChannel.ErrorNode.html": {
    "href": "api/Stride.Animations.AnimationChannel.ErrorNode.html",
    "title": "Class AnimationChannel.ErrorNode | Stride API",
    "summary": "Class AnimationChannel.ErrorNode Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationChannel.ErrorNode Inheritance object AnimationChannel.ErrorNode Extension Methods UnsafeUtilities.As<T>(object?) Constructors ErrorNode(LinkedListNode<KeyFrameData<float>>, CompressedTimeSpan, float) public ErrorNode(LinkedListNode<KeyFrameData<float>> keyFrame, CompressedTimeSpan biggestDeltaTime, float error) Parameters keyFrame LinkedListNode<KeyFrameData<float>> biggestDeltaTime CompressedTimeSpan error float Fields BiggestDeltaTime public CompressedTimeSpan BiggestDeltaTime Field Value CompressedTimeSpan Error public float Error Field Value float KeyFrame public LinkedListNode<KeyFrameData<float>> KeyFrame Field Value LinkedListNode<KeyFrameData<float>>"
  },
  "api/Stride.Animations.AnimationChannel.Evaluator.html": {
    "href": "api/Stride.Animations.AnimationChannel.Evaluator.html",
    "title": "Class AnimationChannel.Evaluator | Stride API",
    "summary": "Class AnimationChannel.Evaluator Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationChannel.Evaluator Inheritance object AnimationChannel.Evaluator Extension Methods UnsafeUtilities.As<T>(object?) Constructors Evaluator(IEnumerable<KeyFrameData<float>>) public Evaluator(IEnumerable<KeyFrameData<float>> keyFrames) Parameters keyFrames IEnumerable<KeyFrameData<float>> Methods Evaluate(CompressedTimeSpan) public float Evaluate(CompressedTimeSpan time) Parameters time CompressedTimeSpan Returns float InvalidateTime() public void InvalidateTime()"
  },
  "api/Stride.Animations.AnimationChannel.EvaluatorData.html": {
    "href": "api/Stride.Animations.AnimationChannel.EvaluatorData.html",
    "title": "Struct AnimationChannel.EvaluatorData | Stride API",
    "summary": "Struct AnimationChannel.EvaluatorData Namespace Stride.Animations Assembly Stride.Engine.dll public struct AnimationChannel.EvaluatorData Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ValueEnd public KeyFrameData<float> ValueEnd Field Value KeyFrameData<float> ValueNext public KeyFrameData<float> ValueNext Field Value KeyFrameData<float> ValuePrev public KeyFrameData<float> ValuePrev Field Value KeyFrameData<float> ValueStart public KeyFrameData<float> ValueStart Field Value KeyFrameData<float> Methods Evaluate(float) public float Evaluate(float t) Parameters t float Returns float"
  },
  "api/Stride.Animations.AnimationChannel.html": {
    "href": "api/Stride.Animations.AnimationChannel.html",
    "title": "Class AnimationChannel | Stride API",
    "summary": "Class AnimationChannel Namespace Stride.Animations Assembly Stride.Engine.dll List of float key frame data applying to a specific property in a node. public class AnimationChannel Inheritance object AnimationChannel Extension Methods UnsafeUtilities.As<T>(object?) Constructors AnimationChannel() public AnimationChannel() Properties KeyFrames public List<KeyFrameData<float>> KeyFrames { get; set; } Property Value List<KeyFrameData<float>> TargetObject Gets or sets the target object name. public string TargetObject { get; set; } Property Value string The target object name. TargetProperty Gets or sets the target property name. public string TargetProperty { get; set; } Property Value string The target property name. Methods EvaluateCubic(CompressedTimeSpan) public float EvaluateCubic(CompressedTimeSpan time) Parameters time CompressedTimeSpan Returns float Fitting(Func<CompressedTimeSpan, float>, CompressedTimeSpan, float) public void Fitting(Func<CompressedTimeSpan, float> originalCurve, CompressedTimeSpan stepSize, float maxErrorThreshold) Parameters originalCurve Func<CompressedTimeSpan, float> stepSize CompressedTimeSpan maxErrorThreshold float"
  },
  "api/Stride.Animations.AnimationClip.Channel.html": {
    "href": "api/Stride.Animations.AnimationClip.Channel.html",
    "title": "Struct AnimationClip.Channel | Stride API",
    "summary": "Struct AnimationClip.Channel Namespace Stride.Animations Assembly Stride.Engine.dll [DataContract] public struct AnimationClip.Channel Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields CurveIndex public int CurveIndex Field Value int ElementSize public int ElementSize Field Value int ElementType public Type ElementType Field Value Type IsUserCustomProperty public bool IsUserCustomProperty Field Value bool PropertyName public string PropertyName Field Value string"
  },
  "api/Stride.Animations.AnimationClip.html": {
    "href": "api/Stride.Animations.AnimationClip.html",
    "title": "Class AnimationClip | Stride API",
    "summary": "Class AnimationClip Namespace Stride.Animations Assembly Stride.Engine.dll An aggregation of AnimationCurve with their channel names. [DataContract] [ContentSerializer(typeof(DataContentSerializer<AnimationClip>))] [DataSerializerGlobal(typeof(ReferenceSerializer<AnimationClip>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public sealed class AnimationClip Inheritance object AnimationClip Extension Methods UnsafeUtilities.As<T>(object?) Fields Channels Gets the channels of this clip. public Dictionary<string, AnimationClip.Channel> Channels Field Value Dictionary<string, AnimationClip.Channel> The channels of this clip. Curves public List<AnimationCurve> Curves Field Value List<AnimationCurve> OptimizedAnimationDatas public AnimationData[] OptimizedAnimationDatas Field Value AnimationData[] ShouldRescanChannels Set this flag to true when the channel information of the clip have changed and need to be rescan by engine. public bool ShouldRescanChannels Field Value bool Properties Duration Gets or sets the duration of this clip. public TimeSpan Duration { get; set; } Property Value TimeSpan The duration of this clip. RepeatMode Gets or sets the repeat mode of the AnimationClip. public AnimationRepeatMode RepeatMode { get; set; } Property Value AnimationRepeatMode Methods AddCurve(string, AnimationCurve, bool) Adds a named curve. public void AddCurve(string propertyName, AnimationCurve curve, bool isUserCustomProperty = false) Parameters propertyName string Name of the property. curve AnimationCurve The curve. isUserCustomProperty bool GetCurve(string) public AnimationCurve GetCurve(string propertyName) Parameters propertyName string Returns AnimationCurve Optimize() Optimizes data from multiple curves to a single linear data stream. public void Optimize()"
  },
  "api/Stride.Animations.AnimationClipEvaluator.html": {
    "href": "api/Stride.Animations.AnimationClipEvaluator.html",
    "title": "Class AnimationClipEvaluator | Stride API",
    "summary": "Class AnimationClipEvaluator Namespace Stride.Animations Assembly Stride.Engine.dll Evaluates AnimationClip to a AnimationClipResult at a given time. public sealed class AnimationClipEvaluator Inheritance object AnimationClipEvaluator Extension Methods UnsafeUtilities.As<T>(object?) Properties Clip public AnimationClip Clip { get; } Property Value AnimationClip Methods AddCurveValues(CompressedTimeSpan, AnimationClipResult) public void AddCurveValues(CompressedTimeSpan newTime, AnimationClipResult result) Parameters newTime CompressedTimeSpan result AnimationClipResult Compute(CompressedTimeSpan, AnimationClipResult) public void Compute(CompressedTimeSpan newTime, AnimationClipResult result) Parameters newTime CompressedTimeSpan result AnimationClipResult"
  },
  "api/Stride.Animations.AnimationClipResult.html": {
    "href": "api/Stride.Animations.AnimationClipResult.html",
    "title": "Class AnimationClipResult | Stride API",
    "summary": "Class AnimationClipResult Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationClipResult Inheritance object AnimationClipResult Extension Methods UnsafeUtilities.As<T>(object?) Fields Data Stores all animation channel blittable struct at a given time. public byte[] Data Field Value byte[] DataSize Total size of all structures to be stored in structures. public int DataSize Field Value int Objects Stores all animation channel objects and non-blittable struct at a given time. public UpdateObjectData[] Objects Field Value UpdateObjectData[] Properties Channels Gets or sets the animation channel descriptions. public List<AnimationBlender.Channel> Channels { get; set; } Property Value List<AnimationBlender.Channel> The animation channel descriptions."
  },
  "api/Stride.Animations.AnimationCurve-1.html": {
    "href": "api/Stride.Animations.AnimationCurve-1.html",
    "title": "Class AnimationCurve<T> | Stride API",
    "summary": "Class AnimationCurve<T> Namespace Stride.Animations Assembly Stride.Engine.dll Typed class for animation curves. [DataContract] public class AnimationCurve<T> : AnimationCurve Type Parameters T Inheritance object AnimationCurve AnimationCurve<T> Inherited Members AnimationCurve.InterpolationType Extension Methods UnsafeUtilities.As<T>(object?) Constructors AnimationCurve() public AnimationCurve() Properties ElementSize Gets the size of keyframe values. public override int ElementSize { get; } Property Value int The size of keyframe values. ElementType Gets the type of keyframe values. public override Type ElementType { get; } Property Value Type The type of keyframe values. KeyFrames Gets or sets the key frames. public List<KeyFrameData<T>> KeyFrames { get; set; } Property Value List<KeyFrameData<T>> The key frames. Keys public override IReadOnlyList<CompressedTimeSpan> Keys { get; } Property Value IReadOnlyList<CompressedTimeSpan> Methods AddValue(CompressedTimeSpan, byte*) Writes a new value at the end of the curve (used for building curves). It should be done in increasing order as it will simply add a new key at the end of KeyFrames. public override void AddValue(CompressedTimeSpan newTime, byte* location) Parameters newTime CompressedTimeSpan The new time. location byte* The location. FindKeyIndex(CompressedTimeSpan) Find key index. public int FindKeyIndex(CompressedTimeSpan time) Parameters time CompressedTimeSpan Returns int ShiftKeys(CompressedTimeSpan) Shifts all animation keys by the specified time, adding it to all Time public override void ShiftKeys(CompressedTimeSpan shiftTimeSpan) Parameters shiftTimeSpan CompressedTimeSpan The time span by which the keys should be shifted"
  },
  "api/Stride.Animations.AnimationCurve.html": {
    "href": "api/Stride.Animations.AnimationCurve.html",
    "title": "Class AnimationCurve | Stride API",
    "summary": "Class AnimationCurve Namespace Stride.Animations Assembly Stride.Engine.dll Untyped base class for animation curves. [DataContract(Inherited = true)] public abstract class AnimationCurve Inheritance object AnimationCurve Derived AnimationCurve<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors AnimationCurve() protected AnimationCurve() Properties ElementSize Gets the size of keyframe values. public abstract int ElementSize { get; } Property Value int The size of keyframe values. ElementType Gets the type of keyframe values. public abstract Type ElementType { get; } Property Value Type The type of keyframe values. InterpolationType Gets or sets the interpolation type. public AnimationCurveInterpolationType InterpolationType { get; set; } Property Value AnimationCurveInterpolationType The interpolation type. Keys public abstract IReadOnlyList<CompressedTimeSpan> Keys { get; } Property Value IReadOnlyList<CompressedTimeSpan> Methods AddValue(CompressedTimeSpan, byte*) Writes a new value at the end of the curve (used for building curves). It should be done in increasing order as it will simply add a new key at the end of KeyFrames. public abstract void AddValue(CompressedTimeSpan newTime, byte* location) Parameters newTime CompressedTimeSpan The new time. location byte* The location. ShiftKeys(CompressedTimeSpan) Shifts all animation keys by the specified time, adding it to all Time public virtual void ShiftKeys(CompressedTimeSpan shiftTimeSpan) Parameters shiftTimeSpan CompressedTimeSpan The time span by which the keys should be shifted"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorDirectBlittableGroup-1.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorDirectBlittableGroup-1.html",
    "title": "Class AnimationCurveEvaluatorDirectBlittableGroup<T> | Stride API",
    "summary": "Class AnimationCurveEvaluatorDirectBlittableGroup<T> Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorDirectBlittableGroup<T> : AnimationCurveEvaluatorDirectBlittableGroupBase<T> Type Parameters T Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorDirectGroup AnimationCurveEvaluatorDirectGroup<T> AnimationCurveEvaluatorDirectBlittableGroupBase<T> AnimationCurveEvaluatorDirectBlittableGroup<T> Inherited Members AnimationCurveEvaluatorDirectBlittableGroupBase<T>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorDirectGroup<T>.channels AnimationCurveEvaluatorDirectGroup<T>.ElementType AnimationCurveEvaluatorDirectGroup<T>.Initialize() AnimationCurveEvaluatorDirectGroup<T>.Cleanup() AnimationCurveEvaluatorDirectGroup<T>.AddChannel(AnimationCurve, int) AnimationCurveEvaluatorDirectGroup<T>.SetTime(ref AnimationCurveEvaluatorDirectGroup<T>.Channel, CompressedTimeSpan) AnimationCurveEvaluatorDirectGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint) protected override void ProcessChannel(ref AnimationCurveEvaluatorDirectGroup<T>.Channel channel, CompressedTimeSpan newTime, nint location) Parameters channel AnimationCurveEvaluatorDirectGroup<T>.Channel newTime CompressedTimeSpan location nint"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorDirectBlittableGroupBase-1.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorDirectBlittableGroupBase-1.html",
    "title": "Class AnimationCurveEvaluatorDirectBlittableGroupBase<T> | Stride API",
    "summary": "Class AnimationCurveEvaluatorDirectBlittableGroupBase<T> Namespace Stride.Animations Assembly Stride.Engine.dll public abstract class AnimationCurveEvaluatorDirectBlittableGroupBase<T> : AnimationCurveEvaluatorDirectGroup<T> Type Parameters T Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorDirectGroup AnimationCurveEvaluatorDirectGroup<T> AnimationCurveEvaluatorDirectBlittableGroupBase<T> Derived AnimationCurveEvaluatorDirectBlittableGroup<T> AnimationCurveEvaluatorDirectFloatGroup AnimationCurveEvaluatorDirectQuaternionGroup AnimationCurveEvaluatorDirectVector3Group AnimationCurveEvaluatorDirectVector4Group Inherited Members AnimationCurveEvaluatorDirectGroup<T>.channels AnimationCurveEvaluatorDirectGroup<T>.ElementType AnimationCurveEvaluatorDirectGroup<T>.Initialize() AnimationCurveEvaluatorDirectGroup<T>.Cleanup() AnimationCurveEvaluatorDirectGroup<T>.AddChannel(AnimationCurve, int) AnimationCurveEvaluatorDirectGroup<T>.SetTime(ref AnimationCurveEvaluatorDirectGroup<T>.Channel, CompressedTimeSpan) AnimationCurveEvaluatorDirectGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) public override void Evaluate(CompressedTimeSpan newTime, nint data, UpdateObjectData[] objects) Parameters newTime CompressedTimeSpan data nint objects UpdateObjectData[] ProcessChannel(ref Channel, CompressedTimeSpan, nint) protected abstract void ProcessChannel(ref AnimationCurveEvaluatorDirectGroup<T>.Channel channel, CompressedTimeSpan newTime, nint location) Parameters channel AnimationCurveEvaluatorDirectGroup<T>.Channel newTime CompressedTimeSpan location nint"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorDirectFloatGroup.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorDirectFloatGroup.html",
    "title": "Class AnimationCurveEvaluatorDirectFloatGroup | Stride API",
    "summary": "Class AnimationCurveEvaluatorDirectFloatGroup Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorDirectFloatGroup : AnimationCurveEvaluatorDirectBlittableGroupBase<float> Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorDirectGroup AnimationCurveEvaluatorDirectGroup<float> AnimationCurveEvaluatorDirectBlittableGroupBase<float> AnimationCurveEvaluatorDirectFloatGroup Inherited Members AnimationCurveEvaluatorDirectBlittableGroupBase<float>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorDirectGroup<float>.channels AnimationCurveEvaluatorDirectGroup<float>.ElementType AnimationCurveEvaluatorDirectGroup<float>.Initialize() AnimationCurveEvaluatorDirectGroup<float>.Cleanup() AnimationCurveEvaluatorDirectGroup<float>.AddChannel(AnimationCurve, int) AnimationCurveEvaluatorDirectGroup<float>.SetTime(ref AnimationCurveEvaluatorDirectGroup<float>.Channel, CompressedTimeSpan) AnimationCurveEvaluatorDirectGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint) protected override void ProcessChannel(ref AnimationCurveEvaluatorDirectGroup<float>.Channel channel, CompressedTimeSpan newTime, nint location) Parameters channel AnimationCurveEvaluatorDirectGroup<float>.Channel newTime CompressedTimeSpan location nint"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorDirectGroup-1.Channel.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorDirectGroup-1.Channel.html",
    "title": "Struct AnimationCurveEvaluatorDirectGroup<T>.Channel | Stride API",
    "summary": "Struct AnimationCurveEvaluatorDirectGroup<T>.Channel Namespace Stride.Animations Assembly Stride.Engine.dll protected struct AnimationCurveEvaluatorDirectGroup<T>.Channel Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields CurrentIndex public int CurrentIndex Field Value int CurrentTime public CompressedTimeSpan CurrentTime Field Value CompressedTimeSpan Curve public AnimationCurve<T> Curve Field Value AnimationCurve<T> InterpolationType public AnimationCurveInterpolationType InterpolationType Field Value AnimationCurveInterpolationType Offset public int Offset Field Value int"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorDirectGroup-1.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorDirectGroup-1.html",
    "title": "Class AnimationCurveEvaluatorDirectGroup<T> | Stride API",
    "summary": "Class AnimationCurveEvaluatorDirectGroup<T> Namespace Stride.Animations Assembly Stride.Engine.dll public abstract class AnimationCurveEvaluatorDirectGroup<T> : AnimationCurveEvaluatorDirectGroup Type Parameters T Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorDirectGroup AnimationCurveEvaluatorDirectGroup<T> Derived AnimationCurveEvaluatorDirectBlittableGroupBase<T> AnimationCurveEvaluatorDirectObjectGroup<T> Inherited Members AnimationCurveEvaluatorDirectGroup.Create<T>() AnimationCurveEvaluatorGroup.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) Extension Methods UnsafeUtilities.As<T>(object?) Fields channels protected FastListStruct<AnimationCurveEvaluatorDirectGroup<T>.Channel> channels Field Value FastListStruct<AnimationCurveEvaluatorDirectGroup<T>.Channel> Properties ElementType public override Type ElementType { get; } Property Value Type Methods AddChannel(AnimationCurve, int) public override void AddChannel(AnimationCurve curve, int offset) Parameters curve AnimationCurve offset int Cleanup() public override void Cleanup() Initialize() public void Initialize() SetTime(ref Channel, CompressedTimeSpan) protected static void SetTime(ref AnimationCurveEvaluatorDirectGroup<T>.Channel channel, CompressedTimeSpan newTime) Parameters channel AnimationCurveEvaluatorDirectGroup<T>.Channel newTime CompressedTimeSpan"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorDirectGroup.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorDirectGroup.html",
    "title": "Class AnimationCurveEvaluatorDirectGroup | Stride API",
    "summary": "Class AnimationCurveEvaluatorDirectGroup Namespace Stride.Animations Assembly Stride.Engine.dll public abstract class AnimationCurveEvaluatorDirectGroup : AnimationCurveEvaluatorGroup Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorDirectGroup Derived AnimationCurveEvaluatorDirectGroup<T> Inherited Members AnimationCurveEvaluatorGroup.ElementType AnimationCurveEvaluatorGroup.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorGroup.Cleanup() Extension Methods UnsafeUtilities.As<T>(object?) Methods AddChannel(AnimationCurve, int) public abstract void AddChannel(AnimationCurve curve, int offset) Parameters curve AnimationCurve offset int Create<T>() public static AnimationCurveEvaluatorDirectGroup Create<T>() Returns AnimationCurveEvaluatorDirectGroup Type Parameters T"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorDirectObjectGroup-1.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorDirectObjectGroup-1.html",
    "title": "Class AnimationCurveEvaluatorDirectObjectGroup<T> | Stride API",
    "summary": "Class AnimationCurveEvaluatorDirectObjectGroup<T> Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorDirectObjectGroup<T> : AnimationCurveEvaluatorDirectGroup<T> Type Parameters T Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorDirectGroup AnimationCurveEvaluatorDirectGroup<T> AnimationCurveEvaluatorDirectObjectGroup<T> Inherited Members AnimationCurveEvaluatorDirectGroup<T>.channels AnimationCurveEvaluatorDirectGroup<T>.ElementType AnimationCurveEvaluatorDirectGroup<T>.Initialize() AnimationCurveEvaluatorDirectGroup<T>.Cleanup() AnimationCurveEvaluatorDirectGroup<T>.AddChannel(AnimationCurve, int) AnimationCurveEvaluatorDirectGroup<T>.SetTime(ref AnimationCurveEvaluatorDirectGroup<T>.Channel, CompressedTimeSpan) AnimationCurveEvaluatorDirectGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) public override void Evaluate(CompressedTimeSpan newTime, nint data, UpdateObjectData[] objects) Parameters newTime CompressedTimeSpan data nint objects UpdateObjectData[]"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorDirectQuaternionGroup.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorDirectQuaternionGroup.html",
    "title": "Class AnimationCurveEvaluatorDirectQuaternionGroup | Stride API",
    "summary": "Class AnimationCurveEvaluatorDirectQuaternionGroup Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorDirectQuaternionGroup : AnimationCurveEvaluatorDirectBlittableGroupBase<Quaternion> Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorDirectGroup AnimationCurveEvaluatorDirectGroup<Quaternion> AnimationCurveEvaluatorDirectBlittableGroupBase<Quaternion> AnimationCurveEvaluatorDirectQuaternionGroup Inherited Members AnimationCurveEvaluatorDirectBlittableGroupBase<Quaternion>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorDirectGroup<Quaternion>.channels AnimationCurveEvaluatorDirectGroup<Quaternion>.ElementType AnimationCurveEvaluatorDirectGroup<Quaternion>.Initialize() AnimationCurveEvaluatorDirectGroup<Quaternion>.Cleanup() AnimationCurveEvaluatorDirectGroup<Quaternion>.AddChannel(AnimationCurve, int) AnimationCurveEvaluatorDirectGroup<Quaternion>.SetTime(ref AnimationCurveEvaluatorDirectGroup<Quaternion>.Channel, CompressedTimeSpan) AnimationCurveEvaluatorDirectGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint) protected override void ProcessChannel(ref AnimationCurveEvaluatorDirectGroup<Quaternion>.Channel channel, CompressedTimeSpan newTime, nint location) Parameters channel AnimationCurveEvaluatorDirectGroup<Quaternion>.Channel newTime CompressedTimeSpan location nint"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorDirectVector3Group.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorDirectVector3Group.html",
    "title": "Class AnimationCurveEvaluatorDirectVector3Group | Stride API",
    "summary": "Class AnimationCurveEvaluatorDirectVector3Group Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorDirectVector3Group : AnimationCurveEvaluatorDirectBlittableGroupBase<Vector3> Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorDirectGroup AnimationCurveEvaluatorDirectGroup<Vector3> AnimationCurveEvaluatorDirectBlittableGroupBase<Vector3> AnimationCurveEvaluatorDirectVector3Group Inherited Members AnimationCurveEvaluatorDirectBlittableGroupBase<Vector3>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorDirectGroup<Vector3>.channels AnimationCurveEvaluatorDirectGroup<Vector3>.ElementType AnimationCurveEvaluatorDirectGroup<Vector3>.Initialize() AnimationCurveEvaluatorDirectGroup<Vector3>.Cleanup() AnimationCurveEvaluatorDirectGroup<Vector3>.AddChannel(AnimationCurve, int) AnimationCurveEvaluatorDirectGroup<Vector3>.SetTime(ref AnimationCurveEvaluatorDirectGroup<Vector3>.Channel, CompressedTimeSpan) AnimationCurveEvaluatorDirectGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint) protected override void ProcessChannel(ref AnimationCurveEvaluatorDirectGroup<Vector3>.Channel channel, CompressedTimeSpan newTime, nint location) Parameters channel AnimationCurveEvaluatorDirectGroup<Vector3>.Channel newTime CompressedTimeSpan location nint"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorDirectVector4Group.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorDirectVector4Group.html",
    "title": "Class AnimationCurveEvaluatorDirectVector4Group | Stride API",
    "summary": "Class AnimationCurveEvaluatorDirectVector4Group Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorDirectVector4Group : AnimationCurveEvaluatorDirectBlittableGroupBase<Vector4> Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorDirectGroup AnimationCurveEvaluatorDirectGroup<Vector4> AnimationCurveEvaluatorDirectBlittableGroupBase<Vector4> AnimationCurveEvaluatorDirectVector4Group Inherited Members AnimationCurveEvaluatorDirectBlittableGroupBase<Vector4>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorDirectGroup<Vector4>.channels AnimationCurveEvaluatorDirectGroup<Vector4>.ElementType AnimationCurveEvaluatorDirectGroup<Vector4>.Initialize() AnimationCurveEvaluatorDirectGroup<Vector4>.Cleanup() AnimationCurveEvaluatorDirectGroup<Vector4>.AddChannel(AnimationCurve, int) AnimationCurveEvaluatorDirectGroup<Vector4>.SetTime(ref AnimationCurveEvaluatorDirectGroup<Vector4>.Channel, CompressedTimeSpan) AnimationCurveEvaluatorDirectGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint) protected override void ProcessChannel(ref AnimationCurveEvaluatorDirectGroup<Vector4>.Channel channel, CompressedTimeSpan newTime, nint location) Parameters channel AnimationCurveEvaluatorDirectGroup<Vector4>.Channel newTime CompressedTimeSpan location nint"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorGroup.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorGroup.html",
    "title": "Class AnimationCurveEvaluatorGroup | Stride API",
    "summary": "Class AnimationCurveEvaluatorGroup Namespace Stride.Animations Assembly Stride.Engine.dll public abstract class AnimationCurveEvaluatorGroup Inheritance object AnimationCurveEvaluatorGroup Derived AnimationCurveEvaluatorDirectGroup AnimationCurveEvaluatorOptimizedGroup Extension Methods UnsafeUtilities.As<T>(object?) Properties ElementType public abstract Type ElementType { get; } Property Value Type Methods Cleanup() public virtual void Cleanup() Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) public abstract void Evaluate(CompressedTimeSpan newTime, nint data, UpdateObjectData[] objects) Parameters newTime CompressedTimeSpan data nint objects UpdateObjectData[]"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedBlittableGroup-1.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedBlittableGroup-1.html",
    "title": "Class AnimationCurveEvaluatorOptimizedBlittableGroup<T> | Stride API",
    "summary": "Class AnimationCurveEvaluatorOptimizedBlittableGroup<T> Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorOptimizedBlittableGroup<T> : AnimationCurveEvaluatorOptimizedBlittableGroupBase<T> Type Parameters T Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedGroup AnimationCurveEvaluatorOptimizedGroup<T> AnimationCurveEvaluatorOptimizedBlittableGroupBase<T> AnimationCurveEvaluatorOptimizedBlittableGroup<T> Inherited Members AnimationCurveEvaluatorOptimizedBlittableGroupBase<T>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorOptimizedBlittableGroupBase<T>.ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<T>.Channel, CompressedTimeSpan, nint) AnimationCurveEvaluatorOptimizedGroup<T>.animationData AnimationCurveEvaluatorOptimizedGroup<T>.channels AnimationCurveEvaluatorOptimizedGroup<T>.ElementType AnimationCurveEvaluatorOptimizedGroup<T>.Initialize(AnimationData) AnimationCurveEvaluatorOptimizedGroup<T>.Initialize(AnimationData<T>) AnimationCurveEvaluatorOptimizedGroup<T>.Cleanup() AnimationCurveEvaluatorOptimizedGroup<T>.SetChannelOffset(string, int) AnimationCurveEvaluatorOptimizedGroup<T>.SetTime(CompressedTimeSpan) AnimationCurveEvaluatorOptimizedGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint, float) protected override void ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<T>.Channel channel, CompressedTimeSpan currentTime, nint location, float factor) Parameters channel AnimationCurveEvaluatorOptimizedGroup<T>.Channel currentTime CompressedTimeSpan location nint factor float"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedBlittableGroupBase-1.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedBlittableGroupBase-1.html",
    "title": "Class AnimationCurveEvaluatorOptimizedBlittableGroupBase<T> | Stride API",
    "summary": "Class AnimationCurveEvaluatorOptimizedBlittableGroupBase<T> Namespace Stride.Animations Assembly Stride.Engine.dll public abstract class AnimationCurveEvaluatorOptimizedBlittableGroupBase<T> : AnimationCurveEvaluatorOptimizedGroup<T> Type Parameters T Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedGroup AnimationCurveEvaluatorOptimizedGroup<T> AnimationCurveEvaluatorOptimizedBlittableGroupBase<T> Derived AnimationCurveEvaluatorOptimizedBlittableGroup<T> AnimationCurveEvaluatorOptimizedFloatGroup AnimationCurveEvaluatorOptimizedIntGroup AnimationCurveEvaluatorOptimizedQuaternionGroup AnimationCurveEvaluatorOptimizedVector3Group AnimationCurveEvaluatorOptimizedVector4Group Inherited Members AnimationCurveEvaluatorOptimizedGroup<T>.animationData AnimationCurveEvaluatorOptimizedGroup<T>.channels AnimationCurveEvaluatorOptimizedGroup<T>.ElementType AnimationCurveEvaluatorOptimizedGroup<T>.Initialize(AnimationData) AnimationCurveEvaluatorOptimizedGroup<T>.Initialize(AnimationData<T>) AnimationCurveEvaluatorOptimizedGroup<T>.Cleanup() AnimationCurveEvaluatorOptimizedGroup<T>.SetChannelOffset(string, int) AnimationCurveEvaluatorOptimizedGroup<T>.SetTime(CompressedTimeSpan) AnimationCurveEvaluatorOptimizedGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) public override void Evaluate(CompressedTimeSpan newTime, nint data, UpdateObjectData[] objects) Parameters newTime CompressedTimeSpan data nint objects UpdateObjectData[] ProcessChannel(ref Channel, CompressedTimeSpan, nint) protected void ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<T>.Channel channel, CompressedTimeSpan currentTime, nint data) Parameters channel AnimationCurveEvaluatorOptimizedGroup<T>.Channel currentTime CompressedTimeSpan data nint ProcessChannel(ref Channel, CompressedTimeSpan, nint, float) protected abstract void ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<T>.Channel channel, CompressedTimeSpan currentTime, nint data, float factor) Parameters channel AnimationCurveEvaluatorOptimizedGroup<T>.Channel currentTime CompressedTimeSpan data nint factor float"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedFloatGroup.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedFloatGroup.html",
    "title": "Class AnimationCurveEvaluatorOptimizedFloatGroup | Stride API",
    "summary": "Class AnimationCurveEvaluatorOptimizedFloatGroup Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorOptimizedFloatGroup : AnimationCurveEvaluatorOptimizedBlittableGroupBase<float> Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedGroup AnimationCurveEvaluatorOptimizedGroup<float> AnimationCurveEvaluatorOptimizedBlittableGroupBase<float> AnimationCurveEvaluatorOptimizedFloatGroup Inherited Members AnimationCurveEvaluatorOptimizedBlittableGroupBase<float>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorOptimizedBlittableGroupBase<float>.ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<float>.Channel, CompressedTimeSpan, nint) AnimationCurveEvaluatorOptimizedGroup<float>.animationData AnimationCurveEvaluatorOptimizedGroup<float>.channels AnimationCurveEvaluatorOptimizedGroup<float>.ElementType AnimationCurveEvaluatorOptimizedGroup<float>.Initialize(AnimationData) AnimationCurveEvaluatorOptimizedGroup<float>.Initialize(AnimationData<float>) AnimationCurveEvaluatorOptimizedGroup<float>.Cleanup() AnimationCurveEvaluatorOptimizedGroup<float>.SetChannelOffset(string, int) AnimationCurveEvaluatorOptimizedGroup<float>.SetTime(CompressedTimeSpan) AnimationCurveEvaluatorOptimizedGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint, float) protected override void ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<float>.Channel channel, CompressedTimeSpan currentTime, nint location, float factor) Parameters channel AnimationCurveEvaluatorOptimizedGroup<float>.Channel currentTime CompressedTimeSpan location nint factor float"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedGroup-1.Channel.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedGroup-1.Channel.html",
    "title": "Struct AnimationCurveEvaluatorOptimizedGroup<T>.Channel | Stride API",
    "summary": "Struct AnimationCurveEvaluatorOptimizedGroup<T>.Channel Namespace Stride.Animations Assembly Stride.Engine.dll protected struct AnimationCurveEvaluatorOptimizedGroup<T>.Channel Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields InterpolationType public AnimationCurveInterpolationType InterpolationType Field Value AnimationCurveInterpolationType Offset public int Offset Field Value int ValueEnd public KeyFrameData<T> ValueEnd Field Value KeyFrameData<T> ValueNext public KeyFrameData<T> ValueNext Field Value KeyFrameData<T> ValuePrev public KeyFrameData<T> ValuePrev Field Value KeyFrameData<T> ValueStart public KeyFrameData<T> ValueStart Field Value KeyFrameData<T>"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedGroup-1.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedGroup-1.html",
    "title": "Class AnimationCurveEvaluatorOptimizedGroup<T> | Stride API",
    "summary": "Class AnimationCurveEvaluatorOptimizedGroup<T> Namespace Stride.Animations Assembly Stride.Engine.dll public abstract class AnimationCurveEvaluatorOptimizedGroup<T> : AnimationCurveEvaluatorOptimizedGroup Type Parameters T Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedGroup AnimationCurveEvaluatorOptimizedGroup<T> Derived AnimationCurveEvaluatorOptimizedBlittableGroupBase<T> AnimationCurveEvaluatorOptimizedObjectGroup<T> Inherited Members AnimationCurveEvaluatorOptimizedGroup.Create<T>() AnimationCurveEvaluatorGroup.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) Extension Methods UnsafeUtilities.As<T>(object?) Fields animationData protected AnimationData<T> animationData Field Value AnimationData<T> channels protected FastListStruct<AnimationCurveEvaluatorOptimizedGroup<T>.Channel> channels Field Value FastListStruct<AnimationCurveEvaluatorOptimizedGroup<T>.Channel> Properties ElementType public override Type ElementType { get; } Property Value Type Methods Cleanup() public override void Cleanup() Initialize(AnimationData) public override void Initialize(AnimationData animationData) Parameters animationData AnimationData Initialize(AnimationData<T>) public void Initialize(AnimationData<T> animationData) Parameters animationData AnimationData<T> SetChannelOffset(string, int) public override void SetChannelOffset(string name, int offset) Parameters name string offset int SetTime(CompressedTimeSpan) protected void SetTime(CompressedTimeSpan timeSpan) Parameters timeSpan CompressedTimeSpan"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedGroup.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedGroup.html",
    "title": "Class AnimationCurveEvaluatorOptimizedGroup | Stride API",
    "summary": "Class AnimationCurveEvaluatorOptimizedGroup Namespace Stride.Animations Assembly Stride.Engine.dll public abstract class AnimationCurveEvaluatorOptimizedGroup : AnimationCurveEvaluatorGroup Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedGroup Derived AnimationCurveEvaluatorOptimizedGroup<T> Inherited Members AnimationCurveEvaluatorGroup.ElementType AnimationCurveEvaluatorGroup.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorGroup.Cleanup() Extension Methods UnsafeUtilities.As<T>(object?) Methods Create<T>() public static AnimationCurveEvaluatorOptimizedGroup Create<T>() Returns AnimationCurveEvaluatorOptimizedGroup Type Parameters T Initialize(AnimationData) public abstract void Initialize(AnimationData animationData) Parameters animationData AnimationData SetChannelOffset(string, int) public abstract void SetChannelOffset(string name, int offset) Parameters name string offset int"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedIntGroup.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedIntGroup.html",
    "title": "Class AnimationCurveEvaluatorOptimizedIntGroup | Stride API",
    "summary": "Class AnimationCurveEvaluatorOptimizedIntGroup Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorOptimizedIntGroup : AnimationCurveEvaluatorOptimizedBlittableGroupBase<int> Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedGroup AnimationCurveEvaluatorOptimizedGroup<int> AnimationCurveEvaluatorOptimizedBlittableGroupBase<int> AnimationCurveEvaluatorOptimizedIntGroup Inherited Members AnimationCurveEvaluatorOptimizedBlittableGroupBase<int>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorOptimizedBlittableGroupBase<int>.ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<int>.Channel, CompressedTimeSpan, nint) AnimationCurveEvaluatorOptimizedGroup<int>.animationData AnimationCurveEvaluatorOptimizedGroup<int>.channels AnimationCurveEvaluatorOptimizedGroup<int>.ElementType AnimationCurveEvaluatorOptimizedGroup<int>.Initialize(AnimationData) AnimationCurveEvaluatorOptimizedGroup<int>.Initialize(AnimationData<int>) AnimationCurveEvaluatorOptimizedGroup<int>.Cleanup() AnimationCurveEvaluatorOptimizedGroup<int>.SetChannelOffset(string, int) AnimationCurveEvaluatorOptimizedGroup<int>.SetTime(CompressedTimeSpan) AnimationCurveEvaluatorOptimizedGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint, float) protected override void ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<int>.Channel channel, CompressedTimeSpan currentTime, nint location, float factor) Parameters channel AnimationCurveEvaluatorOptimizedGroup<int>.Channel currentTime CompressedTimeSpan location nint factor float"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedObjectGroup-1.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedObjectGroup-1.html",
    "title": "Class AnimationCurveEvaluatorOptimizedObjectGroup<T> | Stride API",
    "summary": "Class AnimationCurveEvaluatorOptimizedObjectGroup<T> Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorOptimizedObjectGroup<T> : AnimationCurveEvaluatorOptimizedGroup<T> Type Parameters T Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedGroup AnimationCurveEvaluatorOptimizedGroup<T> AnimationCurveEvaluatorOptimizedObjectGroup<T> Inherited Members AnimationCurveEvaluatorOptimizedGroup<T>.animationData AnimationCurveEvaluatorOptimizedGroup<T>.channels AnimationCurveEvaluatorOptimizedGroup<T>.ElementType AnimationCurveEvaluatorOptimizedGroup<T>.Initialize(AnimationData) AnimationCurveEvaluatorOptimizedGroup<T>.Initialize(AnimationData<T>) AnimationCurveEvaluatorOptimizedGroup<T>.Cleanup() AnimationCurveEvaluatorOptimizedGroup<T>.SetChannelOffset(string, int) AnimationCurveEvaluatorOptimizedGroup<T>.SetTime(CompressedTimeSpan) AnimationCurveEvaluatorOptimizedGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) public override void Evaluate(CompressedTimeSpan newTime, nint data, UpdateObjectData[] objects) Parameters newTime CompressedTimeSpan data nint objects UpdateObjectData[] ProcessChannel(ref Channel, CompressedTimeSpan, UpdateObjectData[]) protected void ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<T>.Channel channel, CompressedTimeSpan currentTime, UpdateObjectData[] objects) Parameters channel AnimationCurveEvaluatorOptimizedGroup<T>.Channel currentTime CompressedTimeSpan objects UpdateObjectData[]"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedQuaternionGroup.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedQuaternionGroup.html",
    "title": "Class AnimationCurveEvaluatorOptimizedQuaternionGroup | Stride API",
    "summary": "Class AnimationCurveEvaluatorOptimizedQuaternionGroup Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorOptimizedQuaternionGroup : AnimationCurveEvaluatorOptimizedBlittableGroupBase<Quaternion> Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedGroup AnimationCurveEvaluatorOptimizedGroup<Quaternion> AnimationCurveEvaluatorOptimizedBlittableGroupBase<Quaternion> AnimationCurveEvaluatorOptimizedQuaternionGroup Inherited Members AnimationCurveEvaluatorOptimizedBlittableGroupBase<Quaternion>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorOptimizedBlittableGroupBase<Quaternion>.ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<Quaternion>.Channel, CompressedTimeSpan, nint) AnimationCurveEvaluatorOptimizedGroup<Quaternion>.animationData AnimationCurveEvaluatorOptimizedGroup<Quaternion>.channels AnimationCurveEvaluatorOptimizedGroup<Quaternion>.ElementType AnimationCurveEvaluatorOptimizedGroup<Quaternion>.Initialize(AnimationData) AnimationCurveEvaluatorOptimizedGroup<Quaternion>.Initialize(AnimationData<Quaternion>) AnimationCurveEvaluatorOptimizedGroup<Quaternion>.Cleanup() AnimationCurveEvaluatorOptimizedGroup<Quaternion>.SetChannelOffset(string, int) AnimationCurveEvaluatorOptimizedGroup<Quaternion>.SetTime(CompressedTimeSpan) AnimationCurveEvaluatorOptimizedGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint, float) protected override void ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<Quaternion>.Channel channel, CompressedTimeSpan currentTime, nint location, float factor) Parameters channel AnimationCurveEvaluatorOptimizedGroup<Quaternion>.Channel currentTime CompressedTimeSpan location nint factor float"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedVector3Group.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedVector3Group.html",
    "title": "Class AnimationCurveEvaluatorOptimizedVector3Group | Stride API",
    "summary": "Class AnimationCurveEvaluatorOptimizedVector3Group Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorOptimizedVector3Group : AnimationCurveEvaluatorOptimizedBlittableGroupBase<Vector3> Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedGroup AnimationCurveEvaluatorOptimizedGroup<Vector3> AnimationCurveEvaluatorOptimizedBlittableGroupBase<Vector3> AnimationCurveEvaluatorOptimizedVector3Group Inherited Members AnimationCurveEvaluatorOptimizedBlittableGroupBase<Vector3>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorOptimizedBlittableGroupBase<Vector3>.ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<Vector3>.Channel, CompressedTimeSpan, nint) AnimationCurveEvaluatorOptimizedGroup<Vector3>.animationData AnimationCurveEvaluatorOptimizedGroup<Vector3>.channels AnimationCurveEvaluatorOptimizedGroup<Vector3>.ElementType AnimationCurveEvaluatorOptimizedGroup<Vector3>.Initialize(AnimationData) AnimationCurveEvaluatorOptimizedGroup<Vector3>.Initialize(AnimationData<Vector3>) AnimationCurveEvaluatorOptimizedGroup<Vector3>.Cleanup() AnimationCurveEvaluatorOptimizedGroup<Vector3>.SetChannelOffset(string, int) AnimationCurveEvaluatorOptimizedGroup<Vector3>.SetTime(CompressedTimeSpan) AnimationCurveEvaluatorOptimizedGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint, float) protected override void ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<Vector3>.Channel channel, CompressedTimeSpan currentTime, nint location, float factor) Parameters channel AnimationCurveEvaluatorOptimizedGroup<Vector3>.Channel currentTime CompressedTimeSpan location nint factor float"
  },
  "api/Stride.Animations.AnimationCurveEvaluatorOptimizedVector4Group.html": {
    "href": "api/Stride.Animations.AnimationCurveEvaluatorOptimizedVector4Group.html",
    "title": "Class AnimationCurveEvaluatorOptimizedVector4Group | Stride API",
    "summary": "Class AnimationCurveEvaluatorOptimizedVector4Group Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationCurveEvaluatorOptimizedVector4Group : AnimationCurveEvaluatorOptimizedBlittableGroupBase<Vector4> Inheritance object AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedGroup AnimationCurveEvaluatorOptimizedGroup<Vector4> AnimationCurveEvaluatorOptimizedBlittableGroupBase<Vector4> AnimationCurveEvaluatorOptimizedVector4Group Inherited Members AnimationCurveEvaluatorOptimizedBlittableGroupBase<Vector4>.Evaluate(CompressedTimeSpan, nint, UpdateObjectData[]) AnimationCurveEvaluatorOptimizedBlittableGroupBase<Vector4>.ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<Vector4>.Channel, CompressedTimeSpan, nint) AnimationCurveEvaluatorOptimizedGroup<Vector4>.animationData AnimationCurveEvaluatorOptimizedGroup<Vector4>.channels AnimationCurveEvaluatorOptimizedGroup<Vector4>.ElementType AnimationCurveEvaluatorOptimizedGroup<Vector4>.Initialize(AnimationData) AnimationCurveEvaluatorOptimizedGroup<Vector4>.Initialize(AnimationData<Vector4>) AnimationCurveEvaluatorOptimizedGroup<Vector4>.Cleanup() AnimationCurveEvaluatorOptimizedGroup<Vector4>.SetChannelOffset(string, int) AnimationCurveEvaluatorOptimizedGroup<Vector4>.SetTime(CompressedTimeSpan) AnimationCurveEvaluatorOptimizedGroup.Create<T>() Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessChannel(ref Channel, CompressedTimeSpan, nint, float) protected override void ProcessChannel(ref AnimationCurveEvaluatorOptimizedGroup<Vector4>.Channel channel, CompressedTimeSpan currentTime, nint location, float factor) Parameters channel AnimationCurveEvaluatorOptimizedGroup<Vector4>.Channel currentTime CompressedTimeSpan location nint factor float"
  },
  "api/Stride.Animations.AnimationCurveInterpolationType.html": {
    "href": "api/Stride.Animations.AnimationCurveInterpolationType.html",
    "title": "Enum AnimationCurveInterpolationType | Stride API",
    "summary": "Enum AnimationCurveInterpolationType Namespace Stride.Animations Assembly Stride.Engine.dll Describes how a curve should be interpolated. [DataContract] public enum AnimationCurveInterpolationType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Constant = 0 Interpolates by using constant value between keyframes. Cubic = 2 Interpolates with implicit derivatives using points before and after. More information at http://en.wikipedia.org/wiki/Cubic_Hermite_spline#Interpolation_on_the_unit_interval_without_exact_derivatives. Linear = 1 Interpolates linearly between keyframes."
  },
  "api/Stride.Animations.AnimationData-1.html": {
    "href": "api/Stride.Animations.AnimationData-1.html",
    "title": "Class AnimationData<T> | Stride API",
    "summary": "Class AnimationData<T> Namespace Stride.Animations Assembly Stride.Engine.dll [DataSerializerGlobal(null, typeof(AnimationData<float>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<double>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<Vector2>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<Vector3>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<Vector4>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<int>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<uint>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<long>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<ulong>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<Int2>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<Int3>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<Int4>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<Quaternion>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(AnimationData<object>), DataSerializerGenericMode.None, false, false)] public class AnimationData<T> : AnimationData Type Parameters T Inheritance object AnimationData AnimationData<T> Inherited Members AnimationData.AnimationSortedValueBlock AnimationData.AnimationSortedValueCount AnimationData.TargetKeys Extension Methods UnsafeUtilities.As<T>(object?) Properties AnimationInitialValues public AnimationInitialValues<T>[] AnimationInitialValues { get; set; } Property Value AnimationInitialValues<T>[] AnimationSortedValues public AnimationKeyValuePair<T>[][] AnimationSortedValues { get; set; } Property Value AnimationKeyValuePair<T>[][] Duration public TimeSpan Duration { get; } Property Value TimeSpan ElementType public override Type ElementType { get; } Property Value Type Methods FromAnimationChannels(IList<KeyValuePair<string, AnimationCurve<T>>>) public static AnimationData<T> FromAnimationChannels(IList<KeyValuePair<string, AnimationCurve<T>>> animationChannelsWithName) Parameters animationChannelsWithName IList<KeyValuePair<string, AnimationCurve<T>>> Returns AnimationData<T>"
  },
  "api/Stride.Animations.AnimationData.html": {
    "href": "api/Stride.Animations.AnimationData.html",
    "title": "Class AnimationData | Stride API",
    "summary": "Class AnimationData Namespace Stride.Animations Assembly Stride.Engine.dll [DataContract(Inherited = true)] public abstract class AnimationData Inheritance object AnimationData Derived AnimationData<T> Extension Methods UnsafeUtilities.As<T>(object?) Fields AnimationSortedValueBlock public const int AnimationSortedValueBlock = 4096 Field Value int Properties AnimationSortedValueCount public int AnimationSortedValueCount { get; set; } Property Value int ElementType public abstract Type ElementType { get; } Property Value Type TargetKeys public string[] TargetKeys { get; set; } Property Value string[]"
  },
  "api/Stride.Animations.AnimationInitialValues-1.html": {
    "href": "api/Stride.Animations.AnimationInitialValues-1.html",
    "title": "Struct AnimationInitialValues<T> | Stride API",
    "summary": "Struct AnimationInitialValues<T> Namespace Stride.Animations Assembly Stride.Engine.dll [DataContract] public struct AnimationInitialValues<T> Type Parameters T Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields InterpolationType public AnimationCurveInterpolationType InterpolationType Field Value AnimationCurveInterpolationType Value1 public KeyFrameData<T> Value1 Field Value KeyFrameData<T> Value2 public KeyFrameData<T> Value2 Field Value KeyFrameData<T>"
  },
  "api/Stride.Animations.AnimationKeyFrame-1.html": {
    "href": "api/Stride.Animations.AnimationKeyFrame-1.html",
    "title": "Class AnimationKeyFrame<T> | Stride API",
    "summary": "Class AnimationKeyFrame<T> Namespace Stride.Animations Assembly Stride.Engine.dll [DataContract] [Display(\"KeyFrame\", null)] public class AnimationKeyFrame<T> where T : struct Type Parameters T Inheritance object AnimationKeyFrame<T> Extension Methods UnsafeUtilities.As<T>(object?) Fields HasChanged public bool HasChanged Field Value bool Properties Key [DataMember(10)] [Display(\"Key\", null)] public float Key { get; set; } Property Value float TangentType [DataMember(30)] [Display(\"Tangent\", null)] public AnimationKeyTangentType TangentType { get; set; } Property Value AnimationKeyTangentType Value [DataMember(20)] [Display(\"Value\", null)] public T Value { get; set; } Property Value T"
  },
  "api/Stride.Animations.AnimationKeyTangentType.html": {
    "href": "api/Stride.Animations.AnimationKeyTangentType.html",
    "title": "Enum AnimationKeyTangentType | Stride API",
    "summary": "Enum AnimationKeyTangentType Namespace Stride.Animations Assembly Stride.Engine.dll public enum AnimationKeyTangentType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Linear = 0 Linear - the value is linearly calculated as V1 * (1 - t) + V2 * t"
  },
  "api/Stride.Animations.AnimationKeyValuePair-1.html": {
    "href": "api/Stride.Animations.AnimationKeyValuePair-1.html",
    "title": "Struct AnimationKeyValuePair<T> | Stride API",
    "summary": "Struct AnimationKeyValuePair<T> Namespace Stride.Animations Assembly Stride.Engine.dll [DataContract] public struct AnimationKeyValuePair<T> Type Parameters T Inherited Members ValueType.Equals(object) ValueType.GetHashCode() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ChannelIndex public int ChannelIndex Field Value int RequiredTime public CompressedTimeSpan RequiredTime Field Value CompressedTimeSpan Value public KeyFrameData<T> Value Field Value KeyFrameData<T> Methods ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name."
  },
  "api/Stride.Animations.AnimationKeyValuePairArraySerializer-1.html": {
    "href": "api/Stride.Animations.AnimationKeyValuePairArraySerializer-1.html",
    "title": "Class AnimationKeyValuePairArraySerializer<T> | Stride API",
    "summary": "Class AnimationKeyValuePairArraySerializer<T> Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationKeyValuePairArraySerializer<T> : DataSerializer<AnimationKeyValuePair<T>[]> where T : struct Type Parameters T Inheritance object DataSerializer DataSerializer<AnimationKeyValuePair<T>[]> AnimationKeyValuePairArraySerializer<T> Inherited Members DataSerializer<AnimationKeyValuePair<T>[]>.SerializationType DataSerializer<AnimationKeyValuePair<T>[]>.IsBlittable DataSerializer<AnimationKeyValuePair<T>[]>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<AnimationKeyValuePair<T>[]>.Serialize(AnimationKeyValuePair<T>[], SerializationStream) DataSerializer<AnimationKeyValuePair<T>[]>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<AnimationKeyValuePair<T>[]>.PreSerialize(ref AnimationKeyValuePair<T>[], ArchiveMode, SerializationStream) DataSerializer<AnimationKeyValuePair<T>[]>.Serialize(ref AnimationKeyValuePair<T>[], ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref AnimationKeyValuePair<T>[], ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref AnimationKeyValuePair<T>[] obj, ArchiveMode mode, SerializationStream stream) Parameters obj AnimationKeyValuePair<T>[] The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref AnimationKeyValuePair<T>[], ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref AnimationKeyValuePair<T>[] obj, ArchiveMode mode, SerializationStream stream) Parameters obj AnimationKeyValuePair<T>[] The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Animations.AnimationOperation.html": {
    "href": "api/Stride.Animations.AnimationOperation.html",
    "title": "Struct AnimationOperation | Stride API",
    "summary": "Struct AnimationOperation Namespace Stride.Animations Assembly Stride.Engine.dll A single animation operation (push or blend). public struct AnimationOperation Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BlendFactor public float BlendFactor Field Value float CoreBlendOperation public CoreAnimationOperation CoreBlendOperation Field Value CoreAnimationOperation Evaluator public AnimationClipEvaluator Evaluator Field Value AnimationClipEvaluator Time public TimeSpan Time Field Value TimeSpan Type public AnimationOperationType Type Field Value AnimationOperationType Methods NewBlend(CoreAnimationOperation, float) Creates a new animation blend operation. public static AnimationOperation NewBlend(CoreAnimationOperation operation, float blendFactor) Parameters operation CoreAnimationOperation The blend operation. blendFactor float The blend factor. Returns AnimationOperation NewPop(AnimationClipEvaluator, TimeSpan) Creates a new animation pop operation. public static AnimationOperation NewPop(AnimationClipEvaluator evaluator, TimeSpan time) Parameters evaluator AnimationClipEvaluator The evaluator. time TimeSpan The time. Returns AnimationOperation NewPush(AnimationClipEvaluator) Creates a new animation push operation. public static AnimationOperation NewPush(AnimationClipEvaluator evaluator) Parameters evaluator AnimationClipEvaluator The evaluator. Returns AnimationOperation NewPush(AnimationClipEvaluator, TimeSpan) Creates a new animation push operation. public static AnimationOperation NewPush(AnimationClipEvaluator evaluator, TimeSpan time) Parameters evaluator AnimationClipEvaluator The evaluator. time TimeSpan The time. Returns AnimationOperation"
  },
  "api/Stride.Animations.AnimationOperationType.html": {
    "href": "api/Stride.Animations.AnimationOperationType.html",
    "title": "Enum AnimationOperationType | Stride API",
    "summary": "Enum AnimationOperationType Namespace Stride.Animations Assembly Stride.Engine.dll public enum AnimationOperationType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Blend = 2 Pop = 1 Push = 0"
  },
  "api/Stride.Animations.AnimationProcessor.AssociatedData.html": {
    "href": "api/Stride.Animations.AnimationProcessor.AssociatedData.html",
    "title": "Class AnimationProcessor.AssociatedData | Stride API",
    "summary": "Class AnimationProcessor.AssociatedData Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationProcessor.AssociatedData Inheritance object AnimationProcessor.AssociatedData Extension Methods UnsafeUtilities.As<T>(object?) Fields AnimationClipResult public AnimationClipResult AnimationClipResult Field Value AnimationClipResult AnimationComponent public AnimationComponent AnimationComponent Field Value AnimationComponent AnimationUpdater public AnimationUpdater AnimationUpdater Field Value AnimationUpdater"
  },
  "api/Stride.Animations.AnimationProcessor.html": {
    "href": "api/Stride.Animations.AnimationProcessor.html",
    "title": "Class AnimationProcessor | Stride API",
    "summary": "Class AnimationProcessor Namespace Stride.Animations Assembly Stride.Engine.dll public class AnimationProcessor : EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData> Inheritance object EntityProcessor EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData> AnimationProcessor Inherited Members EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData>.ComponentDatas EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData>.OnSystemAdd() EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData>.OnSystemRemove() EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData>.RemoveAllEntities() EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData>.GenerateComponentData(Entity, AnimationComponent) EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData>.IsAssociatedDataValid(Entity, AnimationComponent, AnimationProcessor.AssociatedData) EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData>.OnEntityComponentAdding(Entity, AnimationComponent, AnimationProcessor.AssociatedData) EntityProcessor<AnimationComponent, AnimationProcessor.AssociatedData>.OnEntityComponentRemoved(Entity, AnimationComponent, AnimationProcessor.AssociatedData) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.OnSystemAdd() EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors AnimationProcessor() public AnimationProcessor() Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext GenerateComponentData(Entity, AnimationComponent) Generates associated data to the given entity. protected override AnimationProcessor.AssociatedData GenerateComponentData(Entity entity, AnimationComponent component) Parameters entity Entity The entity. component AnimationComponent Returns AnimationProcessor.AssociatedData The associated data. GetAnimationClipResult(AnimationComponent) public AnimationClipResult GetAnimationClipResult(AnimationComponent animationComponent) Parameters animationComponent AnimationComponent Returns AnimationClipResult IsAssociatedDataValid(Entity, AnimationComponent, AssociatedData) Checks if the current associated data is valid, or if readding the entity is required. protected override bool IsAssociatedDataValid(Entity entity, AnimationComponent component, AnimationProcessor.AssociatedData associatedData) Parameters entity Entity The entity. component AnimationComponent associatedData AnimationProcessor.AssociatedData The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise. OnEntityComponentAdding(Entity, AnimationComponent, AssociatedData) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, AnimationComponent component, AnimationProcessor.AssociatedData data) Parameters entity Entity The entity. component AnimationComponent data AnimationProcessor.AssociatedData The associated data. OnEntityComponentRemoved(Entity, AnimationComponent, AssociatedData) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, AnimationComponent component, AnimationProcessor.AssociatedData data) Parameters entity Entity The entity. component AnimationComponent data AnimationProcessor.AssociatedData The associated data."
  },
  "api/Stride.Animations.AnimationRepeatMode.html": {
    "href": "api/Stride.Animations.AnimationRepeatMode.html",
    "title": "Enum AnimationRepeatMode | Stride API",
    "summary": "Enum AnimationRepeatMode Namespace Stride.Animations Assembly Stride.Engine.dll Enumeration describing how an animation should be repeated. [DataContract] public enum AnimationRepeatMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"Loop\", null)] LoopInfinite = 1 The animation loop for always. [Display(\"Play once\", null)] PlayOnce = 0 The animation plays once, and then stops. [Display(\"Play once & hold\", null)] PlayOnceHold = 2 The animation plays once, and then holds, being kept in the list."
  },
  "api/Stride.Animations.AnimationTargetProperty.html": {
    "href": "api/Stride.Animations.AnimationTargetProperty.html",
    "title": "Struct AnimationTargetProperty | Stride API",
    "summary": "Struct AnimationTargetProperty Namespace Stride.Animations Assembly Stride.Engine.dll [DataContract] public struct AnimationTargetProperty Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Name public string Name { readonly get; set; } Property Value string"
  },
  "api/Stride.Animations.AnimationUpdater.html": {
    "href": "api/Stride.Animations.AnimationUpdater.html",
    "title": "Class AnimationUpdater | Stride API",
    "summary": "Class AnimationUpdater Namespace Stride.Animations Assembly Stride.Engine.dll Applies animation from a AnimationClip to a SkeletonUpdater. public class AnimationUpdater Inheritance object AnimationUpdater Extension Methods UnsafeUtilities.As<T>(object?) Methods Update(Entity, AnimationClipResult) public void Update(Entity entity, AnimationClipResult result) Parameters entity Entity result AnimationClipResult"
  },
  "api/Stride.Animations.BinaryCurveOperator.html": {
    "href": "api/Stride.Animations.BinaryCurveOperator.html",
    "title": "Enum BinaryCurveOperator | Stride API",
    "summary": "Enum BinaryCurveOperator Namespace Stride.Animations Assembly Stride.Engine.dll public enum BinaryCurveOperator Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Add = 0 Add the sampled value of both sides. Multiply = 2 Multiplies the left sampled value by the right sampled value Subtract = 1 Subtracts the right sampled value from the left sampled value."
  },
  "api/Stride.Animations.CompressedTimeSpan.html": {
    "href": "api/Stride.Animations.CompressedTimeSpan.html",
    "title": "Struct CompressedTimeSpan | Stride API",
    "summary": "Struct CompressedTimeSpan Namespace Stride.Animations Assembly Stride.Engine.dll [DataSerializer(typeof(CompressedTimeSpanSerializer))] public struct CompressedTimeSpan : IComparable, IComparable<CompressedTimeSpan>, IEquatable<CompressedTimeSpan> Implements IComparable IComparable<CompressedTimeSpan> IEquatable<CompressedTimeSpan> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors CompressedTimeSpan(int) public CompressedTimeSpan(int ticks) Parameters ticks int Fields MaxValue public static readonly CompressedTimeSpan MaxValue Field Value CompressedTimeSpan MinValue public static readonly CompressedTimeSpan MinValue Field Value CompressedTimeSpan TicksPerMillisecond public const int TicksPerMillisecond = 100 Field Value int TicksPerSecond public const int TicksPerSecond = 100000 Field Value int Zero public static readonly CompressedTimeSpan Zero Field Value CompressedTimeSpan Properties Ticks public int Ticks { get; } Property Value int Methods CompareTo(CompressedTimeSpan) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. public int CompareTo(CompressedTimeSpan other) Parameters other CompressedTimeSpan An object to compare with this instance. Returns int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order. CompareTo(object) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. public int CompareTo(object obj) Parameters obj object An object to compare with this instance. Returns int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order. Exceptions ArgumentException obj is not the same type as this instance. Equals(CompressedTimeSpan) Indicates whether the current object is equal to another object of the same type. public bool Equals(CompressedTimeSpan other) Parameters other CompressedTimeSpan An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FromSeconds(double) public static CompressedTimeSpan FromSeconds(double seconds) Parameters seconds double Returns CompressedTimeSpan GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator +(CompressedTimeSpan, CompressedTimeSpan) public static CompressedTimeSpan operator +(CompressedTimeSpan t1, CompressedTimeSpan t2) Parameters t1 CompressedTimeSpan t2 CompressedTimeSpan Returns CompressedTimeSpan operator /(CompressedTimeSpan, int) public static CompressedTimeSpan operator /(CompressedTimeSpan t1, int factor) Parameters t1 CompressedTimeSpan factor int Returns CompressedTimeSpan operator /(CompressedTimeSpan, float) public static CompressedTimeSpan operator /(CompressedTimeSpan t1, float factor) Parameters t1 CompressedTimeSpan factor float Returns CompressedTimeSpan operator ==(CompressedTimeSpan, CompressedTimeSpan) public static bool operator ==(CompressedTimeSpan left, CompressedTimeSpan right) Parameters left CompressedTimeSpan right CompressedTimeSpan Returns bool explicit operator CompressedTimeSpan(TimeSpan) public static explicit operator CompressedTimeSpan(TimeSpan t) Parameters t TimeSpan Returns CompressedTimeSpan operator >(CompressedTimeSpan, CompressedTimeSpan) public static bool operator >(CompressedTimeSpan t1, CompressedTimeSpan t2) Parameters t1 CompressedTimeSpan t2 CompressedTimeSpan Returns bool operator >=(CompressedTimeSpan, CompressedTimeSpan) public static bool operator >=(CompressedTimeSpan t1, CompressedTimeSpan t2) Parameters t1 CompressedTimeSpan t2 CompressedTimeSpan Returns bool implicit operator TimeSpan(CompressedTimeSpan) public static implicit operator TimeSpan(CompressedTimeSpan t) Parameters t CompressedTimeSpan Returns TimeSpan operator !=(CompressedTimeSpan, CompressedTimeSpan) public static bool operator !=(CompressedTimeSpan left, CompressedTimeSpan right) Parameters left CompressedTimeSpan right CompressedTimeSpan Returns bool operator <(CompressedTimeSpan, CompressedTimeSpan) public static bool operator <(CompressedTimeSpan t1, CompressedTimeSpan t2) Parameters t1 CompressedTimeSpan t2 CompressedTimeSpan Returns bool operator <=(CompressedTimeSpan, CompressedTimeSpan) public static bool operator <=(CompressedTimeSpan t1, CompressedTimeSpan t2) Parameters t1 CompressedTimeSpan t2 CompressedTimeSpan Returns bool operator *(CompressedTimeSpan, int) public static CompressedTimeSpan operator *(CompressedTimeSpan t1, int factor) Parameters t1 CompressedTimeSpan factor int Returns CompressedTimeSpan operator *(CompressedTimeSpan, float) public static CompressedTimeSpan operator *(CompressedTimeSpan t1, float factor) Parameters t1 CompressedTimeSpan factor float Returns CompressedTimeSpan operator -(CompressedTimeSpan, CompressedTimeSpan) public static CompressedTimeSpan operator -(CompressedTimeSpan t1, CompressedTimeSpan t2) Parameters t1 CompressedTimeSpan t2 CompressedTimeSpan Returns CompressedTimeSpan"
  },
  "api/Stride.Animations.ComputeAnimationCurve-1.html": {
    "href": "api/Stride.Animations.ComputeAnimationCurve-1.html",
    "title": "Class ComputeAnimationCurve<T> | Stride API",
    "summary": "Class ComputeAnimationCurve<T> Namespace Stride.Animations Assembly Stride.Engine.dll A node which describes a binary operation between two compute curves [DataContract(Inherited = true)] [Display(\"Animation\", null, Expand = ExpandRule.Never)] public abstract class ComputeAnimationCurve<T> : Comparer<AnimationKeyFrame<T>>, IComparer<AnimationKeyFrame<T>>, IComparer, IComputeCurve<T>, IComputeCurve where T : struct Type Parameters T Sampled data's type Inheritance object Comparer<AnimationKeyFrame<T>> ComputeAnimationCurve<T> Implements IComparer<AnimationKeyFrame<T>> IComparer IComputeCurve<T> IComputeCurve Derived ComputeAnimationCurveColor4 ComputeAnimationCurveFloat ComputeAnimationCurveQuaternion ComputeAnimationCurveVector2 ComputeAnimationCurveVector3 ComputeAnimationCurveVector4 Inherited Members Comparer<AnimationKeyFrame<T>>.Create(Comparison<AnimationKeyFrame<T>>) Comparer<AnimationKeyFrame<T>>.Default Extension Methods UnsafeUtilities.As<T>(object?) Properties KeyFrames public TrackingCollection<AnimationKeyFrame<T>> KeyFrames { get; set; } Property Value TrackingCollection<AnimationKeyFrame<T>> Methods Compare(AnimationKeyFrame<T>, AnimationKeyFrame<T>) When overridden in a derived class, performs a comparison of two objects of the same type and returns a value indicating whether one object is less than, equal to, or greater than the other. public override int Compare(AnimationKeyFrame<T> x, AnimationKeyFrame<T> y) Parameters x AnimationKeyFrame<T> The first object to compare. y AnimationKeyFrame<T> The second object to compare. Returns int A signed integer that indicates the relative values of x and y, as shown in the following table. Value Meaning Less than zero x is less than y. Zero x equals y. Greater than zero x is greater than y. Exceptions ArgumentException Type T does not implement either the IComparable<T> generic interface or the IComparable interface. Cubic(ref T, ref T, ref T, ref T, float, out T) public abstract void Cubic(ref T value1, ref T value2, ref T value3, ref T value4, float t, out T result) Parameters value1 T value2 T value3 T value4 T t float result T Evaluate(float) Evaluates the compute curve's value at the specified location, usually in the [0 .. 1] range public T Evaluate(float location) Parameters location float Location to sample at Returns T Sampled value Linear(ref T, ref T, float, out T) public abstract void Linear(ref T value1, ref T value2, float t, out T result) Parameters value1 T value2 T t float result T SampleRaw(float) Unoptimized sampler which searches all the keyframes in order. Intended to be used for baking purposes only protected T SampleRaw(float t) Parameters t float Location t to sample at, between 0 and 1 Returns T Sampled and interpolated data value UpdateChanges() Updates any optimizations in the curve if data has changed. public bool UpdateChanges() Returns bool true there were changes since the last time; otherwise, false."
  },
  "api/Stride.Animations.ComputeAnimationCurveColor4.html": {
    "href": "api/Stride.Animations.ComputeAnimationCurveColor4.html",
    "title": "Class ComputeAnimationCurveColor4 | Stride API",
    "summary": "Class ComputeAnimationCurveColor4 Namespace Stride.Animations Assembly Stride.Engine.dll Constant Color4 value for the IComputeCurve interface [DataContract(\"ComputeAnimationCurveColor4\")] [Display(\"Animation\", null, Expand = ExpandRule.Never)] public class ComputeAnimationCurveColor4 : ComputeAnimationCurve<Color4>, IComparer<AnimationKeyFrame<Color4>>, IComparer, IComputeCurve<Color4>, IComputeCurve Inheritance object Comparer<AnimationKeyFrame<Color4>> ComputeAnimationCurve<Color4> ComputeAnimationCurveColor4 Implements IComparer<AnimationKeyFrame<Color4>> IComparer IComputeCurve<Color4> IComputeCurve Inherited Members ComputeAnimationCurve<Color4>.KeyFrames ComputeAnimationCurve<Color4>.UpdateChanges() ComputeAnimationCurve<Color4>.Compare(AnimationKeyFrame<Color4>, AnimationKeyFrame<Color4>) ComputeAnimationCurve<Color4>.SampleRaw(float) ComputeAnimationCurve<Color4>.Evaluate(float) Comparer<AnimationKeyFrame<Color4>>.Create(Comparison<AnimationKeyFrame<Color4>>) Comparer<AnimationKeyFrame<Color4>>.Default Extension Methods UnsafeUtilities.As<T>(object?) Methods Cubic(ref Color4, ref Color4, ref Color4, ref Color4, float, out Color4) public override void Cubic(ref Color4 value1, ref Color4 value2, ref Color4 value3, ref Color4 value4, float t, out Color4 result) Parameters value1 Color4 value2 Color4 value3 Color4 value4 Color4 t float result Color4 Linear(ref Color4, ref Color4, float, out Color4) public override void Linear(ref Color4 value1, ref Color4 value2, float t, out Color4 result) Parameters value1 Color4 value2 Color4 t float result Color4"
  },
  "api/Stride.Animations.ComputeAnimationCurveFloat.html": {
    "href": "api/Stride.Animations.ComputeAnimationCurveFloat.html",
    "title": "Class ComputeAnimationCurveFloat | Stride API",
    "summary": "Class ComputeAnimationCurveFloat Namespace Stride.Animations Assembly Stride.Engine.dll Animation of a float value for the IComputeCurve interface [DataContract(\"ComputeAnimationCurveFloat\")] [Display(\"Animation\", null, Expand = ExpandRule.Never)] public class ComputeAnimationCurveFloat : ComputeAnimationCurve<float>, IComparer<AnimationKeyFrame<float>>, IComparer, IComputeCurve<float>, IComputeCurve Inheritance object Comparer<AnimationKeyFrame<float>> ComputeAnimationCurve<float> ComputeAnimationCurveFloat Implements IComparer<AnimationKeyFrame<float>> IComparer IComputeCurve<float> IComputeCurve Inherited Members ComputeAnimationCurve<float>.KeyFrames ComputeAnimationCurve<float>.UpdateChanges() ComputeAnimationCurve<float>.Compare(AnimationKeyFrame<float>, AnimationKeyFrame<float>) ComputeAnimationCurve<float>.SampleRaw(float) ComputeAnimationCurve<float>.Evaluate(float) Comparer<AnimationKeyFrame<float>>.Create(Comparison<AnimationKeyFrame<float>>) Comparer<AnimationKeyFrame<float>>.Default Extension Methods UnsafeUtilities.As<T>(object?) Methods Cubic(ref float, ref float, ref float, ref float, float, out float) public override void Cubic(ref float value1, ref float value2, ref float value3, ref float value4, float t, out float result) Parameters value1 float value2 float value3 float value4 float t float result float Linear(ref float, ref float, float, out float) public override void Linear(ref float value1, ref float value2, float t, out float result) Parameters value1 float value2 float t float result float"
  },
  "api/Stride.Animations.ComputeAnimationCurveQuaternion.html": {
    "href": "api/Stride.Animations.ComputeAnimationCurveQuaternion.html",
    "title": "Class ComputeAnimationCurveQuaternion | Stride API",
    "summary": "Class ComputeAnimationCurveQuaternion Namespace Stride.Animations Assembly Stride.Engine.dll Constant Quaternion value for the IComputeCurve interface [DataContract(\"ComputeAnimationCurveQuaternion\")] [Display(\"Animation\", null, Expand = ExpandRule.Never)] public class ComputeAnimationCurveQuaternion : ComputeAnimationCurve<Quaternion>, IComparer<AnimationKeyFrame<Quaternion>>, IComparer, IComputeCurve<Quaternion>, IComputeCurve Inheritance object Comparer<AnimationKeyFrame<Quaternion>> ComputeAnimationCurve<Quaternion> ComputeAnimationCurveQuaternion Implements IComparer<AnimationKeyFrame<Quaternion>> IComparer IComputeCurve<Quaternion> IComputeCurve Inherited Members ComputeAnimationCurve<Quaternion>.KeyFrames ComputeAnimationCurve<Quaternion>.UpdateChanges() ComputeAnimationCurve<Quaternion>.Compare(AnimationKeyFrame<Quaternion>, AnimationKeyFrame<Quaternion>) ComputeAnimationCurve<Quaternion>.SampleRaw(float) ComputeAnimationCurve<Quaternion>.Evaluate(float) Comparer<AnimationKeyFrame<Quaternion>>.Create(Comparison<AnimationKeyFrame<Quaternion>>) Comparer<AnimationKeyFrame<Quaternion>>.Default Extension Methods UnsafeUtilities.As<T>(object?) Methods Cubic(ref Quaternion, ref Quaternion, ref Quaternion, ref Quaternion, float, out Quaternion) public override void Cubic(ref Quaternion value1, ref Quaternion value2, ref Quaternion value3, ref Quaternion value4, float t, out Quaternion result) Parameters value1 Quaternion value2 Quaternion value3 Quaternion value4 Quaternion t float result Quaternion Linear(ref Quaternion, ref Quaternion, float, out Quaternion) public override void Linear(ref Quaternion value1, ref Quaternion value2, float t, out Quaternion result) Parameters value1 Quaternion value2 Quaternion t float result Quaternion"
  },
  "api/Stride.Animations.ComputeAnimationCurveVector2.html": {
    "href": "api/Stride.Animations.ComputeAnimationCurveVector2.html",
    "title": "Class ComputeAnimationCurveVector2 | Stride API",
    "summary": "Class ComputeAnimationCurveVector2 Namespace Stride.Animations Assembly Stride.Engine.dll Constant Vector2 value for the IComputeCurve interface [DataContract(\"ComputeAnimationCurveVector2\")] [Display(\"Animation\", null, Expand = ExpandRule.Never)] public class ComputeAnimationCurveVector2 : ComputeAnimationCurve<Vector2>, IComparer<AnimationKeyFrame<Vector2>>, IComparer, IComputeCurve<Vector2>, IComputeCurve Inheritance object Comparer<AnimationKeyFrame<Vector2>> ComputeAnimationCurve<Vector2> ComputeAnimationCurveVector2 Implements IComparer<AnimationKeyFrame<Vector2>> IComparer IComputeCurve<Vector2> IComputeCurve Inherited Members ComputeAnimationCurve<Vector2>.KeyFrames ComputeAnimationCurve<Vector2>.UpdateChanges() ComputeAnimationCurve<Vector2>.Compare(AnimationKeyFrame<Vector2>, AnimationKeyFrame<Vector2>) ComputeAnimationCurve<Vector2>.SampleRaw(float) ComputeAnimationCurve<Vector2>.Evaluate(float) Comparer<AnimationKeyFrame<Vector2>>.Create(Comparison<AnimationKeyFrame<Vector2>>) Comparer<AnimationKeyFrame<Vector2>>.Default Extension Methods UnsafeUtilities.As<T>(object?) Methods Cubic(ref Vector2, ref Vector2, ref Vector2, ref Vector2, float, out Vector2) public override void Cubic(ref Vector2 value1, ref Vector2 value2, ref Vector2 value3, ref Vector2 value4, float t, out Vector2 result) Parameters value1 Vector2 value2 Vector2 value3 Vector2 value4 Vector2 t float result Vector2 Linear(ref Vector2, ref Vector2, float, out Vector2) public override void Linear(ref Vector2 value1, ref Vector2 value2, float t, out Vector2 result) Parameters value1 Vector2 value2 Vector2 t float result Vector2"
  },
  "api/Stride.Animations.ComputeAnimationCurveVector3.html": {
    "href": "api/Stride.Animations.ComputeAnimationCurveVector3.html",
    "title": "Class ComputeAnimationCurveVector3 | Stride API",
    "summary": "Class ComputeAnimationCurveVector3 Namespace Stride.Animations Assembly Stride.Engine.dll Constant Vector3 value for the IComputeCurve interface [DataContract(\"ComputeAnimationCurveVector3\")] [Display(\"Animation\", null, Expand = ExpandRule.Never)] public class ComputeAnimationCurveVector3 : ComputeAnimationCurve<Vector3>, IComparer<AnimationKeyFrame<Vector3>>, IComparer, IComputeCurve<Vector3>, IComputeCurve Inheritance object Comparer<AnimationKeyFrame<Vector3>> ComputeAnimationCurve<Vector3> ComputeAnimationCurveVector3 Implements IComparer<AnimationKeyFrame<Vector3>> IComparer IComputeCurve<Vector3> IComputeCurve Inherited Members ComputeAnimationCurve<Vector3>.KeyFrames ComputeAnimationCurve<Vector3>.UpdateChanges() ComputeAnimationCurve<Vector3>.Compare(AnimationKeyFrame<Vector3>, AnimationKeyFrame<Vector3>) ComputeAnimationCurve<Vector3>.SampleRaw(float) ComputeAnimationCurve<Vector3>.Evaluate(float) Comparer<AnimationKeyFrame<Vector3>>.Create(Comparison<AnimationKeyFrame<Vector3>>) Comparer<AnimationKeyFrame<Vector3>>.Default Extension Methods UnsafeUtilities.As<T>(object?) Methods Cubic(ref Vector3, ref Vector3, ref Vector3, ref Vector3, float, out Vector3) public override void Cubic(ref Vector3 value1, ref Vector3 value2, ref Vector3 value3, ref Vector3 value4, float t, out Vector3 result) Parameters value1 Vector3 value2 Vector3 value3 Vector3 value4 Vector3 t float result Vector3 Linear(ref Vector3, ref Vector3, float, out Vector3) public override void Linear(ref Vector3 value1, ref Vector3 value2, float t, out Vector3 result) Parameters value1 Vector3 value2 Vector3 t float result Vector3"
  },
  "api/Stride.Animations.ComputeAnimationCurveVector4.html": {
    "href": "api/Stride.Animations.ComputeAnimationCurveVector4.html",
    "title": "Class ComputeAnimationCurveVector4 | Stride API",
    "summary": "Class ComputeAnimationCurveVector4 Namespace Stride.Animations Assembly Stride.Engine.dll Constant Vector4 value for the IComputeCurve interface [DataContract(\"ComputeAnimationCurveVector4\")] [Display(\"Animation\", null, Expand = ExpandRule.Never)] public class ComputeAnimationCurveVector4 : ComputeAnimationCurve<Vector4>, IComparer<AnimationKeyFrame<Vector4>>, IComparer, IComputeCurve<Vector4>, IComputeCurve Inheritance object Comparer<AnimationKeyFrame<Vector4>> ComputeAnimationCurve<Vector4> ComputeAnimationCurveVector4 Implements IComparer<AnimationKeyFrame<Vector4>> IComparer IComputeCurve<Vector4> IComputeCurve Inherited Members ComputeAnimationCurve<Vector4>.KeyFrames ComputeAnimationCurve<Vector4>.UpdateChanges() ComputeAnimationCurve<Vector4>.Compare(AnimationKeyFrame<Vector4>, AnimationKeyFrame<Vector4>) ComputeAnimationCurve<Vector4>.SampleRaw(float) ComputeAnimationCurve<Vector4>.Evaluate(float) Comparer<AnimationKeyFrame<Vector4>>.Create(Comparison<AnimationKeyFrame<Vector4>>) Comparer<AnimationKeyFrame<Vector4>>.Default Extension Methods UnsafeUtilities.As<T>(object?) Methods Cubic(ref Vector4, ref Vector4, ref Vector4, ref Vector4, float, out Vector4) public override void Cubic(ref Vector4 value1, ref Vector4 value2, ref Vector4 value3, ref Vector4 value4, float t, out Vector4 result) Parameters value1 Vector4 value2 Vector4 value3 Vector4 value4 Vector4 t float result Vector4 Linear(ref Vector4, ref Vector4, float, out Vector4) public override void Linear(ref Vector4 value1, ref Vector4 value2, float t, out Vector4 result) Parameters value1 Vector4 value2 Vector4 t float result Vector4"
  },
  "api/Stride.Animations.ComputeBinaryCurve-1.html": {
    "href": "api/Stride.Animations.ComputeBinaryCurve-1.html",
    "title": "Class ComputeBinaryCurve<T> | Stride API",
    "summary": "Class ComputeBinaryCurve<T> Namespace Stride.Animations Assembly Stride.Engine.dll A node which describes a binary operation between two IComputeCurve<T> [DataContract(Inherited = true)] [Display(\"Binary Operator\", null)] public abstract class ComputeBinaryCurve<T> : IComputeCurve<T>, IComputeCurve where T : struct Type Parameters T Sampled data's type Inheritance object ComputeBinaryCurve<T> Implements IComputeCurve<T> IComputeCurve Derived ComputeBinaryCurveColor4 ComputeBinaryCurveFloat ComputeBinaryCurveQuaternion ComputeBinaryCurveVector2 ComputeBinaryCurveVector3 ComputeBinaryCurveVector4 Extension Methods UnsafeUtilities.As<T>(object?) Properties LeftChild The left child node [DataMember(20)] [Display(\"Left\", null)] public IComputeCurve<T> LeftChild { get; set; } Property Value IComputeCurve<T> Operator The operation used to blend the two values [DataMember(10)] public BinaryCurveOperator Operator { get; set; } Property Value BinaryCurveOperator RightChild The right child node [DataMember(30)] [Display(\"Right\", null)] public IComputeCurve<T> RightChild { get; set; } Property Value IComputeCurve<T> Methods Add(T, T) Adds the left value to the right value and retuns their sum protected abstract T Add(T a, T b) Parameters a T Left value A b T Right value B Returns T The sum A + B Evaluate(float) Evaluates the compute curve's value at the specified location, usually in the [0 .. 1] range public T Evaluate(float location) Parameters location float Location to sample at Returns T Sampled value Multiply(T, T) Multiplies the left value to the right value and retuns the result protected abstract T Multiply(T a, T b) Parameters a T Left value A b T Right value B Returns T The result A * B Subtract(T, T) Subtracts the right value from the left value and retuns the result protected abstract T Subtract(T a, T b) Parameters a T Left value A b T Right value B Returns T The result A - B UpdateChanges() Updates any optimizations in the curve if data has changed. public bool UpdateChanges() Returns bool true there were changes since the last time; otherwise, false."
  },
  "api/Stride.Animations.ComputeBinaryCurveColor4.html": {
    "href": "api/Stride.Animations.ComputeBinaryCurveColor4.html",
    "title": "Class ComputeBinaryCurveColor4 | Stride API",
    "summary": "Class ComputeBinaryCurveColor4 Namespace Stride.Animations Assembly Stride.Engine.dll Binary operator Color4 value for the IComputeCurve interface [DataContract(\"ComputeBinaryCurveColor4\")] [Display(\"Binary Operation\", null)] public class ComputeBinaryCurveColor4 : ComputeBinaryCurve<Color4>, IComputeCurve<Color4>, IComputeCurve Inheritance object ComputeBinaryCurve<Color4> ComputeBinaryCurveColor4 Implements IComputeCurve<Color4> IComputeCurve Inherited Members ComputeBinaryCurve<Color4>.UpdateChanges() ComputeBinaryCurve<Color4>.Evaluate(float) ComputeBinaryCurve<Color4>.Operator ComputeBinaryCurve<Color4>.LeftChild ComputeBinaryCurve<Color4>.RightChild Extension Methods UnsafeUtilities.As<T>(object?) Methods Add(Color4, Color4) Adds the left value to the right value and retuns their sum protected override Color4 Add(Color4 a, Color4 b) Parameters a Color4 Left value A b Color4 Right value B Returns Color4 The sum A + B Multiply(Color4, Color4) Multiplies the left value to the right value and retuns the result protected override Color4 Multiply(Color4 a, Color4 b) Parameters a Color4 Left value A b Color4 Right value B Returns Color4 The result A * B Subtract(Color4, Color4) Subtracts the right value from the left value and retuns the result protected override Color4 Subtract(Color4 a, Color4 b) Parameters a Color4 Left value A b Color4 Right value B Returns Color4 The result A - B"
  },
  "api/Stride.Animations.ComputeBinaryCurveFloat.html": {
    "href": "api/Stride.Animations.ComputeBinaryCurveFloat.html",
    "title": "Class ComputeBinaryCurveFloat | Stride API",
    "summary": "Class ComputeBinaryCurveFloat Namespace Stride.Animations Assembly Stride.Engine.dll Binary operator float value for the IComputeCurve interface [DataContract(\"ComputeBinaryCurveFloat\")] [Display(\"Binary Operation\", null)] public class ComputeBinaryCurveFloat : ComputeBinaryCurve<float>, IComputeCurve<float>, IComputeCurve Inheritance object ComputeBinaryCurve<float> ComputeBinaryCurveFloat Implements IComputeCurve<float> IComputeCurve Inherited Members ComputeBinaryCurve<float>.UpdateChanges() ComputeBinaryCurve<float>.Evaluate(float) ComputeBinaryCurve<float>.Operator ComputeBinaryCurve<float>.LeftChild ComputeBinaryCurve<float>.RightChild Extension Methods UnsafeUtilities.As<T>(object?) Methods Add(float, float) Adds the left value to the right value and retuns their sum protected override float Add(float a, float b) Parameters a float Left value A b float Right value B Returns float The sum A + B Multiply(float, float) Multiplies the left value to the right value and retuns the result protected override float Multiply(float a, float b) Parameters a float Left value A b float Right value B Returns float The result A * B Subtract(float, float) Subtracts the right value from the left value and retuns the result protected override float Subtract(float a, float b) Parameters a float Left value A b float Right value B Returns float The result A - B"
  },
  "api/Stride.Animations.ComputeBinaryCurveQuaternion.html": {
    "href": "api/Stride.Animations.ComputeBinaryCurveQuaternion.html",
    "title": "Class ComputeBinaryCurveQuaternion | Stride API",
    "summary": "Class ComputeBinaryCurveQuaternion Namespace Stride.Animations Assembly Stride.Engine.dll Binary operator Quaternion value for the IComputeCurve interface [DataContract(\"ComputeBinaryCurveQuaternion\")] [Display(\"Binary Operation\", null)] public class ComputeBinaryCurveQuaternion : ComputeBinaryCurve<Quaternion>, IComputeCurve<Quaternion>, IComputeCurve Inheritance object ComputeBinaryCurve<Quaternion> ComputeBinaryCurveQuaternion Implements IComputeCurve<Quaternion> IComputeCurve Inherited Members ComputeBinaryCurve<Quaternion>.UpdateChanges() ComputeBinaryCurve<Quaternion>.Evaluate(float) ComputeBinaryCurve<Quaternion>.Operator ComputeBinaryCurve<Quaternion>.LeftChild ComputeBinaryCurve<Quaternion>.RightChild Extension Methods UnsafeUtilities.As<T>(object?) Methods Add(Quaternion, Quaternion) Adds the left value to the right value and retuns their sum protected override Quaternion Add(Quaternion a, Quaternion b) Parameters a Quaternion Left value A b Quaternion Right value B Returns Quaternion The sum A + B Multiply(Quaternion, Quaternion) Multiplies the left value to the right value and retuns the result protected override Quaternion Multiply(Quaternion a, Quaternion b) Parameters a Quaternion Left value A b Quaternion Right value B Returns Quaternion The result A * B Subtract(Quaternion, Quaternion) Subtracts the right value from the left value and retuns the result protected override Quaternion Subtract(Quaternion a, Quaternion b) Parameters a Quaternion Left value A b Quaternion Right value B Returns Quaternion The result A - B"
  },
  "api/Stride.Animations.ComputeBinaryCurveVector2.html": {
    "href": "api/Stride.Animations.ComputeBinaryCurveVector2.html",
    "title": "Class ComputeBinaryCurveVector2 | Stride API",
    "summary": "Class ComputeBinaryCurveVector2 Namespace Stride.Animations Assembly Stride.Engine.dll Binary operator Vector2 value for the IComputeCurve interface [DataContract(\"ComputeBinaryCurveVector2\")] [Display(\"Binary Operation\", null)] public class ComputeBinaryCurveVector2 : ComputeBinaryCurve<Vector2>, IComputeCurve<Vector2>, IComputeCurve Inheritance object ComputeBinaryCurve<Vector2> ComputeBinaryCurveVector2 Implements IComputeCurve<Vector2> IComputeCurve Inherited Members ComputeBinaryCurve<Vector2>.UpdateChanges() ComputeBinaryCurve<Vector2>.Evaluate(float) ComputeBinaryCurve<Vector2>.Operator ComputeBinaryCurve<Vector2>.LeftChild ComputeBinaryCurve<Vector2>.RightChild Extension Methods UnsafeUtilities.As<T>(object?) Methods Add(Vector2, Vector2) Adds the left value to the right value and retuns their sum protected override Vector2 Add(Vector2 a, Vector2 b) Parameters a Vector2 Left value A b Vector2 Right value B Returns Vector2 The sum A + B Multiply(Vector2, Vector2) Multiplies the left value to the right value and retuns the result protected override Vector2 Multiply(Vector2 a, Vector2 b) Parameters a Vector2 Left value A b Vector2 Right value B Returns Vector2 The result A * B Subtract(Vector2, Vector2) Subtracts the right value from the left value and retuns the result protected override Vector2 Subtract(Vector2 a, Vector2 b) Parameters a Vector2 Left value A b Vector2 Right value B Returns Vector2 The result A - B"
  },
  "api/Stride.Animations.ComputeBinaryCurveVector3.html": {
    "href": "api/Stride.Animations.ComputeBinaryCurveVector3.html",
    "title": "Class ComputeBinaryCurveVector3 | Stride API",
    "summary": "Class ComputeBinaryCurveVector3 Namespace Stride.Animations Assembly Stride.Engine.dll Binary operator Vector3 value for the IComputeCurve interface [DataContract(\"ComputeBinaryCurveVector3\")] [Display(\"Binary Operation\", null)] public class ComputeBinaryCurveVector3 : ComputeBinaryCurve<Vector3>, IComputeCurve<Vector3>, IComputeCurve Inheritance object ComputeBinaryCurve<Vector3> ComputeBinaryCurveVector3 Implements IComputeCurve<Vector3> IComputeCurve Inherited Members ComputeBinaryCurve<Vector3>.UpdateChanges() ComputeBinaryCurve<Vector3>.Evaluate(float) ComputeBinaryCurve<Vector3>.Operator ComputeBinaryCurve<Vector3>.LeftChild ComputeBinaryCurve<Vector3>.RightChild Extension Methods UnsafeUtilities.As<T>(object?) Methods Add(Vector3, Vector3) Adds the left value to the right value and retuns their sum protected override Vector3 Add(Vector3 a, Vector3 b) Parameters a Vector3 Left value A b Vector3 Right value B Returns Vector3 The sum A + B Multiply(Vector3, Vector3) Multiplies the left value to the right value and retuns the result protected override Vector3 Multiply(Vector3 a, Vector3 b) Parameters a Vector3 Left value A b Vector3 Right value B Returns Vector3 The result A * B Subtract(Vector3, Vector3) Subtracts the right value from the left value and retuns the result protected override Vector3 Subtract(Vector3 a, Vector3 b) Parameters a Vector3 Left value A b Vector3 Right value B Returns Vector3 The result A - B"
  },
  "api/Stride.Animations.ComputeBinaryCurveVector4.html": {
    "href": "api/Stride.Animations.ComputeBinaryCurveVector4.html",
    "title": "Class ComputeBinaryCurveVector4 | Stride API",
    "summary": "Class ComputeBinaryCurveVector4 Namespace Stride.Animations Assembly Stride.Engine.dll Binary operator Vector4 value for the IComputeCurve interface [DataContract(\"ComputeBinaryCurveVector4\")] [Display(\"Binary Operation\", null)] public class ComputeBinaryCurveVector4 : ComputeBinaryCurve<Vector4>, IComputeCurve<Vector4>, IComputeCurve Inheritance object ComputeBinaryCurve<Vector4> ComputeBinaryCurveVector4 Implements IComputeCurve<Vector4> IComputeCurve Inherited Members ComputeBinaryCurve<Vector4>.UpdateChanges() ComputeBinaryCurve<Vector4>.Evaluate(float) ComputeBinaryCurve<Vector4>.Operator ComputeBinaryCurve<Vector4>.LeftChild ComputeBinaryCurve<Vector4>.RightChild Extension Methods UnsafeUtilities.As<T>(object?) Methods Add(Vector4, Vector4) Adds the left value to the right value and retuns their sum protected override Vector4 Add(Vector4 a, Vector4 b) Parameters a Vector4 Left value A b Vector4 Right value B Returns Vector4 The sum A + B Multiply(Vector4, Vector4) Multiplies the left value to the right value and retuns the result protected override Vector4 Multiply(Vector4 a, Vector4 b) Parameters a Vector4 Left value A b Vector4 Right value B Returns Vector4 The result A * B Subtract(Vector4, Vector4) Subtracts the right value from the left value and retuns the result protected override Vector4 Subtract(Vector4 a, Vector4 b) Parameters a Vector4 Left value A b Vector4 Right value B Returns Vector4 The result A - B"
  },
  "api/Stride.Animations.ComputeConstCurve-1.html": {
    "href": "api/Stride.Animations.ComputeConstCurve-1.html",
    "title": "Class ComputeConstCurve<T> | Stride API",
    "summary": "Class ComputeConstCurve<T> Namespace Stride.Animations Assembly Stride.Engine.dll A node which describes a constant value for a compute curve [DataContract(Inherited = true)] [Display(\"Constant\", null)] public class ComputeConstCurve<T> : IComputeCurve<T>, IComputeCurve where T : struct Type Parameters T Sampled data's type Inheritance object ComputeConstCurve<T> Implements IComputeCurve<T> IComputeCurve Derived ComputeConstCurveColor4 ComputeConstCurveFloat ComputeConstCurveQuaternion ComputeConstCurveVector2 ComputeConstCurveVector3 ComputeConstCurveVector4 Extension Methods UnsafeUtilities.As<T>(object?) Properties Value Constant value to return every time this flat curve is sampled [DataMember(10)] [Display(\"Value\", null)] public T Value { get; set; } Property Value T Methods Evaluate(float) Evaluates the compute curve's value at the specified location, usually in the [0 .. 1] range public T Evaluate(float location) Parameters location float Location to sample at Returns T Sampled value UpdateChanges() Updates any optimizations in the curve if data has changed. public bool UpdateChanges() Returns bool true there were changes since the last time; otherwise, false."
  },
  "api/Stride.Animations.ComputeConstCurveColor4.html": {
    "href": "api/Stride.Animations.ComputeConstCurveColor4.html",
    "title": "Class ComputeConstCurveColor4 | Stride API",
    "summary": "Class ComputeConstCurveColor4 Namespace Stride.Animations Assembly Stride.Engine.dll Constant Color4 value for the IComputeCurve interface [DataContract(\"ComputeConstCurveColor4\")] [Display(\"Constant\", null)] public class ComputeConstCurveColor4 : ComputeConstCurve<Color4>, IComputeCurve<Color4>, IComputeCurve Inheritance object ComputeConstCurve<Color4> ComputeConstCurveColor4 Implements IComputeCurve<Color4> IComputeCurve Inherited Members ComputeConstCurve<Color4>.Value ComputeConstCurve<Color4>.UpdateChanges() ComputeConstCurve<Color4>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Animations.ComputeConstCurveFloat.html": {
    "href": "api/Stride.Animations.ComputeConstCurveFloat.html",
    "title": "Class ComputeConstCurveFloat | Stride API",
    "summary": "Class ComputeConstCurveFloat Namespace Stride.Animations Assembly Stride.Engine.dll Constant float value for the IComputeCurve interface [DataContract(\"ComputeConstCurveFloat\")] [Display(\"Constant\", null)] public class ComputeConstCurveFloat : ComputeConstCurve<float>, IComputeCurve<float>, IComputeCurve Inheritance object ComputeConstCurve<float> ComputeConstCurveFloat Implements IComputeCurve<float> IComputeCurve Inherited Members ComputeConstCurve<float>.Value ComputeConstCurve<float>.UpdateChanges() ComputeConstCurve<float>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Animations.ComputeConstCurveQuaternion.html": {
    "href": "api/Stride.Animations.ComputeConstCurveQuaternion.html",
    "title": "Class ComputeConstCurveQuaternion | Stride API",
    "summary": "Class ComputeConstCurveQuaternion Namespace Stride.Animations Assembly Stride.Engine.dll Constant Quaternion value for the IComputeCurve interface [DataContract(\"ComputeConstCurveQuaternion\")] [Display(\"Constant\", null)] public class ComputeConstCurveQuaternion : ComputeConstCurve<Quaternion>, IComputeCurve<Quaternion>, IComputeCurve Inheritance object ComputeConstCurve<Quaternion> ComputeConstCurveQuaternion Implements IComputeCurve<Quaternion> IComputeCurve Inherited Members ComputeConstCurve<Quaternion>.Value ComputeConstCurve<Quaternion>.UpdateChanges() ComputeConstCurve<Quaternion>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Animations.ComputeConstCurveVector2.html": {
    "href": "api/Stride.Animations.ComputeConstCurveVector2.html",
    "title": "Class ComputeConstCurveVector2 | Stride API",
    "summary": "Class ComputeConstCurveVector2 Namespace Stride.Animations Assembly Stride.Engine.dll Constant Vector2 value for the IComputeCurve interface [DataContract(\"ComputeConstCurveVector2\")] [Display(\"Constant\", null)] public class ComputeConstCurveVector2 : ComputeConstCurve<Vector2>, IComputeCurve<Vector2>, IComputeCurve Inheritance object ComputeConstCurve<Vector2> ComputeConstCurveVector2 Implements IComputeCurve<Vector2> IComputeCurve Inherited Members ComputeConstCurve<Vector2>.Value ComputeConstCurve<Vector2>.UpdateChanges() ComputeConstCurve<Vector2>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Animations.ComputeConstCurveVector3.html": {
    "href": "api/Stride.Animations.ComputeConstCurveVector3.html",
    "title": "Class ComputeConstCurveVector3 | Stride API",
    "summary": "Class ComputeConstCurveVector3 Namespace Stride.Animations Assembly Stride.Engine.dll Constant Vector3 value for the IComputeCurve interface [DataContract(\"ComputeConstCurveVector3\")] [Display(\"Constant\", null)] public class ComputeConstCurveVector3 : ComputeConstCurve<Vector3>, IComputeCurve<Vector3>, IComputeCurve Inheritance object ComputeConstCurve<Vector3> ComputeConstCurveVector3 Implements IComputeCurve<Vector3> IComputeCurve Inherited Members ComputeConstCurve<Vector3>.Value ComputeConstCurve<Vector3>.UpdateChanges() ComputeConstCurve<Vector3>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Animations.ComputeConstCurveVector4.html": {
    "href": "api/Stride.Animations.ComputeConstCurveVector4.html",
    "title": "Class ComputeConstCurveVector4 | Stride API",
    "summary": "Class ComputeConstCurveVector4 Namespace Stride.Animations Assembly Stride.Engine.dll Constant Vector4 value for the IComputeCurve interface [DataContract(\"ComputeConstCurveVector4\")] [Display(\"Constant\", null)] public class ComputeConstCurveVector4 : ComputeConstCurve<Vector4>, IComputeCurve<Vector4>, IComputeCurve Inheritance object ComputeConstCurve<Vector4> ComputeConstCurveVector4 Implements IComputeCurve<Vector4> IComputeCurve Inherited Members ComputeConstCurve<Vector4>.Value ComputeConstCurve<Vector4>.UpdateChanges() ComputeConstCurve<Vector4>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Animations.ComputeCurveSampler-1.html": {
    "href": "api/Stride.Animations.ComputeCurveSampler-1.html",
    "title": "Class ComputeCurveSampler<T> | Stride API",
    "summary": "Class ComputeCurveSampler<T> Namespace Stride.Animations Assembly Stride.Engine.dll Base interface for curve based compute value nodes. [DataContract(Inherited = true)] public abstract class ComputeCurveSampler<T> where T : struct Type Parameters T Inheritance object ComputeCurveSampler<T> Derived ComputeCurveSamplerColor4 ComputeCurveSamplerFloat ComputeCurveSamplerQuaternion ComputeCurveSamplerVector2 ComputeCurveSamplerVector3 ComputeCurveSamplerVector4 Extension Methods UnsafeUtilities.As<T>(object?) Constructors ComputeCurveSampler() protected ComputeCurveSampler() Fields curve protected IComputeCurve<T> curve Field Value IComputeCurve<T> Properties Curve [DataMember(10)] [Display(\"Curve\", null)] public IComputeCurve<T> Curve { get; set; } Property Value IComputeCurve<T> Methods Evaluate(float) Evaluates the compute curve's value at the specified location, usually in the [0 .. 1] range public T Evaluate(float t) Parameters t float Returns T Sampled value Linear(ref T, ref T, float, out T) Interface for linera interpolation between two data values public abstract void Linear(ref T value1, ref T value2, float t, out T result) Parameters value1 T Left value value2 T Right value t float Lerp amount between 0 and 1 result T The interpolated result of linearLerp(L, R, t) UpdateChanges() public bool UpdateChanges() Returns bool"
  },
  "api/Stride.Animations.ComputeCurveSamplerColor4.html": {
    "href": "api/Stride.Animations.ComputeCurveSamplerColor4.html",
    "title": "Class ComputeCurveSamplerColor4 | Stride API",
    "summary": "Class ComputeCurveSamplerColor4 Namespace Stride.Animations Assembly Stride.Engine.dll Sampler container for Color4 data type [DataContract(\"ComputeCurveSamplerColor4\")] [Display(\"Sampler Color4\", null)] public class ComputeCurveSamplerColor4 : ComputeCurveSampler<Color4> Inheritance object ComputeCurveSampler<Color4> ComputeCurveSamplerColor4 Inherited Members ComputeCurveSampler<Color4>.curve ComputeCurveSampler<Color4>.Curve ComputeCurveSampler<Color4>.Evaluate(float) ComputeCurveSampler<Color4>.UpdateChanges() Extension Methods UnsafeUtilities.As<T>(object?) Constructors ComputeCurveSamplerColor4() public ComputeCurveSamplerColor4() Methods Linear(ref Color4, ref Color4, float, out Color4) Interface for linera interpolation between two data values public override void Linear(ref Color4 value1, ref Color4 value2, float t, out Color4 result) Parameters value1 Color4 Left value value2 Color4 Right value t float Lerp amount between 0 and 1 result Color4 The interpolated result of linearLerp(L, R, t)"
  },
  "api/Stride.Animations.ComputeCurveSamplerFloat.html": {
    "href": "api/Stride.Animations.ComputeCurveSamplerFloat.html",
    "title": "Class ComputeCurveSamplerFloat | Stride API",
    "summary": "Class ComputeCurveSamplerFloat Namespace Stride.Animations Assembly Stride.Engine.dll Sampler container for float data type [DataContract(\"ComputeCurveSamplerFloat\")] [Display(\"Sampler Float\", null)] public class ComputeCurveSamplerFloat : ComputeCurveSampler<float> Inheritance object ComputeCurveSampler<float> ComputeCurveSamplerFloat Inherited Members ComputeCurveSampler<float>.curve ComputeCurveSampler<float>.Curve ComputeCurveSampler<float>.Evaluate(float) ComputeCurveSampler<float>.UpdateChanges() Extension Methods UnsafeUtilities.As<T>(object?) Constructors ComputeCurveSamplerFloat() public ComputeCurveSamplerFloat() Methods Linear(ref float, ref float, float, out float) Interface for linera interpolation between two data values public override void Linear(ref float value1, ref float value2, float t, out float result) Parameters value1 float Left value value2 float Right value t float Lerp amount between 0 and 1 result float The interpolated result of linearLerp(L, R, t)"
  },
  "api/Stride.Animations.ComputeCurveSamplerQuaternion.html": {
    "href": "api/Stride.Animations.ComputeCurveSamplerQuaternion.html",
    "title": "Class ComputeCurveSamplerQuaternion | Stride API",
    "summary": "Class ComputeCurveSamplerQuaternion Namespace Stride.Animations Assembly Stride.Engine.dll Sampler container for Quaternion data type [DataContract(\"ComputeCurveSamplerQuaternion\")] [Display(\"Sampler Quaternion\", null)] public class ComputeCurveSamplerQuaternion : ComputeCurveSampler<Quaternion> Inheritance object ComputeCurveSampler<Quaternion> ComputeCurveSamplerQuaternion Inherited Members ComputeCurveSampler<Quaternion>.curve ComputeCurveSampler<Quaternion>.Curve ComputeCurveSampler<Quaternion>.Evaluate(float) ComputeCurveSampler<Quaternion>.UpdateChanges() Extension Methods UnsafeUtilities.As<T>(object?) Constructors ComputeCurveSamplerQuaternion() public ComputeCurveSamplerQuaternion() Methods Linear(ref Quaternion, ref Quaternion, float, out Quaternion) Interface for linera interpolation between two data values public override void Linear(ref Quaternion value1, ref Quaternion value2, float t, out Quaternion result) Parameters value1 Quaternion Left value value2 Quaternion Right value t float Lerp amount between 0 and 1 result Quaternion The interpolated result of linearLerp(L, R, t)"
  },
  "api/Stride.Animations.ComputeCurveSamplerVector2.html": {
    "href": "api/Stride.Animations.ComputeCurveSamplerVector2.html",
    "title": "Class ComputeCurveSamplerVector2 | Stride API",
    "summary": "Class ComputeCurveSamplerVector2 Namespace Stride.Animations Assembly Stride.Engine.dll Sampler container for Vector2 data type [DataContract(\"ComputeCurveSamplerVector2\")] [Display(\"Sampler Vector2\", null)] public class ComputeCurveSamplerVector2 : ComputeCurveSampler<Vector2> Inheritance object ComputeCurveSampler<Vector2> ComputeCurveSamplerVector2 Inherited Members ComputeCurveSampler<Vector2>.curve ComputeCurveSampler<Vector2>.Curve ComputeCurveSampler<Vector2>.Evaluate(float) ComputeCurveSampler<Vector2>.UpdateChanges() Extension Methods UnsafeUtilities.As<T>(object?) Constructors ComputeCurveSamplerVector2() public ComputeCurveSamplerVector2() Methods Linear(ref Vector2, ref Vector2, float, out Vector2) Interface for linera interpolation between two data values public override void Linear(ref Vector2 value1, ref Vector2 value2, float t, out Vector2 result) Parameters value1 Vector2 Left value value2 Vector2 Right value t float Lerp amount between 0 and 1 result Vector2 The interpolated result of linearLerp(L, R, t)"
  },
  "api/Stride.Animations.ComputeCurveSamplerVector3.html": {
    "href": "api/Stride.Animations.ComputeCurveSamplerVector3.html",
    "title": "Class ComputeCurveSamplerVector3 | Stride API",
    "summary": "Class ComputeCurveSamplerVector3 Namespace Stride.Animations Assembly Stride.Engine.dll Sampler container for Vector3 data type [DataContract(\"ComputeCurveSamplerVector3\")] [Display(\"Sampler Vector3\", null)] public class ComputeCurveSamplerVector3 : ComputeCurveSampler<Vector3> Inheritance object ComputeCurveSampler<Vector3> ComputeCurveSamplerVector3 Inherited Members ComputeCurveSampler<Vector3>.curve ComputeCurveSampler<Vector3>.Curve ComputeCurveSampler<Vector3>.Evaluate(float) ComputeCurveSampler<Vector3>.UpdateChanges() Extension Methods UnsafeUtilities.As<T>(object?) Constructors ComputeCurveSamplerVector3() public ComputeCurveSamplerVector3() Methods Linear(ref Vector3, ref Vector3, float, out Vector3) Interface for linera interpolation between two data values public override void Linear(ref Vector3 value1, ref Vector3 value2, float t, out Vector3 result) Parameters value1 Vector3 Left value value2 Vector3 Right value t float Lerp amount between 0 and 1 result Vector3 The interpolated result of linearLerp(L, R, t)"
  },
  "api/Stride.Animations.ComputeCurveSamplerVector4.html": {
    "href": "api/Stride.Animations.ComputeCurveSamplerVector4.html",
    "title": "Class ComputeCurveSamplerVector4 | Stride API",
    "summary": "Class ComputeCurveSamplerVector4 Namespace Stride.Animations Assembly Stride.Engine.dll Sampler container for Vector4 data type [DataContract(\"ComputeCurveSamplerVector4\")] [Display(\"Sampler Vector4\", null)] public class ComputeCurveSamplerVector4 : ComputeCurveSampler<Vector4> Inheritance object ComputeCurveSampler<Vector4> ComputeCurveSamplerVector4 Inherited Members ComputeCurveSampler<Vector4>.curve ComputeCurveSampler<Vector4>.Curve ComputeCurveSampler<Vector4>.Evaluate(float) ComputeCurveSampler<Vector4>.UpdateChanges() Extension Methods UnsafeUtilities.As<T>(object?) Constructors ComputeCurveSamplerVector4() public ComputeCurveSamplerVector4() Methods Linear(ref Vector4, ref Vector4, float, out Vector4) Interface for linera interpolation between two data values public override void Linear(ref Vector4 value1, ref Vector4 value2, float t, out Vector4 result) Parameters value1 Vector4 Left value value2 Vector4 Right value t float Lerp amount between 0 and 1 result Vector4 The interpolated result of linearLerp(L, R, t)"
  },
  "api/Stride.Animations.ComputeFunctionCurve-1.html": {
    "href": "api/Stride.Animations.ComputeFunctionCurve-1.html",
    "title": "Class ComputeFunctionCurve<T> | Stride API",
    "summary": "Class ComputeFunctionCurve<T> Namespace Stride.Animations Assembly Stride.Engine.dll A node which describes a function over t value for a compute curve [DataContract(Inherited = true)] [Display(\"Function\", null)] public abstract class ComputeFunctionCurve<T> : IComputeCurve<T>, IComputeCurve where T : struct Type Parameters T Sampled data's type Inheritance object ComputeFunctionCurve<T> Implements IComputeCurve<T> IComputeCurve Derived ComputeFunctionCurveColor4 ComputeFunctionCurveFloat ComputeFunctionCurveVector2 ComputeFunctionCurveVector3 ComputeFunctionCurveVector4 Extension Methods UnsafeUtilities.As<T>(object?) Properties Amplitude [DataMember(14)] [Display(\"Amplitude\", null)] public float Amplitude { get; set; } Property Value float Period [DataMember(12)] [Display(\"Period\", null)] public float Period { get; set; } Property Value float PhaseShift [DataMember(10)] [Display(\"Phase Shift\", null)] public float PhaseShift { get; set; } Property Value float Methods Evaluate(float) Evaluates the compute curve's value at the specified location, usually in the [0 .. 1] range public T Evaluate(float location) Parameters location float Location to sample at Returns T Sampled value GetElementFrom(float) protected abstract T GetElementFrom(float value) Parameters value float Returns T UpdateChanges() Updates any optimizations in the curve if data has changed. public bool UpdateChanges() Returns bool true there were changes since the last time; otherwise, false."
  },
  "api/Stride.Animations.ComputeFunctionCurveColor4.html": {
    "href": "api/Stride.Animations.ComputeFunctionCurveColor4.html",
    "title": "Class ComputeFunctionCurveColor4 | Stride API",
    "summary": "Class ComputeFunctionCurveColor4 Namespace Stride.Animations Assembly Stride.Engine.dll Function Color4 value for the IComputeCurve interface [DataContract(\"ComputeFunctionCurveColor4\")] [Display(\"Function\", null)] public class ComputeFunctionCurveColor4 : ComputeFunctionCurve<Color4>, IComputeCurve<Color4>, IComputeCurve Inheritance object ComputeFunctionCurve<Color4> ComputeFunctionCurveColor4 Implements IComputeCurve<Color4> IComputeCurve Inherited Members ComputeFunctionCurve<Color4>.PhaseShift ComputeFunctionCurve<Color4>.Period ComputeFunctionCurve<Color4>.Amplitude ComputeFunctionCurve<Color4>.UpdateChanges() ComputeFunctionCurve<Color4>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?) Methods GetElementFrom(float) protected override Color4 GetElementFrom(float value) Parameters value float Returns Color4"
  },
  "api/Stride.Animations.ComputeFunctionCurveFloat.html": {
    "href": "api/Stride.Animations.ComputeFunctionCurveFloat.html",
    "title": "Class ComputeFunctionCurveFloat | Stride API",
    "summary": "Class ComputeFunctionCurveFloat Namespace Stride.Animations Assembly Stride.Engine.dll Function float value for the IComputeCurve interface [DataContract(\"ComputeFunctionCurveFloat\")] [Display(\"Function\", null)] public class ComputeFunctionCurveFloat : ComputeFunctionCurve<float>, IComputeCurve<float>, IComputeCurve Inheritance object ComputeFunctionCurve<float> ComputeFunctionCurveFloat Implements IComputeCurve<float> IComputeCurve Inherited Members ComputeFunctionCurve<float>.PhaseShift ComputeFunctionCurve<float>.Period ComputeFunctionCurve<float>.Amplitude ComputeFunctionCurve<float>.UpdateChanges() ComputeFunctionCurve<float>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?) Methods GetElementFrom(float) protected override float GetElementFrom(float value) Parameters value float Returns float"
  },
  "api/Stride.Animations.ComputeFunctionCurveVector2.html": {
    "href": "api/Stride.Animations.ComputeFunctionCurveVector2.html",
    "title": "Class ComputeFunctionCurveVector2 | Stride API",
    "summary": "Class ComputeFunctionCurveVector2 Namespace Stride.Animations Assembly Stride.Engine.dll Function Vector2 value for the IComputeCurve interface [DataContract(\"ComputeFunctionCurveVector2\")] [Display(\"Function\", null)] public class ComputeFunctionCurveVector2 : ComputeFunctionCurve<Vector2>, IComputeCurve<Vector2>, IComputeCurve Inheritance object ComputeFunctionCurve<Vector2> ComputeFunctionCurveVector2 Implements IComputeCurve<Vector2> IComputeCurve Inherited Members ComputeFunctionCurve<Vector2>.PhaseShift ComputeFunctionCurve<Vector2>.Period ComputeFunctionCurve<Vector2>.Amplitude ComputeFunctionCurve<Vector2>.UpdateChanges() ComputeFunctionCurve<Vector2>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?) Methods GetElementFrom(float) protected override Vector2 GetElementFrom(float value) Parameters value float Returns Vector2"
  },
  "api/Stride.Animations.ComputeFunctionCurveVector3.html": {
    "href": "api/Stride.Animations.ComputeFunctionCurveVector3.html",
    "title": "Class ComputeFunctionCurveVector3 | Stride API",
    "summary": "Class ComputeFunctionCurveVector3 Namespace Stride.Animations Assembly Stride.Engine.dll Function Vector3 value for the IComputeCurve interface [DataContract(\"ComputeFunctionCurveVector3\")] [Display(\"Function\", null)] public class ComputeFunctionCurveVector3 : ComputeFunctionCurve<Vector3>, IComputeCurve<Vector3>, IComputeCurve Inheritance object ComputeFunctionCurve<Vector3> ComputeFunctionCurveVector3 Implements IComputeCurve<Vector3> IComputeCurve Inherited Members ComputeFunctionCurve<Vector3>.PhaseShift ComputeFunctionCurve<Vector3>.Period ComputeFunctionCurve<Vector3>.Amplitude ComputeFunctionCurve<Vector3>.UpdateChanges() ComputeFunctionCurve<Vector3>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?) Methods GetElementFrom(float) protected override Vector3 GetElementFrom(float value) Parameters value float Returns Vector3"
  },
  "api/Stride.Animations.ComputeFunctionCurveVector4.html": {
    "href": "api/Stride.Animations.ComputeFunctionCurveVector4.html",
    "title": "Class ComputeFunctionCurveVector4 | Stride API",
    "summary": "Class ComputeFunctionCurveVector4 Namespace Stride.Animations Assembly Stride.Engine.dll Function Vector4 value for the IComputeCurve interface [DataContract(\"ComputeFunctionCurveVector4\")] [Display(\"Function\", null)] public class ComputeFunctionCurveVector4 : ComputeFunctionCurve<Vector4>, IComputeCurve<Vector4>, IComputeCurve Inheritance object ComputeFunctionCurve<Vector4> ComputeFunctionCurveVector4 Implements IComputeCurve<Vector4> IComputeCurve Inherited Members ComputeFunctionCurve<Vector4>.PhaseShift ComputeFunctionCurve<Vector4>.Period ComputeFunctionCurve<Vector4>.Amplitude ComputeFunctionCurve<Vector4>.UpdateChanges() ComputeFunctionCurve<Vector4>.Evaluate(float) Extension Methods UnsafeUtilities.As<T>(object?) Methods GetElementFrom(float) protected override Vector4 GetElementFrom(float value) Parameters value float Returns Vector4"
  },
  "api/Stride.Animations.ComputeSeparateCurveVector3.html": {
    "href": "api/Stride.Animations.ComputeSeparateCurveVector3.html",
    "title": "Class ComputeSeparateCurveVector3 | Stride API",
    "summary": "Class ComputeSeparateCurveVector3 Namespace Stride.Animations Assembly Stride.Engine.dll [DataContract(\"ComputeSeparateCurveVector3\")] [Display(\"3 Channels\", null)] public class ComputeSeparateCurveVector3 : IComputeCurve<Vector3>, IComputeCurve Inheritance object ComputeSeparateCurveVector3 Implements IComputeCurve<Vector3> IComputeCurve Extension Methods UnsafeUtilities.As<T>(object?) Properties X [DataMember(10)] [Display(\"X\", null)] public IComputeCurve<float> X { get; set; } Property Value IComputeCurve<float> Y [DataMember(20)] [Display(\"Y\", null)] public IComputeCurve<float> Y { get; set; } Property Value IComputeCurve<float> Z [DataMember(30)] [Display(\"Z\", null)] public IComputeCurve<float> Z { get; set; } Property Value IComputeCurve<float> Methods Evaluate(float) Evaluates the compute curve's value at the specified location, usually in the [0 .. 1] range public Vector3 Evaluate(float t) Parameters t float Returns Vector3 Sampled value UpdateChanges() Updates any optimizations in the curve if data has changed. public bool UpdateChanges() Returns bool true there were changes since the last time; otherwise, false."
  },
  "api/Stride.Animations.ComputeSeparateCurveVector4.html": {
    "href": "api/Stride.Animations.ComputeSeparateCurveVector4.html",
    "title": "Class ComputeSeparateCurveVector4 | Stride API",
    "summary": "Class ComputeSeparateCurveVector4 Namespace Stride.Animations Assembly Stride.Engine.dll [DataContract(\"ComputeSeparateCurveVector4\")] [Display(\"4 Channels\", null)] public class ComputeSeparateCurveVector4 : IComputeCurve<Vector4>, IComputeCurve Inheritance object ComputeSeparateCurveVector4 Implements IComputeCurve<Vector4> IComputeCurve Extension Methods UnsafeUtilities.As<T>(object?) Properties W [DataMember(40)] [Display(\"W\", null)] public IComputeCurve<float> W { get; set; } Property Value IComputeCurve<float> X [DataMember(10)] [Display(\"X\", null)] public IComputeCurve<float> X { get; set; } Property Value IComputeCurve<float> Y [DataMember(20)] [Display(\"Y\", null)] public IComputeCurve<float> Y { get; set; } Property Value IComputeCurve<float> Z [DataMember(30)] [Display(\"Z\", null)] public IComputeCurve<float> Z { get; set; } Property Value IComputeCurve<float> Methods Evaluate(float) Evaluates the compute curve's value at the specified location, usually in the [0 .. 1] range public Vector4 Evaluate(float t) Parameters t float Returns Vector4 Sampled value UpdateChanges() Updates any optimizations in the curve if data has changed. public bool UpdateChanges() Returns bool true there were changes since the last time; otherwise, false."
  },
  "api/Stride.Animations.CoreAnimationOperation.html": {
    "href": "api/Stride.Animations.CoreAnimationOperation.html",
    "title": "Enum CoreAnimationOperation | Stride API",
    "summary": "Enum CoreAnimationOperation Namespace Stride.Animations Assembly Stride.Engine.dll Core animation operations support all operations exposed for blending as well as several required for the animation building itself public enum CoreAnimationOperation Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Add = 1 Blend = 0 Subtract = 2"
  },
  "api/Stride.Animations.IComputeCurve-1.html": {
    "href": "api/Stride.Animations.IComputeCurve-1.html",
    "title": "Interface IComputeCurve<T> | Stride API",
    "summary": "Interface IComputeCurve<T> Namespace Stride.Animations Assembly Stride.Engine.dll Base interface for curve based compute value nodes. public interface IComputeCurve<out T> : IComputeCurve where T : struct Type Parameters T Inherited Members IComputeCurve.UpdateChanges() Extension Methods UnsafeUtilities.As<T>(object?) Methods Evaluate(float) Evaluates the compute curve's value at the specified location, usually in the [0 .. 1] range T Evaluate(float location) Parameters location float Location to sample at Returns T Sampled value"
  },
  "api/Stride.Animations.IComputeCurve.html": {
    "href": "api/Stride.Animations.IComputeCurve.html",
    "title": "Interface IComputeCurve | Stride API",
    "summary": "Interface IComputeCurve Namespace Stride.Animations Assembly Stride.Engine.dll public interface IComputeCurve Extension Methods UnsafeUtilities.As<T>(object?) Methods UpdateChanges() Updates any optimizations in the curve if data has changed. bool UpdateChanges() Returns bool true there were changes since the last time; otherwise, false."
  },
  "api/Stride.Animations.Interpolator.Quaternion.html": {
    "href": "api/Stride.Animations.Interpolator.Quaternion.html",
    "title": "Class Interpolator.Quaternion | Stride API",
    "summary": "Class Interpolator.Quaternion Namespace Stride.Animations Assembly Stride.Engine.dll public static class Interpolator.Quaternion Inheritance object Interpolator.Quaternion Methods Cubic(ref Quaternion, ref Quaternion, ref Quaternion, ref Quaternion, float, out Quaternion) public static void Cubic(ref Quaternion value1, ref Quaternion value2, ref Quaternion value3, ref Quaternion value4, float t, out Quaternion result) Parameters value1 Quaternion value2 Quaternion value3 Quaternion value4 Quaternion t float result Quaternion SphericalLinear(ref Quaternion, ref Quaternion, float, out Quaternion) public static void SphericalLinear(ref Quaternion value1, ref Quaternion value2, float t, out Quaternion result) Parameters value1 Quaternion value2 Quaternion t float result Quaternion"
  },
  "api/Stride.Animations.Interpolator.Vector2.html": {
    "href": "api/Stride.Animations.Interpolator.Vector2.html",
    "title": "Class Interpolator.Vector2 | Stride API",
    "summary": "Class Interpolator.Vector2 Namespace Stride.Animations Assembly Stride.Engine.dll public static class Interpolator.Vector2 Inheritance object Interpolator.Vector2 Methods Cubic(ref Vector2, ref Vector2, ref Vector2, ref Vector2, float, out Vector2) public static void Cubic(ref Vector2 value1, ref Vector2 value2, ref Vector2 value3, ref Vector2 value4, float t, out Vector2 result) Parameters value1 Vector2 value2 Vector2 value3 Vector2 value4 Vector2 t float result Vector2 Linear(ref Vector2, ref Vector2, float, out Vector2) public static void Linear(ref Vector2 value1, ref Vector2 value2, float t, out Vector2 result) Parameters value1 Vector2 value2 Vector2 t float result Vector2"
  },
  "api/Stride.Animations.Interpolator.Vector3.html": {
    "href": "api/Stride.Animations.Interpolator.Vector3.html",
    "title": "Class Interpolator.Vector3 | Stride API",
    "summary": "Class Interpolator.Vector3 Namespace Stride.Animations Assembly Stride.Engine.dll public static class Interpolator.Vector3 Inheritance object Interpolator.Vector3 Methods Cubic(ref Vector3, ref Vector3, ref Vector3, ref Vector3, float, out Vector3) public static void Cubic(ref Vector3 value1, ref Vector3 value2, ref Vector3 value3, ref Vector3 value4, float t, out Vector3 result) Parameters value1 Vector3 value2 Vector3 value3 Vector3 value4 Vector3 t float result Vector3 Linear(ref Vector3, ref Vector3, float, out Vector3) public static void Linear(ref Vector3 value1, ref Vector3 value2, float t, out Vector3 result) Parameters value1 Vector3 value2 Vector3 t float result Vector3"
  },
  "api/Stride.Animations.Interpolator.Vector4.html": {
    "href": "api/Stride.Animations.Interpolator.Vector4.html",
    "title": "Class Interpolator.Vector4 | Stride API",
    "summary": "Class Interpolator.Vector4 Namespace Stride.Animations Assembly Stride.Engine.dll public static class Interpolator.Vector4 Inheritance object Interpolator.Vector4 Methods Cubic(ref Vector4, ref Vector4, ref Vector4, ref Vector4, float, out Vector4) public static void Cubic(ref Vector4 value1, ref Vector4 value2, ref Vector4 value3, ref Vector4 value4, float t, out Vector4 result) Parameters value1 Vector4 value2 Vector4 value3 Vector4 value4 Vector4 t float result Vector4 Linear(ref Vector4, ref Vector4, float, out Vector4) public static void Linear(ref Vector4 value1, ref Vector4 value2, float t, out Vector4 result) Parameters value1 Vector4 value2 Vector4 t float result Vector4"
  },
  "api/Stride.Animations.Interpolator.html": {
    "href": "api/Stride.Animations.Interpolator.html",
    "title": "Class Interpolator | Stride API",
    "summary": "Class Interpolator Namespace Stride.Animations Assembly Stride.Engine.dll Various helper functions for float, Vector2, Vector3, Vector4 and Quaternion interpolations. public static class Interpolator Inheritance object Interpolator Methods Cubic(float, float, float, float, float) public static float Cubic(float value1, float value2, float value3, float value4, float t) Parameters value1 float value2 float value3 float value4 float t float Returns float Linear(float, float, float) public static float Linear(float value1, float value2, float t) Parameters value1 float value2 float t float Returns float"
  },
  "api/Stride.Animations.KeyFrameData-1.html": {
    "href": "api/Stride.Animations.KeyFrameData-1.html",
    "title": "Struct KeyFrameData<T> | Stride API",
    "summary": "Struct KeyFrameData<T> Namespace Stride.Animations Assembly Stride.Engine.dll A single key frame value. [DataContract] public struct KeyFrameData<T> Type Parameters T Inherited Members ValueType.Equals(object) ValueType.GetHashCode() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors KeyFrameData(CompressedTimeSpan, T) public KeyFrameData(CompressedTimeSpan time, T value) Parameters time CompressedTimeSpan value T Fields Time public CompressedTimeSpan Time Field Value CompressedTimeSpan Value public T Value Field Value T Methods ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name."
  },
  "api/Stride.Animations.PlayingAnimation.html": {
    "href": "api/Stride.Animations.PlayingAnimation.html",
    "title": "Class PlayingAnimation | Stride API",
    "summary": "Class PlayingAnimation Namespace Stride.Animations Assembly Stride.Engine.dll public class PlayingAnimation Inheritance object PlayingAnimation Extension Methods UnsafeUtilities.As<T>(object?) Properties BlendOperation Gets or sets the blend operation. public AnimationBlendOperation BlendOperation { get; set; } Property Value AnimationBlendOperation Clip Gets or sets the animation clip to run public AnimationClip Clip { get; } Property Value AnimationClip CrossfadeRemainingTime If the CrossfadeRemainingTime is positive the blend weight will shift towards the target weight, reaching it at CrossfadeRemainingTime == 0 At that point if the blend weight reaches 0, the animation will be deleted from the list public TimeSpan CrossfadeRemainingTime { get; set; } Property Value TimeSpan CurrentTime Gets or sets the current time. public TimeSpan CurrentTime { get; set; } Property Value TimeSpan Enabled Gets or sets a value indicating whether animation is playing. public bool Enabled { get; set; } Property Value bool Name Gets or sets the name of this playing animation (optional). public string Name { get; } Property Value string RepeatMode Gets or sets the repeat mode. public AnimationRepeatMode RepeatMode { get; set; } Property Value AnimationRepeatMode TimeFactor Gets or sets the playback speed factor. public float TimeFactor { get; set; } Property Value float Weight Gets or sets the animation weight. public float Weight { get; set; } Property Value float WeightTarget public float WeightTarget { get; set; } Property Value float"
  },
  "api/Stride.Animations.html": {
    "href": "api/Stride.Animations.html",
    "title": "Namespace Stride.Animations | Stride API",
    "summary": "Namespace Stride.Animations Classes AnimationBlender Performs animation blending. For now, all AnimationClip must target the same skeleton. AnimationChannel List of float key frame data applying to a specific property in a node. AnimationChannel.ErrorNode AnimationChannel.Evaluator AnimationClip An aggregation of AnimationCurve with their channel names. AnimationClipEvaluator Evaluates AnimationClip to a AnimationClipResult at a given time. AnimationClipResult AnimationCurve Untyped base class for animation curves. AnimationCurveEvaluatorDirectBlittableGroupBase<T> AnimationCurveEvaluatorDirectBlittableGroup<T> AnimationCurveEvaluatorDirectFloatGroup AnimationCurveEvaluatorDirectGroup AnimationCurveEvaluatorDirectGroup<T> AnimationCurveEvaluatorDirectObjectGroup<T> AnimationCurveEvaluatorDirectQuaternionGroup AnimationCurveEvaluatorDirectVector3Group AnimationCurveEvaluatorDirectVector4Group AnimationCurveEvaluatorGroup AnimationCurveEvaluatorOptimizedBlittableGroupBase<T> AnimationCurveEvaluatorOptimizedBlittableGroup<T> AnimationCurveEvaluatorOptimizedFloatGroup AnimationCurveEvaluatorOptimizedGroup AnimationCurveEvaluatorOptimizedGroup<T> AnimationCurveEvaluatorOptimizedIntGroup AnimationCurveEvaluatorOptimizedObjectGroup<T> AnimationCurveEvaluatorOptimizedQuaternionGroup AnimationCurveEvaluatorOptimizedVector3Group AnimationCurveEvaluatorOptimizedVector4Group AnimationCurve<T> Typed class for animation curves. AnimationData AnimationData<T> AnimationKeyFrame<T> AnimationKeyValuePairArraySerializer<T> AnimationProcessor AnimationProcessor.AssociatedData AnimationUpdater Applies animation from a AnimationClip to a SkeletonUpdater. ComputeAnimationCurveColor4 Constant Color4 value for the IComputeCurve interface ComputeAnimationCurveFloat Animation of a float value for the IComputeCurve interface ComputeAnimationCurveQuaternion Constant Quaternion value for the IComputeCurve interface ComputeAnimationCurveVector2 Constant Vector2 value for the IComputeCurve interface ComputeAnimationCurveVector3 Constant Vector3 value for the IComputeCurve interface ComputeAnimationCurveVector4 Constant Vector4 value for the IComputeCurve interface ComputeAnimationCurve<T> A node which describes a binary operation between two compute curves ComputeBinaryCurveColor4 Binary operator Color4 value for the IComputeCurve interface ComputeBinaryCurveFloat Binary operator float value for the IComputeCurve interface ComputeBinaryCurveQuaternion Binary operator Quaternion value for the IComputeCurve interface ComputeBinaryCurveVector2 Binary operator Vector2 value for the IComputeCurve interface ComputeBinaryCurveVector3 Binary operator Vector3 value for the IComputeCurve interface ComputeBinaryCurveVector4 Binary operator Vector4 value for the IComputeCurve interface ComputeBinaryCurve<T> A node which describes a binary operation between two IComputeCurve<T> ComputeConstCurveColor4 Constant Color4 value for the IComputeCurve interface ComputeConstCurveFloat Constant float value for the IComputeCurve interface ComputeConstCurveQuaternion Constant Quaternion value for the IComputeCurve interface ComputeConstCurveVector2 Constant Vector2 value for the IComputeCurve interface ComputeConstCurveVector3 Constant Vector3 value for the IComputeCurve interface ComputeConstCurveVector4 Constant Vector4 value for the IComputeCurve interface ComputeConstCurve<T> A node which describes a constant value for a compute curve ComputeCurveSamplerColor4 Sampler container for Color4 data type ComputeCurveSamplerFloat Sampler container for float data type ComputeCurveSamplerQuaternion Sampler container for Quaternion data type ComputeCurveSamplerVector2 Sampler container for Vector2 data type ComputeCurveSamplerVector3 Sampler container for Vector3 data type ComputeCurveSamplerVector4 Sampler container for Vector4 data type ComputeCurveSampler<T> Base interface for curve based compute value nodes. ComputeFunctionCurveColor4 Function Color4 value for the IComputeCurve interface ComputeFunctionCurveFloat Function float value for the IComputeCurve interface ComputeFunctionCurveVector2 Function Vector2 value for the IComputeCurve interface ComputeFunctionCurveVector3 Function Vector3 value for the IComputeCurve interface ComputeFunctionCurveVector4 Function Vector4 value for the IComputeCurve interface ComputeFunctionCurve<T> A node which describes a function over t value for a compute curve ComputeSeparateCurveVector3 ComputeSeparateCurveVector4 Interpolator Various helper functions for float, Vector2, Vector3, Vector4 and Quaternion interpolations. Interpolator.Quaternion Interpolator.Vector2 Interpolator.Vector3 Interpolator.Vector4 PlayingAnimation Structs AnimationBlender.Channel AnimationChannel.EvaluatorData AnimationClip.Channel AnimationCurveEvaluatorDirectGroup<T>.Channel AnimationCurveEvaluatorOptimizedGroup<T>.Channel AnimationInitialValues<T> AnimationKeyValuePair<T> AnimationOperation A single animation operation (push or blend). AnimationTargetProperty CompressedTimeSpan KeyFrameData<T> A single key frame value. Interfaces IComputeCurve IComputeCurve<T> Base interface for curve based compute value nodes. Enums AnimationBlendOperation Describes the type of animation blend operation. AnimationBlender.BlendType AnimationCurveInterpolationType Describes how a curve should be interpolated. AnimationKeyTangentType AnimationOperationType AnimationRepeatMode Enumeration describing how an animation should be repeated. BinaryCurveOperator CoreAnimationOperation Core animation operations support all operations exposed for blending as well as several required for the animation building itself"
  },
  "api/Stride.Audio.AudioDevice.html": {
    "href": "api/Stride.Audio.AudioDevice.html",
    "title": "Class AudioDevice | Stride API",
    "summary": "Class AudioDevice Namespace Stride.Audio Assembly Stride.Audio.dll Reprensent an Audio Hardware Device. Can be used when creating an AudioEngine to specify the device on which to play the sound. public class AudioDevice Inheritance object AudioDevice Extension Methods UnsafeUtilities.As<T>(object?) Constructors AudioDevice() public AudioDevice() Properties Name Returns the name of the current device. public string Name { get; set; } Property Value string"
  },
  "api/Stride.Audio.AudioDeviceInvalidatedException.html": {
    "href": "api/Stride.Audio.AudioDeviceInvalidatedException.html",
    "title": "Class AudioDeviceInvalidatedException | Stride API",
    "summary": "Class AudioDeviceInvalidatedException Namespace Stride.Audio Assembly Stride.Audio.dll The exception that is thrown when the audio device became unusable through being unplugged or some other event. public class AudioDeviceInvalidatedException : Exception, ISerializable Inheritance object Exception AudioDeviceInvalidatedException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Audio.AudioEmitter.html": {
    "href": "api/Stride.Audio.AudioEmitter.html",
    "title": "Class AudioEmitter | Stride API",
    "summary": "Class AudioEmitter Namespace Stride.Audio Assembly Stride.Audio.dll Represents a 3D audio emitter in the audio scene. This object, used in combination with an AudioListener, can simulate 3D audio localization effects for a given sound implementing the IPositionableSound interface. For more details take a look at the Apply3D(AudioEmitter) function. public class AudioEmitter Inheritance object AudioEmitter Extension Methods UnsafeUtilities.As<T>(object?) Constructors AudioEmitter() Initializes a new instance of the AudioEmitter class. public AudioEmitter() Fields Position The position of the emitter in the 3D world. public Vector3 Position Field Value Vector3 Velocity The velocity of the emitter in the 3D world. public Vector3 Velocity Field Value Vector3 Remarks This is only used to calculate the doppler effect on the sound effect Properties Forward Gets or sets the forward orientation vector for this emitter. This vector represents the orientation the emitter is looking at. public Vector3 Forward { get; set; } Property Value Vector3 Remarks By default, this value is (0,0,1). The value provided will be normalized if it is not already. The values of the Forward and Up vectors must be orthonormal (at right angles to one another). Behavior is undefined if these vectors are not orthonormal. Doppler and Matrix values between an and an AudioEmitter are effected by the emitter orientation. Exceptions InvalidOperationException The value provided to the set accessor is (0,0,0) or Up. Up Gets or sets the Up orientation vector for this emitter. This vector up of the world for the emitter. public Vector3 Up { get; set; } Property Value Vector3 Remarks By default, this value is (0,1,0). The value provided will be normalized if it is not already. The values of the Forward and Up vectors must be orthonormal (at right angles to one another). Behavior is undefined if these vectors are not orthonormal. Doppler and Matrix values between an and an AudioEmitter are effected by the emitter orientation. Exceptions InvalidOperationException The value provided to the set accessor is (0,0,0). See Also Apply3D(AudioEmitter) AudioListener"
  },
  "api/Stride.Audio.AudioEmitterProcessor.AssociatedData.html": {
    "href": "api/Stride.Audio.AudioEmitterProcessor.AssociatedData.html",
    "title": "Class AudioEmitterProcessor.AssociatedData | Stride API",
    "summary": "Class AudioEmitterProcessor.AssociatedData Namespace Stride.Audio Assembly Stride.Engine.dll Data associated to each Entity instances of the system having an AudioEmitterComponent and an TransformComponent. public class AudioEmitterProcessor.AssociatedData Inheritance object AudioEmitterProcessor.AssociatedData Extension Methods UnsafeUtilities.As<T>(object?) Fields AudioEmitter The AudioEmitter associated to the AudioEmitterComponent. public AudioEmitter AudioEmitter Field Value AudioEmitter AudioEmitterComponent The AudioEmitterComponent associated to the entity public AudioEmitterComponent AudioEmitterComponent Field Value AudioEmitterComponent IsPlaying If this emitter has some instances playing public bool IsPlaying Field Value bool TransformComponent The TransformComponent associated to the entity public TransformComponent TransformComponent Field Value TransformComponent"
  },
  "api/Stride.Audio.AudioEmitterProcessor.html": {
    "href": "api/Stride.Audio.AudioEmitterProcessor.html",
    "title": "Class AudioEmitterProcessor | Stride API",
    "summary": "Class AudioEmitterProcessor Namespace Stride.Audio Assembly Stride.Engine.dll Processor in charge of updating the AudioEmitterComponents. public class AudioEmitterProcessor : EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData> Inheritance object EntityProcessor EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData> AudioEmitterProcessor Inherited Members EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData>.ComponentDatas EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData>.OnSystemAdd() EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData>.OnSystemRemove() EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData>.RemoveAllEntities() EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData>.GenerateComponentData(Entity, AudioEmitterComponent) EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData>.IsAssociatedDataValid(Entity, AudioEmitterComponent, AudioEmitterProcessor.AssociatedData) EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData>.OnEntityComponentAdding(Entity, AudioEmitterComponent, AudioEmitterProcessor.AssociatedData) EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData>.OnEntityComponentRemoved(Entity, AudioEmitterComponent, AudioEmitterProcessor.AssociatedData) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Remarks More precisely it updates the AudioEmitters and then applies 3D localization to each couple AudioEmitterComponent-AudioListenerComponent. When a new emitter or a new listener is added to the system, its creates the required SoundInstances and associate them with the new emitter/listener tuples. Constructors AudioEmitterProcessor() Create a new instance of the processor. public AudioEmitterProcessor() Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext GenerateComponentData(Entity, AudioEmitterComponent) Generates associated data to the given entity. protected override AudioEmitterProcessor.AssociatedData GenerateComponentData(Entity entity, AudioEmitterComponent component) Parameters entity Entity The entity. component AudioEmitterComponent Returns AudioEmitterProcessor.AssociatedData The associated data. IsAssociatedDataValid(Entity, AudioEmitterComponent, AssociatedData) Checks if the current associated data is valid, or if readding the entity is required. protected override bool IsAssociatedDataValid(Entity entity, AudioEmitterComponent component, AudioEmitterProcessor.AssociatedData associatedData) Parameters entity Entity The entity. component AudioEmitterComponent associatedData AudioEmitterProcessor.AssociatedData The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise. OnEntityComponentAdding(Entity, AudioEmitterComponent, AssociatedData) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, AudioEmitterComponent component, AudioEmitterProcessor.AssociatedData data) Parameters entity Entity The entity. component AudioEmitterComponent data AudioEmitterProcessor.AssociatedData The associated data. OnEntityComponentRemoved(Entity, AudioEmitterComponent, AssociatedData) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, AudioEmitterComponent component, AudioEmitterProcessor.AssociatedData data) Parameters entity Entity The entity. component AudioEmitterComponent data AudioEmitterProcessor.AssociatedData The associated data. OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd() OnSystemRemove() Run when this EntityProcessor is removed from an EntityManager. protected override void OnSystemRemove()"
  },
  "api/Stride.Audio.AudioEmitterSoundController.html": {
    "href": "api/Stride.Audio.AudioEmitterSoundController.html",
    "title": "Class AudioEmitterSoundController | Stride API",
    "summary": "Class AudioEmitterSoundController Namespace Stride.Audio Assembly Stride.Engine.dll This class is used to control a SoundBase associated to a AudioEmitterComponent. public class AudioEmitterSoundController : IPlayableSound, IMediaPlayer, IMediaReader Inheritance object AudioEmitterSoundController Implements IPlayableSound IMediaPlayer IMediaReader Extension Methods UnsafeUtilities.As<T>(object?) Remarks Instances of this class can not be directly created by the user, but need to queried from an AudioEmitterComponent instance using the readonly this[string] indexer. An instance AudioEmitterSoundController is not valid anymore if any of those situations arrives: The underlying Sound is disposed. The AudioEmitterComponent is detached from its entity. The entity to which it is attached is removed from the Entity System. Properties IsDisposed Specifies if the extractor has been disposed public bool IsDisposed { get; set; } Property Value bool IsLooping Gets or sets whether the sound is automatically looping from beginning when it reaches the end. public bool IsLooping { get; set; } Property Value bool Pitch public float Pitch { get; set; } Property Value float PlayState The current state of the sound. public PlayState PlayState { get; } Property Value PlayState SpeedFactor Set the play speed of the media public float SpeedFactor { get; set; } Property Value float Volume The global volume at which the sound is played. public float Volume { get; set; } Property Value float Remarks Volume is ranging from 0.0f (silence) to 1.0f (full volume). Values beyond those limits are clamped. Methods Pause() Pause the sounds. public void Pause() Remarks A call to Pause when the sound is already paused or stopped has no effects. Play() Start or resume playing the sound. public void Play() Remarks A call to Play when the sound is already playing has no effects. PlayAndForget() Plays the attached sound in a new instance and let's the engine handle it's disposal. This is useful for very fast overlapping sounds, gun shots, machine gun etc. Where you don't care about controlling each sound. public void PlayAndForget() Seek(TimeSpan) Seek to provided position in the media source. public void Seek(TimeSpan mediaTime) Parameters mediaTime TimeSpan SetRange(PlayRange) Sets the range of the sound to play. public void SetRange(PlayRange range) Parameters range PlayRange a PlayRange structure that describes the starting offset and ending point of the sound to play in seconds. Remarks This will not be valid if the sound is played with PlayAndForget Stop() Stop playing the sound immediately and reset the sound to the beginning of the track. public void Stop() Remarks A call to Stop when the sound is already stopped has no effects"
  },
  "api/Stride.Audio.AudioEngine.html": {
    "href": "api/Stride.Audio.AudioEngine.html",
    "title": "Class AudioEngine | Stride API",
    "summary": "Class AudioEngine Namespace Stride.Audio Assembly Stride.Audio.dll Represents the audio engine. In current version, the audio engine necessarily creates its context on the default audio hardware of the device. The audio engine is required when creating or loading sounds. public class AudioEngine : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase AudioEngine Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks The AudioEngine is Disposable. Call the Dispose() function when you do not need to play sounds anymore to free memory allocated to the audio system. A call to Dispose automatically stops and disposes all the SoundBase, SoundInstance. Constructors AudioEngine(AudioDevice, uint) Initializes a new instance of the AudioEngine class with the default audio device. public AudioEngine(AudioDevice device, uint sampleRate = 0) Parameters device AudioDevice Device on which to create the audio engine. sampleRate uint The desired sample rate of the audio graph. 0 let the engine choose the best value depending on the hardware. Exceptions AudioInitializationException Initialization of the audio engine failed. May be due to memory problems or missing audio hardware. AudioEngine(uint) Initializes a new instance of the AudioEngine class with the default audio device. public AudioEngine(uint sampleRate = 0) Parameters sampleRate uint The desired sample rate of the audio graph. 0 let the engine choose the best value depending on the hardware. Exceptions AudioInitializationException Initialization of the audio engine failed. May be due to memory problems or missing audio hardware. Fields DefaultListener public AudioListener DefaultListener Field Value AudioListener Logger The logger of the audio engine. public static readonly Logger Logger Field Value Logger Properties MasterVolume Gets or sets the Global audio volume public float MasterVolume { get; set; } Property Value float State The current state of the AudioEngine. public AudioEngineState State { get; protected set; } Property Value AudioEngineState Methods Destroy() Destroys the instance. protected override void Destroy() PauseAudio() Pause the audio engine. That is, pause all the currently playing SoundInstance, and block any future play until ResumeAudio() is called. public void PauseAudio() ResumeAudio() Resume all audio engine. That is, resume the sounds paused by PauseAudio(), and re-authorize future calls to play. public void ResumeAudio() Update() Method that updates all the sounds play status. public void Update() Remarks Should be called in same thread as user main thread. Exceptions InvalidOperationException One or several of the sounds asked for play had invalid data (corrupted or unsupported formats)."
  },
  "api/Stride.Audio.AudioEngineFactory.html": {
    "href": "api/Stride.Audio.AudioEngineFactory.html",
    "title": "Class AudioEngineFactory | Stride API",
    "summary": "Class AudioEngineFactory Namespace Stride.Audio Assembly Stride.Audio.dll public static class AudioEngineFactory Inheritance object AudioEngineFactory Methods NewAudioEngine(AudioDevice, DeviceFlags) Based on compilation setting, returns the proper instance of sounds. public static AudioEngine NewAudioEngine(AudioDevice device = null, AudioLayer.DeviceFlags deviceFlags = DeviceFlags.None) Parameters device AudioDevice deviceFlags AudioLayer.DeviceFlags Returns AudioEngine A platform specific instance of AudioEngine"
  },
  "api/Stride.Audio.AudioEngineSettings.html": {
    "href": "api/Stride.Audio.AudioEngineSettings.html",
    "title": "Class AudioEngineSettings | Stride API",
    "summary": "Class AudioEngineSettings Namespace Stride.Audio Assembly Stride.Audio.dll [DataContract] [Display(\"Audio\", null)] public class AudioEngineSettings : Configuration Inheritance object Configuration AudioEngineSettings Inherited Members Configuration.OfflineOnly Extension Methods UnsafeUtilities.As<T>(object?) Properties HrtfSupport Enables HRTF audio. Note that only audio emitters with HRTF enabled produce HRTF audio [DataMember(10)] [Display(\"HRTF (if available)\", null)] public bool HrtfSupport { get; set; } Property Value bool"
  },
  "api/Stride.Audio.AudioEngineState.html": {
    "href": "api/Stride.Audio.AudioEngineState.html",
    "title": "Enum AudioEngineState | Stride API",
    "summary": "Enum AudioEngineState Namespace Stride.Audio Assembly Stride.Audio.dll Describe the possible states of the AudioEngine. public enum AudioEngineState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Disposed = 3 The audio engine is disposed. The current instance cannot be used to play or create sounds anymore. Invalidated = 2 The audio engine is not currently usable due to missing audio hardware or unplugged audio output. Paused = 1 The audio engine is currently paused. Any calls to play will be dropped. Running = 0 The audio engine is currently running."
  },
  "api/Stride.Audio.AudioInitializationException.html": {
    "href": "api/Stride.Audio.AudioInitializationException.html",
    "title": "Class AudioInitializationException | Stride API",
    "summary": "Class AudioInitializationException Namespace Stride.Audio Assembly Stride.Audio.dll The exception that is thrown when audio engine failed to initialized. Most of the time is happens when no hardware is present, or when audio hardware is installed, but it is not enabled or where there is no output connected. public class AudioInitializationException : Exception, ISerializable Inheritance object Exception AudioInitializationException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Audio.AudioLayer.Buffer.html": {
    "href": "api/Stride.Audio.AudioLayer.Buffer.html",
    "title": "Struct AudioLayer.Buffer | Stride API",
    "summary": "Struct AudioLayer.Buffer Namespace Stride.Audio Assembly Stride.Audio.dll public struct AudioLayer.Buffer Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Ptr public nint Ptr Field Value nint"
  },
  "api/Stride.Audio.AudioLayer.BufferType.html": {
    "href": "api/Stride.Audio.AudioLayer.BufferType.html",
    "title": "Enum AudioLayer.BufferType | Stride API",
    "summary": "Enum AudioLayer.BufferType Namespace Stride.Audio Assembly Stride.Audio.dll public enum AudioLayer.BufferType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BeginOfStream = 1 EndOfLoop = 3 EndOfStream = 2 None = 0"
  },
  "api/Stride.Audio.AudioLayer.Device.html": {
    "href": "api/Stride.Audio.AudioLayer.Device.html",
    "title": "Struct AudioLayer.Device | Stride API",
    "summary": "Struct AudioLayer.Device Namespace Stride.Audio Assembly Stride.Audio.dll public struct AudioLayer.Device Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Ptr public nint Ptr Field Value nint"
  },
  "api/Stride.Audio.AudioLayer.DeviceFlags.html": {
    "href": "api/Stride.Audio.AudioLayer.DeviceFlags.html",
    "title": "Enum AudioLayer.DeviceFlags | Stride API",
    "summary": "Enum AudioLayer.DeviceFlags Namespace Stride.Audio Assembly Stride.Audio.dll public enum AudioLayer.DeviceFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Hrtf = 1 None = 0"
  },
  "api/Stride.Audio.AudioLayer.Listener.html": {
    "href": "api/Stride.Audio.AudioLayer.Listener.html",
    "title": "Struct AudioLayer.Listener | Stride API",
    "summary": "Struct AudioLayer.Listener Namespace Stride.Audio Assembly Stride.Audio.dll public struct AudioLayer.Listener Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Ptr public nint Ptr Field Value nint"
  },
  "api/Stride.Audio.AudioLayer.Source.html": {
    "href": "api/Stride.Audio.AudioLayer.Source.html",
    "title": "Struct AudioLayer.Source | Stride API",
    "summary": "Struct AudioLayer.Source Namespace Stride.Audio Assembly Stride.Audio.dll public struct AudioLayer.Source Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Ptr public nint Ptr Field Value nint"
  },
  "api/Stride.Audio.AudioLayer.html": {
    "href": "api/Stride.Audio.AudioLayer.html",
    "title": "Class AudioLayer | Stride API",
    "summary": "Class AudioLayer Namespace Stride.Audio Assembly Stride.Audio.dll Wrapper around OpenAL public class AudioLayer Inheritance object AudioLayer Extension Methods UnsafeUtilities.As<T>(object?) Methods BufferCreate(int) public static extern AudioLayer.Buffer BufferCreate(int maxBufferSizeBytes) Parameters maxBufferSizeBytes int Returns AudioLayer.Buffer BufferDestroy(Buffer) public static extern void BufferDestroy(AudioLayer.Buffer buffer) Parameters buffer AudioLayer.Buffer BufferFill(Buffer, nint, int, int, bool) public static extern void BufferFill(AudioLayer.Buffer buffer, nint pcm, int bufferSize, int sampleRate, bool mono) Parameters buffer AudioLayer.Buffer pcm nint bufferSize int sampleRate int mono bool Create(string, DeviceFlags) public static extern AudioLayer.Device Create(string deviceName, AudioLayer.DeviceFlags flags) Parameters deviceName string flags AudioLayer.DeviceFlags Returns AudioLayer.Device Destroy(Device) public static extern void Destroy(AudioLayer.Device device) Parameters device AudioLayer.Device Init() public static extern bool Init() Returns bool ListenerCreate(Device) public static extern AudioLayer.Listener ListenerCreate(AudioLayer.Device device) Parameters device AudioLayer.Device Returns AudioLayer.Listener ListenerDestroy(Listener) public static extern void ListenerDestroy(AudioLayer.Listener listener) Parameters listener AudioLayer.Listener ListenerDisable(Listener) public static extern void ListenerDisable(AudioLayer.Listener listener) Parameters listener AudioLayer.Listener ListenerEnable(Listener) public static extern bool ListenerEnable(AudioLayer.Listener listener) Parameters listener AudioLayer.Listener Returns bool ListenerPush3D(Listener, ref Vector3, ref Vector3, ref Vector3, ref Vector3, ref Matrix) public static extern void ListenerPush3D(AudioLayer.Listener listener, ref Vector3 pos, ref Vector3 forward, ref Vector3 up, ref Vector3 vel, ref Matrix worldTransform) Parameters listener AudioLayer.Listener pos Vector3 forward Vector3 up Vector3 vel Vector3 worldTransform Matrix SetMasterVolume(Device, float) public static extern void SetMasterVolume(AudioLayer.Device device, float volume) Parameters device AudioLayer.Device volume float SourceCreate(Listener, int, int, bool, bool, bool, bool, float, HrtfEnvironment) public static extern AudioLayer.Source SourceCreate(AudioLayer.Listener listener, int sampleRate, int maxNumberOfBuffers, bool mono, bool spatialized, bool streamed, bool hrtf, float hrtfDirectionFactor, HrtfEnvironment environment) Parameters listener AudioLayer.Listener sampleRate int maxNumberOfBuffers int mono bool spatialized bool streamed bool hrtf bool hrtfDirectionFactor float environment HrtfEnvironment Returns AudioLayer.Source SourceDestroy(Source) public static extern void SourceDestroy(AudioLayer.Source source) Parameters source AudioLayer.Source SourceFlushBuffers(Source) public static extern void SourceFlushBuffers(AudioLayer.Source source) Parameters source AudioLayer.Source SourceGetFreeBuffer(Source) public static extern AudioLayer.Buffer SourceGetFreeBuffer(AudioLayer.Source source) Parameters source AudioLayer.Source Returns AudioLayer.Buffer SourceGetPosition(Source) public static extern double SourceGetPosition(AudioLayer.Source source) Parameters source AudioLayer.Source Returns double SourceIsPlaying(Source) public static extern bool SourceIsPlaying(AudioLayer.Source source) Parameters source AudioLayer.Source Returns bool SourcePause(Source) public static extern void SourcePause(AudioLayer.Source source) Parameters source AudioLayer.Source SourcePlay(Source) public static extern void SourcePlay(AudioLayer.Source source) Parameters source AudioLayer.Source SourcePush3D(Source, ref Vector3, ref Vector3, ref Vector3, ref Vector3, ref Matrix) public static extern void SourcePush3D(AudioLayer.Source source, ref Vector3 pos, ref Vector3 forward, ref Vector3 up, ref Vector3 vel, ref Matrix worldTransform) Parameters source AudioLayer.Source pos Vector3 forward Vector3 up Vector3 vel Vector3 worldTransform Matrix SourceQueueBuffer(Source, Buffer, nint, int, BufferType) public static extern void SourceQueueBuffer(AudioLayer.Source source, AudioLayer.Buffer buffer, nint pcm, int bufferSize, AudioLayer.BufferType streamType) Parameters source AudioLayer.Source buffer AudioLayer.Buffer pcm nint bufferSize int streamType AudioLayer.BufferType SourceSetBuffer(Source, Buffer) public static extern void SourceSetBuffer(AudioLayer.Source source, AudioLayer.Buffer buffer) Parameters source AudioLayer.Source buffer AudioLayer.Buffer SourceSetGain(Source, float) public static extern void SourceSetGain(AudioLayer.Source source, float gain) Parameters source AudioLayer.Source gain float SourceSetLooping(Source, bool) public static extern void SourceSetLooping(AudioLayer.Source source, bool looped) Parameters source AudioLayer.Source looped bool SourceSetPan(Source, float) public static extern void SourceSetPan(AudioLayer.Source source, float pan) Parameters source AudioLayer.Source pan float SourceSetPitch(Source, float) public static extern void SourceSetPitch(AudioLayer.Source source, float pitch) Parameters source AudioLayer.Source pitch float SourceSetRange(Source, double, double) public static extern void SourceSetRange(AudioLayer.Source source, double startTime, double stopTime) Parameters source AudioLayer.Source startTime double stopTime double SourceStop(Source) public static extern void SourceStop(AudioLayer.Source source) Parameters source AudioLayer.Source Update(Device) public static extern void Update(AudioLayer.Device device) Parameters device AudioLayer.Device"
  },
  "api/Stride.Audio.AudioListener.html": {
    "href": "api/Stride.Audio.AudioListener.html",
    "title": "Class AudioListener | Stride API",
    "summary": "Class AudioListener Namespace Stride.Audio Assembly Stride.Audio.dll Represents a 3D audio listener in the audio scene. This object, used in combination with an AudioEmitter, can simulate 3D audio localization effects for a sound implemention the IPositionableSound interface. For more details take a look at the Apply3D(AudioEmitter) function. public class AudioListener : IDisposable Inheritance object AudioListener Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors AudioListener() Initializes a new instance of the AudioListener class. public AudioListener() AudioListener(AudioEngine) public AudioListener(AudioEngine engine) Parameters engine AudioEngine Fields Position The position of the listener in the 3D world. public Vector3 Position Field Value Vector3 Velocity The velocity of the listener in the 3D world. public Vector3 Velocity Field Value Vector3 Remarks This is only used to calculate the doppler effect on the sound effect Properties Forward Gets or sets the forward orientation vector for this listener. This vector represents the orientation the listener is looking at. public Vector3 Forward { get; set; } Property Value Vector3 Remarks By default, this value is (0,0,1). The value provided will be normalized if it is not already. The values of the Forward and Up vectors must be orthonormal (at right angles to one another). Behavior is undefined if these vectors are not orthonormal. Doppler and Matrix values between an and an AudioListener are effected by the listener orientation. Exceptions InvalidOperationException The value provided to the set accessor is (0,0,0) or Up. Up Gets or sets the Up orientation vector for this listener. This vector up of the world for the listener. public Vector3 Up { get; set; } Property Value Vector3 Remarks By default, this value is (0,1,0). The value provided will be normalized if it is not already. The values of the Forward and Up vectors must be orthonormal (at right angles to one another). Behavior is undefined if these vectors are not orthonormal. Doppler and Matrix values between an and an AudioListener are effected by the listener orientation. Exceptions InvalidOperationException The value provided to the set accessor is (0,0,0). Methods Dispose() Disposes the Listener public void Dispose() See Also Apply3D(AudioEmitter) AudioEmitter"
  },
  "api/Stride.Audio.AudioListenerProcessor.html": {
    "href": "api/Stride.Audio.AudioListenerProcessor.html",
    "title": "Class AudioListenerProcessor | Stride API",
    "summary": "Class AudioListenerProcessor Namespace Stride.Audio Assembly Stride.Engine.dll Processor in charge of creating and updating the AudioListener data associated to the scene AudioListenerComponents. public class AudioListenerProcessor : EntityProcessor<AudioListenerComponent> Inheritance object EntityProcessor EntityProcessor<AudioListenerComponent, AudioListenerComponent> EntityProcessor<AudioListenerComponent> AudioListenerProcessor Inherited Members EntityProcessor<AudioListenerComponent>.GenerateComponentData(Entity, AudioListenerComponent) EntityProcessor<AudioListenerComponent>.IsAssociatedDataValid(Entity, AudioListenerComponent, AudioListenerComponent) EntityProcessor<AudioListenerComponent, AudioListenerComponent>.ComponentDatas EntityProcessor<AudioListenerComponent, AudioListenerComponent>.OnSystemAdd() EntityProcessor<AudioListenerComponent, AudioListenerComponent>.OnSystemRemove() EntityProcessor<AudioListenerComponent, AudioListenerComponent>.RemoveAllEntities() EntityProcessor<AudioListenerComponent, AudioListenerComponent>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<AudioListenerComponent, AudioListenerComponent>.GenerateComponentData(Entity, AudioListenerComponent) EntityProcessor<AudioListenerComponent, AudioListenerComponent>.IsAssociatedDataValid(Entity, AudioListenerComponent, AudioListenerComponent) EntityProcessor<AudioListenerComponent, AudioListenerComponent>.OnEntityComponentAdding(Entity, AudioListenerComponent, AudioListenerComponent) EntityProcessor<AudioListenerComponent, AudioListenerComponent>.OnEntityComponentRemoved(Entity, AudioListenerComponent, AudioListenerComponent) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Remarks The processor updates only AudioListener associated to AudioListenerComponents The processor is subscribing to the AudioSystem AudioListenerComponent collection events to be informed of required AudioEmitter updates. When a AudioListenerComponent is added to the AudioSystem, the processor set the associated AudioEmitter. When a AudioListenerComponent is removed from the entity system, the processor set the AudioEmitter reference of the AudioSystem to null but do not remove the AudioListenerComponent from its collection. Constructors AudioListenerProcessor() Create a new instance of AudioListenerProcessor. public AudioListenerProcessor() Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext OnEntityComponentAdding(Entity, AudioListenerComponent, AudioListenerComponent) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, AudioListenerComponent component, AudioListenerComponent data) Parameters entity Entity The entity. component AudioListenerComponent data AudioListenerComponent The associated data. OnEntityComponentRemoved(Entity, AudioListenerComponent, AudioListenerComponent) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, AudioListenerComponent component, AudioListenerComponent data) Parameters entity Entity The entity. component AudioListenerComponent data AudioListenerComponent The associated data. OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd() OnSystemRemove() Run when this EntityProcessor is removed from an EntityManager. protected override void OnSystemRemove()"
  },
  "api/Stride.Audio.AudioSystem.html": {
    "href": "api/Stride.Audio.AudioSystem.html",
    "title": "Class AudioSystem | Stride API",
    "summary": "Class AudioSystem Namespace Stride.Audio Assembly Stride.Engine.dll The Audio System. It creates an underlying instance of AudioEngine. public class AudioSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable, IAudioEngineProvider Inheritance object DisposeBase ComponentBase GameSystemBase AudioSystem Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable IAudioEngineProvider Inherited Members GameSystemBase.Game GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.Draw(GameTime) GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) GameSystemBase.LoadContent() GameSystemBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors AudioSystem(IServiceRegistry) Create an new instance of AudioSystem public AudioSystem(IServiceRegistry registry) Parameters registry IServiceRegistry The service registry in which to register the AudioSystem services Properties AudioEngine The underlying AudioEngine. public AudioEngine AudioEngine { get; } Property Value AudioEngine The audio engine. RequestedAudioDevice public AudioDevice RequestedAudioDevice { get; set; } Property Value AudioDevice Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. Initialize() Initializes the Game System. public override void Initialize() Remarks This method is called when the component is added to the Game. This can be used for tasks like querying for services the component needs and setting up non-graphics resources (as here the Graphics Device may have not been initialized yet). Update(GameTime) This method is called when this game component is updated. public override void Update(GameTime gameTime) Parameters gameTime GameTime The current timing."
  },
  "api/Stride.Audio.AudioSystemInternalException.html": {
    "href": "api/Stride.Audio.AudioSystemInternalException.html",
    "title": "Class AudioSystemInternalException | Stride API",
    "summary": "Class AudioSystemInternalException Namespace Stride.Audio Assembly Stride.Audio.dll The exception that is thrown when an internal error happened in the Audio System. That is an error that is not due to the user behaviour. public class AudioSystemInternalException : Exception, ISerializable Inheritance object Exception AudioSystemInternalException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Audio.CompressedSoundPacket.html": {
    "href": "api/Stride.Audio.CompressedSoundPacket.html",
    "title": "Class CompressedSoundPacket | Stride API",
    "summary": "Class CompressedSoundPacket Namespace Stride.Audio Assembly Stride.Audio.dll Used internally in SoundAsset [DataContract(\"CompressedSoundPacket\")] public class CompressedSoundPacket Inheritance object CompressedSoundPacket Extension Methods UnsafeUtilities.As<T>(object?) Fields Data The Data. public byte[] Data Field Value byte[] Length The length of the Data. public int Length Field Value int"
  },
  "api/Stride.Audio.DynamicSoundSource.AsyncCommand.html": {
    "href": "api/Stride.Audio.DynamicSoundSource.AsyncCommand.html",
    "title": "Enum DynamicSoundSource.AsyncCommand | Stride API",
    "summary": "Enum DynamicSoundSource.AsyncCommand Namespace Stride.Audio Assembly Stride.Audio.dll The possible async commands that can be queued and be handled by subclasses protected enum DynamicSoundSource.AsyncCommand Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Dispose = 5 Pause = 1 Play = 0 Seek = 3 SetRange = 4 Stop = 2"
  },
  "api/Stride.Audio.DynamicSoundSource.html": {
    "href": "api/Stride.Audio.DynamicSoundSource.html",
    "title": "Class DynamicSoundSource | Stride API",
    "summary": "Class DynamicSoundSource Namespace Stride.Audio Assembly Stride.Audio.dll public abstract class DynamicSoundSource : IDisposable Inheritance object DynamicSoundSource Implements IDisposable Derived StreamedBufferSoundSource Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DynamicSoundSource(SoundInstance, int, int) Initializes a new instance of the DynamicSoundSource class. Sub classes can implement their own streaming sources. protected DynamicSoundSource(SoundInstance soundInstance, int numberOfBuffers, int maxBufferSizeBytes) Parameters soundInstance SoundInstance the sound instance associated. numberOfBuffers int the size of the streaming ring-buffer. maxBufferSizeBytes int the maximum size of each buffer. Fields Commands The commands derived classes should execute. protected readonly ConcurrentQueue<DynamicSoundSource.AsyncCommand> Commands Field Value ConcurrentQueue<DynamicSoundSource.AsyncCommand> Logger public static Logger Logger Field Value Logger NewSources protected static readonly ConcurrentBag<DynamicSoundSource> NewSources Field Value ConcurrentBag<DynamicSoundSource> Sources protected static readonly List<DynamicSoundSource> Sources Field Value List<DynamicSoundSource> deviceBuffers protected readonly List<AudioLayer.Buffer> deviceBuffers Field Value List<AudioLayer.Buffer> freeBuffers protected readonly Queue<AudioLayer.Buffer> freeBuffers Field Value Queue<AudioLayer.Buffer> isDisposed protected bool isDisposed Field Value bool isInitialized protected bool isInitialized Field Value bool playingQueued If we are waiting to play. protected volatile bool playingQueued Field Value bool soundInstance The sound instance associated. protected SoundInstance soundInstance Field Value SoundInstance state If we are in the paused state. protected PlayState state Field Value PlayState Properties CanFill Checks if a buffer can be filled, before calling FillBuffer this should be checked. protected virtual bool CanFill { get; } Property Value bool Ended Gets a task that will be fired once there will be no more queueud data. public TaskCompletionSource<bool> Ended { get; } Property Value TaskCompletionSource<bool> IsPausedOrPlaying Gets if this instance is in the playing state. public bool IsPausedOrPlaying { get; } Property Value bool MaxNumberOfBuffers Max number of buffers that are going to be queued. public abstract int MaxNumberOfBuffers { get; } Property Value int PlayRange Gets or sets the region of time to play from the audio clip. public virtual PlayRange PlayRange { get; set; } Property Value PlayRange ReadyToPlay Gets a task that will be fired once the source is ready to play. public TaskCompletionSource<bool> ReadyToPlay { get; } Property Value TaskCompletionSource<bool> Methods Dispose() Enqueues a dispose command, to dispose this instance. public virtual void Dispose() DisposeInternal() Destroys the instance. protected virtual void DisposeInternal() ExtractAndFillData() protected abstract void ExtractAndFillData() FillBuffer(byte[], int, BufferType) If CanFillis true with this method you can fill the next free buffer protected void FillBuffer(byte[] pcm, int bufferSize, AudioLayer.BufferType type) Parameters pcm byte[] The array containing PCM data bufferSize int The full size in bytes of PCM data type AudioLayer.BufferType If this buffer is the last buffer of the stream set to true, if not false FillBuffer(short[], int, BufferType) If CanFillis true with this method you can fill the next free buffer protected void FillBuffer(short[] pcm, int bufferSize, AudioLayer.BufferType type) Parameters pcm short[] The array containing PCM data bufferSize int The full size in bytes of PCM data type AudioLayer.BufferType If this buffer is the last buffer of the stream set to true, if not false FillBuffer(nint, int, BufferType) If CanFillis true with this method you can fill the next free buffer protected void FillBuffer(nint pcm, int bufferSize, AudioLayer.BufferType type) Parameters pcm nint The pointer to PCM data bufferSize int The full size in bytes of PCM data type AudioLayer.BufferType If this buffer is the last buffer of the stream set to true, if not false InitializeInternal() protected virtual void InitializeInternal() Pause() Enqueues a Pause command, to Pause this instance. public void Pause() PauseInternal() protected virtual void PauseInternal() Play() Enqueues a Play command, to Play this instance. public void Play() PlayInternal() protected virtual void PlayInternal() PrepareInternal() Prepare the source for playback protected virtual void PrepareInternal() RestartInternal() Restarts streaming from the beginning. protected virtual void RestartInternal() SeekInternal() protected virtual void SeekInternal() SetLooped(bool) Sets if the stream should be played in loop. public abstract void SetLooped(bool looped) Parameters looped bool if looped or not Stop() Enqueues a Stop command, to Stop this instance. public void Stop() StopInternal(bool) protected virtual void StopInternal(bool ignoreQueuedBuffer = true) Parameters ignoreQueuedBuffer bool UpdateInternal() Update the sound source protected virtual void UpdateInternal()"
  },
  "api/Stride.Audio.HrtfEnvironment.html": {
    "href": "api/Stride.Audio.HrtfEnvironment.html",
    "title": "Enum HrtfEnvironment | Stride API",
    "summary": "Enum HrtfEnvironment Namespace Stride.Audio Assembly Stride.Audio.dll public enum HrtfEnvironment Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Large = 2 Medium = 1 Outdoors = 3 Small = 0"
  },
  "api/Stride.Audio.IAudioEngineProvider.html": {
    "href": "api/Stride.Audio.IAudioEngineProvider.html",
    "title": "Interface IAudioEngineProvider | Stride API",
    "summary": "Interface IAudioEngineProvider Namespace Stride.Audio Assembly Stride.Audio.dll Used internally to find the currently active audio engine public interface IAudioEngineProvider Extension Methods UnsafeUtilities.As<T>(object?) Properties AudioEngine AudioEngine AudioEngine { get; } Property Value AudioEngine"
  },
  "api/Stride.Audio.IPlayableSound.html": {
    "href": "api/Stride.Audio.IPlayableSound.html",
    "title": "Interface IPlayableSound | Stride API",
    "summary": "Interface IPlayableSound Namespace Stride.Audio Assembly Stride.Audio.dll Interface for a playable sound. A playable sound can loop (ref IsLooping), be played (ref Play()), be paused (ref Pause()), be resumed (ref Play()), be stopped (ref Stop()) and be attenuated (ref Volume). To query the current state of a sound use the PlayState property. To stop a sound after its currently loop set IsLooping = false; public interface IPlayableSound Extension Methods UnsafeUtilities.As<T>(object?) Properties IsLooping Gets or sets whether the sound is automatically looping from beginning when it reaches the end. bool IsLooping { get; set; } Property Value bool PlayState The current state of the sound. PlayState PlayState { get; } Property Value PlayState Volume The global volume at which the sound is played. float Volume { get; set; } Property Value float Remarks Volume is ranging from 0.0f (silence) to 1.0f (full volume). Values beyond those limits are clamped. Methods Pause() Pause the sounds. void Pause() Remarks A call to Pause when the sound is already paused or stopped has no effects. Play() Start or resume playing the sound. void Play() Remarks A call to Play when the sound is already playing has no effects. Stop() Stop playing the sound immediately and reset the sound to the beginning of the track. void Stop() Remarks A call to Stop when the sound is already stopped has no effects"
  },
  "api/Stride.Audio.IPositionableSound.html": {
    "href": "api/Stride.Audio.IPositionableSound.html",
    "title": "Interface IPositionableSound | Stride API",
    "summary": "Interface IPositionableSound Namespace Stride.Audio Assembly Stride.Audio.dll Interface for 3D localizable sound. The interface currently supports only mono and stereo sounds (ref Pan). The user can localize its sound with Apply3D(AudioEmitter) by creating one AudioEmitter and one AudioListener respectly corresponding to the source of the sound and the listener. The Pan function enable the user to change the distribution of sound between the left and right speakers. public interface IPositionableSound : IPlayableSound Inherited Members IPlayableSound.PlayState IPlayableSound.IsLooping IPlayableSound.Play() IPlayableSound.Pause() IPlayableSound.Stop() IPlayableSound.Volume Extension Methods UnsafeUtilities.As<T>(object?) Remarks Functions Pan and Apply3D(AudioEmitter) cannot be used together. A call to Apply3D(AudioEmitter) will reset Pan to its default value and inverse. Properties Pan Set the sound balance between left and right speaker. float Pan { get; set; } Property Value float Remarks Panning is ranging from -1.0f (full left) to 1.0f (full right). 0.0f is centered. Values beyond this range are clamped. Panning modifies the total energy of the signal (Pan == -1 => Energy = 1 + 0, Pan == 0 => Energy = 1 + 1, Pan == 0.5 => Energy = 1 + 0.5, ...) <p>A call to <xref href=\"Stride.Audio.IPositionableSound.Pan\" data-throw-if-not-resolved=\"false\"></xref> cancels the effect of Apply3D.</p> Pitch Gets or sets the pitch of the sound, might conflict with spatialized sound spatialization. float Pitch { get; set; } Property Value float Methods Apply3D(AudioEmitter) Applies 3D positioning to the sound. More precisely adjust the channel volumes and pitch of the sound, such that the sound source seems to come from the emitter to the listener/>. void Apply3D(AudioEmitter emitter) Parameters emitter AudioEmitter The emitter that correspond to this sound Remarks Apply3D(AudioEmitter) can be used only on mono-sounds. A call to Apply3D(AudioEmitter) reset Pan to its default values. A call to Apply3D(AudioEmitter) does not modify the value of Volume, the effective volume of the sound is a combination of the two effects. The final resulting pitch depends on the listener and emitter relative velocity. The final resulting channel volumes depend on the listener and emitter relative positions and the value of Volume. See Also Sound SoundInstance"
  },
  "api/Stride.Audio.NoMicrophoneConnectedException.html": {
    "href": "api/Stride.Audio.NoMicrophoneConnectedException.html",
    "title": "Class NoMicrophoneConnectedException | Stride API",
    "summary": "Class NoMicrophoneConnectedException Namespace Stride.Audio Assembly Stride.Audio.dll The exception that is thrown when Stride.Audio.Microphone API calls are made on a disconnected microphone. public class NoMicrophoneConnectedException : Exception, ISerializable Inheritance object Exception NoMicrophoneConnectedException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Audio.Sound.html": {
    "href": "api/Stride.Audio.Sound.html",
    "title": "Class Sound | Stride API",
    "summary": "Class Sound Namespace Stride.Audio Assembly Stride.Audio.dll Sound content. [ContentSerializer(typeof(DataContentSerializer<Sound>))] [DataSerializerGlobal(typeof(ReferenceSerializer<Sound>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] [DataSerializer(typeof(SoundSerializer))] public sealed class Sound : SoundBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase SoundBase Sound Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members SoundBase.TotalLength SoundBase.GetCountChannels() ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks Sound is played with a SoundInstance. Methods CreateInstance(AudioListener, bool, bool, float, HrtfEnvironment) Create a new sound effect instance of the sound effect. The audio data are shared between the instances so that useless memory copies is avoided. Each instance that can be played and localized independently from others. public SoundInstance CreateInstance(AudioListener listener = null, bool forceLoadInMemory = false, bool useHrtf = false, float directionalFactor = 0, HrtfEnvironment environment = HrtfEnvironment.Small) Parameters listener AudioListener forceLoadInMemory bool useHrtf bool directionalFactor float environment HrtfEnvironment Returns SoundInstance A new sound instance Exceptions ObjectDisposedException The sound has already been disposed CreateInstance(AudioListener, bool, float, HrtfEnvironment) Create a new sound effect instance of the sound effect. Each instance that can be played and localized independently from others. public override SoundInstance CreateInstance(AudioListener listener = null, bool useHrtf = false, float directionalFactor = 0, HrtfEnvironment environment = HrtfEnvironment.Small) Parameters listener AudioListener useHrtf bool directionalFactor float environment HrtfEnvironment Returns SoundInstance A new sound instance Exceptions ObjectDisposedException The sound has already been disposed Destroy() Destroys the instance. protected override void Destroy()"
  },
  "api/Stride.Audio.SoundBase.html": {
    "href": "api/Stride.Audio.SoundBase.html",
    "title": "Class SoundBase | Stride API",
    "summary": "Class SoundBase Namespace Stride.Audio Assembly Stride.Audio.dll Base class for a Sound content. public abstract class SoundBase : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase SoundBase Implements IDisposable IComponent IReferencable ICollectorHolder Derived Sound StreamedBufferSound Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks Sound is played with a SoundInstance. Fields intancesCreationCount The number of Instances Created so far by this SoundEffect. Used only to give a unique name to the SoundEffectInstance. protected int intancesCreationCount Field Value int Properties TotalLength Gets the total length in time of the Sound. public TimeSpan TotalLength { get; } Property Value TimeSpan Methods CreateInstance(AudioListener, bool, float, HrtfEnvironment) Create a new sound effect instance of the sound effect. Each instance that can be played and localized independently from others. public abstract SoundInstance CreateInstance(AudioListener listener = null, bool useHrtf = false, float directionalFactor = 0, HrtfEnvironment environment = HrtfEnvironment.Small) Parameters listener AudioListener useHrtf bool directionalFactor float environment HrtfEnvironment Returns SoundInstance A new sound instance Exceptions ObjectDisposedException The sound has already been disposed Destroy() Destroys the instance. protected override void Destroy() GetCountChannels() public int GetCountChannels() Returns int RegisterInstance(SoundInstance) Register a new instance to the soundEffect. protected void RegisterInstance(SoundInstance instance) Parameters instance SoundInstance new instance to register."
  },
  "api/Stride.Audio.SoundInstance.html": {
    "href": "api/Stride.Audio.SoundInstance.html",
    "title": "Class SoundInstance | Stride API",
    "summary": "Class SoundInstance Namespace Stride.Audio Assembly Stride.Audio.dll Base class for sound that creates voices public class SoundInstance : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder, IPositionableSound, IPlayableSound Inheritance object DisposeBase ComponentBase SoundInstance Implements IDisposable IComponent IReferencable ICollectorHolder IPositionableSound IPlayableSound Derived SoundInstanceStreamedBuffer Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors SoundInstance(AudioEngine, AudioListener, DynamicSoundSource, int, bool, bool, bool, float, HrtfEnvironment) Initializes a new instance of the SoundInstance class using a dynamic sound source. public SoundInstance(AudioEngine engine, AudioListener listener, DynamicSoundSource dynamicSoundSource, int sampleRate, bool mono, bool spatialized = false, bool useHrtf = false, float directionalFactor = 0, HrtfEnvironment environment = HrtfEnvironment.Small) Parameters engine AudioEngine The audio engine that will be used to play this instance listener AudioListener The listener of this instance dynamicSoundSource DynamicSoundSource The source from where the PCM data will be fetched sampleRate int The sample rate of this audio stream mono bool Set to true if the souce is mono, false if stereo spatialized bool If the SoundInstance will be used for spatialized audio set to true, if not false, if true mono must also be true useHrtf bool If the engine should use Hrtf for spatialization directionalFactor float environment HrtfEnvironment Fields engine protected AudioEngine engine Field Value AudioEngine isLooping protected bool isLooping Field Value bool pan protected float pan Field Value float pitch protected float pitch Field Value float playState protected PlayState playState Field Value PlayState sound protected SoundBase sound Field Value SoundBase soundSource protected DynamicSoundSource soundSource Field Value DynamicSoundSource spatialized protected bool spatialized Field Value bool volume protected float volume Field Value float Properties DynamicSoundSource Gets the DynamicSoundSource, might be null if the sound is not using DynamicSoundSource, e.g. not streamed from disk or not using a DynamicSoundSource derived class as backing. public DynamicSoundSource DynamicSoundSource { get; } Property Value DynamicSoundSource IsLooping Gets or sets whether the sound is automatically looping from beginning when it reaches the end. public bool IsLooping { get; set; } Property Value bool Pan Set the sound balance between left and right speaker. public float Pan { get; set; } Property Value float Remarks Panning is ranging from -1.0f (full left) to 1.0f (full right). 0.0f is centered. Values beyond this range are clamped. Panning modifies the total energy of the signal (Pan == -1 => Energy = 1 + 0, Pan == 0 => Energy = 1 + 1, Pan == 0.5 => Energy = 1 + 0.5, ...) Pitch Gets or sets the pitch of the sound, might conflict with spatialized sound spatialization. public float Pitch { get; set; } Property Value float PlayState Gets the state of the SoundInstance. public PlayState PlayState { get; } Property Value PlayState Position Gets the position in time of this playing instance. public TimeSpan Position { get; } Property Value TimeSpan Volume The global volume at which the sound is played. public float Volume { get; set; } Property Value float Remarks Volume is ranging from 0.0f (silence) to 1.0f (full volume). Values beyond those limits are clamped. Methods Apply3D(AudioEmitter) Applies 3D positioning to the sound. More precisely adjust the channel volumes and pitch of the sound, such that the sound source seems to come from the emitter to the listener/>. public void Apply3D(AudioEmitter emitter) Parameters emitter AudioEmitter The emitter that correspond to this sound Remarks Apply3D(AudioEmitter) can be used only on mono-sounds. The final resulting pitch depends on the listener and emitter relative velocity. The final resulting channel volumes depend on the listener and emitter relative positions and the value of Volume. Destroy() Destroys the instance. protected override void Destroy() Pause() Pause the sounds. public void Pause() Remarks A call to Pause when the sound is already paused or stopped has no effects. Play() Play or resume the sound effect instance. public void Play() Play(bool) Play the sound instance. protected void Play(bool stopSiblingInstances) Parameters stopSiblingInstances bool if true any other istance of the same Sound will be stopped. PlayExclusive() Play or resume the sound effect instance, stopping sibling instances. public void PlayExclusive() ReadyToPlay() A task that completes when the sound is ready to play public Task<bool> ReadyToPlay() Returns Task<bool> Returns a task that will complete when the sound has been buffered and ready to play SetRange(PlayRange) Sets the range of the sound to play. public void SetRange(PlayRange range) Parameters range PlayRange a PlayRange structure that describes the starting offset and ending point of the sound to play in seconds. Stop() Stop playing the sound immediately and reset the sound to the beginning of the track. public void Stop() Remarks A call to Stop when the sound is already stopped has no effects."
  },
  "api/Stride.Audio.SoundInstanceStreamedBuffer.html": {
    "href": "api/Stride.Audio.SoundInstanceStreamedBuffer.html",
    "title": "Class SoundInstanceStreamedBuffer | Stride API",
    "summary": "Class SoundInstanceStreamedBuffer Namespace Stride.Audio Assembly Stride.Audio.dll A Sound Instance where the SoundSource comes from a StreamedBufferSoundSource, and implementing ISynchronizedMediaExtractor interface public class SoundInstanceStreamedBuffer : SoundInstance, IDisposable, IComponent, IReferencable, ICollectorHolder, IPositionableSound, IPlayableSound, IMediaPlayer, IMediaReader Inheritance object DisposeBase ComponentBase SoundInstance SoundInstanceStreamedBuffer Implements IDisposable IComponent IReferencable ICollectorHolder IPositionableSound IPlayableSound IMediaPlayer IMediaReader Inherited Members SoundInstance.soundSource SoundInstance.sound SoundInstance.engine SoundInstance.isLooping SoundInstance.pan SoundInstance.pitch SoundInstance.volume SoundInstance.spatialized SoundInstance.playState SoundInstance.IsLooping SoundInstance.Pan SoundInstance.Volume SoundInstance.Pitch SoundInstance.ReadyToPlay() SoundInstance.Apply3D(AudioEmitter) SoundInstance.Pause() SoundInstance.Play() SoundInstance.PlayExclusive() SoundInstance.Stop() SoundInstance.Destroy() SoundInstance.Play(bool) SoundInstance.PlayState SoundInstance.DynamicSoundSource SoundInstance.SetRange(PlayRange) SoundInstance.Position ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties SpeedFactor Set the play speed of the media public float SpeedFactor { get; set; } Property Value float Methods ReachedEndOfMedia() public bool ReachedEndOfMedia() Returns bool Seek(TimeSpan) Seek to provided position in the media source. public void Seek(TimeSpan mediaTime) Parameters mediaTime TimeSpan SeekRequestCompleted() public bool SeekRequestCompleted() Returns bool"
  },
  "api/Stride.Audio.StreamedBufferSound.html": {
    "href": "api/Stride.Audio.StreamedBufferSound.html",
    "title": "Class StreamedBufferSound | Stride API",
    "summary": "Class StreamedBufferSound Namespace Stride.Audio Assembly Stride.Audio.dll Sound streamed buffer public sealed class StreamedBufferSound : SoundBase, IDisposable, IComponent, IReferencable, ICollectorHolder, IMediaExtractor, IMediaReader Inheritance object DisposeBase ComponentBase SoundBase StreamedBufferSound Implements IDisposable IComponent IReferencable ICollectorHolder IMediaExtractor IMediaReader Inherited Members SoundBase.TotalLength SoundBase.GetCountChannels() ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks The sound comes from an external process (such like a video decoder, ...) streaming the audio data into a buffer Constructors StreamedBufferSound(AudioEngine, MediaSynchronizer, string, long, long, bool) public StreamedBufferSound(AudioEngine engine, MediaSynchronizer scheduler, string mediaDataUrl, long startPosition, long length, bool spatialized) Parameters engine AudioEngine scheduler MediaSynchronizer mediaDataUrl string startPosition long length long spatialized bool Properties MediaCurrentTime Gets the current presentation time of the media public TimeSpan MediaCurrentTime { get; } Property Value TimeSpan MediaDuration Returns the total duration of the media public TimeSpan MediaDuration { get; } Property Value TimeSpan MediaType Returns the type of media that is extracted public MediaType MediaType { get; } Property Value MediaType SpeedFactor Set the play speed of the media public float SpeedFactor { get; set; } Property Value float Methods CreateInstance(AudioListener, bool, float, HrtfEnvironment) Create a new sound effect instance of the sound effect. Each instance that can be played and localized independently from others. public override SoundInstance CreateInstance(AudioListener listener = null, bool useHrtf = false, float directionalFactor = 0, HrtfEnvironment environment = HrtfEnvironment.Small) Parameters listener AudioListener useHrtf bool directionalFactor float environment HrtfEnvironment Returns SoundInstance A new sound instance Exceptions ObjectDisposedException The sound has already been disposed ReachedEndOfMedia() Specifies if the end of the media has been reached. public bool ReachedEndOfMedia() Returns bool Seek(TimeSpan) Seek to provided position in the media source. public void Seek(TimeSpan mediaTime) Parameters mediaTime TimeSpan SeekRequestCompleted() Indicate if a previous seek request has been completed. public bool SeekRequestCompleted() Returns bool"
  },
  "api/Stride.Audio.StreamedBufferSoundSource.html": {
    "href": "api/Stride.Audio.StreamedBufferSoundSource.html",
    "title": "Class StreamedBufferSoundSource | Stride API",
    "summary": "Class StreamedBufferSoundSource Namespace Stride.Audio Assembly Stride.Audio.dll public class StreamedBufferSoundSource : DynamicSoundSource, IDisposable, IMediaExtractor, IMediaReader Inheritance object DynamicSoundSource StreamedBufferSoundSource Implements IDisposable IMediaExtractor IMediaReader Inherited Members DynamicSoundSource.Logger DynamicSoundSource.NewSources DynamicSoundSource.Sources DynamicSoundSource.Commands DynamicSoundSource.ReadyToPlay DynamicSoundSource.Ended DynamicSoundSource.deviceBuffers DynamicSoundSource.freeBuffers DynamicSoundSource.soundInstance DynamicSoundSource.isInitialized DynamicSoundSource.isDisposed DynamicSoundSource.state DynamicSoundSource.playingQueued DynamicSoundSource.Dispose() DynamicSoundSource.Play() DynamicSoundSource.Pause() DynamicSoundSource.Stop() DynamicSoundSource.IsPausedOrPlaying DynamicSoundSource.RestartInternal() DynamicSoundSource.PlayInternal() DynamicSoundSource.PauseInternal() DynamicSoundSource.StopInternal(bool) DynamicSoundSource.FillBuffer(nint, int, AudioLayer.BufferType) DynamicSoundSource.FillBuffer(short[], int, AudioLayer.BufferType) DynamicSoundSource.FillBuffer(byte[], int, AudioLayer.BufferType) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors StreamedBufferSoundSource(SoundInstanceStreamedBuffer, MediaSynchronizer, string, long, long) public StreamedBufferSoundSource(SoundInstanceStreamedBuffer instance, MediaSynchronizer synchronizer, string mediaDataUrl, long startPosition, long length) Parameters instance SoundInstanceStreamedBuffer synchronizer MediaSynchronizer mediaDataUrl string startPosition long length long Properties CanFill Checks if a buffer can be filled, before calling FillBuffer this should be checked. protected override bool CanFill { get; } Property Value bool Channels public int Channels { get; } Property Value int IsDisposed Specifies if the extractor has been disposed public bool IsDisposed { get; } Property Value bool MaxNumberOfBuffers Max number of buffers that are going to be queued. public override int MaxNumberOfBuffers { get; } Property Value int MediaCurrentTime Gets the current presentation time of the media public TimeSpan MediaCurrentTime { get; set; } Property Value TimeSpan MediaDuration Returns the total duration of the media public TimeSpan MediaDuration { get; } Property Value TimeSpan MediaType Returns the type of media that is extracted public MediaType MediaType { get; } Property Value MediaType PlayRange Gets or sets the region of time to play from the audio clip. public override PlayRange PlayRange { get; set; } Property Value PlayRange SampleRate public int SampleRate { get; } Property Value int SpeedFactor Set the play speed of the media public float SpeedFactor { get; set; } Property Value float Methods DisposeInternal() Destroys the instance. protected override void DisposeInternal() ExtractAndFillData() protected override void ExtractAndFillData() InitializeInternal() protected override void InitializeInternal() PrepareInternal() Prepare the source for playback protected override void PrepareInternal() ReachedEndOfMedia() Specifies if the end of the media has been reached. public bool ReachedEndOfMedia() Returns bool Seek(TimeSpan) Seek to provided position in the media source. public void Seek(TimeSpan mediaTime) Parameters mediaTime TimeSpan SeekInternal() Should be called from working thread only (or add proper locks) protected override void SeekInternal() SeekRequestCompleted() Indicate if a previous seek request has been completed. public bool SeekRequestCompleted() Returns bool SetLooped(bool) Sets if the stream should be played in loop public override void SetLooped(bool loop) Parameters loop bool if looped or not UpdateInternal() Update the sound source protected override void UpdateInternal()"
  },
  "api/Stride.Audio.html": {
    "href": "api/Stride.Audio.html",
    "title": "Namespace Stride.Audio | Stride API",
    "summary": "Namespace Stride.Audio Classes AudioDevice Reprensent an Audio Hardware Device. Can be used when creating an AudioEngine to specify the device on which to play the sound. AudioDeviceInvalidatedException The exception that is thrown when the audio device became unusable through being unplugged or some other event. AudioEmitter Represents a 3D audio emitter in the audio scene. This object, used in combination with an AudioListener, can simulate 3D audio localization effects for a given sound implementing the IPositionableSound interface. For more details take a look at the Apply3D(AudioEmitter) function. AudioEmitterProcessor Processor in charge of updating the AudioEmitterComponents. AudioEmitterProcessor.AssociatedData Data associated to each Entity instances of the system having an AudioEmitterComponent and an TransformComponent. AudioEmitterSoundController This class is used to control a SoundBase associated to a AudioEmitterComponent. AudioEngine Represents the audio engine. In current version, the audio engine necessarily creates its context on the default audio hardware of the device. The audio engine is required when creating or loading sounds. AudioEngineFactory AudioEngineSettings AudioInitializationException The exception that is thrown when audio engine failed to initialized. Most of the time is happens when no hardware is present, or when audio hardware is installed, but it is not enabled or where there is no output connected. AudioLayer Wrapper around OpenAL AudioListener Represents a 3D audio listener in the audio scene. This object, used in combination with an AudioEmitter, can simulate 3D audio localization effects for a sound implemention the IPositionableSound interface. For more details take a look at the Apply3D(AudioEmitter) function. AudioListenerProcessor Processor in charge of creating and updating the AudioListener data associated to the scene AudioListenerComponents. AudioSystem The Audio System. It creates an underlying instance of AudioEngine. AudioSystemInternalException The exception that is thrown when an internal error happened in the Audio System. That is an error that is not due to the user behaviour. CompressedSoundPacket Used internally in SoundAsset DynamicSoundSource NoMicrophoneConnectedException The exception that is thrown when Stride.Audio.Microphone API calls are made on a disconnected microphone. Sound Sound content. SoundBase Base class for a Sound content. SoundInstance Base class for sound that creates voices SoundInstanceStreamedBuffer A Sound Instance where the SoundSource comes from a StreamedBufferSoundSource, and implementing ISynchronizedMediaExtractor interface StreamedBufferSound Sound streamed buffer StreamedBufferSoundSource Structs AudioLayer.Buffer AudioLayer.Device AudioLayer.Listener AudioLayer.Source Interfaces IAudioEngineProvider Used internally to find the currently active audio engine IPlayableSound Interface for a playable sound. A playable sound can loop (ref IsLooping), be played (ref Play()), be paused (ref Pause()), be resumed (ref Play()), be stopped (ref Stop()) and be attenuated (ref Volume). To query the current state of a sound use the PlayState property. To stop a sound after its currently loop set IsLooping = false; IPositionableSound Interface for 3D localizable sound. The interface currently supports only mono and stereo sounds (ref Pan). The user can localize its sound with Apply3D(AudioEmitter) by creating one AudioEmitter and one AudioListener respectly corresponding to the source of the sound and the listener. The Pan function enable the user to change the distribution of sound between the left and right speakers. Enums AudioEngineState Describe the possible states of the AudioEngine. AudioLayer.BufferType AudioLayer.DeviceFlags DynamicSoundSource.AsyncCommand The possible async commands that can be queued and be handled by subclasses HrtfEnvironment"
  },
  "api/Stride.BepuPhysics.BepuConfiguration.html": {
    "href": "api/Stride.BepuPhysics.BepuConfiguration.html",
    "title": "Class BepuConfiguration | Stride API",
    "summary": "Class BepuConfiguration Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll [DataContract] [Display(\"Bepu Configuration\", null)] public class BepuConfiguration : Configuration, IService Inheritance object Configuration BepuConfiguration Implements IService Inherited Members Configuration.OfflineOnly Extension Methods UnsafeUtilities.As<T>(object?) Fields BepuSimulations public List<BepuSimulation> BepuSimulations Field Value List<BepuSimulation> Methods NewInstance(IServiceRegistry) public static IService NewInstance(IServiceRegistry services) Parameters services IServiceRegistry Returns IService"
  },
  "api/Stride.BepuPhysics.BepuSimulation.TickAwaiter.html": {
    "href": "api/Stride.BepuPhysics.BepuSimulation.TickAwaiter.html",
    "title": "Struct BepuSimulation.TickAwaiter | Stride API",
    "summary": "Struct BepuSimulation.TickAwaiter Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll Await this struct to continue during a physics tick public struct BepuSimulation.TickAwaiter : INotifyCompletion Implements INotifyCompletion Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties IsCompleted public bool IsCompleted { get; } Property Value bool Methods GetAwaiter() public BepuSimulation.TickAwaiter GetAwaiter() Returns BepuSimulation.TickAwaiter GetResult() public void GetResult() OnCompleted(Action) Schedules the continuation action that's invoked when the instance completes. public void OnCompleted(Action continuation) Parameters continuation Action The action to invoke when the operation completes. Exceptions ArgumentNullException The continuation argument is null (Nothing in Visual Basic)."
  },
  "api/Stride.BepuPhysics.BepuSimulation.html": {
    "href": "api/Stride.BepuPhysics.BepuSimulation.html",
    "title": "Class BepuSimulation | Stride API",
    "summary": "Class BepuSimulation Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll [DataContract] public sealed class BepuSimulation : IDisposable Inheritance object BepuSimulation Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors BepuSimulation() public BepuSimulation() Fields CollisionMatrix Defines how layers collide between each other. public CollisionMatrix CollisionMatrix Field Value CollisionMatrix Remarks This structure is VERY large, prefer referencing it directly instead of passing it around. Properties AssociatedScene The scene associated with this simulation. public UrlReference<Scene>? AssociatedScene { get; set; } Property Value UrlReference<Scene> Remarks When this is set, entities spawning inside this scene will be automatically associated with this simulation as long as their SimulationSelector is set to SceneBasedSimulationSelector. See SceneBasedSimulationSelector for more info. Deterministic Whether to use a deterministic time step when using multithreading. When set to true, additional time is spent sorting constraint additions and transfers. [Display(2, \"Deterministic\", null)] public bool Deterministic { get; set; } Property Value bool Remarks This can only affect determinism locally- different processor architectures may implement instructions differently. There is also some performance cost Enabled Whether to update the simulation. [Display(0, \"Enabled\", null)] public bool Enabled { get; set; } Property Value bool Remarks False also disables contact processing but won't prevent re-synchronization of static physics bodies to their engine counterpart FixedTimeStep The amount of time between individual simulation steps/ticks, by default ~16.67 milliseconds which would run 60 ticks per second public TimeSpan FixedTimeStep { get; set; } Property Value TimeSpan Remarks Larger values improve performance at the cost of stability and precision. FixedTimeStepSeconds The number of seconds per step to simulate. Lossy, prefer FixedTimeStep. [Display(3, \"Fixed Time Step (s)\", \"Time\")] public double FixedTimeStepSeconds { get; set; } Property Value double Layer0 [Display(null, \"Collision Matrix\")] public CollisionMask Layer0 { get; set; } Property Value CollisionMask Layer1 [Display(null, \"Collision Matrix\")] public CollisionMask Layer1 { get; set; } Property Value CollisionMask Layer10 [Display(null, \"Collision Matrix\")] public CollisionMask Layer10 { get; set; } Property Value CollisionMask Layer11 [Display(null, \"Collision Matrix\")] public CollisionMask Layer11 { get; set; } Property Value CollisionMask Layer12 [Display(null, \"Collision Matrix\")] public CollisionMask Layer12 { get; set; } Property Value CollisionMask Layer13 [Display(null, \"Collision Matrix\")] public CollisionMask Layer13 { get; set; } Property Value CollisionMask Layer14 [Display(null, \"Collision Matrix\")] public CollisionMask Layer14 { get; set; } Property Value CollisionMask Layer15 [Display(null, \"Collision Matrix\")] public CollisionMask Layer15 { get; set; } Property Value CollisionMask Layer16 [Display(null, \"Collision Matrix\")] public CollisionMask Layer16 { get; set; } Property Value CollisionMask Layer17 [Display(null, \"Collision Matrix\")] public CollisionMask Layer17 { get; set; } Property Value CollisionMask Layer18 [Display(null, \"Collision Matrix\")] public CollisionMask Layer18 { get; set; } Property Value CollisionMask Layer19 [Display(null, \"Collision Matrix\")] public CollisionMask Layer19 { get; set; } Property Value CollisionMask Layer2 [Display(null, \"Collision Matrix\")] public CollisionMask Layer2 { get; set; } Property Value CollisionMask Layer20 [Display(null, \"Collision Matrix\")] public CollisionMask Layer20 { get; set; } Property Value CollisionMask Layer21 [Display(null, \"Collision Matrix\")] public CollisionMask Layer21 { get; set; } Property Value CollisionMask Layer22 [Display(null, \"Collision Matrix\")] public CollisionMask Layer22 { get; set; } Property Value CollisionMask Layer23 [Display(null, \"Collision Matrix\")] public CollisionMask Layer23 { get; set; } Property Value CollisionMask Layer24 [Display(null, \"Collision Matrix\")] public CollisionMask Layer24 { get; set; } Property Value CollisionMask Layer25 [Display(null, \"Collision Matrix\")] public CollisionMask Layer25 { get; set; } Property Value CollisionMask Layer26 [Display(null, \"Collision Matrix\")] public CollisionMask Layer26 { get; set; } Property Value CollisionMask Layer27 [Display(null, \"Collision Matrix\")] public CollisionMask Layer27 { get; set; } Property Value CollisionMask Layer28 [Display(null, \"Collision Matrix\")] public CollisionMask Layer28 { get; set; } Property Value CollisionMask Layer29 [Display(null, \"Collision Matrix\")] public CollisionMask Layer29 { get; set; } Property Value CollisionMask Layer3 [Display(null, \"Collision Matrix\")] public CollisionMask Layer3 { get; set; } Property Value CollisionMask Layer30 [Display(null, \"Collision Matrix\")] public CollisionMask Layer30 { get; set; } Property Value CollisionMask Layer31 [Display(null, \"Collision Matrix\")] public CollisionMask Layer31 { get; set; } Property Value CollisionMask Layer4 [Display(null, \"Collision Matrix\")] public CollisionMask Layer4 { get; set; } Property Value CollisionMask Layer5 [Display(null, \"Collision Matrix\")] public CollisionMask Layer5 { get; set; } Property Value CollisionMask Layer6 [Display(null, \"Collision Matrix\")] public CollisionMask Layer6 { get; set; } Property Value CollisionMask Layer7 [Display(null, \"Collision Matrix\")] public CollisionMask Layer7 { get; set; } Property Value CollisionMask Layer8 [Display(null, \"Collision Matrix\")] public CollisionMask Layer8 { get; set; } Property Value CollisionMask Layer9 [Display(null, \"Collision Matrix\")] public CollisionMask Layer9 { get; set; } Property Value CollisionMask MaxStepPerFrame Represents the maximum number of steps per frame to avoid a death loop [Display(5, \"Max steps/frame\", \"Time\")] public int MaxStepPerFrame { get; set; } Property Value int ParallelUpdate Allow entity synchronization to occur across multiple threads instead of just the main thread [Display(1, \"Parallel Update\", null)] public bool ParallelUpdate { get; set; } Property Value bool PoseAngularDamping Controls angular damping, how fast object loose their angular velocity [Display(9, \"Angular Damping\", \"Forces\")] public float PoseAngularDamping { get; set; } Property Value float PoseGravity Global gravity settings. This gravity will be applied to all bodies in the simulations that are not kinematic. [Display(7, \"Gravity\", \"Forces\")] public Vector3 PoseGravity { get; set; } Property Value Vector3 PoseLinearDamping Controls linear damping, how fast object loose their linear velocity [Display(8, \"Linear Damping\", \"Forces\")] public float PoseLinearDamping { get; set; } Property Value float Simulation Accessing and altering this object is inherently unsupported and unsafe, this is the internal bepu simulation. public Simulation Simulation { get; } Property Value Simulation SoftStartDuration The duration for the SoftStart; when the simulation starts up, more SolverSubStep run to improve constraints stability and let them come to rest sooner. [Display(12, \"SoftStart Duration\", \"Constraints\")] public TimeSpan SoftStartDuration { get; set; } Property Value TimeSpan Remarks Negative or 0 disables this feature. SoftStartSubstepFactor Multiplier over SolverSubStep during Soft Start [Display(13, \"SoftStart Substep factor\", \"Constraints\")] public int SoftStartSubstepFactor { get; set; } Property Value int SolverIteration The number of iterations for the solver [Display(10, \"Solver Iteration\", \"Constraints\")] public int SolverIteration { get; init; } Property Value int Remarks Smaller values improve performance at the cost of stability and precision. SolverSubStep The number of sub-steps used when solving constraints [Display(11, \"Solver SubStep\", \"Constraints\")] public int SolverSubStep { get; init; } Property Value int Remarks Smaller values improve performance at the cost of stability and precision. ThreadCount The number of threads the simulation runs on. [Display(-1, \"Thread Count\", null)] public int ThreadCount { get; set; } Property Value int Remarks A negative value results in automatic thread selection. TimeScale The speed of the simulation compared to real-time. [Display(4, \"Time Scale\", \"Time\")] public float TimeScale { get; set; } Property Value float Remarks This stacks with GameTime.Factor, changing that one already affects the simulation speed. UsePerBodyAttributes Allows for per-body features like Gravity at a cost to the simulation's performance [Display(6, \"Per Body Attributes\", \"Forces\")] public bool UsePerBodyAttributes { get; set; } Property Value bool Remarks Gravity will be ignored if this is false. Methods AfterUpdate() Yields execution until right after the next physics tick public BepuSimulation.TickAwaiter AfterUpdate() Returns BepuSimulation.TickAwaiter Task that will resume next tick. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() GetComponent(BodyHandle) public BodyComponent GetComponent(BodyHandle handle) Parameters handle BodyHandle Returns BodyComponent GetComponent(CollidableReference) public CollidableComponent GetComponent(CollidableReference collidable) Parameters collidable CollidableReference Returns CollidableComponent GetComponent(StaticHandle) public StaticComponent GetComponent(StaticHandle handle) Parameters handle StaticHandle Returns StaticComponent NextUpdate() Yields execution until right before the next physics tick public BepuSimulation.TickAwaiter NextUpdate() Returns BepuSimulation.TickAwaiter Task that will resume next tick. OverlapInfo<TShape>(in TShape, in RigidPose, Span<OverlapInfoStack>, CollisionMask) Enumerates all overlap info for any shape and sub-shapes found to be overlapping with shape public ConversionEnum<ManagedConverter, OverlapInfoStack, OverlapInfo> OverlapInfo<TShape>(in TShape shape, in RigidPose pose, Span<OverlapInfoStack> buffer, CollisionMask collisionMask = CollisionMask.Everything) where TShape : unmanaged, IConvexShape Parameters shape TShape The shape used to test for overlap pose RigidPose Position the shape is on for this test buffer Span<OverlapInfoStack> A temporary buffer which is used as a backing array to write to, its length defines the maximum amount of info you want to read. It is used by the returned enumerator as its backing array from which you read collisionMask CollisionMask Which layer should be hit Returns ConversionEnum<ManagedConverter, OverlapInfoStack, OverlapInfo> Type Parameters TShape A bepu BepuPhysics.Collidables.IConvexShape representing the shape that will be used when testing for overlap Remarks Multiple info may come from the same CollidableComponent when it is a compound shape Overlap<TShape>(in TShape, in RigidPose, ICollection<OverlapInfo>, CollisionMask) Appends any physics object into collection if it was found to be overlapping with shape public void Overlap<TShape>(in TShape shape, in RigidPose pose, ICollection<OverlapInfo> collection, CollisionMask collisionMask = CollisionMask.Everything) where TShape : unmanaged, IConvexShape Parameters shape TShape The shape used to test for overlap pose RigidPose Position the shape is on for this test collection ICollection<OverlapInfo> The collection used to store overlapped shapes into. Note that the collection is not cleared before items are added to it collisionMask CollisionMask Which layer should be hit Type Parameters TShape Remarks The collection is not cleared before appending items into it Overlap<TShape>(in TShape, in RigidPose, Span<CollidableStack>, CollisionMask) Enumerates any physics object found to be overlapping with shape public ConversionEnum<ManagedConverter, CollidableStack, CollidableComponent> Overlap<TShape>(in TShape shape, in RigidPose pose, Span<CollidableStack> buffer, CollisionMask collisionMask = CollisionMask.Everything) where TShape : unmanaged, IConvexShape Parameters shape TShape The shape used to test for overlap pose RigidPose Position the shape is on for this test buffer Span<CollidableStack> A temporary buffer which is used as a backing array to write to, its length defines the maximum amount of info you want to read. It is used by the returned enumerator as its backing array from which you read collisionMask CollisionMask Which layer should be hit Returns ConversionEnum<ManagedConverter, CollidableStack, CollidableComponent> Type Parameters TShape A bepu BepuPhysics.Collidables.IConvexShape representing the shape that will be used when testing for overlap RayCast(in Vector3, in Vector3, float, out HitInfo, CollisionMask) Finds the closest intersection between this ray and shapes in the simulation. public bool RayCast(in Vector3 origin, in Vector3 dir, float maxDistance, out HitInfo result, CollisionMask collisionMask = CollisionMask.Everything) Parameters origin Vector3 The start position for this ray dir Vector3 The normalized direction the ray is facing maxDistance float The maximum distance from the origin that hits will be collected result HitInfo An intersection in the world when this method returns true, an undefined value when this method returns false collisionMask CollisionMask Which layer should be hit Returns bool True when the given ray intersects with a shape, false otherwise RayCastPenetrating(in Vector3, in Vector3, float, ICollection<HitInfo>, CollisionMask) Collect intersections between the given ray and shapes in this simulation. Hits are NOT sorted. public void RayCastPenetrating(in Vector3 origin, in Vector3 dir, float maxDistance, ICollection<HitInfo> collection, CollisionMask collisionMask = CollisionMask.Everything) Parameters origin Vector3 The start position for this ray dir Vector3 The normalized direction the ray is facing maxDistance float The maximum distance from the origin that hits will be collected collection ICollection<HitInfo> The collection used to store hits into, the collection is not cleared before usage, hits are appended to it collisionMask CollisionMask Which layer should be hit Remarks There are no guarantees as to the order hits are returned in. RayCastPenetrating(in Vector3, in Vector3, float, Span<HitInfoStack>, CollisionMask) Collect intersections between the given ray and shapes in this simulation. public ConversionEnum<ManagedConverter, HitInfoStack, HitInfo> RayCastPenetrating(in Vector3 origin, in Vector3 dir, float maxDistance, Span<HitInfoStack> buffer, CollisionMask collisionMask = CollisionMask.Everything) Parameters origin Vector3 The start position for this ray dir Vector3 The normalized direction the ray is facing maxDistance float The maximum distance from the origin that hits will be collected buffer Span<HitInfoStack> A temporary buffer which is used as a backing array to write to, its length defines the maximum amount of info you want to read. It is used by the returned enumerator as its backing array from which you read collisionMask CollisionMask Which layer should be hit Returns ConversionEnum<ManagedConverter, HitInfoStack, HitInfo> Remarks When there are more hits than buffer can accomodate, returns only the closest hits. There are no guarantees as to the order hits are returned in. ResetSoftStart() Reset the SoftStart to SoftStartDuration. public void ResetSoftStart() ShouldPerformPhysicsTest(CollisionMask, CollidableReference) Whether a physics test with mask against collidable should be performed or entirely ignored public bool ShouldPerformPhysicsTest(CollisionMask mask, CollidableReference collidable) Parameters mask CollisionMask collidable CollidableReference Returns bool True when it should be performed, false when it should be ignored SweepCastPenetrating<TShape>(in TShape, in RigidPose, in BodyVelocity, float, ICollection<HitInfo>, CollisionMask) Finds contacts between shape and other shapes in the simulation when thrown in velocity direction. public void SweepCastPenetrating<TShape>(in TShape shape, in RigidPose pose, in BodyVelocity velocity, float maxDistance, ICollection<HitInfo> collection, CollisionMask collisionMask = CollisionMask.Everything) where TShape : unmanaged, IConvexShape Parameters shape TShape The shape thrown at the scene pose RigidPose Initial position for the shape velocity BodyVelocity Velocity used to throw the shape maxDistance float The maximum distance, or amount of time along the path of the velocity collection ICollection<HitInfo> The collection used to store hits into, the collection is not cleared before usage, hits are appended to it collisionMask CollisionMask Which layer should be hit Type Parameters TShape Remarks There are no guarantees as to the order hits are returned in. SweepCastPenetrating<TShape>(in TShape, in RigidPose, in BodyVelocity, float, Span<HitInfoStack>, CollisionMask) Finds contacts between shape and other shapes in the simulation when thrown in velocity direction. public ConversionEnum<ManagedConverter, HitInfoStack, HitInfo> SweepCastPenetrating<TShape>(in TShape shape, in RigidPose pose, in BodyVelocity velocity, float maxDistance, Span<HitInfoStack> buffer, CollisionMask collisionMask = CollisionMask.Everything) where TShape : unmanaged, IConvexShape Parameters shape TShape The shape thrown at the scene pose RigidPose Initial position for the shape velocity BodyVelocity Velocity used to throw the shape maxDistance float The maximum distance, or amount of time along the path of the velocity buffer Span<HitInfoStack> A temporary buffer which is used as a backing array to write to, its length defines the maximum amount of info you want to read. It is used by the returned enumerator as its backing array from which you read collisionMask CollisionMask Which layer should be hit Returns ConversionEnum<ManagedConverter, HitInfoStack, HitInfo> Type Parameters TShape Remarks When there are more hits than buffer can accomodate, returns only the closest hits There are no guarantees as to the order hits are returned in. SweepCast<TShape>(in TShape, in RigidPose, in BodyVelocity, float, out HitInfo, CollisionMask) Finds the closest contact between shape and other shapes in the simulation when thrown in velocity direction. public bool SweepCast<TShape>(in TShape shape, in RigidPose pose, in BodyVelocity velocity, float maxDistance, out HitInfo result, CollisionMask collisionMask = CollisionMask.Everything) where TShape : unmanaged, IConvexShape Parameters shape TShape The shape thrown at the scene pose RigidPose Initial position for the shape velocity BodyVelocity Velocity used to throw the shape maxDistance float The maximum distance, or amount of time along the path of the velocity result HitInfo The resulting contact when this method returns true, an undefined value when this method returns false collisionMask CollisionMask Which layer should be hit Returns bool True when the given ray intersects with a shape, false otherwise Type Parameters TShape"
  },
  "api/Stride.BepuPhysics.BodyComponent.html": {
    "href": "api/Stride.BepuPhysics.BodyComponent.html",
    "title": "Class BodyComponent | Stride API",
    "summary": "Class BodyComponent Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll [ComponentCategory(\"Physics - Bepu\")] public class BodyComponent : CollidableComponent, IIdentifiable Inheritance object EntityComponent CollidableComponent BodyComponent Implements IIdentifiable Derived CharacterComponent Inherited Members CollidableComponent.CategoryCollider CollidableComponent.CategoryForces CollidableComponent.CategoryContacts CollidableComponent.CategoryActivity CollidableComponent.ShapeIndex CollidableComponent.Simulation CollidableComponent.Collider CollidableComponent.SpringFrequency CollidableComponent.SpringDampingRatio CollidableComponent.FrictionCoefficient CollidableComponent.MaximumRecoveryVelocity CollidableComponent.SimulationSelector CollidableComponent.CollisionLayer CollidableComponent.CollisionGroup CollidableComponent.ContactEventHandler CollidableComponent.CenterOfMass CollidableComponent.TryUpdateMaterialProperties() CollidableComponent.RegisterContactHandler() CollidableComponent.UnregisterContactHandler() CollidableComponent.IsContactHandlerRegistered() CollidableComponent.RayCast(in Vector3, in Vector3, float, out HitInfo) CollidableComponent.RayCastPenetrating(in Vector3, in Vector3, float, Span<HitInfoStack>) CollidableComponent.RayCastPenetrating(in Vector3, in Vector3, float, ICollection<HitInfo>) EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties AngularVelocity The rotation velocity in unit per second public Vector3 AngularVelocity { get; set; } Property Value Vector3 Remarks The rotation format is in axis-angle, meaning that AngularVelocity.Normalized is the axis of rotation, while AngularVelocity.Length is the amount of rotation around that axis in radians per second Awake Whether the body is being actively simulated. Setting this to true will attempt to wake the body; setting it to false will force the body and any constraint-connected bodies asleep. public bool Awake { get; set; } Property Value bool BodyInertia The mass and inertia tensor of this body public BodyInertia BodyInertia { get; set; } Property Value BodyInertia CollidableReference protected override CollidableReference? CollidableReference { get; } Property Value CollidableReference? Constraints The constraints targeting this body, some of those may not be Attached public IReadOnlyList<ConstraintComponentBase> Constraints { get; } Property Value IReadOnlyList<ConstraintComponentBase> ContinuousDetection Determines the continuous collision detection configuration set for that object. Helps prevent fast-moving objects from tunneling through other objects. public ContinuousDetection ContinuousDetection { get; set; } Property Value ContinuousDetection ContinuousDetectionMode Whether the object's path or only its destination is checked for collision when moving, prevents objects from passing through each other at higher speed [Display(null, \"Forces\")] public ContinuousDetectionMode ContinuousDetectionMode { get; set; } Property Value ContinuousDetectionMode Remarks This property is a shortcut to the ContinuousDetection.BepuPhysics.Collidables.ContinuousDetection.Mode property Gravity Whether gravity should affect the simulation's PoseGravity [Display(null, \"Forces\")] public bool Gravity { get; set; } Property Value bool Remarks Gravity is always active if UsePerBodyAttributes is false InterpolationMode Controls whether and how the motion of this body is smoothed out between physics update [Display(null, \"Forces\")] public InterpolationMode InterpolationMode { get; set; } Property Value InterpolationMode Kinematic When kinematic is set, the object will not be affected by physics forces like gravity or collisions but will still push away bodies it collides with. [Display(null, \"Forces\")] public bool Kinematic { get; set; } Property Value bool LinearVelocity The translation velocity in unit per second public Vector3 LinearVelocity { get; set; } Property Value Vector3 MaterialProperties protected override ref MaterialProperties MaterialProperties { get; } Property Value MaterialProperties MinimumTimestepCountUnderThreshold The number of time steps that the body must be under the sleep threshold before the body becomes a sleeping candidate. Note that the body is not guaranteed to go to sleep immediately after meeting this minimum. [Display(null, \"Activity\")] public byte MinimumTimestepCountUnderThreshold { get; set; } Property Value byte Orientation The rotation of this body in the physics scene, setting it will 'teleport' this object's rotation to the one provided. public Quaternion Orientation { get; set; } Property Value Quaternion Remarks Using this property to move objects around is not recommended, as it disregards any collider that may overlap with the body at this new orientation, you should make sure the area is clear to ensure this object does not become stuck in the scenery. Pose protected override RigidPose? Pose { get; } Property Value RigidPose? Position The position of this body in the physics scene, setting it will teleport this object to the position provided. public Vector3 Position { get; set; } Property Value Vector3 Remarks Using this property to move objects around is not recommended, as it disregards any collider that may overlap with the body at this new position, you should make sure the area is clear to ensure this object does not become stuck in the scenery. This value is slightly offset from this entity's Transform Position based on its CenterOfMass PreviousAngularVelocity The rotation velocity in unit per second during the previous physics tick public Vector3 PreviousAngularVelocity { get; } Property Value Vector3 Remarks The rotation format is in axis-angle, meaning that AngularVelocity.Normalized is the axis of rotation, while AngularVelocity.Length is the amount of rotation around that axis in radians per second PreviousLinearVelocity The translation velocity in unit per second during the previous physics tick public Vector3 PreviousLinearVelocity { get; } Property Value Vector3 SleepThreshold Threshold of squared combined velocity under which the body is allowed to go to sleep. Setting this to a negative value guarantees the body cannot go to sleep without user action. [Display(null, \"Activity\")] public float SleepThreshold { get; set; } Property Value float SpeculativeMargin Automatically computed size of the margin around the surface of the shape in which contacts can be generated. These contacts will have negative depth and only contribute if the frame's velocities would push the shapes of a pair into overlap. This is automatically set by bounding box prediction each frame, and is bound by the collidable's BepuPhysics.Collidables.Collidable.MinimumSpeculativeMargin and BepuPhysics.Collidables.Collidable.MaximumSpeculativeMargin values. The effective speculative margin for a collision pair can also be modified from BepuPhysics.CollisionDetection.INarrowPhaseCallbacks callbacks. This should be positive to avoid jittering. It can also be used as a form of continuous collision detection, but excessively high values combined with fast motion may result in visible 'ghost collision' artifacts. For continuous collision detection with less chance of ghost collisions, use BepuPhysics.Collidables.ContinuousDetectionMode.Continuous. If using BepuPhysics.Collidables.ContinuousDetectionMode.Continuous, consider setting BepuPhysics.Collidables.Collidable.MaximumSpeculativeMargin to a smaller value to help filter ghost collisions. For more information, see the Continuous Collision Detection documentation. public float SpeculativeMargin { get; set; } Property Value float Methods ApplyAngularImpulse(Vector3) Applies an explosive force which will only affect this body's angular velocity public void ApplyAngularImpulse(Vector3 impulse) Parameters impulse Vector3 Remarks Does not wake the body up ApplyImpulse(Vector3, Vector3) Applies an explosive force at a specific offset off of this body which will affect both its angular and linear velocity public void ApplyImpulse(Vector3 impulse, Vector3 impulseOffset) Parameters impulse Vector3 Impulse to apply to the velocity impulseOffset Vector3 World space offset from the center of the body to apply the impulse at Remarks Does not wake the body up ApplyLinearImpulse(Vector3) Applies an explosive force which will only affect this body's linear velocity public void ApplyLinearImpulse(Vector3 impulse) Parameters impulse Vector3 Remarks Does not wake the body up AttachInner(RigidPose, BodyInertia, TypedIndex) Called every time this is added to a simulation protected override void AttachInner(RigidPose pose, BodyInertia shapeInertia, TypedIndex shapeIndex) Parameters pose RigidPose shapeInertia BodyInertia shapeIndex TypedIndex Remarks May occur when certain larger changes are made to the object, Simulation is the one this object is being added to DetachInner() Called every time this is removed from the simulation protected override void DetachInner() Remarks May occur right before AttachInner(RigidPose, BodyInertia, TypedIndex) when certain larger changes are made to the object, Simulation is the one this object was on prior to detaching SetPose(Vector3, Quaternion) Teleport this body into a new pose [Obsolete(\"This method will be removed in the future, use Teleport instead\")] public void SetPose(Vector3 position, Quaternion orientation) Parameters position Vector3 orientation Quaternion Remarks Using this function to move objects around is not recommended, as it disregards any collider that may overlap with the body at this new position, you should make sure the area is clear to ensure this object does not become stuck in the scenery. position is slightly offset from this entity's Transform Position based on its CenterOfMass SetTargetPose(Vector3, Quaternion) Set the pose this body should try to match on the next physics tick, this will collide with objects on the way public void SetTargetPose(Vector3 targetPosition, Quaternion targetOrientation) Parameters targetPosition Vector3 targetOrientation Quaternion Remarks Using this function to move objects around is not recommended as it results in unrealistic forces being applied on this body, or unexpected stuttering depending on the input. Consider using a constraint between this body and whatever it is following, or using the different Impulse methods instead targetPosition is slightly offset from this entity's Transform Position based on its CenterOfMass This method sets this body's LinearVelocity and AngularVelocity, setting these properties after the call would overwrite the result of this method Teleport(Vector3, Quaternion) Teleport this body into a new pose public void Teleport(Vector3 position, Quaternion orientation) Parameters position Vector3 orientation Quaternion Remarks Using this function to move objects around is not recommended, as it disregards any collider that may overlap with the body at this new position, you should make sure the area is clear to ensure this object does not become stuck in the scenery. position is slightly offset from this entity's Transform Position based on its CenterOfMass"
  },
  "api/Stride.BepuPhysics.CharacterComponent.html": {
    "href": "api/Stride.BepuPhysics.CharacterComponent.html",
    "title": "Class CharacterComponent | Stride API",
    "summary": "Class CharacterComponent Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll [ComponentCategory(\"Physics - Bepu\")] public class CharacterComponent : BodyComponent, IIdentifiable, ISimulationUpdate, IComponent<ISimulationUpdate.SimUpdateProcessor, ISimulationUpdate>, IMarkedComponent, IContactHandler Inheritance object EntityComponent CollidableComponent BodyComponent CharacterComponent Implements IIdentifiable ISimulationUpdate IComponent<ISimulationUpdate.SimUpdateProcessor, ISimulationUpdate> IMarkedComponent IContactHandler Inherited Members BodyComponent.Kinematic BodyComponent.Gravity BodyComponent.ContinuousDetectionMode BodyComponent.InterpolationMode BodyComponent.SleepThreshold BodyComponent.MinimumTimestepCountUnderThreshold BodyComponent.Awake BodyComponent.LinearVelocity BodyComponent.AngularVelocity BodyComponent.PreviousLinearVelocity BodyComponent.PreviousAngularVelocity BodyComponent.Position BodyComponent.Orientation BodyComponent.BodyInertia BodyComponent.SpeculativeMargin BodyComponent.ContinuousDetection BodyComponent.Constraints BodyComponent.CollidableReference BodyComponent.ApplyImpulse(Vector3, Vector3) BodyComponent.ApplyAngularImpulse(Vector3) BodyComponent.ApplyLinearImpulse(Vector3) BodyComponent.SetTargetPose(Vector3, Quaternion) BodyComponent.Teleport(Vector3, Quaternion) BodyComponent.SetPose(Vector3, Quaternion) BodyComponent.MaterialProperties BodyComponent.Pose BodyComponent.DetachInner() CollidableComponent.CategoryCollider CollidableComponent.CategoryForces CollidableComponent.CategoryContacts CollidableComponent.CategoryActivity CollidableComponent.ShapeIndex CollidableComponent.Simulation CollidableComponent.Collider CollidableComponent.SpringFrequency CollidableComponent.SpringDampingRatio CollidableComponent.FrictionCoefficient CollidableComponent.MaximumRecoveryVelocity CollidableComponent.SimulationSelector CollidableComponent.CollisionLayer CollidableComponent.CollisionGroup CollidableComponent.ContactEventHandler CollidableComponent.CenterOfMass CollidableComponent.TryUpdateMaterialProperties() CollidableComponent.RegisterContactHandler() CollidableComponent.UnregisterContactHandler() CollidableComponent.IsContactHandlerRegistered() CollidableComponent.RayCast(in Vector3, in Vector3, float, out HitInfo) CollidableComponent.RayCastPenetrating(in Vector3, in Vector3, float, Span<HitInfoStack>) CollidableComponent.RayCastPenetrating(in Vector3, in Vector3, float, ICollection<HitInfo>) EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Constructors CharacterComponent() public CharacterComponent() Properties Contacts Order is not guaranteed and may change at any moment public List<(CollidableComponent Source, Contact Contact)> Contacts { get; } Property Value List<(CollidableComponent Source, Contact Contact)> IsGrounded public bool IsGrounded { get; protected set; } Property Value bool IsJumping public bool IsJumping { get; } Property Value bool JumpForce Force of the impulse applied when calling TryJump() [DataAlias(\"JumpSpeed\")] public float JumpForce { get; set; } Property Value float NoContactResponse protected bool NoContactResponse { get; } Property Value bool Speed Base speed applied when moving, measured in units per second public float Speed { get; set; } Property Value float Velocity public Vector3 Velocity { get; set; } Property Value Vector3 Methods AfterSimulationUpdate(BepuSimulation, float) This is called internally right after the physics simulation does a tick public virtual void AfterSimulationUpdate(BepuSimulation sim, float simTimeStep) Parameters sim BepuSimulation The simulation this ISimulationUpdate is bound to, and the one currently updating simTimeStep float The amount of time in seconds since the last simulation AttachInner(RigidPose, BodyInertia, TypedIndex) Called every time this is added to a simulation protected override void AttachInner(RigidPose pose, BodyInertia shapeInertia, TypedIndex shapeIndex) Parameters pose RigidPose shapeInertia BodyInertia shapeIndex TypedIndex Remarks May occur when certain larger changes are made to the object, Simulation is the one this object is being added to GroundTest(Vector3, float) Returns whether this body is in contact with the ground. protected bool GroundTest(Vector3 groundNormal, float threshold = 0) Parameters groundNormal Vector3 Which direction a surface has to be in to be considered as ground threshold float How close to this direction a supporting contact has to be for it to be considered as ground. In the [-1,1] range, where -1 would return true for any given surface we are in contact with, 0 would return true for a surface that is at most 90 degrees away from groundNormal, and 1 would return true only when a surface matches groundNormal exactly. Returns bool Remarks Goes through the list of Contacts to do so Move(Vector3) Sets the velocity based on direction and Speed public virtual void Move(Vector3 direction) Parameters direction Vector3 Remarks direction does not have to be normalized; if the vector passed in has a length of 2, the character will go twice as fast OnStartedTouching<TManifold>(Contacts<TManifold>) Fires the first time a pair is observed to be touching. Touching means that there are contacts with nonnegative depths in the manifold. protected virtual void OnStartedTouching<TManifold>(Contacts<TManifold> contacts) where TManifold : unmanaged, IContactManifold<TManifold> Parameters contacts Contacts<TManifold> Data associated with this contact event. Type Parameters TManifold Type of the contact manifold detected. OnStoppedTouching<TManifold>(Contacts<TManifold>) Fires when a pair stops touching. Touching means that there are contacts with nonnegative depths in the manifold. protected virtual void OnStoppedTouching<TManifold>(Contacts<TManifold> contacts) where TManifold : unmanaged, IContactManifold<TManifold> Parameters contacts Contacts<TManifold> Data associated with this contact event. Type Parameters TManifold Type of the contact manifold detected. OnTouching<TManifold>(Contacts<TManifold>) Fires whenever a pair is observed to be touching. Touching means that there are contacts with nonnegative depths in the manifold. Will not fire for sleeping pairs. protected virtual void OnTouching<TManifold>(Contacts<TManifold> contacts) where TManifold : unmanaged, IContactManifold<TManifold> Parameters contacts Contacts<TManifold> Data associated with this contact event. Type Parameters TManifold Type of the contact manifold detected. SimulationUpdate(BepuSimulation, float) This is called internally right before the physics simulation does a tick public virtual void SimulationUpdate(BepuSimulation sim, float simTimeStep) Parameters sim BepuSimulation The simulation this ISimulationUpdate is bound to, and the one currently updating simTimeStep float The amount of time in seconds since the last simulation TryJump() Try to perform a jump on the next physics tick, will fail when not grounded public virtual void TryJump()"
  },
  "api/Stride.BepuPhysics.CollidableComponent.html": {
    "href": "api/Stride.BepuPhysics.CollidableComponent.html",
    "title": "Class CollidableComponent | Stride API",
    "summary": "Class CollidableComponent Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll [CategoryOrder(5, \"Collider\")] [CategoryOrder(10, \"Forces\", Expand = ExpandRule.Once)] [CategoryOrder(15, \"Contacts\", Expand = ExpandRule.Once)] [CategoryOrder(20, \"Activity\", Expand = ExpandRule.Once)] [DataContract(Inherited = true)] [DefaultEntityComponentProcessor(typeof(CollidableProcessor), ExecutionMode = ExecutionMode.Runtime)] public abstract class CollidableComponent : EntityComponent, IIdentifiable Inheritance object EntityComponent CollidableComponent Implements IIdentifiable Derived BodyComponent StaticComponent Inherited Members EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Constructors CollidableComponent() public CollidableComponent() Fields CategoryActivity public const string CategoryActivity = \"Activity\" Field Value string CategoryCollider public const string CategoryCollider = \"Collider\" Field Value string CategoryContacts public const string CategoryContacts = \"Contacts\" Field Value string CategoryForces public const string CategoryForces = \"Forces\" Field Value string Properties CenterOfMass The center of mass of this object in local space public Vector3 CenterOfMass { get; } Property Value Vector3 Remarks This property will always return Zero if this object is not part of a simulation yet. CollidableReference protected abstract CollidableReference? CollidableReference { get; } Property Value CollidableReference? Collider The collider definition used by this object. [Display(null, \"Collider\", Expand = ExpandRule.Always)] public required ICollider Collider { get; set; } Property Value ICollider Remarks Changing this value will reset some of the internal physics state of this body CollisionGroup This value follows up CollisionLayer when filtering out collisions. It prevents collisions between objects sharing the same Id, when the absolute difference between their IndexA, IndexB, and IndexC is less than two. [DataAlias(\"FilterByDistance\")] [Display(null, \"Contacts\")] public CollisionGroup CollisionGroup { get; set; } Property Value CollisionGroup Remarks Example A: You have multiple characters (A, B, C, D) all with the same CollisionLayer, they are split in two teams {A, B} and {C, D}, but you don't want members of the same team to collide between each other, you can set {A, B}'s Id to 1 and {C, D}'s Id to 2. Example B: You have a chain of three colliders attached to each other {A, B, C}, you don't want A and C to collide with B, but A and C should collide together. Set A, B and C's Ids to 1 to start filtering, leave A's IndexA at 0, B's to 1 and C to 2. A and C will collide since the difference between their IndexA is equal to two, but neither of them will collide with B since they are both only one away from B's index. CollisionLayer Controls how this object interacts with other objects, allow or prevent collisions between it and other groups based on how CollisionMatrix is set up. [DataAlias(\"CollisionMask\")] [Display(null, \"Contacts\")] public CollisionLayer CollisionLayer { get; set; } Property Value CollisionLayer ContactEventHandler Provides the ability to collect and mutate contact data when this object collides with other objects. [Display(null, \"Contacts\")] public IContactHandler? ContactEventHandler { get; set; } Property Value IContactHandler FrictionCoefficient [Display(null, \"Forces\")] public float FrictionCoefficient { get; set; } Property Value float MaterialProperties protected abstract ref MaterialProperties MaterialProperties { get; } Property Value MaterialProperties MaximumRecoveryVelocity The maximum speed this object will exit out of the collision when overlapping another collidable [Display(null, \"Forces\")] public float MaximumRecoveryVelocity { get; set; } Property Value float Pose protected abstract RigidPose? Pose { get; } Property Value RigidPose? ShapeIndex protected TypedIndex ShapeIndex { get; } Property Value TypedIndex Simulation The simulation this object belongs to, null when it is not part of a simulation. public BepuSimulation? Simulation { get; } Property Value BepuSimulation SimulationSelector Which simulation this object is assigned to [DefaultValueIsSceneBased] [Display(null, \"Contacts\")] public ISimulationSelector SimulationSelector { get; set; } Property Value ISimulationSelector SpringDampingRatio The amount of energy/velocity lost when this collidable bounces off [Display(null, \"Forces\")] public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The bounce frequency in hz [Display(null, \"Forces\")] public float SpringFrequency { get; set; } Property Value float Remarks Must be low enough that the simulation can actually represent it. If the contact is trying to make a bounce happen at 240hz, but the integrator timestep is only 60hz, the unrepresentable motion will get damped out and the body won't bounce as much. Methods AttachInner(RigidPose, BodyInertia, TypedIndex) Called every time this is added to a simulation protected abstract void AttachInner(RigidPose pose, BodyInertia shapeInertia, TypedIndex shapeIndex) Parameters pose RigidPose shapeInertia BodyInertia shapeIndex TypedIndex Remarks May occur when certain larger changes are made to the object, Simulation is the one this object is being added to DetachInner() Called every time this is removed from the simulation protected abstract void DetachInner() Remarks May occur right before AttachInner(RigidPose, BodyInertia, TypedIndex) when certain larger changes are made to the object, Simulation is the one this object was on prior to detaching IsContactHandlerRegistered() protected bool IsContactHandlerRegistered() Returns bool RayCast(in Vector3, in Vector3, float, out HitInfo) Finds the closest intersection between the ray provided and this shape. public bool RayCast(in Vector3 origin, in Vector3 dir, float maxDistance, out HitInfo result) Parameters origin Vector3 The start position for this ray dir Vector3 The normalized direction the ray is facing maxDistance float The maximum distance from the origin that hits will be collected result HitInfo An intersection in the world when this method returns true, an undefined value when this method returns false Returns bool True when the given ray intersects with this shape, false otherwise RayCastPenetrating(in Vector3, in Vector3, float, ICollection<HitInfo>) Collect intersections between the given ray and this shape. Hits are NOT sorted. public void RayCastPenetrating(in Vector3 origin, in Vector3 dir, float maxDistance, ICollection<HitInfo> collection) Parameters origin Vector3 The start position for this ray dir Vector3 The normalized direction the ray is facing maxDistance float The maximum distance from the origin that hits will be collected collection ICollection<HitInfo> The collection used to store hits into, the collection is not cleared before usage, hits are appended to it Remarks There are no guarantees as to the order hits are returned in. RayCastPenetrating(in Vector3, in Vector3, float, Span<HitInfoStack>) Collect intersections between the ray provided and this shape in this simulation. public ConversionEnum<ManagedConverter, HitInfoStack, HitInfo> RayCastPenetrating(in Vector3 origin, in Vector3 dir, float maxDistance, Span<HitInfoStack> buffer) Parameters origin Vector3 The start position for this ray dir Vector3 The normalized direction the ray is facing maxDistance float The maximum distance from the origin that hits will be collected buffer Span<HitInfoStack> A temporary buffer which is used as a backing array to write to, its length defines the maximum amount of info you want to read. It is used by the returned enumerator as its backing array from which you read Returns ConversionEnum<ManagedConverter, HitInfoStack, HitInfo> Remarks When there are more hits than buffer can accomodate, returns only the closest hits. There are no guarantees as to the order hits are returned in. RegisterContactHandler() protected void RegisterContactHandler() TryUpdateMaterialProperties() protected void TryUpdateMaterialProperties() UnregisterContactHandler() protected void UnregisterContactHandler()"
  },
  "api/Stride.BepuPhysics.CollidableStack.html": {
    "href": "api/Stride.BepuPhysics.CollidableStack.html",
    "title": "Struct CollidableStack | Stride API",
    "summary": "Struct CollidableStack Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll Unmanaged low level information about an overlap test public readonly record struct CollidableStack : IEquatable<CollidableStack> Implements IEquatable<CollidableStack> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors CollidableStack(CollidableReference, uint) Unmanaged low level information about an overlap test public CollidableStack(CollidableReference Reference, uint Versioning) Parameters Reference CollidableReference Collidable the test shape overlaps with Versioning uint Stores the version the collidable was sampled on to conditionally skip collidables that were removed or otherwise changed while the iteration ran Properties Reference Collidable the test shape overlaps with public CollidableReference Reference { get; init; } Property Value CollidableReference Versioning Stores the version the collidable was sampled on to conditionally skip collidables that were removed or otherwise changed while the iteration ran public uint Versioning { get; init; } Property Value uint"
  },
  "api/Stride.BepuPhysics.CollisionLayer.html": {
    "href": "api/Stride.BepuPhysics.CollisionLayer.html",
    "title": "Enum CollisionLayer | Stride API",
    "summary": "Enum CollisionLayer Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll Represent a collision layer, used in conjunction with CollisionMask and CollisionMatrix public enum CollisionLayer : uint Extension Methods CollisionLayersExtension.IsSetIn(CollisionLayer, CollisionMask) CollisionLayersExtension.ToMask(CollisionLayer) UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Layer0 = 0 Layer1 = 1 Layer10 = 10 Layer11 = 11 Layer12 = 12 Layer13 = 13 Layer14 = 14 Layer15 = 15 Layer16 = 16 Layer17 = 17 Layer18 = 18 Layer19 = 19 Layer2 = 2 Layer20 = 20 Layer21 = 21 Layer22 = 22 Layer23 = 23 Layer24 = 24 Layer25 = 25 Layer26 = 26 Layer27 = 27 Layer28 = 28 Layer29 = 29 Layer3 = 3 Layer30 = 30 Layer31 = 31 Layer4 = 4 Layer5 = 5 Layer6 = 6 Layer7 = 7 Layer8 = 8 Layer9 = 9"
  },
  "api/Stride.BepuPhysics.CollisionLayersExtension.html": {
    "href": "api/Stride.BepuPhysics.CollisionLayersExtension.html",
    "title": "Class CollisionLayersExtension | Stride API",
    "summary": "Class CollisionLayersExtension Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll public static class CollisionLayersExtension Inheritance object CollisionLayersExtension Methods IsSet(CollisionMask, CollisionLayer) Returns whether layer can be found in mask public static bool IsSet(this CollisionMask mask, CollisionLayer layer) Parameters mask CollisionMask layer CollisionLayer Returns bool IsSetIn(CollisionLayer, CollisionMask) Returns whether layer can be found in mask public static bool IsSetIn(this CollisionLayer layer, CollisionMask mask) Parameters layer CollisionLayer mask CollisionMask Returns bool ToMask(CollisionLayer) Returns a new CollisionMask where layer is set public static CollisionMask ToMask(this CollisionLayer layer) Parameters layer CollisionLayer Returns CollisionMask"
  },
  "api/Stride.BepuPhysics.CollisionMask.html": {
    "href": "api/Stride.BepuPhysics.CollisionMask.html",
    "title": "Enum CollisionMask | Stride API",
    "summary": "Enum CollisionMask Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll Represents a collection of layers, any layer set in this value would be colliding. [Flags] public enum CollisionMask : uint Extension Methods CollisionLayersExtension.IsSet(CollisionMask, CollisionLayer) UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Everything = Layer0 | Layer1 | Layer2 | Layer3 | Layer4 | Layer5 | Layer6 | Layer7 | Layer8 | Layer9 | Layer10 | Layer11 | Layer12 | Layer13 | Layer14 | Layer15 | Layer16 | Layer17 | Layer18 | Layer19 | Layer20 | Layer21 | Layer22 | Layer23 | Layer24 | Layer25 | Layer26 | Layer27 | Layer28 | Layer29 | Layer30 | Layer31 Layer0 = 1 Layer1 = 2 Layer10 = 1024 Layer11 = 2048 Layer12 = 4096 Layer13 = 8192 Layer14 = 16384 Layer15 = 32768 Layer16 = 65536 Layer17 = 131072 Layer18 = 262144 Layer19 = 524288 Layer2 = 4 Layer20 = 1048576 Layer21 = 2097152 Layer22 = 4194304 Layer23 = 8388608 Layer24 = 16777216 Layer25 = 33554432 Layer26 = 67108864 Layer27 = 134217728 Layer28 = 268435456 Layer29 = 536870912 Layer3 = 8 Layer30 = 1073741824 Layer31 = 2147483648 Layer4 = 16 Layer5 = 32 Layer6 = 64 Layer7 = 128 Layer8 = 256 Layer9 = 512 None = 0"
  },
  "api/Stride.BepuPhysics.Components.ISimulationUpdate.SimUpdateProcessor.html": {
    "href": "api/Stride.BepuPhysics.Components.ISimulationUpdate.SimUpdateProcessor.html",
    "title": "Class ISimulationUpdate.SimUpdateProcessor | Stride API",
    "summary": "Class ISimulationUpdate.SimUpdateProcessor Namespace Stride.BepuPhysics.Components Assembly Stride.BepuPhysics.dll public class ISimulationUpdate.SimUpdateProcessor : IComponent<ISimulationUpdate.SimUpdateProcessor, ISimulationUpdate>.IProcessor, IProcessorBase Inheritance object ISimulationUpdate.SimUpdateProcessor Implements IComponent<ISimulationUpdate.SimUpdateProcessor, ISimulationUpdate>.IProcessor IProcessorBase Extension Methods UnsafeUtilities.As<T>(object?) Methods OnComponentAdded(ISimulationUpdate) Occurs right after a component is added to the scene public void OnComponentAdded(ISimulationUpdate item) Parameters item ISimulationUpdate OnComponentRemoved(ISimulationUpdate) Occurs right after a component is removed from the scene public void OnComponentRemoved(ISimulationUpdate item) Parameters item ISimulationUpdate RebindSimulation(ISimulationUpdate) public void RebindSimulation(ISimulationUpdate item) Parameters item ISimulationUpdate SystemAdded(IServiceRegistry) Occurs right after the first component handled by this processor is added to the scene, but before OnComponentAdded(IMarkedComponent) public void SystemAdded(IServiceRegistry registryParam) Parameters registryParam IServiceRegistry SystemRemoved() Occurs right after the last component handled by this processor is removed from the scene, after the call to OnComponentRemoved(IMarkedComponent) public void SystemRemoved() TryGetSimulationOf(ISimulationUpdate, out BepuSimulation) public bool TryGetSimulationOf(ISimulationUpdate item, out BepuSimulation sim) Parameters item ISimulationUpdate sim BepuSimulation Returns bool"
  },
  "api/Stride.BepuPhysics.Components.ISimulationUpdate.html": {
    "href": "api/Stride.BepuPhysics.Components.ISimulationUpdate.html",
    "title": "Interface ISimulationUpdate | Stride API",
    "summary": "Interface ISimulationUpdate Namespace Stride.BepuPhysics.Components Assembly Stride.BepuPhysics.dll Add this interface to your Entity components to get notified when physics simulation update occur public interface ISimulationUpdate : IComponent<ISimulationUpdate.SimUpdateProcessor, ISimulationUpdate>, IMarkedComponent Extension Methods UnsafeUtilities.As<T>(object?) Properties Entity The entity this component belongs to, used with SimulationSelector Entity Entity { get; } Property Value Entity Simulation BepuSimulation? Simulation { get; } Property Value BepuSimulation SimulationSelector The simulation which will call SimulationUpdate(BepuSimulation, float) and AfterSimulationUpdate(BepuSimulation, float) when it updates ISimulationSelector SimulationSelector { get; } Property Value ISimulationSelector Remarks Changing this in the middle of runtime will not change the simulation this object belongs to, you must call NotifySimulationChanged() afterward Methods AfterSimulationUpdate(BepuSimulation, float) Called after the simulation updates void AfterSimulationUpdate(BepuSimulation simulation, float simTimeStep) Parameters simulation BepuSimulation The simulation this ISimulationUpdate is bound to, and the one currently updating simTimeStep float The amount of time in seconds this simulation lasts for NotifySimulationChanged() void NotifySimulationChanged() SimulationUpdate(BepuSimulation, float) Called before the simulation updates void SimulationUpdate(BepuSimulation simulation, float simTimeStep) Parameters simulation BepuSimulation The simulation this ISimulationUpdate is bound to, and the one currently updating simTimeStep float The amount of time in seconds this simulation lasts for"
  },
  "api/Stride.BepuPhysics.Components.html": {
    "href": "api/Stride.BepuPhysics.Components.html",
    "title": "Namespace Stride.BepuPhysics.Components | Stride API",
    "summary": "Namespace Stride.BepuPhysics.Components Classes ISimulationUpdate.SimUpdateProcessor Interfaces ISimulationUpdate Add this interface to your Entity components to get notified when physics simulation update occur"
  },
  "api/Stride.BepuPhysics.Constraints.AngularAxisGearMotorConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.AngularAxisGearMotorConstraintComponent.html",
    "title": "Class AngularAxisGearMotorConstraintComponent | Stride API",
    "summary": "Class AngularAxisGearMotorConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class AngularAxisGearMotorConstraintComponent : TwoBodyConstraintComponent<AngularAxisGearMotor>, IIdentifiable, ITwoBody, IMotor Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<AngularAxisGearMotor> TwoBodyConstraintComponent<AngularAxisGearMotor> AngularAxisGearMotorConstraintComponent Implements IIdentifiable ITwoBody IMotor Inherited Members TwoBodyConstraintComponent<AngularAxisGearMotor>.A TwoBodyConstraintComponent<AngularAxisGearMotor>.B ConstraintComponent<AngularAxisGearMotor>.Attached ConstraintComponent<AngularAxisGearMotor>.GetAccumulatedImpulseMagnitude() ConstraintComponent<AngularAxisGearMotor>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors AngularAxisGearMotorConstraintComponent() public AngularAxisGearMotorConstraintComponent() Properties LocalAxisA public Vector3 LocalAxisA { get; set; } Property Value Vector3 MotorDamping Mass-scaled damping constant, How rigid the constraint is. public float MotorDamping { get; set; } Property Value float Remarks If you want to simulate a viscous damping coefficient of D with an object of mass M, set this damping value to D / M. MotorMaximumForce Maximum amount of force the motor can apply in one unit of time. public float MotorMaximumForce { get; set; } Property Value float VelocityScale public float VelocityScale { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.AngularAxisMotorConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.AngularAxisMotorConstraintComponent.html",
    "title": "Class AngularAxisMotorConstraintComponent | Stride API",
    "summary": "Class AngularAxisMotorConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class AngularAxisMotorConstraintComponent : TwoBodyConstraintComponent<AngularAxisMotor>, IIdentifiable, ITwoBody, IMotor Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<AngularAxisMotor> TwoBodyConstraintComponent<AngularAxisMotor> AngularAxisMotorConstraintComponent Implements IIdentifiable ITwoBody IMotor Inherited Members TwoBodyConstraintComponent<AngularAxisMotor>.A TwoBodyConstraintComponent<AngularAxisMotor>.B ConstraintComponent<AngularAxisMotor>.Attached ConstraintComponent<AngularAxisMotor>.GetAccumulatedImpulseMagnitude() ConstraintComponent<AngularAxisMotor>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors AngularAxisMotorConstraintComponent() public AngularAxisMotorConstraintComponent() Properties LocalAxisA public Vector3 LocalAxisA { get; set; } Property Value Vector3 MotorDamping Mass-scaled damping constant, How rigid the constraint is. public float MotorDamping { get; set; } Property Value float Remarks If you want to simulate a viscous damping coefficient of D with an object of mass M, set this damping value to D / M. MotorMaximumForce Maximum amount of force the motor can apply in one unit of time. public float MotorMaximumForce { get; set; } Property Value float TargetVelocity public float TargetVelocity { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.AngularHingeConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.AngularHingeConstraintComponent.html",
    "title": "Class AngularHingeConstraintComponent | Stride API",
    "summary": "Class AngularHingeConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class AngularHingeConstraintComponent : TwoBodyConstraintComponent<AngularHinge>, IIdentifiable, ITwoBody, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<AngularHinge> TwoBodyConstraintComponent<AngularHinge> AngularHingeConstraintComponent Implements IIdentifiable ITwoBody ISpring Inherited Members TwoBodyConstraintComponent<AngularHinge>.A TwoBodyConstraintComponent<AngularHinge>.B ConstraintComponent<AngularHinge>.Attached ConstraintComponent<AngularHinge>.GetAccumulatedImpulseMagnitude() ConstraintComponent<AngularHinge>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors AngularHingeConstraintComponent() public AngularHingeConstraintComponent() Properties LocalHingeAxisA public Vector3 LocalHingeAxisA { get; set; } Property Value Vector3 LocalHingeAxisB public Vector3 LocalHingeAxisB { get; set; } Property Value Vector3 SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.AngularMotorConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.AngularMotorConstraintComponent.html",
    "title": "Class AngularMotorConstraintComponent | Stride API",
    "summary": "Class AngularMotorConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract(\"AngularMotorConstraint\")] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class AngularMotorConstraintComponent : TwoBodyConstraintComponent<AngularMotor>, IIdentifiable, ITwoBody, IMotor Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<AngularMotor> TwoBodyConstraintComponent<AngularMotor> AngularMotorConstraintComponent Implements IIdentifiable ITwoBody IMotor Inherited Members TwoBodyConstraintComponent<AngularMotor>.A TwoBodyConstraintComponent<AngularMotor>.B ConstraintComponent<AngularMotor>.Attached ConstraintComponent<AngularMotor>.GetAccumulatedImpulseMagnitude() ConstraintComponent<AngularMotor>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors AngularMotorConstraintComponent() public AngularMotorConstraintComponent() Properties MotorDamping Mass-scaled damping constant, How rigid the constraint is. public float MotorDamping { get; set; } Property Value float Remarks If you want to simulate a viscous damping coefficient of D with an object of mass M, set this damping value to D / M. MotorMaximumForce Maximum amount of force the motor can apply in one unit of time. public float MotorMaximumForce { get; set; } Property Value float TargetVelocityLocalA public Vector3 TargetVelocityLocalA { get; set; } Property Value Vector3"
  },
  "api/Stride.BepuPhysics.Constraints.AngularServoConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.AngularServoConstraintComponent.html",
    "title": "Class AngularServoConstraintComponent | Stride API",
    "summary": "Class AngularServoConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract(\"AngularServoConstraint\")] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class AngularServoConstraintComponent : TwoBodyConstraintComponent<AngularServo>, IIdentifiable, ITwoBody, IServo, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<AngularServo> TwoBodyConstraintComponent<AngularServo> AngularServoConstraintComponent Implements IIdentifiable ITwoBody IServo ISpring Inherited Members TwoBodyConstraintComponent<AngularServo>.A TwoBodyConstraintComponent<AngularServo>.B ConstraintComponent<AngularServo>.Attached ConstraintComponent<AngularServo>.GetAccumulatedImpulseMagnitude() ConstraintComponent<AngularServo>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors AngularServoConstraintComponent() public AngularServoConstraintComponent() Properties ServoBaseSpeed Minimum speed that the constraint will try to use to move towards the target. If the speed implied by the spring configuration is higher than this, the servo will attempt to use the higher speed. Will be clamped by the MaximumSpeed. public float ServoBaseSpeed { get; set; } Property Value float ServoMaximumForce The maximum force that the constraint can apply to move towards the target. public float ServoMaximumForce { get; set; } Property Value float Remarks This value is specified in terms of force: a change in momentum over time. It is approximated as a maximum impulse (an instantaneous change in momentum) on a per-substep basis. In other words, for a given velocity iteration, the constraint's impulse can be no larger than ServoMaximumForce * dt where dt is the substep duration. ServoMaximumSpeed Maximum speed that the constraint can try to use to move towards the target. public float ServoMaximumSpeed { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float TargetRelativeRotationLocalA public Quaternion TargetRelativeRotationLocalA { get; set; } Property Value Quaternion"
  },
  "api/Stride.BepuPhysics.Constraints.AngularSwivelHingeConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.AngularSwivelHingeConstraintComponent.html",
    "title": "Class AngularSwivelHingeConstraintComponent | Stride API",
    "summary": "Class AngularSwivelHingeConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class AngularSwivelHingeConstraintComponent : TwoBodyConstraintComponent<AngularSwivelHinge>, IIdentifiable, ITwoBody, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<AngularSwivelHinge> TwoBodyConstraintComponent<AngularSwivelHinge> AngularSwivelHingeConstraintComponent Implements IIdentifiable ITwoBody ISpring Inherited Members TwoBodyConstraintComponent<AngularSwivelHinge>.A TwoBodyConstraintComponent<AngularSwivelHinge>.B ConstraintComponent<AngularSwivelHinge>.Attached ConstraintComponent<AngularSwivelHinge>.GetAccumulatedImpulseMagnitude() ConstraintComponent<AngularSwivelHinge>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors AngularSwivelHingeConstraintComponent() public AngularSwivelHingeConstraintComponent() Properties LocalHingeAxisB public Vector3 LocalHingeAxisB { get; set; } Property Value Vector3 LocalSwivelAxisA public Vector3 LocalSwivelAxisA { get; set; } Property Value Vector3 SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.AreaConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.AreaConstraintComponent.html",
    "title": "Class AreaConstraintComponent | Stride API",
    "summary": "Class AreaConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class AreaConstraintComponent : ThreeBodyConstraintComponent<AreaConstraint>, IIdentifiable, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<AreaConstraint> ThreeBodyConstraintComponent<AreaConstraint> AreaConstraintComponent Implements IIdentifiable ISpring Inherited Members ThreeBodyConstraintComponent<AreaConstraint>.A ThreeBodyConstraintComponent<AreaConstraint>.B ThreeBodyConstraintComponent<AreaConstraint>.C ConstraintComponent<AreaConstraint>.Attached ConstraintComponent<AreaConstraint>.GetAccumulatedImpulseMagnitude() ConstraintComponent<AreaConstraint>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors AreaConstraintComponent() public AreaConstraintComponent() Properties SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float TargetScaledArea public float TargetScaledArea { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.BallSocketConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.BallSocketConstraintComponent.html",
    "title": "Class BallSocketConstraintComponent | Stride API",
    "summary": "Class BallSocketConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll Creates a spherical joint (also known as a ball and socket joint) that constrains two bodies to share a connection point. This constraint keeps a specific point on body A (defined by LocalOffsetA) coincident with a specific point on body B (defined by LocalOffsetB), while still allowing full rotational freedom around the connection point. Common uses include: Character joint connections (shoulders, hips, etc.) Chain links Pendulums Rag doll physics Cloth and soft body simulation [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class BallSocketConstraintComponent : TwoBodyConstraintComponent<BallSocket>, IIdentifiable, ISpring, IWithTwoLocalOffset, ITwoBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<BallSocket> TwoBodyConstraintComponent<BallSocket> BallSocketConstraintComponent Implements IIdentifiable ISpring IWithTwoLocalOffset ITwoBody Inherited Members TwoBodyConstraintComponent<BallSocket>.A TwoBodyConstraintComponent<BallSocket>.B ConstraintComponent<BallSocket>.Attached ConstraintComponent<BallSocket>.GetAccumulatedImpulseMagnitude() ConstraintComponent<BallSocket>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors BallSocketConstraintComponent() public BallSocketConstraintComponent() Properties LocalOffsetA Offset from the center of body A to its attachment in A's local space. public Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. public Vector3 LocalOffsetB { get; set; } Property Value Vector3 SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.BallSocketMotorConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.BallSocketMotorConstraintComponent.html",
    "title": "Class BallSocketMotorConstraintComponent | Stride API",
    "summary": "Class BallSocketMotorConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class BallSocketMotorConstraintComponent : TwoBodyConstraintComponent<BallSocketMotor>, IIdentifiable, ITwoBody, IMotor Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<BallSocketMotor> TwoBodyConstraintComponent<BallSocketMotor> BallSocketMotorConstraintComponent Implements IIdentifiable ITwoBody IMotor Inherited Members TwoBodyConstraintComponent<BallSocketMotor>.A TwoBodyConstraintComponent<BallSocketMotor>.B ConstraintComponent<BallSocketMotor>.Attached ConstraintComponent<BallSocketMotor>.GetAccumulatedImpulseMagnitude() ConstraintComponent<BallSocketMotor>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors BallSocketMotorConstraintComponent() public BallSocketMotorConstraintComponent() Properties LocalOffsetB public Vector3 LocalOffsetB { get; set; } Property Value Vector3 MotorDamping Mass-scaled damping constant, How rigid the constraint is. public float MotorDamping { get; set; } Property Value float Remarks If you want to simulate a viscous damping coefficient of D with an object of mass M, set this damping value to D / M. MotorMaximumForce Maximum amount of force the motor can apply in one unit of time. public float MotorMaximumForce { get; set; } Property Value float TargetVelocityLocalA public Vector3 TargetVelocityLocalA { get; set; } Property Value Vector3"
  },
  "api/Stride.BepuPhysics.Constraints.BallSocketServoConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.BallSocketServoConstraintComponent.html",
    "title": "Class BallSocketServoConstraintComponent | Stride API",
    "summary": "Class BallSocketServoConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class BallSocketServoConstraintComponent : TwoBodyConstraintComponent<BallSocketServo>, IIdentifiable, IServo, ISpring, IWithTwoLocalOffset, ITwoBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<BallSocketServo> TwoBodyConstraintComponent<BallSocketServo> BallSocketServoConstraintComponent Implements IIdentifiable IServo ISpring IWithTwoLocalOffset ITwoBody Inherited Members TwoBodyConstraintComponent<BallSocketServo>.A TwoBodyConstraintComponent<BallSocketServo>.B ConstraintComponent<BallSocketServo>.Attached ConstraintComponent<BallSocketServo>.GetAccumulatedImpulseMagnitude() ConstraintComponent<BallSocketServo>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors BallSocketServoConstraintComponent() public BallSocketServoConstraintComponent() Properties LocalOffsetA Offset from the center of body A to its attachment in A's local space. public Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. public Vector3 LocalOffsetB { get; set; } Property Value Vector3 ServoBaseSpeed Minimum speed that the constraint will try to use to move towards the target. If the speed implied by the spring configuration is higher than this, the servo will attempt to use the higher speed. Will be clamped by the MaximumSpeed. public float ServoBaseSpeed { get; set; } Property Value float ServoMaximumForce The maximum force that the constraint can apply to move towards the target. public float ServoMaximumForce { get; set; } Property Value float Remarks This value is specified in terms of force: a change in momentum over time. It is approximated as a maximum impulse (an instantaneous change in momentum) on a per-substep basis. In other words, for a given velocity iteration, the constraint's impulse can be no larger than ServoMaximumForce * dt where dt is the substep duration. ServoMaximumSpeed Maximum speed that the constraint can try to use to move towards the target. public float ServoMaximumSpeed { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.CenterDistanceConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.CenterDistanceConstraintComponent.html",
    "title": "Class CenterDistanceConstraintComponent | Stride API",
    "summary": "Class CenterDistanceConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll Constrains the center of two bodies to be separated by a target distance. This constraint ensures that the distance between the center points of two bodies attempts to match a specific target value. Unlike DistanceServoConstraintComponent, this constraint operates directly on the body centers rather than on specific points on the bodies. [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class CenterDistanceConstraintComponent : TwoBodyConstraintComponent<CenterDistanceConstraint>, IIdentifiable, ITwoBody, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<CenterDistanceConstraint> TwoBodyConstraintComponent<CenterDistanceConstraint> CenterDistanceConstraintComponent Implements IIdentifiable ITwoBody ISpring Inherited Members TwoBodyConstraintComponent<CenterDistanceConstraint>.A TwoBodyConstraintComponent<CenterDistanceConstraint>.B ConstraintComponent<CenterDistanceConstraint>.Attached ConstraintComponent<CenterDistanceConstraint>.GetAccumulatedImpulseMagnitude() ConstraintComponent<CenterDistanceConstraint>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Remarks This is a specialized variant of DistanceServoConstraintComponent that works with body centers. Use this when you need to constrain the distance between bodies without specifying exact attachment points. For a version that allows a range of distances rather than a single target value, see CenterDistanceLimitConstraintComponent. Constructors CenterDistanceConstraintComponent() public CenterDistanceConstraintComponent() Properties SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float TargetDistance Target distance between the body centers. public float TargetDistance { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.CenterDistanceLimitConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.CenterDistanceLimitConstraintComponent.html",
    "title": "Class CenterDistanceLimitConstraintComponent | Stride API",
    "summary": "Class CenterDistanceLimitConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll Constrains the center of two bodies to be separated by a distance within a range. This constraint ensures that the distance between the center points of two bodies remains within a minimum and maximum range. Unlike DistanceLimitConstraintComponent, this constraint operates directly on the body centers rather than on specific points on the bodies. [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class CenterDistanceLimitConstraintComponent : TwoBodyConstraintComponent<CenterDistanceLimit>, IIdentifiable, ITwoBody, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<CenterDistanceLimit> TwoBodyConstraintComponent<CenterDistanceLimit> CenterDistanceLimitConstraintComponent Implements IIdentifiable ITwoBody ISpring Inherited Members TwoBodyConstraintComponent<CenterDistanceLimit>.A TwoBodyConstraintComponent<CenterDistanceLimit>.B ConstraintComponent<CenterDistanceLimit>.Attached ConstraintComponent<CenterDistanceLimit>.GetAccumulatedImpulseMagnitude() ConstraintComponent<CenterDistanceLimit>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Remarks This is a specialized variant of DistanceLimitConstraintComponent that works with body centers. Use this when you need to constrain the overall distance between bodies without specifying exact attachment points. Constructors CenterDistanceLimitConstraintComponent() public CenterDistanceLimitConstraintComponent() Properties MaximumDistance Maximum distance between the body centers. public float MaximumDistance { get; set; } Property Value float MinimumDistance Minimum distance between the body centers. public float MinimumDistance { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.ConstraintComponent-1.html": {
    "href": "api/Stride.BepuPhysics.Constraints.ConstraintComponent-1.html",
    "title": "Class ConstraintComponent<T> | Stride API",
    "summary": "Class ConstraintComponent<T> Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll public abstract class ConstraintComponent<T> : ConstraintComponentBase, IIdentifiable where T : unmanaged, IConstraintDescription<T> Type Parameters T Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<T> Implements IIdentifiable Derived FourBodyConstraintComponent<T> OneBodyConstraintComponent<T> ThreeBodyConstraintComponent<T> TwoBodyConstraintComponent<T> Inherited Members ConstraintComponentBase.Logger ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies ConstraintComponentBase.this[int] EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Constructors ConstraintComponent(int) protected ConstraintComponent(int bodies) Parameters bodies int Properties Attached Whether this constraint is in a valid state and actively constraining its targets. public override bool Attached { get; } Property Value bool Remarks May not be attached if it is not in a scene, when not Enabled, when any of its target is null, not in a scene or in a different simulation Methods BodiesChanged() protected override void BodiesChanged() GetAccumulatedForceMagnitude() Returns the sum of all forces this constraint applied on the last tick public override float GetAccumulatedForceMagnitude() Returns float Remarks This can be used to compare with a given motor constraints' MaximumForce property for example. GetAccumulatedImpulseMagnitude() Returns the sum of all impulses this constraint applied on the last tick public override float GetAccumulatedImpulseMagnitude() Returns float Remarks Impulses increase depending on FixedTimeStep, as well as the amount of SolverSubStep. You may want to use GetAccumulatedForceMagnitude() instead."
  },
  "api/Stride.BepuPhysics.Constraints.ConstraintComponentBase.ConstraintState.html": {
    "href": "api/Stride.BepuPhysics.Constraints.ConstraintComponentBase.ConstraintState.html",
    "title": "Enum ConstraintComponentBase.ConstraintState | Stride API",
    "summary": "Enum ConstraintComponentBase.ConstraintState Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll public enum ConstraintComponentBase.ConstraintState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BodyNotInScene = 2 BodyNull = 3 ConstraintDisabled = 1 ConstraintNotInScene = 0 FullyOperational = 5 SimulationMismatch = 4"
  },
  "api/Stride.BepuPhysics.Constraints.ConstraintComponentBase.html": {
    "href": "api/Stride.BepuPhysics.Constraints.ConstraintComponentBase.html",
    "title": "Class ConstraintComponentBase | Stride API",
    "summary": "Class ConstraintComponentBase Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract(Inherited = true)] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public abstract class ConstraintComponentBase : EntityComponent, IIdentifiable Inheritance object EntityComponent ConstraintComponentBase Implements IIdentifiable Derived ConstraintComponent<T> Inherited Members EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Constructors ConstraintComponentBase(int) protected ConstraintComponentBase(int bodies) Parameters bodies int Fields Logger protected static Logger Logger Field Value Logger Properties Attached Whether this constraint is in a valid state and actively constraining its targets. public abstract bool Attached { get; } Property Value bool Remarks May not be attached if it is not in a scene, when not Enabled, when any of its target is null, not in a scene or in a different simulation Bodies public ReadOnlySpan<BodyComponent?> Bodies { get; } Property Value ReadOnlySpan<BodyComponent> Enabled public bool Enabled { get; set; } Property Value bool this[int] protected BodyComponent? this[int i] { get; set; } Parameters i int Property Value BodyComponent Methods BodiesChanged() protected abstract void BodiesChanged() GetAccumulatedForceMagnitude() Returns the sum of all forces this constraint applied on the last tick public abstract float GetAccumulatedForceMagnitude() Returns float Remarks This can be used to compare with a given motor constraints' MaximumForce property for example. GetAccumulatedImpulseMagnitude() Returns the sum of all impulses this constraint applied on the last tick public abstract float GetAccumulatedImpulseMagnitude() Returns float Remarks Impulses increase depending on FixedTimeStep, as well as the amount of SolverSubStep. You may want to use GetAccumulatedForceMagnitude() instead."
  },
  "api/Stride.BepuPhysics.Constraints.DistanceLimitConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.DistanceLimitConstraintComponent.html",
    "title": "Class DistanceLimitConstraintComponent | Stride API",
    "summary": "Class DistanceLimitConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll Constrains points on two bodies to be separated by a distance within a specified range. This constraint ensures that the distance between two points on two bodies remains within a minimum and maximum range. It is useful for creating elastic or flexible connections between bodies, where the distance can vary within the specified limits. [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class DistanceLimitConstraintComponent : TwoBodyConstraintComponent<DistanceLimit>, IIdentifiable, ISpring, IWithTwoLocalOffset, ITwoBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<DistanceLimit> TwoBodyConstraintComponent<DistanceLimit> DistanceLimitConstraintComponent Implements IIdentifiable ISpring IWithTwoLocalOffset ITwoBody Inherited Members TwoBodyConstraintComponent<DistanceLimit>.A TwoBodyConstraintComponent<DistanceLimit>.B ConstraintComponent<DistanceLimit>.Attached ConstraintComponent<DistanceLimit>.GetAccumulatedImpulseMagnitude() ConstraintComponent<DistanceLimit>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Remarks Unlike CenterDistanceLimitConstraintComponent, this constraint allows you to specify exact attachment points on each body using LocalOffsetA and LocalOffsetB properties. If you need to constrain only the centers of bodies, use CenterDistanceLimitConstraintComponent instead. Constructors DistanceLimitConstraintComponent() public DistanceLimitConstraintComponent() Properties LocalOffsetA Offset from the center of body A to its attachment in A's local space. public Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. public Vector3 LocalOffsetB { get; set; } Property Value Vector3 MaximumDistance Maximum distance permitted between the point on A and the point on B. public float MaximumDistance { get; set; } Property Value float MinimumDistance Minimum distance permitted between the point on A and the point on B. public float MinimumDistance { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.DistanceServoConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.DistanceServoConstraintComponent.html",
    "title": "Class DistanceServoConstraintComponent | Stride API",
    "summary": "Class DistanceServoConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll Constrains points on two bodies to be separated by a target distance using servo settings. This constraint attempts to maintain a specific distance between two points on two bodies by applying forces to reach the target distance. It uses servo settings to control the speed and force applied to achieve the target distance. [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class DistanceServoConstraintComponent : TwoBodyConstraintComponent<DistanceServo>, IIdentifiable, IServo, ISpring, IWithTwoLocalOffset, ITwoBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<DistanceServo> TwoBodyConstraintComponent<DistanceServo> DistanceServoConstraintComponent Implements IIdentifiable IServo ISpring IWithTwoLocalOffset ITwoBody Inherited Members TwoBodyConstraintComponent<DistanceServo>.A TwoBodyConstraintComponent<DistanceServo>.B ConstraintComponent<DistanceServo>.Attached ConstraintComponent<DistanceServo>.GetAccumulatedImpulseMagnitude() ConstraintComponent<DistanceServo>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Remarks Unlike CenterDistanceConstraintComponent, this constraint allows you to specify exact attachment points on each body using LocalOffsetA and LocalOffsetB properties. If you need to constrain only the centers of bodies, use CenterDistanceConstraintComponent instead. For a version that allows a range of distances rather than a single target value, see DistanceLimitConstraintComponent. Constructors DistanceServoConstraintComponent() public DistanceServoConstraintComponent() Properties LocalOffsetA Offset from the center of body A to its attachment in A's local space. public Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. public Vector3 LocalOffsetB { get; set; } Property Value Vector3 ServoBaseSpeed Minimum speed that the constraint will try to use to move towards the target. If the speed implied by the spring configuration is higher than this, the servo will attempt to use the higher speed. Will be clamped by the MaximumSpeed. public float ServoBaseSpeed { get; set; } Property Value float ServoMaximumForce The maximum force that the constraint can apply to move towards the target. public float ServoMaximumForce { get; set; } Property Value float Remarks This value is specified in terms of force: a change in momentum over time. It is approximated as a maximum impulse (an instantaneous change in momentum) on a per-substep basis. In other words, for a given velocity iteration, the constraint's impulse can be no larger than ServoMaximumForce * dt where dt is the substep duration. ServoMaximumSpeed Maximum speed that the constraint can try to use to move towards the target. public float ServoMaximumSpeed { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float TargetDistance Distance that the constraint will try to reach between the attachment points. public float TargetDistance { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.FourBodyConstraintComponent-1.html": {
    "href": "api/Stride.BepuPhysics.Constraints.FourBodyConstraintComponent-1.html",
    "title": "Class FourBodyConstraintComponent<T> | Stride API",
    "summary": "Class FourBodyConstraintComponent<T> Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll public abstract class FourBodyConstraintComponent<T> : ConstraintComponent<T>, IIdentifiable where T : unmanaged, IConstraintDescription<T>, IFourBodyConstraintDescription<T> Type Parameters T Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<T> FourBodyConstraintComponent<T> Implements IIdentifiable Derived VolumeConstraintComponent Inherited Members ConstraintComponent<T>.Attached ConstraintComponent<T>.BodiesChanged() ConstraintComponent<T>.GetAccumulatedImpulseMagnitude() ConstraintComponent<T>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Logger ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies ConstraintComponentBase.this[int] EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Constructors FourBodyConstraintComponent() public FourBodyConstraintComponent() Properties A public BodyComponent? A { get; set; } Property Value BodyComponent B public BodyComponent? B { get; set; } Property Value BodyComponent C public BodyComponent? C { get; set; } Property Value BodyComponent D public BodyComponent? D { get; set; } Property Value BodyComponent"
  },
  "api/Stride.BepuPhysics.Constraints.HingeConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.HingeConstraintComponent.html",
    "title": "Class HingeConstraintComponent | Stride API",
    "summary": "Class HingeConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class HingeConstraintComponent : TwoBodyConstraintComponent<Hinge>, IIdentifiable, ISpring, IWithTwoLocalOffset, ITwoBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<Hinge> TwoBodyConstraintComponent<Hinge> HingeConstraintComponent Implements IIdentifiable ISpring IWithTwoLocalOffset ITwoBody Inherited Members TwoBodyConstraintComponent<Hinge>.A TwoBodyConstraintComponent<Hinge>.B ConstraintComponent<Hinge>.Attached ConstraintComponent<Hinge>.GetAccumulatedImpulseMagnitude() ConstraintComponent<Hinge>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors HingeConstraintComponent() public HingeConstraintComponent() Properties LocalHingeAxisA public Vector3 LocalHingeAxisA { get; set; } Property Value Vector3 LocalHingeAxisB public Vector3 LocalHingeAxisB { get; set; } Property Value Vector3 LocalOffsetA Offset from the center of body A to its attachment in A's local space. public Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. public Vector3 LocalOffsetB { get; set; } Property Value Vector3 SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.IMotor.html": {
    "href": "api/Stride.BepuPhysics.Constraints.IMotor.html",
    "title": "Interface IMotor | Stride API",
    "summary": "Interface IMotor Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll Motors try to reach a given relative velocity between the connected bodies public interface IMotor Extension Methods UnsafeUtilities.As<T>(object?) Properties MotorDamping Mass-scaled damping constant, How rigid the constraint is. float MotorDamping { get; set; } Property Value float Remarks If you want to simulate a viscous damping coefficient of D with an object of mass M, set this damping value to D / M. MotorMaximumForce Maximum amount of force the motor can apply in one unit of time. float MotorMaximumForce { get; set; } Property Value float MotorSoftness Gets or sets how soft the constraint is. Values range from 0 to infinity. Softness is inverse damping; 0 is perfectly rigid, 1 is very soft, float.MaxValue is effectively nonexistent. float MotorSoftness { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.IOneBody.html": {
    "href": "api/Stride.BepuPhysics.Constraints.IOneBody.html",
    "title": "Interface IOneBody | Stride API",
    "summary": "Interface IOneBody Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll public interface IOneBody Extension Methods UnsafeUtilities.As<T>(object?) Properties A BodyComponent? A { get; set; } Property Value BodyComponent"
  },
  "api/Stride.BepuPhysics.Constraints.IServo.html": {
    "href": "api/Stride.BepuPhysics.Constraints.IServo.html",
    "title": "Interface IServo | Stride API",
    "summary": "Interface IServo Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll Servos change velocity of the connected bodies to achieve a position or orientation goal public interface IServo Extension Methods UnsafeUtilities.As<T>(object?) Properties ServoBaseSpeed Minimum speed that the constraint will try to use to move towards the target. If the speed implied by the spring configuration is higher than this, the servo will attempt to use the higher speed. Will be clamped by the MaximumSpeed. float ServoBaseSpeed { get; set; } Property Value float ServoMaximumForce The maximum force that the constraint can apply to move towards the target. float ServoMaximumForce { get; set; } Property Value float Remarks This value is specified in terms of force: a change in momentum over time. It is approximated as a maximum impulse (an instantaneous change in momentum) on a per-substep basis. In other words, for a given velocity iteration, the constraint's impulse can be no larger than ServoMaximumForce * dt where dt is the substep duration. ServoMaximumSpeed Maximum speed that the constraint can try to use to move towards the target. float ServoMaximumSpeed { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.ISpring.html": {
    "href": "api/Stride.BepuPhysics.Constraints.ISpring.html",
    "title": "Interface ISpring | Stride API",
    "summary": "Interface ISpring Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll public interface ISpring Extension Methods UnsafeUtilities.As<T>(object?) Properties SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.ITwoBody.html": {
    "href": "api/Stride.BepuPhysics.Constraints.ITwoBody.html",
    "title": "Interface ITwoBody | Stride API",
    "summary": "Interface ITwoBody Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll public interface ITwoBody Extension Methods UnsafeUtilities.As<T>(object?) Properties A BodyComponent? A { get; set; } Property Value BodyComponent B BodyComponent? B { get; set; } Property Value BodyComponent"
  },
  "api/Stride.BepuPhysics.Constraints.IWithTwoLocalOffset.html": {
    "href": "api/Stride.BepuPhysics.Constraints.IWithTwoLocalOffset.html",
    "title": "Interface IWithTwoLocalOffset | Stride API",
    "summary": "Interface IWithTwoLocalOffset Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll public interface IWithTwoLocalOffset : ITwoBody Inherited Members ITwoBody.A ITwoBody.B Extension Methods UnsafeUtilities.As<T>(object?) Properties LocalOffsetA Offset from the center of body A to its attachment in A's local space. Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. Vector3 LocalOffsetB { get; set; } Property Value Vector3"
  },
  "api/Stride.BepuPhysics.Constraints.LinearAxisLimitConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.LinearAxisLimitConstraintComponent.html",
    "title": "Class LinearAxisLimitConstraintComponent | Stride API",
    "summary": "Class LinearAxisLimitConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class LinearAxisLimitConstraintComponent : TwoBodyConstraintComponent<LinearAxisLimit>, IIdentifiable, ISpring, IWithTwoLocalOffset, ITwoBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<LinearAxisLimit> TwoBodyConstraintComponent<LinearAxisLimit> LinearAxisLimitConstraintComponent Implements IIdentifiable ISpring IWithTwoLocalOffset ITwoBody Inherited Members TwoBodyConstraintComponent<LinearAxisLimit>.A TwoBodyConstraintComponent<LinearAxisLimit>.B ConstraintComponent<LinearAxisLimit>.Attached ConstraintComponent<LinearAxisLimit>.GetAccumulatedImpulseMagnitude() ConstraintComponent<LinearAxisLimit>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors LinearAxisLimitConstraintComponent() public LinearAxisLimitConstraintComponent() Properties LocalAxis public Vector3 LocalAxis { get; set; } Property Value Vector3 LocalOffsetA Offset from the center of body A to its attachment in A's local space. public Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. public Vector3 LocalOffsetB { get; set; } Property Value Vector3 MaximumOffset public float MaximumOffset { get; set; } Property Value float MinimumOffset public float MinimumOffset { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.LinearAxisMotorConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.LinearAxisMotorConstraintComponent.html",
    "title": "Class LinearAxisMotorConstraintComponent | Stride API",
    "summary": "Class LinearAxisMotorConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class LinearAxisMotorConstraintComponent : TwoBodyConstraintComponent<LinearAxisMotor>, IIdentifiable, IMotor, IWithTwoLocalOffset, ITwoBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<LinearAxisMotor> TwoBodyConstraintComponent<LinearAxisMotor> LinearAxisMotorConstraintComponent Implements IIdentifiable IMotor IWithTwoLocalOffset ITwoBody Inherited Members TwoBodyConstraintComponent<LinearAxisMotor>.A TwoBodyConstraintComponent<LinearAxisMotor>.B ConstraintComponent<LinearAxisMotor>.Attached ConstraintComponent<LinearAxisMotor>.GetAccumulatedImpulseMagnitude() ConstraintComponent<LinearAxisMotor>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors LinearAxisMotorConstraintComponent() public LinearAxisMotorConstraintComponent() Properties LocalAxis public Vector3 LocalAxis { get; set; } Property Value Vector3 LocalOffsetA Offset from the center of body A to its attachment in A's local space. public Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. public Vector3 LocalOffsetB { get; set; } Property Value Vector3 MotorDamping Mass-scaled damping constant, How rigid the constraint is. public float MotorDamping { get; set; } Property Value float Remarks If you want to simulate a viscous damping coefficient of D with an object of mass M, set this damping value to D / M. MotorMaximumForce Maximum amount of force the motor can apply in one unit of time. public float MotorMaximumForce { get; set; } Property Value float TargetVelocity public float TargetVelocity { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.LinearAxisServoConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.LinearAxisServoConstraintComponent.html",
    "title": "Class LinearAxisServoConstraintComponent | Stride API",
    "summary": "Class LinearAxisServoConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll Constrains two bodies' position to a plane local to the first body [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class LinearAxisServoConstraintComponent : TwoBodyConstraintComponent<LinearAxisServo>, IIdentifiable, IServo, ISpring, IWithTwoLocalOffset, ITwoBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<LinearAxisServo> TwoBodyConstraintComponent<LinearAxisServo> LinearAxisServoConstraintComponent Implements IIdentifiable IServo ISpring IWithTwoLocalOffset ITwoBody Inherited Members TwoBodyConstraintComponent<LinearAxisServo>.A TwoBodyConstraintComponent<LinearAxisServo>.B ConstraintComponent<LinearAxisServo>.Attached ConstraintComponent<LinearAxisServo>.GetAccumulatedImpulseMagnitude() ConstraintComponent<LinearAxisServo>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors LinearAxisServoConstraintComponent() public LinearAxisServoConstraintComponent() Properties LocalOffsetA Offset from the center of body A to its attachment in A's local space. public Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. public Vector3 LocalOffsetB { get; set; } Property Value Vector3 LocalPlaneNormal Direction of the plane normal in the local space of body A public Vector3 LocalPlaneNormal { get; set; } Property Value Vector3 ServoBaseSpeed Minimum speed that the constraint will try to use to move towards the target. If the speed implied by the spring configuration is higher than this, the servo will attempt to use the higher speed. Will be clamped by the MaximumSpeed. public float ServoBaseSpeed { get; set; } Property Value float ServoMaximumForce The maximum force that the constraint can apply to move towards the target. public float ServoMaximumForce { get; set; } Property Value float Remarks This value is specified in terms of force: a change in momentum over time. It is approximated as a maximum impulse (an instantaneous change in momentum) on a per-substep basis. In other words, for a given velocity iteration, the constraint's impulse can be no larger than ServoMaximumForce * dt where dt is the substep duration. ServoMaximumSpeed Maximum speed that the constraint can try to use to move towards the target. public float ServoMaximumSpeed { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float TargetOffset Target offset from A's plane anchor to B's anchor along the plane normal public float TargetOffset { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.OneBodyAngularMotorConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.OneBodyAngularMotorConstraintComponent.html",
    "title": "Class OneBodyAngularMotorConstraintComponent | Stride API",
    "summary": "Class OneBodyAngularMotorConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class OneBodyAngularMotorConstraintComponent : OneBodyConstraintComponent<OneBodyAngularMotor>, IIdentifiable, IMotor, IOneBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<OneBodyAngularMotor> OneBodyConstraintComponent<OneBodyAngularMotor> OneBodyAngularMotorConstraintComponent Implements IIdentifiable IMotor IOneBody Inherited Members OneBodyConstraintComponent<OneBodyAngularMotor>.A ConstraintComponent<OneBodyAngularMotor>.Attached ConstraintComponent<OneBodyAngularMotor>.GetAccumulatedImpulseMagnitude() ConstraintComponent<OneBodyAngularMotor>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors OneBodyAngularMotorConstraintComponent() public OneBodyAngularMotorConstraintComponent() Properties MotorDamping Mass-scaled damping constant, How rigid the constraint is. public float MotorDamping { get; set; } Property Value float Remarks If you want to simulate a viscous damping coefficient of D with an object of mass M, set this damping value to D / M. MotorMaximumForce Maximum amount of force the motor can apply in one unit of time. public float MotorMaximumForce { get; set; } Property Value float TargetVelocity public Vector3 TargetVelocity { get; set; } Property Value Vector3"
  },
  "api/Stride.BepuPhysics.Constraints.OneBodyAngularServoConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.OneBodyAngularServoConstraintComponent.html",
    "title": "Class OneBodyAngularServoConstraintComponent | Stride API",
    "summary": "Class OneBodyAngularServoConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll Constrains a single body to a target orientation in space, controlling both rotation and tilt. This constraint applies torque to make a body gradually align with a specific target orientation. It works like a spring system that pulls the body's orientation (rotation around any axis, including tilt) toward the specified target orientation. Common uses include: Stabilizing objects to maintain a specific orientation Creating motorized joints that rotate/tilt objects to desired angles Simulating gyroscopic or magnetic orientation control The spring and servo settings control how quickly and forcefully the body moves toward the target orientation. [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class OneBodyAngularServoConstraintComponent : OneBodyConstraintComponent<OneBodyAngularServo>, IIdentifiable, IServo, ISpring, IOneBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<OneBodyAngularServo> OneBodyConstraintComponent<OneBodyAngularServo> OneBodyAngularServoConstraintComponent Implements IIdentifiable IServo ISpring IOneBody Inherited Members OneBodyConstraintComponent<OneBodyAngularServo>.A ConstraintComponent<OneBodyAngularServo>.Attached ConstraintComponent<OneBodyAngularServo>.GetAccumulatedImpulseMagnitude() ConstraintComponent<OneBodyAngularServo>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors OneBodyAngularServoConstraintComponent() public OneBodyAngularServoConstraintComponent() Properties ServoBaseSpeed Minimum speed that the constraint will try to use to move towards the target. If the speed implied by the spring configuration is higher than this, the servo will attempt to use the higher speed. Will be clamped by the MaximumSpeed. public float ServoBaseSpeed { get; set; } Property Value float ServoMaximumForce The maximum force that the constraint can apply to move towards the target. public float ServoMaximumForce { get; set; } Property Value float Remarks This value is specified in terms of force: a change in momentum over time. It is approximated as a maximum impulse (an instantaneous change in momentum) on a per-substep basis. In other words, for a given velocity iteration, the constraint's impulse can be no larger than ServoMaximumForce * dt where dt is the substep duration. ServoMaximumSpeed Maximum speed that the constraint can try to use to move towards the target. public float ServoMaximumSpeed { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float TargetOrientation public Quaternion TargetOrientation { get; set; } Property Value Quaternion"
  },
  "api/Stride.BepuPhysics.Constraints.OneBodyConstraintComponent-1.html": {
    "href": "api/Stride.BepuPhysics.Constraints.OneBodyConstraintComponent-1.html",
    "title": "Class OneBodyConstraintComponent<T> | Stride API",
    "summary": "Class OneBodyConstraintComponent<T> Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll public abstract class OneBodyConstraintComponent<T> : ConstraintComponent<T>, IIdentifiable, IOneBody where T : unmanaged, IConstraintDescription<T>, IOneBodyConstraintDescription<T> Type Parameters T Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<T> OneBodyConstraintComponent<T> Implements IIdentifiable IOneBody Derived OneBodyAngularMotorConstraintComponent OneBodyAngularServoConstraintComponent OneBodyLinearMotorConstraintComponent OneBodyLinearServoConstraintComponent Inherited Members ConstraintComponent<T>.Attached ConstraintComponent<T>.BodiesChanged() ConstraintComponent<T>.GetAccumulatedImpulseMagnitude() ConstraintComponent<T>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Logger ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies ConstraintComponentBase.this[int] EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Constructors OneBodyConstraintComponent() public OneBodyConstraintComponent() Properties A public BodyComponent? A { get; set; } Property Value BodyComponent"
  },
  "api/Stride.BepuPhysics.Constraints.OneBodyLinearMotorConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.OneBodyLinearMotorConstraintComponent.html",
    "title": "Class OneBodyLinearMotorConstraintComponent | Stride API",
    "summary": "Class OneBodyLinearMotorConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class OneBodyLinearMotorConstraintComponent : OneBodyConstraintComponent<OneBodyLinearMotor>, IIdentifiable, IMotor, IOneBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<OneBodyLinearMotor> OneBodyConstraintComponent<OneBodyLinearMotor> OneBodyLinearMotorConstraintComponent Implements IIdentifiable IMotor IOneBody Inherited Members OneBodyConstraintComponent<OneBodyLinearMotor>.A ConstraintComponent<OneBodyLinearMotor>.Attached ConstraintComponent<OneBodyLinearMotor>.GetAccumulatedImpulseMagnitude() ConstraintComponent<OneBodyLinearMotor>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors OneBodyLinearMotorConstraintComponent() public OneBodyLinearMotorConstraintComponent() Properties LocalOffset public Vector3 LocalOffset { get; set; } Property Value Vector3 MotorDamping Mass-scaled damping constant, How rigid the constraint is. public float MotorDamping { get; set; } Property Value float Remarks If you want to simulate a viscous damping coefficient of D with an object of mass M, set this damping value to D / M. MotorMaximumForce Maximum amount of force the motor can apply in one unit of time. public float MotorMaximumForce { get; set; } Property Value float TargetVelocity public Vector3 TargetVelocity { get; set; } Property Value Vector3"
  },
  "api/Stride.BepuPhysics.Constraints.OneBodyLinearServoConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.OneBodyLinearServoConstraintComponent.html",
    "title": "Class OneBodyLinearServoConstraintComponent | Stride API",
    "summary": "Class OneBodyLinearServoConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class OneBodyLinearServoConstraintComponent : OneBodyConstraintComponent<OneBodyLinearServo>, IIdentifiable, IServo, ISpring, IOneBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<OneBodyLinearServo> OneBodyConstraintComponent<OneBodyLinearServo> OneBodyLinearServoConstraintComponent Implements IIdentifiable IServo ISpring IOneBody Inherited Members OneBodyConstraintComponent<OneBodyLinearServo>.A ConstraintComponent<OneBodyLinearServo>.Attached ConstraintComponent<OneBodyLinearServo>.GetAccumulatedImpulseMagnitude() ConstraintComponent<OneBodyLinearServo>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors OneBodyLinearServoConstraintComponent() public OneBodyLinearServoConstraintComponent() Properties LocalOffset public Vector3 LocalOffset { get; set; } Property Value Vector3 ServoBaseSpeed Minimum speed that the constraint will try to use to move towards the target. If the speed implied by the spring configuration is higher than this, the servo will attempt to use the higher speed. Will be clamped by the MaximumSpeed. public float ServoBaseSpeed { get; set; } Property Value float ServoMaximumForce The maximum force that the constraint can apply to move towards the target. public float ServoMaximumForce { get; set; } Property Value float Remarks This value is specified in terms of force: a change in momentum over time. It is approximated as a maximum impulse (an instantaneous change in momentum) on a per-substep basis. In other words, for a given velocity iteration, the constraint's impulse can be no larger than ServoMaximumForce * dt where dt is the substep duration. ServoMaximumSpeed Maximum speed that the constraint can try to use to move towards the target. public float ServoMaximumSpeed { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float Target public Vector3 Target { get; set; } Property Value Vector3"
  },
  "api/Stride.BepuPhysics.Constraints.PointOnLineServoConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.PointOnLineServoConstraintComponent.html",
    "title": "Class PointOnLineServoConstraintComponent | Stride API",
    "summary": "Class PointOnLineServoConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class PointOnLineServoConstraintComponent : TwoBodyConstraintComponent<PointOnLineServo>, IIdentifiable, IServo, ISpring, IWithTwoLocalOffset, ITwoBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<PointOnLineServo> TwoBodyConstraintComponent<PointOnLineServo> PointOnLineServoConstraintComponent Implements IIdentifiable IServo ISpring IWithTwoLocalOffset ITwoBody Inherited Members TwoBodyConstraintComponent<PointOnLineServo>.A TwoBodyConstraintComponent<PointOnLineServo>.B ConstraintComponent<PointOnLineServo>.Attached ConstraintComponent<PointOnLineServo>.GetAccumulatedImpulseMagnitude() ConstraintComponent<PointOnLineServo>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors PointOnLineServoConstraintComponent() public PointOnLineServoConstraintComponent() Properties LocalDirection public Vector3 LocalDirection { get; set; } Property Value Vector3 LocalOffsetA Offset from the center of body A to its attachment in A's local space. public Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. public Vector3 LocalOffsetB { get; set; } Property Value Vector3 ServoBaseSpeed Minimum speed that the constraint will try to use to move towards the target. If the speed implied by the spring configuration is higher than this, the servo will attempt to use the higher speed. Will be clamped by the MaximumSpeed. public float ServoBaseSpeed { get; set; } Property Value float ServoMaximumForce The maximum force that the constraint can apply to move towards the target. public float ServoMaximumForce { get; set; } Property Value float Remarks This value is specified in terms of force: a change in momentum over time. It is approximated as a maximum impulse (an instantaneous change in momentum) on a per-substep basis. In other words, for a given velocity iteration, the constraint's impulse can be no larger than ServoMaximumForce * dt where dt is the substep duration. ServoMaximumSpeed Maximum speed that the constraint can try to use to move towards the target. public float ServoMaximumSpeed { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.SwingLimitConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.SwingLimitConstraintComponent.html",
    "title": "Class SwingLimitConstraintComponent | Stride API",
    "summary": "Class SwingLimitConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class SwingLimitConstraintComponent : TwoBodyConstraintComponent<SwingLimit>, IIdentifiable, ITwoBody, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<SwingLimit> TwoBodyConstraintComponent<SwingLimit> SwingLimitConstraintComponent Implements IIdentifiable ITwoBody ISpring Inherited Members TwoBodyConstraintComponent<SwingLimit>.A TwoBodyConstraintComponent<SwingLimit>.B ConstraintComponent<SwingLimit>.Attached ConstraintComponent<SwingLimit>.GetAccumulatedImpulseMagnitude() ConstraintComponent<SwingLimit>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors SwingLimitConstraintComponent() public SwingLimitConstraintComponent() Properties AxisLocalA public Vector3 AxisLocalA { get; set; } Property Value Vector3 AxisLocalB public Vector3 AxisLocalB { get; set; } Property Value Vector3 MaximumSwingAngle public float MaximumSwingAngle { get; set; } Property Value float Remarks This is just a shortcut to MinimumDot were the value is in radians MinimumDot public float MinimumDot { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.SwivelHingeConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.SwivelHingeConstraintComponent.html",
    "title": "Class SwivelHingeConstraintComponent | Stride API",
    "summary": "Class SwivelHingeConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class SwivelHingeConstraintComponent : TwoBodyConstraintComponent<SwivelHinge>, IIdentifiable, ISpring, IWithTwoLocalOffset, ITwoBody Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<SwivelHinge> TwoBodyConstraintComponent<SwivelHinge> SwivelHingeConstraintComponent Implements IIdentifiable ISpring IWithTwoLocalOffset ITwoBody Inherited Members TwoBodyConstraintComponent<SwivelHinge>.A TwoBodyConstraintComponent<SwivelHinge>.B ConstraintComponent<SwivelHinge>.Attached ConstraintComponent<SwivelHinge>.GetAccumulatedImpulseMagnitude() ConstraintComponent<SwivelHinge>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors SwivelHingeConstraintComponent() public SwivelHingeConstraintComponent() Properties LocalHingeAxisB public Vector3 LocalHingeAxisB { get; set; } Property Value Vector3 LocalOffsetA Offset from the center of body A to its attachment in A's local space. public Vector3 LocalOffsetA { get; set; } Property Value Vector3 LocalOffsetB Offset from the center of body B to its attachment in B's local space. public Vector3 LocalOffsetB { get; set; } Property Value Vector3 LocalSwivelAxisA public Vector3 LocalSwivelAxisA { get; set; } Property Value Vector3 SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.ThreeBodyConstraintComponent-1.html": {
    "href": "api/Stride.BepuPhysics.Constraints.ThreeBodyConstraintComponent-1.html",
    "title": "Class ThreeBodyConstraintComponent<T> | Stride API",
    "summary": "Class ThreeBodyConstraintComponent<T> Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll public abstract class ThreeBodyConstraintComponent<T> : ConstraintComponent<T>, IIdentifiable where T : unmanaged, IConstraintDescription<T>, IThreeBodyConstraintDescription<T> Type Parameters T Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<T> ThreeBodyConstraintComponent<T> Implements IIdentifiable Derived AreaConstraintComponent Inherited Members ConstraintComponent<T>.Attached ConstraintComponent<T>.BodiesChanged() ConstraintComponent<T>.GetAccumulatedImpulseMagnitude() ConstraintComponent<T>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Logger ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies ConstraintComponentBase.this[int] EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Constructors ThreeBodyConstraintComponent() public ThreeBodyConstraintComponent() Properties A public BodyComponent? A { get; set; } Property Value BodyComponent B public BodyComponent? B { get; set; } Property Value BodyComponent C public BodyComponent? C { get; set; } Property Value BodyComponent"
  },
  "api/Stride.BepuPhysics.Constraints.TwistLimitConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.TwistLimitConstraintComponent.html",
    "title": "Class TwistLimitConstraintComponent | Stride API",
    "summary": "Class TwistLimitConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class TwistLimitConstraintComponent : TwoBodyConstraintComponent<TwistLimit>, IIdentifiable, ITwoBody, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<TwistLimit> TwoBodyConstraintComponent<TwistLimit> TwistLimitConstraintComponent Implements IIdentifiable ITwoBody ISpring Inherited Members TwoBodyConstraintComponent<TwistLimit>.A TwoBodyConstraintComponent<TwistLimit>.B ConstraintComponent<TwistLimit>.Attached ConstraintComponent<TwistLimit>.GetAccumulatedImpulseMagnitude() ConstraintComponent<TwistLimit>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors TwistLimitConstraintComponent() public TwistLimitConstraintComponent() Properties LocalBasisA Local space basis attached to body A against which to measure body B's transformed axis. Expressed as a 3x3 rotation matrix, the X axis corresponds with 0 degrees, the Y axis corresponds to 90 degrees, and the Z axis is the twist axis. public Quaternion LocalBasisA { get; set; } Property Value Quaternion LocalBasisB Local space basis attached to body B that will be measured against body A's basis. Expressed as a 3x3 rotation matrix, the transformed X axis will be measured against A's X and Y axes. The Z axis is the twist axis public Quaternion LocalBasisB { get; set; } Property Value Quaternion MaximumAngle Maximum angle between B's axis to measure and A's measurement axis public float MaximumAngle { get; set; } Property Value float MinimumAngle Minimum angle between B's axis to measure and A's measurement axis public float MinimumAngle { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.TwistMotorConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.TwistMotorConstraintComponent.html",
    "title": "Class TwistMotorConstraintComponent | Stride API",
    "summary": "Class TwistMotorConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class TwistMotorConstraintComponent : TwoBodyConstraintComponent<TwistMotor>, IIdentifiable, ITwoBody, IMotor Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<TwistMotor> TwoBodyConstraintComponent<TwistMotor> TwistMotorConstraintComponent Implements IIdentifiable ITwoBody IMotor Inherited Members TwoBodyConstraintComponent<TwistMotor>.A TwoBodyConstraintComponent<TwistMotor>.B ConstraintComponent<TwistMotor>.Attached ConstraintComponent<TwistMotor>.GetAccumulatedImpulseMagnitude() ConstraintComponent<TwistMotor>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors TwistMotorConstraintComponent() public TwistMotorConstraintComponent() Properties LocalAxisA Local twist axis attached to body A public Vector3 LocalAxisA { get; set; } Property Value Vector3 LocalAxisB Local twist axis attached to body B public Vector3 LocalAxisB { get; set; } Property Value Vector3 MotorDamping Mass-scaled damping constant, How rigid the constraint is. public float MotorDamping { get; set; } Property Value float Remarks If you want to simulate a viscous damping coefficient of D with an object of mass M, set this damping value to D / M. MotorMaximumForce Maximum amount of force the motor can apply in one unit of time. public float MotorMaximumForce { get; set; } Property Value float TargetVelocity Goal relative twist velocity around the body axes public float TargetVelocity { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.TwistServoConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.TwistServoConstraintComponent.html",
    "title": "Class TwistServoConstraintComponent | Stride API",
    "summary": "Class TwistServoConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class TwistServoConstraintComponent : TwoBodyConstraintComponent<TwistServo>, IIdentifiable, ITwoBody, IServo, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<TwistServo> TwoBodyConstraintComponent<TwistServo> TwistServoConstraintComponent Implements IIdentifiable ITwoBody IServo ISpring Inherited Members TwoBodyConstraintComponent<TwistServo>.A TwoBodyConstraintComponent<TwistServo>.B ConstraintComponent<TwistServo>.Attached ConstraintComponent<TwistServo>.GetAccumulatedImpulseMagnitude() ConstraintComponent<TwistServo>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors TwistServoConstraintComponent() public TwistServoConstraintComponent() Properties LocalBasisA Local space basis attached to body A against which to measure body B's transformed axis. Expressed as a 3x3 rotation matrix, the X axis corresponds with 0 degrees, the Y axis corresponds to 90 degrees, and the -Z axis is the twist axis. When viewed along the twist axis, positive change in angle causes counterclockwise rotation in right handed coordinates. public Quaternion LocalBasisA { get; set; } Property Value Quaternion LocalBasisB Local space basis attached to body B that will be measured against body A's basis. Expressed as a 3x3 rotation matrix, the transformed X axis will be measured against A's X and Y axes. The Z axis is the twist axis. public Quaternion LocalBasisB { get; set; } Property Value Quaternion ServoBaseSpeed Minimum speed that the constraint will try to use to move towards the target. If the speed implied by the spring configuration is higher than this, the servo will attempt to use the higher speed. Will be clamped by the MaximumSpeed. public float ServoBaseSpeed { get; set; } Property Value float ServoMaximumForce The maximum force that the constraint can apply to move towards the target. public float ServoMaximumForce { get; set; } Property Value float Remarks This value is specified in terms of force: a change in momentum over time. It is approximated as a maximum impulse (an instantaneous change in momentum) on a per-substep basis. In other words, for a given velocity iteration, the constraint's impulse can be no larger than ServoMaximumForce * dt where dt is the substep duration. ServoMaximumSpeed Maximum speed that the constraint can try to use to move towards the target. public float ServoMaximumSpeed { get; set; } Property Value float SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float TargetAngle Target angle between B's axis to measure and A's measurement axis. public float TargetAngle { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.TwoBodyConstraintComponent-1.html": {
    "href": "api/Stride.BepuPhysics.Constraints.TwoBodyConstraintComponent-1.html",
    "title": "Class TwoBodyConstraintComponent<T> | Stride API",
    "summary": "Class TwoBodyConstraintComponent<T> Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll public abstract class TwoBodyConstraintComponent<T> : ConstraintComponent<T>, IIdentifiable, ITwoBody where T : unmanaged, IConstraintDescription<T>, ITwoBodyConstraintDescription<T> Type Parameters T Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<T> TwoBodyConstraintComponent<T> Implements IIdentifiable ITwoBody Derived AngularAxisGearMotorConstraintComponent AngularAxisMotorConstraintComponent AngularHingeConstraintComponent AngularMotorConstraintComponent AngularServoConstraintComponent AngularSwivelHingeConstraintComponent BallSocketConstraintComponent BallSocketMotorConstraintComponent BallSocketServoConstraintComponent CenterDistanceConstraintComponent CenterDistanceLimitConstraintComponent DistanceLimitConstraintComponent DistanceServoConstraintComponent HingeConstraintComponent LinearAxisLimitConstraintComponent LinearAxisMotorConstraintComponent LinearAxisServoConstraintComponent PointOnLineServoConstraintComponent SwingLimitConstraintComponent SwivelHingeConstraintComponent TwistLimitConstraintComponent TwistMotorConstraintComponent TwistServoConstraintComponent WeldConstraintComponent Inherited Members ConstraintComponent<T>.Attached ConstraintComponent<T>.BodiesChanged() ConstraintComponent<T>.GetAccumulatedImpulseMagnitude() ConstraintComponent<T>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Logger ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies ConstraintComponentBase.this[int] EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Constructors TwoBodyConstraintComponent() public TwoBodyConstraintComponent() Properties A public BodyComponent? A { get; set; } Property Value BodyComponent B public BodyComponent? B { get; set; } Property Value BodyComponent"
  },
  "api/Stride.BepuPhysics.Constraints.VolumeConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.VolumeConstraintComponent.html",
    "title": "Class VolumeConstraintComponent | Stride API",
    "summary": "Class VolumeConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class VolumeConstraintComponent : FourBodyConstraintComponent<VolumeConstraint>, IIdentifiable, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<VolumeConstraint> FourBodyConstraintComponent<VolumeConstraint> VolumeConstraintComponent Implements IIdentifiable ISpring Inherited Members FourBodyConstraintComponent<VolumeConstraint>.A FourBodyConstraintComponent<VolumeConstraint>.B FourBodyConstraintComponent<VolumeConstraint>.C FourBodyConstraintComponent<VolumeConstraint>.D ConstraintComponent<VolumeConstraint>.Attached ConstraintComponent<VolumeConstraint>.GetAccumulatedImpulseMagnitude() ConstraintComponent<VolumeConstraint>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors VolumeConstraintComponent() public VolumeConstraintComponent() Properties SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float TargetScaledVolume 6 times the target volume of the tetrahedra. Computed from (ab x ac) * ad; this may be negative depending on the winding of the tetrahedron. public float TargetScaledVolume { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.WeldConstraintComponent.html": {
    "href": "api/Stride.BepuPhysics.Constraints.WeldConstraintComponent.html",
    "title": "Class WeldConstraintComponent | Stride API",
    "summary": "Class WeldConstraintComponent Namespace Stride.BepuPhysics.Constraints Assembly Stride.BepuPhysics.dll [DataContract] [DefaultEntityComponentProcessor(typeof(ConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Physics - Bepu Constraint\")] public sealed class WeldConstraintComponent : TwoBodyConstraintComponent<Weld>, IIdentifiable, ITwoBody, ISpring Inheritance object EntityComponent ConstraintComponentBase ConstraintComponent<Weld> TwoBodyConstraintComponent<Weld> WeldConstraintComponent Implements IIdentifiable ITwoBody ISpring Inherited Members TwoBodyConstraintComponent<Weld>.A TwoBodyConstraintComponent<Weld>.B ConstraintComponent<Weld>.Attached ConstraintComponent<Weld>.GetAccumulatedImpulseMagnitude() ConstraintComponent<Weld>.GetAccumulatedForceMagnitude() ConstraintComponentBase.Enabled ConstraintComponentBase.Bodies EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors WeldConstraintComponent() public WeldConstraintComponent() Properties LocalOffset Offset from body A to body B in the local space of A public Vector3 LocalOffset { get; set; } Property Value Vector3 LocalOrientation Target orientation of body B in body A's local space public Quaternion LocalOrientation { get; set; } Property Value Quaternion SpringDampingRatio The ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped. Higher damping ratios reduce oscillations and make the connection less elastic. public float SpringDampingRatio { get; set; } Property Value float SpringFrequency The target number of undamped oscillations per unit of time. Higher frequency values create stiffer connections, while lower values allow more elasticity in the joint. public float SpringFrequency { get; set; } Property Value float"
  },
  "api/Stride.BepuPhysics.Constraints.html": {
    "href": "api/Stride.BepuPhysics.Constraints.html",
    "title": "Namespace Stride.BepuPhysics.Constraints | Stride API",
    "summary": "Namespace Stride.BepuPhysics.Constraints Classes AngularAxisGearMotorConstraintComponent AngularAxisMotorConstraintComponent AngularHingeConstraintComponent AngularMotorConstraintComponent AngularServoConstraintComponent AngularSwivelHingeConstraintComponent AreaConstraintComponent BallSocketConstraintComponent Creates a spherical joint (also known as a ball and socket joint) that constrains two bodies to share a connection point. This constraint keeps a specific point on body A (defined by LocalOffsetA) coincident with a specific point on body B (defined by LocalOffsetB), while still allowing full rotational freedom around the connection point. Common uses include: Character joint connections (shoulders, hips, etc.) Chain links Pendulums Rag doll physics Cloth and soft body simulation BallSocketMotorConstraintComponent BallSocketServoConstraintComponent CenterDistanceConstraintComponent Constrains the center of two bodies to be separated by a target distance. This constraint ensures that the distance between the center points of two bodies attempts to match a specific target value. Unlike DistanceServoConstraintComponent, this constraint operates directly on the body centers rather than on specific points on the bodies. CenterDistanceLimitConstraintComponent Constrains the center of two bodies to be separated by a distance within a range. This constraint ensures that the distance between the center points of two bodies remains within a minimum and maximum range. Unlike DistanceLimitConstraintComponent, this constraint operates directly on the body centers rather than on specific points on the bodies. ConstraintComponentBase ConstraintComponent<T> DistanceLimitConstraintComponent Constrains points on two bodies to be separated by a distance within a specified range. This constraint ensures that the distance between two points on two bodies remains within a minimum and maximum range. It is useful for creating elastic or flexible connections between bodies, where the distance can vary within the specified limits. DistanceServoConstraintComponent Constrains points on two bodies to be separated by a target distance using servo settings. This constraint attempts to maintain a specific distance between two points on two bodies by applying forces to reach the target distance. It uses servo settings to control the speed and force applied to achieve the target distance. FourBodyConstraintComponent<T> HingeConstraintComponent LinearAxisLimitConstraintComponent LinearAxisMotorConstraintComponent LinearAxisServoConstraintComponent Constrains two bodies' position to a plane local to the first body OneBodyAngularMotorConstraintComponent OneBodyAngularServoConstraintComponent Constrains a single body to a target orientation in space, controlling both rotation and tilt. This constraint applies torque to make a body gradually align with a specific target orientation. It works like a spring system that pulls the body's orientation (rotation around any axis, including tilt) toward the specified target orientation. Common uses include: Stabilizing objects to maintain a specific orientation Creating motorized joints that rotate/tilt objects to desired angles Simulating gyroscopic or magnetic orientation control The spring and servo settings control how quickly and forcefully the body moves toward the target orientation. OneBodyConstraintComponent<T> OneBodyLinearMotorConstraintComponent OneBodyLinearServoConstraintComponent PointOnLineServoConstraintComponent SwingLimitConstraintComponent SwivelHingeConstraintComponent ThreeBodyConstraintComponent<T> TwistLimitConstraintComponent TwistMotorConstraintComponent TwistServoConstraintComponent TwoBodyConstraintComponent<T> VolumeConstraintComponent WeldConstraintComponent Interfaces IMotor Motors try to reach a given relative velocity between the connected bodies IOneBody IServo Servos change velocity of the connected bodies to achieve a position or orientation goal ISpring ITwoBody IWithTwoLocalOffset Enums ConstraintComponentBase.ConstraintState"
  },
  "api/Stride.BepuPhysics.Definitions.BodyVelocity.html": {
    "href": "api/Stride.BepuPhysics.Definitions.BodyVelocity.html",
    "title": "Struct BodyVelocity | Stride API",
    "summary": "Struct BodyVelocity Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll public struct BodyVelocity Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors BodyVelocity() public BodyVelocity() BodyVelocity(Vector3, Vector3) Creates a new set of body velocities. public BodyVelocity(Vector3 linear, Vector3 angular) Parameters linear Vector3 Linear velocity to use for the body. angular Vector3 Angular velocity to use for the body. Fields Angular Angular velocity associated with the body. public Vector3 Angular Field Value Vector3 Linear Linear velocity associated with the body. public Vector3 Linear Field Value Vector3"
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.BoxCollider.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.BoxCollider.html",
    "title": "Class BoxCollider | Stride API",
    "summary": "Class BoxCollider Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll [DataContract] public sealed class BoxCollider : ColliderBase Inheritance object ColliderBase BoxCollider Inherited Members ColliderBase.Mass ColliderBase.PositionLocal ColliderBase.RotationLocal ColliderBase.Container Extension Methods UnsafeUtilities.As<T>(object?) Properties Size public Vector3 Size { get; set; } Property Value Vector3 Remarks Changing this value will reset some of the internal physics state of this body"
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.CapsuleCollider.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.CapsuleCollider.html",
    "title": "Class CapsuleCollider | Stride API",
    "summary": "Class CapsuleCollider Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll [DataContract] public sealed class CapsuleCollider : ColliderBase Inheritance object ColliderBase CapsuleCollider Inherited Members ColliderBase.Mass ColliderBase.PositionLocal ColliderBase.RotationLocal ColliderBase.Container Extension Methods UnsafeUtilities.As<T>(object?) Properties Length public float Length { get; set; } Property Value float Remarks Changing this value will reset some of the internal physics state of this body Radius public float Radius { get; set; } Property Value float Remarks Changing this value will reset some of the internal physics state of this body"
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.ColliderBase.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.ColliderBase.html",
    "title": "Class ColliderBase | Stride API",
    "summary": "Class ColliderBase Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll [DataContract(Inherited = true)] public abstract class ColliderBase Inheritance object ColliderBase Derived BoxCollider CapsuleCollider ConvexHullCollider CylinderCollider SphereCollider TriangleCollider Extension Methods UnsafeUtilities.As<T>(object?) Properties Container public CompoundCollider? Container { get; } Property Value CompoundCollider Mass public float Mass { get; set; } Property Value float Remarks Changing this value will reset some of the internal physics state of this body PositionLocal Local position of this collider relative to its parent [DataAlias(\"LinearOffset\")] public Vector3 PositionLocal { get; set; } Property Value Vector3 Remarks Changing this value will reset some of the internal physics state of this body RotationLocal Local rotation of this collider relative to its parent public Quaternion RotationLocal { get; set; } Property Value Quaternion Remarks Changing this value will reset some of the internal physics state of this body Methods TryUpdateFeatures() protected void TryUpdateFeatures()"
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.CompoundCollider.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.CompoundCollider.html",
    "title": "Class CompoundCollider | Stride API",
    "summary": "Class CompoundCollider Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll Represents a compound collider that combines multiple child colliders into a single collider. [DataContract] public sealed class CompoundCollider : ICollider Inheritance object CompoundCollider Implements ICollider Extension Methods UnsafeUtilities.As<T>(object?) Constructors CompoundCollider() public CompoundCollider() Properties Colliders Gets the collection of child colliders that make up this compound collider. [DataMember] public IList<ColliderBase> Colliders { get; } Property Value IList<ColliderBase> A list of collider bases that form this compound shape. IsBig public bool IsBig { get; } Property Value bool Transforms public int Transforms { get; } Property Value int Methods GetLocalTransforms(CollidableComponent, Span<ShapeTransform>) Fills in a span to transform AppendModel(List<BasicMeshBuffers>, ShapeCacheSystem, out object) from their neutral transform into the one specified by its collidable. public void GetLocalTransforms(CollidableComponent collidable, Span<ShapeTransform> transforms) Parameters collidable CollidableComponent transforms Span<ShapeTransform> Remarks You must still transform this further into worldspace by using the world position and rotation the collidable's entity."
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.ConvexHullCollider.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.ConvexHullCollider.html",
    "title": "Class ConvexHullCollider | Stride API",
    "summary": "Class ConvexHullCollider Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll [DataContract] public sealed class ConvexHullCollider : ColliderBase Inheritance object ColliderBase ConvexHullCollider Inherited Members ColliderBase.Mass ColliderBase.PositionLocal ColliderBase.RotationLocal ColliderBase.Container Extension Methods UnsafeUtilities.As<T>(object?) Properties Hull public required DecomposedHulls Hull { get; set; } Property Value DecomposedHulls Remarks Changing this value will reset some of the internal physics state of this body"
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.CylinderCollider.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.CylinderCollider.html",
    "title": "Class CylinderCollider | Stride API",
    "summary": "Class CylinderCollider Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll [DataContract] public sealed class CylinderCollider : ColliderBase Inheritance object ColliderBase CylinderCollider Inherited Members ColliderBase.Mass ColliderBase.PositionLocal ColliderBase.RotationLocal ColliderBase.Container Extension Methods UnsafeUtilities.As<T>(object?) Properties Length public float Length { get; set; } Property Value float Remarks Changing this value will reset some of the internal physics state of this body Radius public float Radius { get; set; } Property Value float Remarks Changing this value will reset some of the internal physics state of this body"
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.EmptyCollider.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.EmptyCollider.html",
    "title": "Class EmptyCollider | Stride API",
    "summary": "Class EmptyCollider Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll [DataContract] public sealed class EmptyCollider : ICollider Inheritance object EmptyCollider Implements ICollider Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.ICollider.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.ICollider.html",
    "title": "Interface ICollider | Stride API",
    "summary": "Interface ICollider Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll public interface ICollider Extension Methods UnsafeUtilities.As<T>(object?) Properties Transforms int Transforms { get; } Property Value int Methods GetLocalTransforms(CollidableComponent, Span<ShapeTransform>) Fills in a span to transform AppendModel(List<BasicMeshBuffers>, ShapeCacheSystem, out object) from their neutral transform into the one specified by its collidable. void GetLocalTransforms(CollidableComponent collidable, Span<ShapeTransform> transforms) Parameters collidable CollidableComponent transforms Span<ShapeTransform> Remarks You must still transform this further into worldspace by using the world position and rotation the collidable's entity."
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.MeshCollider.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.MeshCollider.html",
    "title": "Class MeshCollider | Stride API",
    "summary": "Class MeshCollider Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll [DataContract] public sealed class MeshCollider : ICollider Inheritance object MeshCollider Implements ICollider Extension Methods UnsafeUtilities.As<T>(object?) Properties Closed Physics assume that the mesh's surface doesn't have any holes. That all edges of the mesh are shared between two triangles. public bool Closed { get; set; } Property Value bool Mass public float Mass { get; set; } Property Value float Model public required Model Model { get; set; } Property Value Model Transforms public int Transforms { get; } Property Value int Methods ComputeMeshScale(CollidableComponent) public static Vector3 ComputeMeshScale(CollidableComponent collidable) Parameters collidable CollidableComponent Returns Vector3 GetLocalTransforms(CollidableComponent, Span<ShapeTransform>) Fills in a span to transform AppendModel(List<BasicMeshBuffers>, ShapeCacheSystem, out object) from their neutral transform into the one specified by its collidable. public void GetLocalTransforms(CollidableComponent collidable, Span<ShapeTransform> transforms) Parameters collidable CollidableComponent transforms Span<ShapeTransform> Remarks You must still transform this further into worldspace by using the world position and rotation the collidable's entity."
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.SphereCollider.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.SphereCollider.html",
    "title": "Class SphereCollider | Stride API",
    "summary": "Class SphereCollider Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll [DataContract] public sealed class SphereCollider : ColliderBase Inheritance object ColliderBase SphereCollider Inherited Members ColliderBase.Mass ColliderBase.PositionLocal ColliderBase.RotationLocal ColliderBase.Container Extension Methods UnsafeUtilities.As<T>(object?) Properties Radius public float Radius { get; set; } Property Value float Remarks Changing this value will reset some of the internal physics state of this body"
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.TriangleCollider.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.TriangleCollider.html",
    "title": "Class TriangleCollider | Stride API",
    "summary": "Class TriangleCollider Namespace Stride.BepuPhysics.Definitions.Colliders Assembly Stride.BepuPhysics.dll [DataContract] public sealed class TriangleCollider : ColliderBase Inheritance object ColliderBase TriangleCollider Inherited Members ColliderBase.Mass ColliderBase.PositionLocal ColliderBase.RotationLocal ColliderBase.Container Extension Methods UnsafeUtilities.As<T>(object?) Properties A public Vector3 A { get; set; } Property Value Vector3 Remarks Changing this value will reset some of the internal physics state of this body B public Vector3 B { get; set; } Property Value Vector3 Remarks Changing this value will reset some of the internal physics state of this body C public Vector3 C { get; set; } Property Value Vector3 Remarks Changing this value will reset some of the internal physics state of this body"
  },
  "api/Stride.BepuPhysics.Definitions.Colliders.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Colliders.html",
    "title": "Namespace Stride.BepuPhysics.Definitions.Colliders | Stride API",
    "summary": "Namespace Stride.BepuPhysics.Definitions.Colliders Classes BoxCollider CapsuleCollider ColliderBase CompoundCollider Represents a compound collider that combines multiple child colliders into a single collider. ConvexHullCollider CylinderCollider EmptyCollider MeshCollider SphereCollider TriangleCollider Interfaces ICollider"
  },
  "api/Stride.BepuPhysics.Definitions.CollisionGroup.html": {
    "href": "api/Stride.BepuPhysics.Definitions.CollisionGroup.html",
    "title": "Struct CollisionGroup | Stride API",
    "summary": "Struct CollisionGroup Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll This value follows up CollisionLayer when filtering out collisions. It prevents collisions between objects sharing the same Id, when the absolute difference between their IndexA, IndexB, and IndexC is less than two. [DataContract] public struct CollisionGroup Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks Example A: You have multiple characters (A, B, C, D) all with the same CollisionLayer, they are split in two teams {A, B} and {C, D}, but you don't want members of the same team to collide between each other, you can set {A, B}'s Id to 1 and {C, D}'s Id to 2. Example B: You have a chain of three colliders attached to each other {A, B, C}, you don't want A and C to collide with B, but A and C should collide together. Set A, B and C's Ids to 1 to start filtering, leave A's IndexA at 0, B's to 1 and C to 2. A and C will collide since the difference between their IndexA is equal to two, but neither of them will collide with B since they are both only one away from B's index. Fields Id The identification number used by this object, zero when you don't want to filter more than CollisionLayer already does. public ushort Id Field Value ushort Remarks Set this value to the same number for all objects which should have their collisions ignored when colliding between each other. IndexA An index associated with this object in the collision group Id [DataAlias(\"XAxis\")] public ushort IndexA Field Value ushort Remarks For a bunch of objects sharing the same Id, if the two objects have the same or subsequent values, collision between those two objects will be ignored. But, if their values are more than one apart, they will collide with each other. IndexB An index associated with this object in the collision group Id [DataAlias(\"YAxis\")] public ushort IndexB Field Value ushort Remarks For a bunch of objects sharing the same Id, if the two objects have the same or subsequent values, collision between those two objects will be ignored. But, if their values are more than one apart, they will collide with each other. IndexC An index associated with this object in the collision group Id [DataAlias(\"ZAxis\")] public ushort IndexC Field Value ushort Remarks For a bunch of objects sharing the same Id, if the two objects have the same or subsequent values, collision between those two objects will be ignored. But, if their values are more than one apart, they will collide with each other."
  },
  "api/Stride.BepuPhysics.Definitions.CollisionMatrix.html": {
    "href": "api/Stride.BepuPhysics.Definitions.CollisionMatrix.html",
    "title": "Struct CollisionMatrix | Stride API",
    "summary": "Struct CollisionMatrix Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll Defines how layers collide between each other. public struct CollisionMatrix : IEquatable<CollisionMatrix> Implements IEquatable<CollisionMatrix> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks This structure is VERY large, prefer referencing it directly instead of passing it around. Fields All public static CollisionMatrix All Field Value CollisionMatrix DataBits public const int DataBits = 528 Field Value int DataLength public const int DataLength = 17 Field Value int Methods Equals(CollisionMatrix) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(CollisionMatrix other) Parameters other CollisionMatrix An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. Get(CollisionLayer) Return all layers colliding with a given layer public readonly CollisionMask Get(CollisionLayer layer) Parameters layer CollisionLayer Returns CollisionMask Remarks Prefer Get(CollisionLayer, CollisionLayer) over this one when checking a single layer Get(CollisionLayer, CollisionLayer) Returns whether two layers would collide with each other public readonly bool Get(CollisionLayer layer1, CollisionLayer layer2) Parameters layer1 CollisionLayer layer2 CollisionLayer Returns bool GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. LayersToIndex(CollisionLayer, CollisionLayer) public static int LayersToIndex(CollisionLayer layer1, CollisionLayer layer2) Parameters layer1 CollisionLayer layer2 CollisionLayer Returns int Set(CollisionLayer, CollisionLayer, bool) Set whether two layers should collide with each other public void Set(CollisionLayer layer1, CollisionLayer layer2, bool shouldCollide) Parameters layer1 CollisionLayer layer2 CollisionLayer shouldCollide bool Set(CollisionLayer, CollisionMask) Set all layers that should collide with a given layer public void Set(CollisionLayer layer, CollisionMask mask) Parameters layer CollisionLayer mask CollisionMask Remarks Prefer Set(CollisionLayer, CollisionLayer, bool) over this one when setting one or two layers Operators operator ==(CollisionMatrix, CollisionMatrix) public static bool operator ==(CollisionMatrix left, CollisionMatrix right) Parameters left CollisionMatrix right CollisionMatrix Returns bool operator !=(CollisionMatrix, CollisionMatrix) public static bool operator !=(CollisionMatrix left, CollisionMatrix right) Parameters left CollisionMatrix right CollisionMatrix Returns bool"
  },
  "api/Stride.BepuPhysics.Definitions.Contacts.Contact-1.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Contacts.Contact-1.html",
    "title": "Struct Contact<TManifold> | Stride API",
    "summary": "Struct Contact<TManifold> Namespace Stride.BepuPhysics.Definitions.Contacts Assembly Stride.BepuPhysics.dll An individual contact public ref struct Contact<TManifold> where TManifold : unmanaged, IContactManifold<TManifold> Type Parameters TManifold Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Fields ContactGroup The group this contact is a part of public ContactGroup<TManifold> ContactGroup Field Value ContactGroup<TManifold> Contacts The contact info pair this contact is a part of public readonly Contacts<TManifold> Contacts Field Value Contacts<TManifold> Index The index used when reading into this group's manifold to retrieve this contact public readonly int Index Field Value int Properties Depth How far the two collidables intersect public float Depth { get; } Property Value float FeatureId Gets the feature id associated with this contact public int FeatureId { get; } Property Value int Normal The normal on Other's surface. Points from Other towards EventSource's surface public Vector3 Normal { get; } Property Value Vector3 OtherChildIndex When Other has a CompoundCollider, this is the index of the collider in that collection which EventSource collided with. public int OtherChildIndex { get; } Property Value int Point The position at which the contact occured public Vector3 Point { get; } Property Value Vector3 Remarks This may not be accurate if they separated within this tick, or when you removed either of them from the simulation within this scope SourceChildIndex When EventSource has a CompoundCollider, this is the index of the collider in that collection which Other collided with. public int SourceChildIndex { get; } Property Value int"
  },
  "api/Stride.BepuPhysics.Definitions.Contacts.ContactGroup-1.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Contacts.ContactGroup-1.html",
    "title": "Struct ContactGroup<TManifold> | Stride API",
    "summary": "Struct ContactGroup<TManifold> Namespace Stride.BepuPhysics.Definitions.Contacts Assembly Stride.BepuPhysics.dll A set of contacts generated from two collidables public struct ContactGroup<TManifold> where TManifold : unmanaged, IContactManifold<TManifold> Type Parameters TManifold Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ContactGroup(ref TManifold, CollidablePair, int, int) public ContactGroup(ref TManifold manifold, CollidablePair pair, int childIndexA, int childIndexB) Parameters manifold TManifold pair CollidablePair childIndexA int childIndexB int Fields ChildIndexA When BepuPhysics.CollisionDetection.CollidablePair.A has a CompoundCollider, this is the index of the collider in that collection which is in contact. public readonly int ChildIndexA Field Value int ChildIndexB When BepuPhysics.CollisionDetection.CollidablePair.B has a CompoundCollider, this is the index of the collider in that collection which is in contact. public readonly int ChildIndexB Field Value int Manifold The manifold associated with this collision public TManifold Manifold Field Value TManifold Pair The raw id for the two collidables that generated this contact group public readonly CollidablePair Pair Field Value CollidablePair SortedPair Pair sorted in a deterministic order public readonly (uint A, uint B) SortedPair Field Value (uint A, uint B)"
  },
  "api/Stride.BepuPhysics.Definitions.Contacts.Contacts-1.Enumerator.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Contacts.Contacts-1.Enumerator.html",
    "title": "Struct Contacts<TManifold>.Enumerator | Stride API",
    "summary": "Struct Contacts<TManifold>.Enumerator Namespace Stride.BepuPhysics.Definitions.Contacts Assembly Stride.BepuPhysics.dll The enumerator for Contacts<TManifold> public ref struct Contacts<TManifold>.Enumerator Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Constructors Enumerator(Contacts<TManifold>) The enumerator for Contacts<TManifold> public Enumerator(Contacts<TManifold> data) Parameters data Contacts<TManifold> Properties Current public Contact<TManifold> Current { get; } Property Value Contact<TManifold> Methods MoveNext() public bool MoveNext() Returns bool"
  },
  "api/Stride.BepuPhysics.Definitions.Contacts.Contacts-1.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Contacts.Contacts-1.html",
    "title": "Struct Contacts<TManifold> | Stride API",
    "summary": "Struct Contacts<TManifold> Namespace Stride.BepuPhysics.Definitions.Contacts Assembly Stride.BepuPhysics.dll Enumerate over this structure to get individual contact public readonly ref struct Contacts<TManifold> where TManifold : unmanaged, IContactManifold<TManifold> Type Parameters TManifold Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Properties EventSource The collidable which is bound to this IContactHandler public required CollidableComponent EventSource { get; init; } Property Value CollidableComponent Groups Contact group registered between these two bodies, one per compound child hit public required ReadOnlySpan<ContactGroup<TManifold>> Groups { get; init; } Property Value ReadOnlySpan<ContactGroup<TManifold>> IsSourceOriginalA Whether EventSource maps to the unsorted, original A public required bool IsSourceOriginalA { get; init; } Property Value bool Other The other collidable public required CollidableComponent Other { get; init; } Property Value CollidableComponent Simulation The simulation this contact occured in public required BepuSimulation Simulation { get; init; } Property Value BepuSimulation Methods ComputeImpactForce(Contact<TManifold>) [Pure] public Vector3 ComputeImpactForce(Contact<TManifold> contact) Parameters contact Contact<TManifold> Returns Vector3 GetEnumerator() Enumerate over this structure to get individual contact public Contacts<TManifold>.Enumerator GetEnumerator() Returns Contacts<TManifold>.Enumerator"
  },
  "api/Stride.BepuPhysics.Definitions.Contacts.IContactEventHandler.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Contacts.IContactEventHandler.html",
    "title": "Interface IContactEventHandler | Stride API",
    "summary": "Interface IContactEventHandler Namespace Stride.BepuPhysics.Definitions.Contacts Assembly Stride.BepuPhysics.dll Implements handlers for various collision events. [Obsolete(\"IContactEventHandler as been superseded by IContactHandler, update your contact methods when migrating to this new class\")] public interface IContactEventHandler : IContactHandler Inherited Members IContactHandler.OnStartedTouching<TManifold>(Contacts<TManifold>) IContactHandler.OnTouching<TManifold>(Contacts<TManifold>) IContactHandler.OnStoppedTouching<TManifold>(Contacts<TManifold>) Extension Methods UnsafeUtilities.As<T>(object?) Properties NoContactResponse Whether the object this is attached to should let colliders pass through it [Obsolete(\"IContactEventHandler as been superseded by IContactHandler, this property will never be called\")] bool NoContactResponse { get; } Property Value bool Methods OnContactAdded<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, int, BepuSimulation) Fires when a contact is added. [Obsolete(\"IContactEventHandler as been superseded by IContactHandler, this method will never be called\", true)] void OnContactAdded<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int contactIndex, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold> Parameters eventSource CollidableComponent Collidable that the event was attached to. other CollidableComponent Other collider eventSource collided with. contactManifold TManifold Set of remaining contacts in the collision. flippedManifold bool Whether the manifold's normals and offset is flipped from the source's point of view. contactIndex int Index of the new contact in the contact manifold. workerIndex int Index of the worker thread that fired this event. bepuSimulation BepuSimulation The simulation where the contact occured. Type Parameters TManifold Type of the contact manifold detected. Remarks This may be called before OnStartedTouching<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation), contacts are registered when two collidables are close enough, not necessarily when actually touching. OnContactRemoved<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, int, BepuSimulation) Fires when a contact is removed. [Obsolete(\"IContactEventHandler as been superseded by IContactHandler, this method will never be called\", true)] void OnContactRemoved<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int removedFeatureId, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold> Parameters eventSource CollidableComponent Collidable that the event was attached to. other CollidableComponent Other collider eventSource collided with. contactManifold TManifold Set of remaining contacts in the collision. flippedManifold bool Whether the manifold's normals and offset is flipped from the source's point of view. removedFeatureId int Feature id of the contact that was removed and is no longer present in the contact manifold. workerIndex int Index of the worker thread that fired this event. bepuSimulation BepuSimulation The simulation where the contact occured. Type Parameters TManifold Type of the contact manifold detected. Remarks This may be called without a corresponding call to OnStoppedTouching<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation), contacts are registered when two collidables are close enough, not necessarily when actually touching. If the two collidables grazed each other, none of the touching methods will be called. OnPairCreated<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation) Fires when a pair is observed for the first time. [Obsolete(\"IContactEventHandler as been superseded by IContactHandler, this method will never be called\", true)] void OnPairCreated<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold> Parameters eventSource CollidableComponent Collidable that the event was attached to. other CollidableComponent Other collider eventSource collided with. contactManifold TManifold Set of remaining contacts in the collision. flippedManifold bool Whether the manifold's normals and offset is flipped from the source's point of view. workerIndex int Index of the worker thread that fired this event. bepuSimulation BepuSimulation The simulation where the contact occured. Type Parameters TManifold Type of the contact manifold detected. OnPairEnded(CollidableComponent, CollidableComponent, BepuSimulation) Fires when a pair ends. [Obsolete(\"IContactEventHandler as been superseded by IContactHandler, this method will never be called\", true)] void OnPairEnded(CollidableComponent eventSource, CollidableComponent other, BepuSimulation bepuSimulation) Parameters eventSource CollidableComponent Collidable that the event was attached to. other CollidableComponent Other collider eventSource collided with. bepuSimulation BepuSimulation The simulation where the contact occured. OnPairUpdated<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation) Fires whenever a pair is updated. Will not fire for sleeping pairs. [Obsolete(\"IContactEventHandler as been superseded by IContactHandler, this method will never be called\", true)] void OnPairUpdated<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold> Parameters eventSource CollidableComponent Collidable that the event was attached to. other CollidableComponent Other collider eventSource collided with. contactManifold TManifold Set of remaining contacts in the collision. flippedManifold bool Whether the manifold's normals and offset is flipped from the source's point of view. workerIndex int Index of the worker thread that fired this event. bepuSimulation BepuSimulation The simulation where the contact occured. Type Parameters TManifold Type of the contact manifold detected. OnStartedTouching<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation) Fires the first time a pair is observed to be touching. Touching means that there are contacts with nonnegative depths in the manifold. [Obsolete(\"IContactEventHandler as been superseded by IContactHandler\")] void OnStartedTouching<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold> Parameters eventSource CollidableComponent Collidable that the event was attached to. other CollidableComponent Other collider eventSource collided with. contactManifold TManifold Set of remaining contacts in the collision. flippedManifold bool Whether the manifold's normals and offset is flipped from the source's point of view. workerIndex int Index of the worker thread that fired this event. bepuSimulation BepuSimulation The simulation where the contact occured. Type Parameters TManifold Type of the contact manifold detected. OnStoppedTouching<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation) Fires when a pair stops touching. Touching means that there are contacts with nonnegative depths in the manifold. [Obsolete(\"IContactEventHandler as been superseded by IContactHandler\")] void OnStoppedTouching<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold> Parameters eventSource CollidableComponent Collidable that the event was attached to. other CollidableComponent Other collider eventSource collided with. contactManifold TManifold Set of remaining contacts in the collision. flippedManifold bool Whether the manifold's normals and offset is flipped from the source's point of view. workerIndex int Index of the worker thread that fired this event. bepuSimulation BepuSimulation The simulation where the contact occured. Type Parameters TManifold Type of the contact manifold detected. OnTouching<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation) Fires whenever a pair is observed to be touching. Touching means that there are contacts with nonnegative depths in the manifold. Will not fire for sleeping pairs. [Obsolete(\"IContactEventHandler as been superseded by IContactHandler\")] void OnTouching<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold> Parameters eventSource CollidableComponent Collidable that the event was attached to. other CollidableComponent Other collider eventSource collided with. contactManifold TManifold Set of remaining contacts in the collision. flippedManifold bool Whether the manifold's normals and offset is flipped from the source's point of view. workerIndex int Index of the worker thread that fired this event. bepuSimulation BepuSimulation The simulation where the contact occured. Type Parameters TManifold Type of the contact manifold detected."
  },
  "api/Stride.BepuPhysics.Definitions.Contacts.IContactHandler.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Contacts.IContactHandler.html",
    "title": "Interface IContactHandler | Stride API",
    "summary": "Interface IContactHandler Namespace Stride.BepuPhysics.Definitions.Contacts Assembly Stride.BepuPhysics.dll public interface IContactHandler Extension Methods UnsafeUtilities.As<T>(object?) Properties NoContactResponse Whether the object this is attached to should let colliders pass through it bool NoContactResponse { get; } Property Value bool Methods OnStartedTouching<TManifold>(Contacts<TManifold>) Fires the first time a pair is observed to be touching. Touching means that there are contacts with nonnegative depths in the manifold. void OnStartedTouching<TManifold>(Contacts<TManifold> contacts) where TManifold : unmanaged, IContactManifold<TManifold> Parameters contacts Contacts<TManifold> Data associated with this contact event. Type Parameters TManifold Type of the contact manifold detected. OnStoppedTouching<TManifold>(Contacts<TManifold>) Fires when a pair stops touching. Touching means that there are contacts with nonnegative depths in the manifold. void OnStoppedTouching<TManifold>(Contacts<TManifold> contacts) where TManifold : unmanaged, IContactManifold<TManifold> Parameters contacts Contacts<TManifold> Data associated with this contact event. Type Parameters TManifold Type of the contact manifold detected. OnTouching<TManifold>(Contacts<TManifold>) Fires whenever a pair is observed to be touching. Touching means that there are contacts with nonnegative depths in the manifold. Will not fire for sleeping pairs. void OnTouching<TManifold>(Contacts<TManifold> contacts) where TManifold : unmanaged, IContactManifold<TManifold> Parameters contacts Contacts<TManifold> Data associated with this contact event. Type Parameters TManifold Type of the contact manifold detected."
  },
  "api/Stride.BepuPhysics.Definitions.Contacts.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Contacts.html",
    "title": "Namespace Stride.BepuPhysics.Definitions.Contacts | Stride API",
    "summary": "Namespace Stride.BepuPhysics.Definitions.Contacts Structs ContactGroup<TManifold> A set of contacts generated from two collidables Contact<TManifold> An individual contact Contacts<TManifold> Enumerate over this structure to get individual contact Contacts<TManifold>.Enumerator The enumerator for Contacts<TManifold> Interfaces IContactEventHandler Implements handlers for various collision events. IContactHandler"
  },
  "api/Stride.BepuPhysics.Definitions.DecomposedHulls.DecomposedMesh.html": {
    "href": "api/Stride.BepuPhysics.Definitions.DecomposedHulls.DecomposedMesh.html",
    "title": "Class DecomposedHulls.DecomposedMesh | Stride API",
    "summary": "Class DecomposedHulls.DecomposedMesh Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll [DataContract] public class DecomposedHulls.DecomposedMesh Inheritance object DecomposedHulls.DecomposedMesh Extension Methods UnsafeUtilities.As<T>(object?) Constructors DecomposedMesh() public DecomposedMesh() DecomposedMesh(Hull[]) This method expects full ownership over this array public DecomposedMesh(DecomposedHulls.Hull[] hulls) Parameters hulls Hull[] Properties Hulls The hulls generated by decomposing this mesh public ReadOnlySpan<DecomposedHulls.Hull> Hulls { get; } Property Value ReadOnlySpan<DecomposedHulls.Hull>"
  },
  "api/Stride.BepuPhysics.Definitions.DecomposedHulls.Hull.html": {
    "href": "api/Stride.BepuPhysics.Definitions.DecomposedHulls.Hull.html",
    "title": "Class DecomposedHulls.Hull | Stride API",
    "summary": "Class DecomposedHulls.Hull Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll [DataContract] public class DecomposedHulls.Hull Inheritance object DecomposedHulls.Hull Extension Methods UnsafeUtilities.As<T>(object?) Constructors Hull() public Hull() Hull(Vector3[], uint[]) This method expects full ownership over those arrays public Hull(Vector3[] points, uint[] indices) Parameters points Vector3[] indices uint[] Properties Indices Indices used to recreate a 3d mesh from those points public ReadOnlySpan<uint> Indices { get; } Property Value ReadOnlySpan<uint> Points The points marking the bounds of the hull public ReadOnlySpan<Vector3> Points { get; } Property Value ReadOnlySpan<Vector3>"
  },
  "api/Stride.BepuPhysics.Definitions.DecomposedHulls.html": {
    "href": "api/Stride.BepuPhysics.Definitions.DecomposedHulls.html",
    "title": "Class DecomposedHulls | Stride API",
    "summary": "Class DecomposedHulls Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll A collection of convex hulls decomposed from an input model [DataContract] [ContentSerializer(typeof(DataContentSerializer<DecomposedHulls>))] [DataSerializerGlobal(typeof(CloneSerializer<DecomposedHulls>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(ReferenceSerializer<DecomposedHulls>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public class DecomposedHulls Inheritance object DecomposedHulls Extension Methods UnsafeUtilities.As<T>(object?) Constructors DecomposedHulls() public DecomposedHulls() DecomposedHulls(DecomposedMesh[]) This method expects full ownership over this array public DecomposedHulls(DecomposedHulls.DecomposedMesh[] meshes) Parameters meshes DecomposedMesh[] Properties Meshes Convex hulls for each meshes the decomposed model contained public ReadOnlySpan<DecomposedHulls.DecomposedMesh> Meshes { get; } Property Value ReadOnlySpan<DecomposedHulls.DecomposedMesh>"
  },
  "api/Stride.BepuPhysics.Definitions.ISimulationSelector.html": {
    "href": "api/Stride.BepuPhysics.Definitions.ISimulationSelector.html",
    "title": "Interface ISimulationSelector | Stride API",
    "summary": "Interface ISimulationSelector Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll Implement this to control which BepuSimulation a given component is assigned to public interface ISimulationSelector Extension Methods UnsafeUtilities.As<T>(object?) Methods Pick(BepuConfiguration, Entity) Go through available simulations and pick the most appropriate one for target BepuSimulation Pick(BepuConfiguration configuration, Entity target) Parameters configuration BepuConfiguration target Entity Returns BepuSimulation"
  },
  "api/Stride.BepuPhysics.Definitions.IVertexStructure.html": {
    "href": "api/Stride.BepuPhysics.Definitions.IVertexStructure.html",
    "title": "Interface IVertexStructure | Stride API",
    "summary": "Interface IVertexStructure Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll public interface IVertexStructure : IVertex Inherited Members IVertex.GetLayout() IVertex.FlipWinding() Extension Methods UnsafeUtilities.As<T>(object?) Methods Declaration() public static abstract VertexDeclaration Declaration() Returns VertexDeclaration"
  },
  "api/Stride.BepuPhysics.Definitions.IndexBasedSimulationSelector.html": {
    "href": "api/Stride.BepuPhysics.Definitions.IndexBasedSimulationSelector.html",
    "title": "Class IndexBasedSimulationSelector | Stride API",
    "summary": "Class IndexBasedSimulationSelector Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll This selector picks the simulation based on the simulation index [DataContract] public record IndexBasedSimulationSelector : ISimulationSelector, IEquatable<IndexBasedSimulationSelector> Inheritance object IndexBasedSimulationSelector Implements ISimulationSelector IEquatable<IndexBasedSimulationSelector> Extension Methods UnsafeUtilities.As<T>(object?) Properties Index public int Index { get; init; } Property Value int Methods Pick(BepuConfiguration, Entity) Go through available simulations and pick the most appropriate one for target public BepuSimulation Pick(BepuConfiguration configuration, Entity target) Parameters configuration BepuConfiguration target Entity Returns BepuSimulation"
  },
  "api/Stride.BepuPhysics.Definitions.InterpolationMode.html": {
    "href": "api/Stride.BepuPhysics.Definitions.InterpolationMode.html",
    "title": "Enum InterpolationMode | Stride API",
    "summary": "Enum InterpolationMode Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll public enum InterpolationMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Extrapolated = 2 The body will move from the current physics pose to a predicted one, reducing the latency but introducing imprecise or jerky motion when the pose changes significantly Interpolated = 1 The body will move from the previous physics pose to the current physics pose, introducing one physics update of latency but should be very smooth None = 0 No interpolation, the body will be moved on every physics update and left alone during normal updates"
  },
  "api/Stride.BepuPhysics.Definitions.MaterialProperties.html": {
    "href": "api/Stride.BepuPhysics.Definitions.MaterialProperties.html",
    "title": "Struct MaterialProperties | Stride API",
    "summary": "Struct MaterialProperties Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll public struct MaterialProperties Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields CollisionGroup public CollisionGroup CollisionGroup Field Value CollisionGroup FrictionCoefficient public float FrictionCoefficient Field Value float Gravity public bool Gravity Field Value bool IsTrigger public bool IsTrigger Field Value bool Layer public CollisionLayer Layer Field Value CollisionLayer MaximumRecoveryVelocity public float MaximumRecoveryVelocity Field Value float SpringSettings public SpringSettings SpringSettings Field Value SpringSettings"
  },
  "api/Stride.BepuPhysics.Definitions.RigidPose.html": {
    "href": "api/Stride.BepuPhysics.Definitions.RigidPose.html",
    "title": "Struct RigidPose | Stride API",
    "summary": "Struct RigidPose Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll public struct RigidPose Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors RigidPose() public RigidPose() RigidPose(Vector3, Quaternion) public RigidPose(Vector3 position, Quaternion orientation) Parameters position Vector3 orientation Quaternion Properties Orientation public Quaternion Orientation { readonly get; set; } Property Value Quaternion Position public Vector3 Position { readonly get; set; } Property Value Vector3"
  },
  "api/Stride.BepuPhysics.Definitions.SceneBasedSimulationSelector.html": {
    "href": "api/Stride.BepuPhysics.Definitions.SceneBasedSimulationSelector.html",
    "title": "Class SceneBasedSimulationSelector | Stride API",
    "summary": "Class SceneBasedSimulationSelector Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll This selector picks the simulation based on the scene the entity lives in, see AssociatedScene. [DataContract] public record SceneBasedSimulationSelector : ISimulationSelector, IEquatable<SceneBasedSimulationSelector> Inheritance object SceneBasedSimulationSelector Implements ISimulationSelector IEquatable<SceneBasedSimulationSelector> Extension Methods UnsafeUtilities.As<T>(object?) Remarks - Pick the first simulation whose scene matches the entity's scene. - If that fails, the first simulation whose scene is null. - If that failed too, The first simulation in the list. Fields Shared A read only instance which you can use instead of newing an instance public static readonly SceneBasedSimulationSelector Shared Field Value SceneBasedSimulationSelector Methods Pick(BepuConfiguration, Entity) Go through available simulations and pick the most appropriate one for target public BepuSimulation Pick(BepuConfiguration configuration, Entity target) Parameters configuration BepuConfiguration target Entity Returns BepuSimulation"
  },
  "api/Stride.BepuPhysics.Definitions.ShapeTransform.html": {
    "href": "api/Stride.BepuPhysics.Definitions.ShapeTransform.html",
    "title": "Struct ShapeTransform | Stride API",
    "summary": "Struct ShapeTransform Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll public struct ShapeTransform Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ShapeTransform() public ShapeTransform() Fields PositionLocal public Vector3 PositionLocal Field Value Vector3 RotationLocal public Quaternion RotationLocal Field Value Quaternion Scale public Vector3 Scale Field Value Vector3"
  },
  "api/Stride.BepuPhysics.Definitions.SimTests.ConversionEnum-3.Enumerator.html": {
    "href": "api/Stride.BepuPhysics.Definitions.SimTests.ConversionEnum-3.Enumerator.html",
    "title": "Struct ConversionEnum<TConverter, TSource, TDest>.Enumerator | Stride API",
    "summary": "Struct ConversionEnum<TConverter, TSource, TDest>.Enumerator Namespace Stride.BepuPhysics.Definitions.SimTests Assembly Stride.BepuPhysics.dll public ref struct ConversionEnum<TConverter, TSource, TDest>.Enumerator Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Properties Current public TDest Current { get; } Property Value TDest Methods MoveNext() public bool MoveNext() Returns bool"
  },
  "api/Stride.BepuPhysics.Definitions.SimTests.ConversionEnum-3.html": {
    "href": "api/Stride.BepuPhysics.Definitions.SimTests.ConversionEnum-3.html",
    "title": "Struct ConversionEnum<TConverter, TSource, TDest> | Stride API",
    "summary": "Struct ConversionEnum<TConverter, TSource, TDest> Namespace Stride.BepuPhysics.Definitions.SimTests Assembly Stride.BepuPhysics.dll public readonly ref struct ConversionEnum<TConverter, TSource, TDest> where TConverter : IConverter<TSource, TDest> where TSource : unmanaged Type Parameters TConverter TSource TDest Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Constructors ConversionEnum(Span<TSource>, TConverter) public ConversionEnum(Span<TSource> span, TConverter converter) Parameters span Span<TSource> converter TConverter Fields Span public readonly Span<TSource> Span Field Value Span<TSource> Methods GetEnumerator() public ConversionEnum<TConverter, TSource, TDest>.Enumerator GetEnumerator() Returns ConversionEnum<TConverter, TSource, TDest>.Enumerator"
  },
  "api/Stride.BepuPhysics.Definitions.SimTests.IConverter-2.html": {
    "href": "api/Stride.BepuPhysics.Definitions.SimTests.IConverter-2.html",
    "title": "Interface IConverter<TFrom, TTo> | Stride API",
    "summary": "Interface IConverter<TFrom, TTo> Namespace Stride.BepuPhysics.Definitions.SimTests Assembly Stride.BepuPhysics.dll public interface IConverter<TFrom, TTo> Type Parameters TFrom TTo Extension Methods UnsafeUtilities.As<T>(object?) Methods TryConvert(TFrom, out TTo) bool TryConvert(TFrom from, out TTo to) Parameters from TFrom to TTo Returns bool"
  },
  "api/Stride.BepuPhysics.Definitions.SimTests.ManagedConverter.html": {
    "href": "api/Stride.BepuPhysics.Definitions.SimTests.ManagedConverter.html",
    "title": "Struct ManagedConverter | Stride API",
    "summary": "Struct ManagedConverter Namespace Stride.BepuPhysics.Definitions.SimTests Assembly Stride.BepuPhysics.dll public readonly record struct ManagedConverter : IConverter<OverlapInfoStack, OverlapInfo>, IConverter<CollidableStack, CollidableComponent>, IConverter<HitInfoStack, HitInfo>, IEquatable<ManagedConverter> Implements IConverter<OverlapInfoStack, OverlapInfo> IConverter<CollidableStack, CollidableComponent> IConverter<HitInfoStack, HitInfo> IEquatable<ManagedConverter> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ManagedConverter(BepuSimulation) public ManagedConverter(BepuSimulation BepuSimulation) Parameters BepuSimulation BepuSimulation Properties BepuSimulation public BepuSimulation BepuSimulation { get; init; } Property Value BepuSimulation Methods TryConvert(CollidableStack, out CollidableComponent) public bool TryConvert(CollidableStack from, out CollidableComponent to) Parameters from CollidableStack to CollidableComponent Returns bool TryConvert(HitInfoStack, out HitInfo) public bool TryConvert(HitInfoStack from, out HitInfo to) Parameters from HitInfoStack to HitInfo Returns bool TryConvert(OverlapInfoStack, out OverlapInfo) public bool TryConvert(OverlapInfoStack from, out OverlapInfo to) Parameters from OverlapInfoStack to OverlapInfo Returns bool"
  },
  "api/Stride.BepuPhysics.Definitions.SimTests.html": {
    "href": "api/Stride.BepuPhysics.Definitions.SimTests.html",
    "title": "Namespace Stride.BepuPhysics.Definitions.SimTests | Stride API",
    "summary": "Namespace Stride.BepuPhysics.Definitions.SimTests Structs ConversionEnum<TConverter, TSource, TDest> ConversionEnum<TConverter, TSource, TDest>.Enumerator ManagedConverter Interfaces IConverter<TFrom, TTo>"
  },
  "api/Stride.BepuPhysics.Definitions.Trigger.html": {
    "href": "api/Stride.BepuPhysics.Definitions.Trigger.html",
    "title": "Class Trigger | Stride API",
    "summary": "Class Trigger Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll A contact event handler without collision response, which runs delegates on enter and exit [DataContract] public class Trigger : IContactHandler Inheritance object Trigger Implements IContactHandler Extension Methods UnsafeUtilities.As<T>(object?) Properties NoContactResponse Whether the object this is attached to should let colliders pass through it public bool NoContactResponse { get; } Property Value bool Methods OnStartedTouching<TManifold>(Contacts<TManifold>) Fires the first time a pair is observed to be touching. Touching means that there are contacts with nonnegative depths in the manifold. protected void OnStartedTouching<TManifold>(Contacts<TManifold> contacts) where TManifold : unmanaged, IContactManifold<TManifold> Parameters contacts Contacts<TManifold> Data associated with this contact event. Type Parameters TManifold Type of the contact manifold detected. OnStoppedTouching<TManifold>(Contacts<TManifold>) Fires when a pair stops touching. Touching means that there are contacts with nonnegative depths in the manifold. protected void OnStoppedTouching<TManifold>(Contacts<TManifold> contacts) where TManifold : unmanaged, IContactManifold<TManifold> Parameters contacts Contacts<TManifold> Data associated with this contact event. Type Parameters TManifold Type of the contact manifold detected. Events OnEnter public event TriggerDelegate? OnEnter Event Type TriggerDelegate OnLeave public event TriggerDelegate? OnLeave Event Type TriggerDelegate"
  },
  "api/Stride.BepuPhysics.Definitions.TriggerDelegate.html": {
    "href": "api/Stride.BepuPhysics.Definitions.TriggerDelegate.html",
    "title": "Delegate TriggerDelegate | Stride API",
    "summary": "Delegate TriggerDelegate Namespace Stride.BepuPhysics.Definitions Assembly Stride.BepuPhysics.dll public delegate void TriggerDelegate(CollidableComponent @this, CollidableComponent other) Parameters this CollidableComponent other CollidableComponent Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.BepuPhysics.Definitions.html": {
    "href": "api/Stride.BepuPhysics.Definitions.html",
    "title": "Namespace Stride.BepuPhysics.Definitions | Stride API",
    "summary": "Namespace Stride.BepuPhysics.Definitions Classes DecomposedHulls A collection of convex hulls decomposed from an input model DecomposedHulls.DecomposedMesh DecomposedHulls.Hull IndexBasedSimulationSelector This selector picks the simulation based on the simulation index SceneBasedSimulationSelector This selector picks the simulation based on the scene the entity lives in, see AssociatedScene. Trigger A contact event handler without collision response, which runs delegates on enter and exit Structs BodyVelocity CollisionGroup This value follows up CollisionLayer when filtering out collisions. It prevents collisions between objects sharing the same Id, when the absolute difference between their IndexA, IndexB, and IndexC is less than two. CollisionMatrix Defines how layers collide between each other. MaterialProperties RigidPose ShapeTransform Interfaces ISimulationSelector Implement this to control which BepuSimulation a given component is assigned to IVertexStructure Enums InterpolationMode Delegates TriggerDelegate"
  },
  "api/Stride.BepuPhysics.HitInfo.html": {
    "href": "api/Stride.BepuPhysics.HitInfo.html",
    "title": "Struct HitInfo | Stride API",
    "summary": "Struct HitInfo Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll Information returned by the different simulation test methods in BepuSimulation public readonly record struct HitInfo : IComparable<HitInfo>, IEquatable<HitInfo> Implements IComparable<HitInfo> IEquatable<HitInfo> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors HitInfo(Vector3, Vector3, float, CollidableComponent, int) Information returned by the different simulation test methods in BepuSimulation public HitInfo(Vector3 Point, Vector3 Normal, float Distance, CollidableComponent Collidable, int ChildIndex) Parameters Point Vector3 Normal Vector3 Distance float Collidable CollidableComponent ChildIndex int HitInfo(Vector3, Vector3, float, CollidableComponent, int) public HitInfo(Vector3 point, Vector3 normal, float distance, CollidableComponent collidable, int childIndex) Parameters point Vector3 normal Vector3 distance float collidable CollidableComponent childIndex int Properties ChildIndex The specific child hit if the Collidable's Collider is a CompoundCollider public int ChildIndex { get; init; } Property Value int Collidable The collidable hit public CollidableComponent Collidable { get; init; } Property Value CollidableComponent Distance The distance along the ray where the hit occured public float Distance { get; init; } Property Value float Normal The direction of the surface hit public Vector3 Normal { get; init; } Property Value Vector3 Point The position where the intersection occured public Vector3 Point { get; init; } Property Value Vector3 Methods CompareTo(HitInfo) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. public int CompareTo(HitInfo other) Parameters other HitInfo An object to compare with this instance. Returns int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order."
  },
  "api/Stride.BepuPhysics.HitInfoStack.html": {
    "href": "api/Stride.BepuPhysics.HitInfoStack.html",
    "title": "Struct HitInfoStack | Stride API",
    "summary": "Struct HitInfoStack Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll Structure used through the different simulation test methods in BepuSimulation public readonly record struct HitInfoStack : IEquatable<HitInfoStack> Implements IEquatable<HitInfoStack> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors HitInfoStack(CollidableStack, Vector3, Vector3, float, int) Structure used through the different simulation test methods in BepuSimulation public HitInfoStack(CollidableStack Collidable, Vector3 Point, Vector3 Normal, float Distance, int ChildIndex) Parameters Collidable CollidableStack Point Vector3 Normal Vector3 Distance float ChildIndex int Properties ChildIndex public int ChildIndex { get; init; } Property Value int Collidable public CollidableStack Collidable { get; init; } Property Value CollidableStack Distance public float Distance { get; init; } Property Value float Normal public Vector3 Normal { get; init; } Property Value Vector3 Point public Vector3 Point { get; init; } Property Value Vector3"
  },
  "api/Stride.BepuPhysics.OverlapInfo.html": {
    "href": "api/Stride.BepuPhysics.OverlapInfo.html",
    "title": "Struct OverlapInfo | Stride API",
    "summary": "Struct OverlapInfo Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll Information about an overlap test public readonly record struct OverlapInfo : IEquatable<OverlapInfo> Implements IEquatable<OverlapInfo> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors OverlapInfo(CollidableComponent, Vector3, float) Information about an overlap test public OverlapInfo(CollidableComponent Collidable, Vector3 PenetrationDirection, float PenetrationLength) Parameters Collidable CollidableComponent The object the test shape overlaps with PenetrationDirection Vector3 Direction the test shape as to move towards for it to exit out of this particular manifold PenetrationLength float Distance the test shape as to move towards for it to exit out of this particular manifold Properties Collidable The object the test shape overlaps with public CollidableComponent Collidable { get; init; } Property Value CollidableComponent PenetrationDirection Direction the test shape as to move towards for it to exit out of this particular manifold public Vector3 PenetrationDirection { get; init; } Property Value Vector3 PenetrationLength Distance the test shape as to move towards for it to exit out of this particular manifold public float PenetrationLength { get; init; } Property Value float"
  },
  "api/Stride.BepuPhysics.OverlapInfoStack.html": {
    "href": "api/Stride.BepuPhysics.OverlapInfoStack.html",
    "title": "Struct OverlapInfoStack | Stride API",
    "summary": "Struct OverlapInfoStack Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll Unmanaged low level information about an overlap test public readonly record struct OverlapInfoStack : IEquatable<OverlapInfoStack> Implements IEquatable<OverlapInfoStack> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors OverlapInfoStack(CollidableStack, Vector3, float) Unmanaged low level information about an overlap test public OverlapInfoStack(CollidableStack CollidableStack, Vector3 PenetrationDirection, float PenetrationLength) Parameters CollidableStack CollidableStack PenetrationDirection Vector3 Direction the test shape as to move towards for it to exit out of this particular manifold PenetrationLength float Distance the test shape as to move towards for it to exit out of this particular manifold Properties CollidableStack public CollidableStack CollidableStack { get; init; } Property Value CollidableStack PenetrationDirection Direction the test shape as to move towards for it to exit out of this particular manifold public Vector3 PenetrationDirection { get; init; } Property Value Vector3 PenetrationLength Distance the test shape as to move towards for it to exit out of this particular manifold public float PenetrationLength { get; init; } Property Value float"
  },
  "api/Stride.BepuPhysics.StaticComponent.html": {
    "href": "api/Stride.BepuPhysics.StaticComponent.html",
    "title": "Class StaticComponent | Stride API",
    "summary": "Class StaticComponent Namespace Stride.BepuPhysics Assembly Stride.BepuPhysics.dll [ComponentCategory(\"Physics - Bepu\")] public class StaticComponent : CollidableComponent, IIdentifiable Inheritance object EntityComponent CollidableComponent StaticComponent Implements IIdentifiable Inherited Members CollidableComponent.CategoryCollider CollidableComponent.CategoryForces CollidableComponent.CategoryContacts CollidableComponent.CategoryActivity CollidableComponent.ShapeIndex CollidableComponent.Simulation CollidableComponent.Collider CollidableComponent.SpringFrequency CollidableComponent.SpringDampingRatio CollidableComponent.FrictionCoefficient CollidableComponent.MaximumRecoveryVelocity CollidableComponent.SimulationSelector CollidableComponent.CollisionLayer CollidableComponent.CollisionGroup CollidableComponent.ContactEventHandler CollidableComponent.CenterOfMass CollidableComponent.TryUpdateMaterialProperties() CollidableComponent.RegisterContactHandler() CollidableComponent.UnregisterContactHandler() CollidableComponent.IsContactHandlerRegistered() CollidableComponent.RayCast(in Vector3, in Vector3, float, out HitInfo) CollidableComponent.RayCastPenetrating(in Vector3, in Vector3, float, Span<HitInfoStack>) CollidableComponent.RayCastPenetrating(in Vector3, in Vector3, float, ICollection<HitInfo>) EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties CollidableReference protected override CollidableReference? CollidableReference { get; } Property Value CollidableReference? ContinuousDetection public ContinuousDetection ContinuousDetection { get; set; } Property Value ContinuousDetection MaterialProperties protected override ref MaterialProperties MaterialProperties { get; } Property Value MaterialProperties Orientation public Quaternion Orientation { get; set; } Property Value Quaternion Pose protected override RigidPose? Pose { get; } Property Value RigidPose? Position public Vector3 Position { get; set; } Property Value Vector3 Methods AttachInner(RigidPose, BodyInertia, TypedIndex) Called every time this is added to a simulation protected override void AttachInner(RigidPose pose, BodyInertia shapeInertia, TypedIndex shapeIndex) Parameters pose RigidPose shapeInertia BodyInertia shapeIndex TypedIndex Remarks May occur when certain larger changes are made to the object, Simulation is the one this object is being added to DetachInner() Called every time this is removed from the simulation protected override void DetachInner() Remarks May occur right before AttachInner(RigidPose, BodyInertia, TypedIndex) when certain larger changes are made to the object, Simulation is the one this object was on prior to detaching"
  },
  "api/Stride.BepuPhysics.Systems.CollidableGizmo.html": {
    "href": "api/Stride.BepuPhysics.Systems.CollidableGizmo.html",
    "title": "Class CollidableGizmo | Stride API",
    "summary": "Class CollidableGizmo Namespace Stride.BepuPhysics.Systems Assembly Stride.BepuPhysics.dll [GizmoComponent(typeof(CollidableComponent), false)] public sealed class CollidableGizmo : IEntityGizmo, IGizmo, IDisposable Inheritance object CollidableGizmo Implements IEntityGizmo IGizmo IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors CollidableGizmo(CollidableComponent) public CollidableGizmo(CollidableComponent component) Parameters component CollidableComponent Properties IsEnabled Gets or sets the enabled state of the gizmo. public bool IsEnabled { get; set; } Property Value bool IsSelected Gets or sets the selected state of the gizmo. public bool IsSelected { get; set; } Property Value bool SizeFactor Gets or sets the size scale factor of the gizmo. public float SizeFactor { get; set; } Property Value float Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() HandlesComponentId(OpaqueComponentId, out Entity?) Used for picking gizmos on mouse down, returns true when that component was created by this gizmo public bool HandlesComponentId(OpaqueComponentId pickedComponentId, out Entity? selection) Parameters pickedComponentId OpaqueComponentId selection Entity Returns bool Initialize(IServiceRegistry, Scene) Initialize the gizmo. public void Initialize(IServiceRegistry services, Scene editorScene) Parameters services IServiceRegistry editorScene Scene Update() Updates the gizmo state. public void Update()"
  },
  "api/Stride.BepuPhysics.Systems.CollidableProcessor.html": {
    "href": "api/Stride.BepuPhysics.Systems.CollidableProcessor.html",
    "title": "Class CollidableProcessor | Stride API",
    "summary": "Class CollidableProcessor Namespace Stride.BepuPhysics.Systems Assembly Stride.BepuPhysics.dll public class CollidableProcessor : EntityProcessor<CollidableComponent> Inheritance object EntityProcessor EntityProcessor<CollidableComponent, CollidableComponent> EntityProcessor<CollidableComponent> CollidableProcessor Inherited Members EntityProcessor<CollidableComponent>.GenerateComponentData(Entity, CollidableComponent) EntityProcessor<CollidableComponent>.IsAssociatedDataValid(Entity, CollidableComponent, CollidableComponent) EntityProcessor<CollidableComponent, CollidableComponent>.ComponentDatas EntityProcessor<CollidableComponent, CollidableComponent>.OnSystemAdd() EntityProcessor<CollidableComponent, CollidableComponent>.OnSystemRemove() EntityProcessor<CollidableComponent, CollidableComponent>.RemoveAllEntities() EntityProcessor<CollidableComponent, CollidableComponent>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<CollidableComponent, CollidableComponent>.GenerateComponentData(Entity, CollidableComponent) EntityProcessor<CollidableComponent, CollidableComponent>.IsAssociatedDataValid(Entity, CollidableComponent, CollidableComponent) EntityProcessor<CollidableComponent, CollidableComponent>.OnEntityComponentAdding(Entity, CollidableComponent, CollidableComponent) EntityProcessor<CollidableComponent, CollidableComponent>.OnEntityComponentRemoved(Entity, CollidableComponent, CollidableComponent) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors CollidableProcessor() public CollidableProcessor() Fields OnPostAdd public Action<CollidableComponent>? OnPostAdd Field Value Action<CollidableComponent> OnPreRemove public Action<CollidableComponent>? OnPreRemove Field Value Action<CollidableComponent> Properties BepuConfiguration public BepuConfiguration BepuConfiguration { get; } Property Value BepuConfiguration Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext OnEntityComponentAdding(Entity, CollidableComponent, CollidableComponent) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, CollidableComponent component, CollidableComponent data) Parameters entity Entity The entity. component CollidableComponent data CollidableComponent The associated data. OnEntityComponentRemoved(Entity, CollidableComponent, CollidableComponent) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, CollidableComponent component, CollidableComponent data) Parameters entity Entity The entity. component CollidableComponent data CollidableComponent The associated data. OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd()"
  },
  "api/Stride.BepuPhysics.Systems.ConstraintGizmo.ShapeCache.html": {
    "href": "api/Stride.BepuPhysics.Systems.ConstraintGizmo.ShapeCache.html",
    "title": "Class ConstraintGizmo.ShapeCache | Stride API",
    "summary": "Class ConstraintGizmo.ShapeCache Namespace Stride.BepuPhysics.Systems Assembly Stride.BepuPhysics.dll protected class ConstraintGizmo.ShapeCache Inheritance object ConstraintGizmo.ShapeCache Extension Methods UnsafeUtilities.As<T>(object?) Constructors ShapeCache(GraphicsDevice) public ShapeCache(GraphicsDevice graphicsDevice) Parameters graphicsDevice GraphicsDevice Fields Box public readonly Mesh Box Field Value Mesh Cone public readonly Mesh Cone Field Value Mesh Cylinder public readonly Mesh Cylinder Field Value Mesh Disc public readonly Mesh Disc Field Value Mesh Sphere public readonly Mesh Sphere Field Value Mesh"
  },
  "api/Stride.BepuPhysics.Systems.ConstraintGizmo.html": {
    "href": "api/Stride.BepuPhysics.Systems.ConstraintGizmo.html",
    "title": "Class ConstraintGizmo | Stride API",
    "summary": "Class ConstraintGizmo Namespace Stride.BepuPhysics.Systems Assembly Stride.BepuPhysics.dll [GizmoComponent(typeof(ConstraintComponentBase), false)] public class ConstraintGizmo : IEntityGizmo, IGizmo, IDisposable Inheritance object ConstraintGizmo Implements IEntityGizmo IGizmo IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ConstraintGizmo(ConstraintComponentBase) public ConstraintGizmo(ConstraintComponentBase component) Parameters component ConstraintComponentBase Fields Shapes protected ConstraintGizmo.ShapeCache Shapes Field Value ConstraintGizmo.ShapeCache Properties IsEnabled Gets or sets the enabled state of the gizmo. public bool IsEnabled { get; set; } Property Value bool IsSelected Gets or sets the selected state of the gizmo. public bool IsSelected { get; set; } Property Value bool SizeFactor Gets or sets the size scale factor of the gizmo. public float SizeFactor { get; set; } Property Value float Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() HandlesComponentId(OpaqueComponentId, out Entity?) Used for picking gizmos on mouse down, returns true when that component was created by this gizmo public bool HandlesComponentId(OpaqueComponentId pickedComponentId, out Entity? selection) Parameters pickedComponentId OpaqueComponentId selection Entity Returns bool Initialize(IServiceRegistry, Scene) Initialize the gizmo. public void Initialize(IServiceRegistry services, Scene editorScene) Parameters services IServiceRegistry editorScene Scene Update() Updates the gizmo state. public void Update()"
  },
  "api/Stride.BepuPhysics.Systems.ConstraintProcessor.html": {
    "href": "api/Stride.BepuPhysics.Systems.ConstraintProcessor.html",
    "title": "Class ConstraintProcessor | Stride API",
    "summary": "Class ConstraintProcessor Namespace Stride.BepuPhysics.Systems Assembly Stride.BepuPhysics.dll public class ConstraintProcessor : EntityProcessor<ConstraintComponentBase> Inheritance object EntityProcessor EntityProcessor<ConstraintComponentBase, ConstraintComponentBase> EntityProcessor<ConstraintComponentBase> ConstraintProcessor Inherited Members EntityProcessor<ConstraintComponentBase>.GenerateComponentData(Entity, ConstraintComponentBase) EntityProcessor<ConstraintComponentBase>.IsAssociatedDataValid(Entity, ConstraintComponentBase, ConstraintComponentBase) EntityProcessor<ConstraintComponentBase, ConstraintComponentBase>.ComponentDatas EntityProcessor<ConstraintComponentBase, ConstraintComponentBase>.OnSystemAdd() EntityProcessor<ConstraintComponentBase, ConstraintComponentBase>.OnSystemRemove() EntityProcessor<ConstraintComponentBase, ConstraintComponentBase>.RemoveAllEntities() EntityProcessor<ConstraintComponentBase, ConstraintComponentBase>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<ConstraintComponentBase, ConstraintComponentBase>.GenerateComponentData(Entity, ConstraintComponentBase) EntityProcessor<ConstraintComponentBase, ConstraintComponentBase>.IsAssociatedDataValid(Entity, ConstraintComponentBase, ConstraintComponentBase) EntityProcessor<ConstraintComponentBase, ConstraintComponentBase>.OnEntityComponentAdding(Entity, ConstraintComponentBase, ConstraintComponentBase) EntityProcessor<ConstraintComponentBase, ConstraintComponentBase>.OnEntityComponentRemoved(Entity, ConstraintComponentBase, ConstraintComponentBase) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.Draw(RenderContext) EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors ConstraintProcessor() public ConstraintProcessor() Methods OnEntityComponentAdding(Entity, ConstraintComponentBase, ConstraintComponentBase) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, ConstraintComponentBase component, ConstraintComponentBase data) Parameters entity Entity The entity. component ConstraintComponentBase data ConstraintComponentBase The associated data. OnEntityComponentRemoved(Entity, ConstraintComponentBase, ConstraintComponentBase) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, ConstraintComponentBase component, ConstraintComponentBase data) Parameters entity Entity The entity. component ConstraintComponentBase data ConstraintComponentBase The associated data. OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd()"
  },
  "api/Stride.BepuPhysics.Systems.DefaultValueIsSceneBasedAttribute.html": {
    "href": "api/Stride.BepuPhysics.Systems.DefaultValueIsSceneBasedAttribute.html",
    "title": "Class DefaultValueIsSceneBasedAttribute | Stride API",
    "summary": "Class DefaultValueIsSceneBasedAttribute Namespace Stride.BepuPhysics.Systems Assembly Stride.BepuPhysics.dll See DefaultValueAttribute, this one specifies that the default value for the member is Shared public class DefaultValueIsSceneBasedAttribute : DefaultValueAttribute Inheritance object Attribute DefaultValueAttribute DefaultValueIsSceneBasedAttribute Inherited Members DefaultValueAttribute.Equals(object) DefaultValueAttribute.GetHashCode() DefaultValueAttribute.SetValue(object) DefaultValueAttribute.Value Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DefaultValueIsSceneBasedAttribute() See DefaultValueAttribute, this one specifies that the default value for the member is Shared public DefaultValueIsSceneBasedAttribute()"
  },
  "api/Stride.BepuPhysics.Systems.html": {
    "href": "api/Stride.BepuPhysics.Systems.html",
    "title": "Namespace Stride.BepuPhysics.Systems | Stride API",
    "summary": "Namespace Stride.BepuPhysics.Systems Classes CollidableGizmo CollidableProcessor ConstraintGizmo ConstraintGizmo.ShapeCache ConstraintProcessor DefaultValueIsSceneBasedAttribute See DefaultValueAttribute, this one specifies that the default value for the member is Shared"
  },
  "api/Stride.BepuPhysics.html": {
    "href": "api/Stride.BepuPhysics.html",
    "title": "Namespace Stride.BepuPhysics | Stride API",
    "summary": "Namespace Stride.BepuPhysics Classes BepuConfiguration BepuSimulation BodyComponent CharacterComponent CollidableComponent CollisionLayersExtension StaticComponent Structs BepuSimulation.TickAwaiter Await this struct to continue during a physics tick CollidableStack Unmanaged low level information about an overlap test HitInfo Information returned by the different simulation test methods in BepuSimulation HitInfoStack Structure used through the different simulation test methods in BepuSimulation OverlapInfo Information about an overlap test OverlapInfoStack Unmanaged low level information about an overlap test Enums CollisionLayer Represent a collision layer, used in conjunction with CollisionMask and CollisionMatrix CollisionMask Represents a collection of layers, any layer set in this value would be colliding."
  },
  "api/Stride.CompilationMode.html": {
    "href": "api/Stride.CompilationMode.html",
    "title": "Enum CompilationMode | Stride API",
    "summary": "Enum CompilationMode Namespace Stride Assembly Stride.dll An enum that describes the compilation mode used to compile a game. public enum CompilationMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AppStore = 2 The game was compiled in release mode for app-store (for end-user release) Impact on compilation on other components: Shaders are compiled in optimization level 2 with no debug information. Debug = 0 The game was compiled in debug mode. Impact on compilation on other components: Shaders are compiled in debug mode with debug information. Release = 1 The game was compiled in release mode. Impact on compilation on other components: Shaders are compiled in optimization level 1 with debug information. Testing = 3 The game was compiled in testing mode. Impact on compilation on other components: Shaders are compiled in debug mode with debug information."
  },
  "api/Stride.Core.AccessorMetadata.GetterDelegate.html": {
    "href": "api/Stride.Core.AccessorMetadata.GetterDelegate.html",
    "title": "Delegate AccessorMetadata.GetterDelegate | Stride API",
    "summary": "Delegate AccessorMetadata.GetterDelegate Namespace Stride.Core Assembly Stride.Core.dll Getter delegate public delegate object AccessorMetadata.GetterDelegate(ref PropertyContainer propertyContainer) Parameters propertyContainer PropertyContainer The property container holding the value. Returns object Returns the value Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.AccessorMetadata.SetterDelegate.html": {
    "href": "api/Stride.Core.AccessorMetadata.SetterDelegate.html",
    "title": "Delegate AccessorMetadata.SetterDelegate | Stride API",
    "summary": "Delegate AccessorMetadata.SetterDelegate Namespace Stride.Core Assembly Stride.Core.dll Setter delegate. public delegate void AccessorMetadata.SetterDelegate(ref PropertyContainer propertyContainer, object value) Parameters propertyContainer PropertyContainer The property container holding the value. value object The value to set Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.AccessorMetadata.html": {
    "href": "api/Stride.Core.AccessorMetadata.html",
    "title": "Class AccessorMetadata | Stride API",
    "summary": "Class AccessorMetadata Namespace Stride.Core Assembly Stride.Core.dll Metadata used for providing attached getter/setter to a PropertyKey. public class AccessorMetadata : PropertyKeyMetadata Inheritance object PropertyKeyMetadata AccessorMetadata Extension Methods UnsafeUtilities.As<T>(object?) Constructors AccessorMetadata(GetterDelegate, SetterDelegate) Initializes a new instance of the AccessorMetadata class. public AccessorMetadata(AccessorMetadata.GetterDelegate getter, AccessorMetadata.SetterDelegate setter) Parameters getter AccessorMetadata.GetterDelegate Getter delegate. setter AccessorMetadata.SetterDelegate Setter delegate. Methods GetValue(ref PropertyContainer) Gets the value from a PropertyContainer associated to this getter. public object GetValue(ref PropertyContainer obj) Parameters obj PropertyContainer the property container. Returns object The value stored. SetValue(ref PropertyContainer, object) Sets the value for a PropertyContainer value. public void SetValue(ref PropertyContainer obj, object value) Parameters obj PropertyContainer The property container. value object The value to set."
  },
  "api/Stride.Core.Annotations.CanBeNullAttribute.html": {
    "href": "api/Stride.Core.Annotations.CanBeNullAttribute.html",
    "title": "Class CanBeNullAttribute | Stride API",
    "summary": "Class CanBeNullAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll Indicates that the value of the marked element could be null sometimes, so the check for null is necessary before its usage. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Event|AttributeTargets.Interface|AttributeTargets.Parameter|AttributeTargets.Delegate|AttributeTargets.GenericParameter)] public sealed class CanBeNullAttribute : Attribute Inheritance object Attribute CanBeNullAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Examples [CanBeNull] object Test() => null; void UseTest() { var p = Test(); var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' }"
  },
  "api/Stride.Core.Annotations.CategoryOrderAttribute.html": {
    "href": "api/Stride.Core.Annotations.CategoryOrderAttribute.html",
    "title": "Class CategoryOrderAttribute | Stride API",
    "summary": "Class CategoryOrderAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll This attribute allows to associate an Order value to a category name. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct, AllowMultiple = true, Inherited = true)] public sealed class CategoryOrderAttribute : Attribute Inheritance object Attribute CategoryOrderAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors CategoryOrderAttribute(int, string) public CategoryOrderAttribute(int order, string name) Parameters order int name string Properties Expand Gets or sets whether to expand the category in the UI. public ExpandRule Expand { get; set; } Property Value ExpandRule Name Gets or sets the name of the category. public string Name { get; } Property Value string Order Gets or sets the order value of the category. public int Order { get; } Property Value int"
  },
  "api/Stride.Core.Annotations.DataMemberRangeAttribute.html": {
    "href": "api/Stride.Core.Annotations.DataMemberRangeAttribute.html",
    "title": "Class DataMemberRangeAttribute | Stride API",
    "summary": "Class DataMemberRangeAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll Defines range values for a property or field. [AttributeUsage(AttributeTargets.Property|AttributeTargets.Field)] public class DataMemberRangeAttribute : Attribute Inheritance object Attribute DataMemberRangeAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Remarks Minimum, Maximum and SmallStep must have the same type Constructors DataMemberRangeAttribute(double, double, double, double, int) Initializes a new instance of the DataMemberRangeAttribute class. public DataMemberRangeAttribute(double minimum, double maximum, double smallStep, double largeStep, int decimalPlaces) Parameters minimum double The minimum. maximum double The maximum. smallStep double The minimum step used to go from minimum to maximum. largeStep double The maximum step used to go from minimum to maximum. decimalPlaces int The decimal places. DataMemberRangeAttribute(double, int) Initializes a new instance of the DataMemberRangeAttribute class. public DataMemberRangeAttribute(double minimum, int decimalPlaces) Parameters minimum double The minimum. decimalPlaces int The decimal places Properties DecimalPlaces Gets the decimal places. public int? DecimalPlaces { get; } Property Value int? The decimal places. LargeStep Gets the maximum step. public double? LargeStep { get; } Property Value double? The maximum step. Maximum Gets the maximum inclusive. public double? Maximum { get; } Property Value double? The maximum. Minimum Gets the minimum inclusive. public double? Minimum { get; } Property Value double? The minimum. SmallStep Gets the minimum step. public double? SmallStep { get; } Property Value double? The minimum step."
  },
  "api/Stride.Core.Annotations.DynamicTypeAttributeBase.html": {
    "href": "api/Stride.Core.Annotations.DynamicTypeAttributeBase.html",
    "title": "Class DynamicTypeAttributeBase | Stride API",
    "summary": "Class DynamicTypeAttributeBase Namespace Stride.Core.Annotations Assembly Stride.Core.dll Base class for a dynamic type attribute. public abstract class DynamicTypeAttributeBase : Attribute Inheritance object Attribute DynamicTypeAttributeBase Derived AssetCompilerAttribute DefaultEntityComponentProcessorAttribute DefaultEntityComponentRendererAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DynamicTypeAttributeBase(string) Initializes a new instance of the DynamicTypeAttributeBase class. protected DynamicTypeAttributeBase(string typeName) Parameters typeName string The type. DynamicTypeAttributeBase(Type) Initializes a new instance of the DynamicTypeAttributeBase class. protected DynamicTypeAttributeBase(Type type) Parameters type Type The type. Properties TypeName Gets the name of the DynamicTypeAttributeBase type public string TypeName { get; } Property Value string The name of the serializable type."
  },
  "api/Stride.Core.Annotations.InlinePropertyAttribute.html": {
    "href": "api/Stride.Core.Annotations.InlinePropertyAttribute.html",
    "title": "Class InlinePropertyAttribute | Stride API",
    "summary": "Class InlinePropertyAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll This attribute indicates that the associated property should be inlined in its container presentation when displayed in a property grid. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Interface)] public sealed class InlinePropertyAttribute : Attribute Inheritance object Attribute InlinePropertyAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Properties Expand Gets or sets whether to expand the inline property in the UI. The default is Never. public ExpandRule Expand { get; set; } Property Value ExpandRule"
  },
  "api/Stride.Core.Annotations.ItemCanBeNullAttribute.html": {
    "href": "api/Stride.Core.Annotations.ItemCanBeNullAttribute.html",
    "title": "Class ItemCanBeNullAttribute | Stride API",
    "summary": "Class ItemCanBeNullAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll Can be appplied to symbols of types derived from IEnumerable<T> as well as to symbols of Task and Lazy<T> classes to indicate that the value of a collection item, of the Task.Result property or of the Lazy.Value property can be null. [AttributeUsage(AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.Delegate)] public sealed class ItemCanBeNullAttribute : Attribute Inheritance object Attribute ItemCanBeNullAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Annotations.ItemNotNullAttribute.html": {
    "href": "api/Stride.Core.Annotations.ItemNotNullAttribute.html",
    "title": "Class ItemNotNullAttribute | Stride API",
    "summary": "Class ItemNotNullAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll Can be appplied to symbols of types derived from IEnumerable<T> as well as to symbols of Task and Lazy<T> classes to indicate that the value of a collection item, of the Task.Result property or of the Lazy.Value property can never be null. [AttributeUsage(AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.Delegate)] public sealed class ItemNotNullAttribute : Attribute Inheritance object Attribute ItemNotNullAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Annotations.MemberCollectionAttribute.html": {
    "href": "api/Stride.Core.Annotations.MemberCollectionAttribute.html",
    "title": "Class MemberCollectionAttribute | Stride API",
    "summary": "Class MemberCollectionAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll This attributes provides additional information on a member collection. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Property|AttributeTargets.Field)] public sealed class MemberCollectionAttribute : Attribute Inheritance object Attribute MemberCollectionAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Properties CanReorderItems Gets or sets whether the items of this collection can be reordered. If true, applications using this collection should provide users a way to reorder items. public bool CanReorderItems { get; set; } Property Value bool NotNullItems Gets or sets whether the items of this collection can be null. If true, applications using this collection should prevent user to add null items to the collection. public bool NotNullItems { get; set; } Property Value bool ReadOnly Gets or sets whether this collection is read-only. If true, applications using this collection should not allow adding or removing items. public bool ReadOnly { get; set; } Property Value bool"
  },
  "api/Stride.Core.Annotations.MemberRequiredAttribute.html": {
    "href": "api/Stride.Core.Annotations.MemberRequiredAttribute.html",
    "title": "Class MemberRequiredAttribute | Stride API",
    "summary": "Class MemberRequiredAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll This attribute signals the asset compiler that the field/property is required to have a value (i.e. not null) when compiling assets. [AttributeUsage(AttributeTargets.Property|AttributeTargets.Field)] public class MemberRequiredAttribute : Attribute Inheritance object Attribute MemberRequiredAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Properties ReportAs Gets or sets the reporting level (warning/error) of the notification that the field/property is null. public MemberRequiredReportType ReportAs { get; set; } Property Value MemberRequiredReportType"
  },
  "api/Stride.Core.Annotations.MemberRequiredReportType.html": {
    "href": "api/Stride.Core.Annotations.MemberRequiredReportType.html",
    "title": "Enum MemberRequiredReportType | Stride API",
    "summary": "Enum MemberRequiredReportType Namespace Stride.Core.Annotations Assembly Stride.Core.dll Specifies the reporting level for a missing value of a field/property with a MemberRequiredAttribute. public enum MemberRequiredReportType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Error = 1 Report missing required member as an error. Warning = 0 Report missing required member as a warning."
  },
  "api/Stride.Core.Annotations.NonIdentifiableCollectionItemsAttribute.html": {
    "href": "api/Stride.Core.Annotations.NonIdentifiableCollectionItemsAttribute.html",
    "title": "Class NonIdentifiableCollectionItemsAttribute | Stride API",
    "summary": "Class NonIdentifiableCollectionItemsAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll This attribute indicates that a collection should not be serialized with identifiers associated to each of its item. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Property|AttributeTargets.Field)] public class NonIdentifiableCollectionItemsAttribute : Attribute Inheritance object Attribute NonIdentifiableCollectionItemsAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Remarks When this attribute is attached to a type (class or struct), any collection in that type or in a nested type will be serialized without identifier. When this attribute is attached to a member (property of field) that is a collection, only this collection will be serialized without identifier."
  },
  "api/Stride.Core.Annotations.NonInstantiableAttribute.html": {
    "href": "api/Stride.Core.Annotations.NonInstantiableAttribute.html",
    "title": "Class NonInstantiableAttribute | Stride API",
    "summary": "Class NonInstantiableAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll This attribute indicates that the associated type cannot be instanced in the property grid [AttributeUsage(AttributeTargets.Class|AttributeTargets.Interface)] public sealed class NonInstantiableAttribute : Attribute Inheritance object Attribute NonInstantiableAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Annotations.NonOverridableAttribute.html": {
    "href": "api/Stride.Core.Annotations.NonOverridableAttribute.html",
    "title": "Class NonOverridableAttribute | Stride API",
    "summary": "Class NonOverridableAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll This attribute notifies that the attached member cannot be overridden. [AttributeUsage(AttributeTargets.Property|AttributeTargets.Field)] public sealed class NonOverridableAttribute : Attribute Inheritance object Attribute NonOverridableAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Annotations.NotNullAttribute.html": {
    "href": "api/Stride.Core.Annotations.NotNullAttribute.html",
    "title": "Class NotNullAttribute | Stride API",
    "summary": "Class NotNullAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll Indicates that the value of the marked element could never be null. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Event|AttributeTargets.Interface|AttributeTargets.Parameter|AttributeTargets.Delegate|AttributeTargets.GenericParameter)] public sealed class NotNullAttribute : Attribute Inheritance object Attribute NotNullAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Examples [NotNull] object Foo() { return null; // Warning: Possible 'null' assignment }"
  },
  "api/Stride.Core.Annotations.ObjectFactoryAttribute.html": {
    "href": "api/Stride.Core.Annotations.ObjectFactoryAttribute.html",
    "title": "Class ObjectFactoryAttribute | Stride API",
    "summary": "Class ObjectFactoryAttribute Namespace Stride.Core.Annotations Assembly Stride.Core.dll An attribute that defines a factory class implementing IObjectFactory, used to create instances of the related type in design-time scenarios. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct)] public sealed class ObjectFactoryAttribute : Attribute Inheritance object Attribute ObjectFactoryAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors ObjectFactoryAttribute(Type) Initializes a new instance of the ObjectFactoryAttribute class. public ObjectFactoryAttribute(Type factoryType) Parameters factoryType Type The factory type that implements IObjectFactory. Properties FactoryType The type of the factory to use to create instance of the related type. public Type FactoryType { get; } Property Value Type"
  },
  "api/Stride.Core.Annotations.html": {
    "href": "api/Stride.Core.Annotations.html",
    "title": "Namespace Stride.Core.Annotations | Stride API",
    "summary": "Namespace Stride.Core.Annotations Classes CanBeNullAttribute Indicates that the value of the marked element could be null sometimes, so the check for null is necessary before its usage. CategoryOrderAttribute This attribute allows to associate an Order value to a category name. DataMemberRangeAttribute Defines range values for a property or field. DynamicTypeAttributeBase Base class for a dynamic type attribute. InlinePropertyAttribute This attribute indicates that the associated property should be inlined in its container presentation when displayed in a property grid. ItemCanBeNullAttribute Can be appplied to symbols of types derived from IEnumerable<T> as well as to symbols of Task and Lazy<T> classes to indicate that the value of a collection item, of the Task.Result property or of the Lazy.Value property can be null. ItemNotNullAttribute Can be appplied to symbols of types derived from IEnumerable<T> as well as to symbols of Task and Lazy<T> classes to indicate that the value of a collection item, of the Task.Result property or of the Lazy.Value property can never be null. MemberCollectionAttribute This attributes provides additional information on a member collection. MemberRequiredAttribute This attribute signals the asset compiler that the field/property is required to have a value (i.e. not null) when compiling assets. NonIdentifiableCollectionItemsAttribute This attribute indicates that a collection should not be serialized with identifiers associated to each of its item. NonInstantiableAttribute This attribute indicates that the associated type cannot be instanced in the property grid NonOverridableAttribute This attribute notifies that the attached member cannot be overridden. NotNullAttribute Indicates that the value of the marked element could never be null. ObjectFactoryAttribute An attribute that defines a factory class implementing IObjectFactory, used to create instances of the related type in design-time scenarios. Enums MemberRequiredReportType Specifies the reporting level for a missing value of a field/property with a MemberRequiredAttribute."
  },
  "api/Stride.Core.AnonymousDisposable.html": {
    "href": "api/Stride.Core.AnonymousDisposable.html",
    "title": "Class AnonymousDisposable | Stride API",
    "summary": "Class AnonymousDisposable Namespace Stride.Core Assembly Stride.Core.dll This class allows implementation of IDisposable using anonymous functions. The anonymous function will be invoked only on the first call to the Dispose() method. public sealed class AnonymousDisposable : IDisposable Inheritance object AnonymousDisposable Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors AnonymousDisposable(Action) Initializes a new instance of the AnonymousDisposable class. public AnonymousDisposable(Action onDispose) Parameters onDispose Action The anonymous function to invoke when this object is disposed. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose()"
  },
  "api/Stride.Core.Assets.Analysis.AssetAnalysis.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetAnalysis.html",
    "title": "Class AssetAnalysis | Stride API",
    "summary": "Class AssetAnalysis Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Analysis for AssetItem. public static class AssetAnalysis Inheritance object AssetAnalysis Methods FixAssetReferences(IEnumerable<AssetItem>) public static LoggerResult FixAssetReferences(IEnumerable<AssetItem> items) Parameters items IEnumerable<AssetItem> Returns LoggerResult Run(AssetItem, ILogger, AssetAnalysisParameters) public static void Run(AssetItem assetItem, ILogger log, AssetAnalysisParameters parameters) Parameters assetItem AssetItem log ILogger parameters AssetAnalysisParameters Run(IEnumerable<AssetItem>, AssetAnalysisParameters) public static LoggerResult Run(IEnumerable<AssetItem> items, AssetAnalysisParameters parameters) Parameters items IEnumerable<AssetItem> parameters AssetAnalysisParameters Returns LoggerResult Run(IEnumerable<AssetItem>, ILogger, AssetAnalysisParameters) public static void Run(IEnumerable<AssetItem> items, ILogger log, AssetAnalysisParameters parameters) Parameters items IEnumerable<AssetItem> log ILogger parameters AssetAnalysisParameters"
  },
  "api/Stride.Core.Assets.Analysis.AssetAnalysisParameters.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetAnalysisParameters.html",
    "title": "Class AssetAnalysisParameters | Stride API",
    "summary": "Class AssetAnalysisParameters Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Parameters for asset analysis. public class AssetAnalysisParameters Inheritance object AssetAnalysisParameters Derived PackageAnalysisParameters Extension Methods UnsafeUtilities.As<T>(object?) Properties ConvertUPathTo public UPathType ConvertUPathTo { get; set; } Property Value UPathType IsLoggingAssetNotFoundAsError public bool IsLoggingAssetNotFoundAsError { get; set; } Property Value bool IsProcessingAssetReferences public bool IsProcessingAssetReferences { get; set; } Property Value bool IsProcessingUPaths public bool IsProcessingUPaths { get; set; } Property Value bool SetDirtyFlagOnAssetWhenFixingAbsoluteUFile public bool SetDirtyFlagOnAssetWhenFixingAbsoluteUFile { get; set; } Property Value bool SetDirtyFlagOnAssetWhenFixingUFile public bool SetDirtyFlagOnAssetWhenFixingUFile { get; set; } Property Value bool Methods Clone() public virtual AssetAnalysisParameters Clone() Returns AssetAnalysisParameters"
  },
  "api/Stride.Core.Assets.Analysis.AssetBaseAnalysis.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetBaseAnalysis.html",
    "title": "Class AssetBaseAnalysis | Stride API",
    "summary": "Class AssetBaseAnalysis Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll An analysis to validate that all assets in a package have a valid Asset base. In order to be valid, this analysis must be run after a PackageAnalysis public sealed class AssetBaseAnalysis : PackageSessionAnalysisBase Inheritance object PackageSessionAnalysisBase AssetBaseAnalysis Inherited Members PackageSessionAnalysisBase.Session PackageSessionAnalysisBase.Run() Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetBaseAnalysis(PackageSession) Initializes a new instance of the AssetBaseAnalysis class. public AssetBaseAnalysis(PackageSession packageSession) Parameters packageSession PackageSession The package session. Methods Run(ILogger) Performs a wide package validation analysis. public override void Run(ILogger log) Parameters log ILogger The log to output the result of the validation. ValidateAssetBase(AssetItem) Validates the inheritance of an asset by checking base accessibility up to the root base. public LoggerValueResult<List<Asset>> ValidateAssetBase(AssetItem assetItem) Parameters assetItem AssetItem The asset item. Returns LoggerValueResult<List<Asset>> A logger result with a list of all the base in bottom-up orde. ValidateAssetBase(AssetItem, ILogger) Validates the inheritance of an asset by checking base accessibility up to the root base. public List<Asset> ValidateAssetBase(AssetItem assetItem, ILogger log) Parameters assetItem AssetItem The asset item. log ILogger The log to output the result of the analysis. Returns List<Asset> A list of all the base in bottom-up order. Exceptions ArgumentNullException asset or log ValidateAssetBase(ILogger) Validates the inheritance of all assets in the package. public HashSet<Asset> ValidateAssetBase(ILogger log) Parameters log ILogger The log to output the result of the analysis. Returns HashSet<Asset> A collection that contains all valid assets."
  },
  "api/Stride.Core.Assets.Analysis.AssetCollision.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetCollision.html",
    "title": "Class AssetCollision | Stride API",
    "summary": "Class AssetCollision Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll public static class AssetCollision Inheritance object AssetCollision Methods Clean(Package, ICollection<AssetItem>, ICollection<AssetItem>, AssetResolver, bool, bool) Cleans the specified input items. public static void Clean(Package package, ICollection<AssetItem> inputItems, ICollection<AssetItem> outputItems, AssetResolver assetResolver, bool cloneInput, bool removeUnloadableObjects) Parameters package Package The package to process (optional). inputItems ICollection<AssetItem> The input items. outputItems ICollection<AssetItem> The output items. assetResolver AssetResolver The asset resolver. cloneInput bool if set to true [clone input]. removeUnloadableObjects bool If set to true, assets will be cloned with RemoveUnloadableObjects. Exceptions ArgumentNullException inputItems or outputItems or assetResolver ArgumentException List cannot contain null items;inputItems"
  },
  "api/Stride.Core.Assets.Analysis.AssetDependencies.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetDependencies.html",
    "title": "Class AssetDependencies | Stride API",
    "summary": "Class AssetDependencies Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Describes dependencies (in/out/broken) for a specific asset. public class AssetDependencies Inheritance object AssetDependencies Extension Methods UnsafeUtilities.As<T>(object?) Remarks There are 3 types of dependencies: <ul> <li><code>in</code> dependencies: through the <xref href=\"Stride.Core.Assets.Analysis.AssetDependencies.LinksIn\" data-throw-if-not-resolved=\"false\"></xref> property, contains assets that are referencing this asset.</li> <li><code>out</code> dependencies: through the <xref href=\"Stride.Core.Assets.Analysis.AssetDependencies.LinksOut\" data-throw-if-not-resolved=\"false\"></xref> property, contains assets that are referenced by this asset.</li> <li><code>broken</code> dependencies: through the <xref href=\"Stride.Core.Assets.Analysis.AssetDependencies.BrokenLinksOut\" data-throw-if-not-resolved=\"false\"></xref> property, contains output links to assets that are missing.</li> </ul> Constructors AssetDependencies(AssetDependencies) public AssetDependencies(AssetDependencies set) Parameters set AssetDependencies AssetDependencies(AssetItem) public AssetDependencies(AssetItem assetItem) Parameters assetItem AssetItem Properties BrokenLinksOut Gets the links out. public IEnumerable<IContentLink> BrokenLinksOut { get; } Property Value IEnumerable<IContentLink> The missing references. HasMissingDependencies Gets a value indicating whether this instance has missing references. public bool HasMissingDependencies { get; } Property Value bool true if this instance has missing references; otherwise, false. Id public AssetId Id { get; } Property Value AssetId Item Gets the itemReferenced. public AssetItem Item { get; } Property Value AssetItem The itemReferenced. LinksIn Gets the links coming into the element. public IEnumerable<AssetLink> LinksIn { get; } Property Value IEnumerable<AssetLink> LinksOut Gets the links going out of the element. public IEnumerable<AssetLink> LinksOut { get; } Property Value IEnumerable<AssetLink> MissingDependencyCount Gets the number of missing dependencies of the asset. public int MissingDependencyCount { get; } Property Value int Methods AddBrokenLinkOut(IContentLink) Adds a broken link out. public void AddBrokenLinkOut(IContentLink contentLink) Parameters contentLink IContentLink The broken link Exceptions ArgumentException A broken link to this element already exists AddBrokenLinkOut(IReference, ContentLinkType) Adds a broken link out. public void AddBrokenLinkOut(IReference reference, ContentLinkType contentLinkType) Parameters reference IReference the reference to the missing element contentLinkType ContentLinkType The type of link Exceptions ArgumentException A broken link to this element already exists AddLinkIn(AssetLink) Adds a link coming from the provided element. public void AddLinkIn(AssetLink contentLink) Parameters contentLink AssetLink The link in Exceptions ArgumentException A link from this element already exists AddLinkIn(AssetItem, ContentLinkType) Adds a link going into the element. public void AddLinkIn(AssetItem fromItem, ContentLinkType contentLinkType) Parameters fromItem AssetItem The element the link is coming from contentLinkType ContentLinkType The type of link Exceptions ArgumentException A link from this element already exists AddLinkOut(AssetLink) Adds a link going to the provided element. public void AddLinkOut(AssetLink contentLink) Parameters contentLink AssetLink The link out Exceptions ArgumentException A link to this element already exists AddLinkOut(AssetItem, ContentLinkType) Adds a link going to the provided element. public void AddLinkOut(AssetItem toItem, ContentLinkType contentLinkType) Parameters toItem AssetItem The element the link is going to contentLinkType ContentLinkType The type of link Exceptions ArgumentException A link to this element already exists GetBrokenLinkOut(AssetId) Gets the broken link out to the provided element. public IContentLink GetBrokenLinkOut(AssetId id) Parameters id AssetId The id of the element the link is going to Returns IContentLink The link Exceptions ArgumentException There is not link to the provided element ArgumentNullException toItem GetLinkIn(AssetItem) Gets the link coming from the provided element. public AssetLink GetLinkIn(AssetItem fromItem) Parameters fromItem AssetItem The element the link is coming from Returns AssetLink The link Exceptions ArgumentException There is not link to the provided element ArgumentNullException fromItem GetLinkOut(AssetItem) Gets the link going to the provided element. public AssetLink GetLinkOut(AssetItem toItem) Parameters toItem AssetItem The element the link is going to Returns AssetLink The link Exceptions ArgumentException There is not link to the provided element ArgumentNullException toItem RemoveBrokenLinkOut(AssetId) Removes the broken link to the provided element. public IContentLink RemoveBrokenLinkOut(AssetId id) Parameters id AssetId The id to the missing element Returns IContentLink The removed link Exceptions ArgumentNullException toItem RemoveLinkIn(AssetItem) Removes the link coming from the provided element. public AssetLink RemoveLinkIn(AssetItem fromItem) Parameters fromItem AssetItem The element the link is coming from Returns AssetLink The removed link Exceptions ArgumentNullException fromItem RemoveLinkOut(AssetItem) Removes the link going to the provided element. public AssetLink RemoveLinkOut(AssetItem toItem) Parameters toItem AssetItem The element the link is going to Returns AssetLink The removed link Exceptions ArgumentNullException toItem Reset(bool) Resets this instance and clear all dependencies (including missing) public void Reset(bool keepParents) Parameters keepParents bool"
  },
  "api/Stride.Core.Assets.Analysis.AssetDependencyManager.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetDependencyManager.html",
    "title": "Class AssetDependencyManager | Stride API",
    "summary": "Class AssetDependencyManager Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll A class responsible for providing asset dependencies for a PackageSession and file tracking dependency. public sealed class AssetDependencyManager : IAssetDependencyManager, IDisposable Inheritance object AssetDependencyManager Implements IAssetDependencyManager IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks This class provides methods to: Find assets referencing a particular asset (recursively or not) Find assets referenced by a particular asset (recursively or not) Find missing references Find missing references for a particular asset Find assets file changed events that have changed on the disk Properties IsInitialized Gets a value indicating whether this instance is initialized. See remarks. public bool IsInitialized { get; } Property Value bool true if this instance is initialized; otherwise, false. Remarks If this instance is not initialized, all public methods may block until the full initialization of this instance. Methods BeginSavingSession() This methods is called when a session is about to being saved. public void BeginSavingSession() ComputeDependencies(AssetId, AssetDependencySearchOptions, ContentLinkType, HashSet<AssetId>?) Computes the dependencies for the specified asset. public AssetDependencies? ComputeDependencies(AssetId assetId, AssetDependencySearchOptions dependenciesOptions = AssetDependencySearchOptions.All, ContentLinkType linkTypes = ContentLinkType.All, HashSet<AssetId>? visited = null) Parameters assetId AssetId The asset id. dependenciesOptions AssetDependencySearchOptions The dependencies options. linkTypes ContentLinkType The type of links to visit while computing the dependencies visited HashSet<AssetId> The list of element already visited. Returns AssetDependencies The dependencies, or null if the object is not tracked. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() EndSavingSession() This methods is called when a session has been saved. public void EndSavingSession() Events AssetChanged Occurs when a asset changed. This event is called in the critical section of the dependency manager, meaning that dependencies can be safely computed via ComputeDependencies(AssetId, AssetDependencySearchOptions, ContentLinkType, HashSet<AssetId>?) method from this callback. public event DirtyFlagChangedDelegate<AssetItem>? AssetChanged Event Type DirtyFlagChangedDelegate<AssetItem>"
  },
  "api/Stride.Core.Assets.Analysis.AssetDependencySearchOptions.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetDependencySearchOptions.html",
    "title": "Enum AssetDependencySearchOptions | Stride API",
    "summary": "Enum AssetDependencySearchOptions Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Options used when searching asset dependencies. [Flags] public enum AssetDependencySearchOptions Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields All = InOut | Recursive Search recursively all in and out dependencies. In = 1 Search for in only dependencies. InOut = In | Out Search for in and out dependencies. Out = 2 Search for out only dependencies. Recursive = 4 Search recursively"
  },
  "api/Stride.Core.Assets.Analysis.AssetFileChangedEvent.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetFileChangedEvent.html",
    "title": "Class AssetFileChangedEvent | Stride API",
    "summary": "Class AssetFileChangedEvent Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll An event that notifies the type of disk change for an asset. public class AssetFileChangedEvent : EventArgs Inheritance object EventArgs AssetFileChangedEvent Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetFileChangedEvent(Package, AssetFileChangedType, UFile) Initializes a new instance of the AssetFileChangedEvent class. public AssetFileChangedEvent(Package package, AssetFileChangedType changeType, UFile assetLocation) Parameters package Package The package. changeType AssetFileChangedType Type of the change. assetLocation UFile The asset URL. Properties AssetId Gets or sets the asset identifier. public Guid AssetId { get; set; } Property Value Guid The asset identifier. AssetLocation Gets the asset location relative to the package. public UFile? AssetLocation { get; set; } Property Value UFile The asset location. ChangeType Gets the type of the change. public AssetFileChangedType ChangeType { get; set; } Property Value AssetFileChangedType The type of the change. Hash Gets or sets the hash of the asset source (optional). public ObjectId? Hash { get; set; } Property Value ObjectId? The hash of the asset source. Package Gets the package the event is related to. public Package Package { get; set; } Property Value Package The package."
  },
  "api/Stride.Core.Assets.Analysis.AssetFileChangedType.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetFileChangedType.html",
    "title": "Enum AssetFileChangedType | Stride API",
    "summary": "Enum AssetFileChangedType Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Type of a change event for an asset. [Flags] public enum AssetFileChangedType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Added = 1 An asset was added to the disk AssetEventMask = Added | Deleted | Updated The asset event mask (Added | Deleted | Updated). Deleted = 2 The asset was deleted from the disk SourceDeleted = 16 The asset import was deleted from the disk SourceEventMask = SourceUpdated | SourceDeleted The source event mask (SourceUpdated | SourceDeleted). SourceUpdated = 8 The asset import was modified on the disk Updated = 4 The asset is updated on the disk"
  },
  "api/Stride.Core.Assets.Analysis.AssetInheritanceSearchOptions.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetInheritanceSearchOptions.html",
    "title": "Enum AssetInheritanceSearchOptions | Stride API",
    "summary": "Enum AssetInheritanceSearchOptions Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Possible options used when searching asset inheritance. [Flags] public enum AssetInheritanceSearchOptions Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields All = Base | Composition Search for all types of inheritances. Base = 1 Search for inheritances from base (direct object inheritance). Composition = 2 Search for inheritances from compositions."
  },
  "api/Stride.Core.Assets.Analysis.AssetLink.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetLink.html",
    "title": "Struct AssetLink | Stride API",
    "summary": "Struct AssetLink Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Represent a link between Assets. public struct AssetLink : IContentLink Implements IContentLink Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors AssetLink(AssetItem, ContentLinkType) Create an asset dependency of type type and pointing to item public AssetLink(AssetItem item, ContentLinkType type) Parameters item AssetItem The item the dependency is pointing to type ContentLinkType The type of the dependency between the items Fields Item The asset item pointed by the dependency. public readonly AssetItem Item Field Value AssetItem Properties Element The reference to the element at the opposite side of the link. public readonly IReference Element { get; } Property Value IReference Type The type of the link. public ContentLinkType Type { readonly get; set; } Property Value ContentLinkType Methods Clone() Gets a clone copy of the asset dependency. public readonly AssetLink Clone() Returns AssetLink the clone instance"
  },
  "api/Stride.Core.Assets.Analysis.AssetPartsAnalysis.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetPartsAnalysis.html",
    "title": "Class AssetPartsAnalysis | Stride API",
    "summary": "Class AssetPartsAnalysis Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll public static class AssetPartsAnalysis Inheritance object AssetPartsAnalysis Methods GenerateNewBaseInstanceIds<TAssetPartDesign, TAssetPart>(AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart>) Assigns new unique identifiers for base part InstanceId in the given hierarchy. public static void GenerateNewBaseInstanceIds<TAssetPartDesign, TAssetPart>(AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> hierarchy) where TAssetPartDesign : class, IAssetPartDesign<TAssetPart> where TAssetPart : class, IIdentifiable Parameters hierarchy AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> The hierarchy which part groups should have new identifiers. Type Parameters TAssetPartDesign TAssetPart The underlying type of part."
  },
  "api/Stride.Core.Assets.Analysis.AssetReferenceAnalysis.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetReferenceAnalysis.html",
    "title": "Class AssetReferenceAnalysis | Stride API",
    "summary": "Class AssetReferenceAnalysis Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll This analysis provides a method for visiting asset and file references (IReference or Stride.Core.IO.UFile or Stride.Core.IO.UDirectory) public static class AssetReferenceAnalysis Inheritance object AssetReferenceAnalysis Methods Visit(object) Gets all references (subclass of IReference and Stride.Core.IO.UFile) from the specified asset public static List<AssetReferenceLink> Visit(object obj) Parameters obj object The object. Returns List<AssetReferenceLink> A list of references."
  },
  "api/Stride.Core.Assets.Analysis.AssetReferenceLink.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetReferenceLink.html",
    "title": "Class AssetReferenceLink | Stride API",
    "summary": "Class AssetReferenceLink Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Updatable reference link returned by Visit(object). public class AssetReferenceLink Inheritance object AssetReferenceLink Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetReferenceLink(MemberPath, object, Func<AssetId?, string, object?>) Initializes a new instance of the AssetReferenceLink class. public AssetReferenceLink(MemberPath path, object reference, Func<AssetId?, string, object?> updateReference) Parameters path MemberPath The path. reference object The reference. updateReference Func<AssetId?, string, object> The update reference. Fields Path The path to the member holding this reference. public readonly MemberPath Path Field Value MemberPath Properties Reference A IReference or Stride.Core.IO.UFile. public object? Reference { get; } Property Value object Methods UpdateReference(AssetId?, string) Updates the reference. public void UpdateReference(AssetId? guid, string location) Parameters guid AssetId? The unique identifier. location string The location."
  },
  "api/Stride.Core.Assets.Analysis.AssetResolver.ContainsAssetWithIdDelegate.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetResolver.ContainsAssetWithIdDelegate.html",
    "title": "Delegate AssetResolver.ContainsAssetWithIdDelegate | Stride API",
    "summary": "Delegate AssetResolver.ContainsAssetWithIdDelegate Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Delegate to test if an asset id is already used. public delegate bool AssetResolver.ContainsAssetWithIdDelegate(AssetId id) Parameters id AssetId The unique identifier. Returns bool true if an asset id is already used, false otherwise. Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Assets.Analysis.AssetResolver.html": {
    "href": "api/Stride.Core.Assets.Analysis.AssetResolver.html",
    "title": "Class AssetResolver | Stride API",
    "summary": "Class AssetResolver Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Helper to find available new asset locations and identifiers. public sealed class AssetResolver Inheritance object AssetResolver Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetResolver() Initializes a new instance of the AssetResolver class. public AssetResolver() AssetResolver(ContainsLocationDelegate?, ContainsAssetWithIdDelegate?) Initializes a new instance of the AssetResolver class. public AssetResolver(NamingHelper.ContainsLocationDelegate? containsLocation, AssetResolver.ContainsAssetWithIdDelegate? containsAssetWithId) Parameters containsLocation NamingHelper.ContainsLocationDelegate The delegate used to check if an asset location is already used. containsAssetWithId AssetResolver.ContainsAssetWithIdDelegate The delegate used to check if an asset identifier is already used. Properties AlwaysCreateNewId Gets or sets a value indicating whether to always generate a new id on RegisterId(AssetId, out AssetId). public bool AlwaysCreateNewId { get; set; } Property Value bool true if [force new identifier]; otherwise, false. ContainsAssetWithId Gets or sets a delegate to test if an asset id is already used. public AssetResolver.ContainsAssetWithIdDelegate? ContainsAssetWithId { get; set; } Property Value AssetResolver.ContainsAssetWithIdDelegate A delegate to test if an asset id is already used. ContainsLocation Gets or sets a delegate to test if a location is already used. public NamingHelper.ContainsLocationDelegate? ContainsLocation { get; set; } Property Value NamingHelper.ContainsLocationDelegate A delegate to test if a location is already used. ExistingIds Gets the asset ids already used. public HashSet<AssetId> ExistingIds { get; } Property Value HashSet<AssetId> The existing ids. ExistingLocations Gets the locations already used. public HashSet<string> ExistingLocations { get; } Property Value HashSet<string> The locations. Methods FromPackage(Package) Creates a new AssetResolver using an existing package to check the existence of asset locations and ids. public static AssetResolver FromPackage(Package package) Parameters package Package The package. Returns AssetResolver A new AssetResolver. Exceptions ArgumentNullException package FromPackage(IList<Package>) Creates a new AssetResolver using an existing package to check the existence of asset locations and ids. public static AssetResolver FromPackage(IList<Package> packages) Parameters packages IList<Package> The packages. Returns AssetResolver A new AssetResolver. Exceptions ArgumentNullException package RegisterId(AssetId, out AssetId) Registers an asset identifier for usage. public bool RegisterId(AssetId assetId, out AssetId newGuid) Parameters assetId AssetId The asset identifier. newGuid AssetId The new unique identifier if an asset has already been registered with the same id. Returns bool true if the asset id is already in used. newGuid contains a new guid, false otherwise. RegisterLocation(UFile, out UFile) Finds a name available for a new asset. This method will try to create a name based on an existing name and will append \"_\" + (number++) on every try. The new location found is added to the known existing locations. public bool RegisterLocation(UFile location, out UFile newLocation) Parameters location UFile The location. newLocation UFile The new location. Returns bool true if there is a new location, false otherwise."
  },
  "api/Stride.Core.Assets.Analysis.BuildAssetLink.html": {
    "href": "api/Stride.Core.Assets.Analysis.BuildAssetLink.html",
    "title": "Struct BuildAssetLink | Stride API",
    "summary": "Struct BuildAssetLink Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll A structure representing a link (a dependency) between two BuildAssetNode instances (assets). public readonly struct BuildAssetLink : IEquatable<BuildAssetLink> Implements IEquatable<BuildAssetLink> Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors BuildAssetLink(BuildAssetNode, BuildAssetNode, BuildDependencyType) Initialize a new instance of the BuildAssetLink structure. public BuildAssetLink(BuildAssetNode source, BuildAssetNode target, BuildDependencyType dependencyType) Parameters source BuildAssetNode The source asset of the dependency. target BuildAssetNode The target asset of the dependency. dependencyType BuildDependencyType The type of dependency. Properties DependencyType The type of dependency. public BuildDependencyType DependencyType { get; } Property Value BuildDependencyType Source The source asset of the dependency. public BuildAssetNode Source { get; } Property Value BuildAssetNode Target The target asset of the dependency. public BuildAssetNode Target { get; } Property Value BuildAssetNode Methods Equals(BuildAssetLink) Indicates whether the current object is equal to another object of the same type. public bool Equals(BuildAssetLink other) Parameters other BuildAssetLink An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. HasAll(BuildDependencyType) Indicates whether this BuildAssetLink has at all dependencies of the given flags. public bool HasAll(BuildDependencyType type) Parameters type BuildDependencyType A bitset of BuildDependencyType. Returns bool True if it has all the given dependencies, false otherwise. HasOne(BuildDependencyType) Indicates whether this BuildAssetLink has at least one of the dependency of the given flags. public bool HasOne(BuildDependencyType type) Parameters type BuildDependencyType A bitset of BuildDependencyType. Returns bool True if it has at least one of the given dependencies, false otherwise. ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(BuildAssetLink, BuildAssetLink) public static bool operator ==(BuildAssetLink left, BuildAssetLink right) Parameters left BuildAssetLink right BuildAssetLink Returns bool operator !=(BuildAssetLink, BuildAssetLink) public static bool operator !=(BuildAssetLink left, BuildAssetLink right) Parameters left BuildAssetLink right BuildAssetLink Returns bool"
  },
  "api/Stride.Core.Assets.Analysis.BuildAssetNode.html": {
    "href": "api/Stride.Core.Assets.Analysis.BuildAssetNode.html",
    "title": "Class BuildAssetNode | Stride API",
    "summary": "Class BuildAssetNode Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll public class BuildAssetNode Inheritance object BuildAssetNode Extension Methods UnsafeUtilities.As<T>(object?) Constructors BuildAssetNode(AssetItem, Type, BuildDependencyManager) public BuildAssetNode(AssetItem assetItem, Type compilationContext, BuildDependencyManager dependencyManager) Parameters assetItem AssetItem compilationContext Type dependencyManager BuildDependencyManager Fields VisitRuntimeTypes public static PropertyKey<bool> VisitRuntimeTypes Field Value PropertyKey<bool> Properties AssetItem public AssetItem AssetItem { get; } Property Value AssetItem CompilationContext public Type CompilationContext { get; } Property Value Type References public ICollection<BuildAssetLink> References { get; } Property Value ICollection<BuildAssetLink> Methods Analyze(AssetCompilerContext) Performs analysis on the asset to figure out all the needed dependencies public bool Analyze(AssetCompilerContext context) Parameters context AssetCompilerContext The compiler context Returns bool True if the node was updated, false otherwise. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.Analysis.BuildDependencyInfo.html": {
    "href": "api/Stride.Core.Assets.Analysis.BuildDependencyInfo.html",
    "title": "Struct BuildDependencyInfo | Stride API",
    "summary": "Struct BuildDependencyInfo Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll A structure representing information related to a build dependency between one source assets and a target type of asset. public readonly struct BuildDependencyInfo : IEquatable<BuildDependencyInfo> Implements IEquatable<BuildDependencyInfo> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors BuildDependencyInfo(Type, Type, BuildDependencyType) Initializes a new instance of the BuildDependencyInfo structure. public BuildDependencyInfo(Type assetType, Type compilationContext, BuildDependencyType dependencyType) Parameters assetType Type The type of asset targeted by this dependency info. compilationContext Type The compilation context in which to compile the target asset. dependencyType BuildDependencyType The type of dependency. Fields AssetType The type of asset targeted by this dependency. public readonly Type AssetType Field Value Type CompilationContext The compilation context in which to compile the target asset. public readonly Type CompilationContext Field Value Type Remarks This context is not relevant if the asset is not compiled, like when DependencyType is CompileAsset DependencyType The type of dependency, indicating whether the target asset must actually be compiled, and whether it should be compiled before the referecing asset or can be at the same time. public readonly BuildDependencyType DependencyType Field Value BuildDependencyType Methods Equals(BuildDependencyInfo) Indicates whether the current object is equal to another object of the same type. public bool Equals(BuildDependencyInfo other) Parameters other BuildDependencyInfo An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(BuildDependencyInfo, BuildDependencyInfo) public static bool operator ==(BuildDependencyInfo left, BuildDependencyInfo right) Parameters left BuildDependencyInfo right BuildDependencyInfo Returns bool operator !=(BuildDependencyInfo, BuildDependencyInfo) public static bool operator !=(BuildDependencyInfo left, BuildDependencyInfo right) Parameters left BuildDependencyInfo right BuildDependencyInfo Returns bool"
  },
  "api/Stride.Core.Assets.Analysis.BuildDependencyManager.html": {
    "href": "api/Stride.Core.Assets.Analysis.BuildDependencyManager.html",
    "title": "Class BuildDependencyManager | Stride API",
    "summary": "Class BuildDependencyManager Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Build dependency manager Basically is a container of BuildAssetNode public class BuildDependencyManager Inheritance object BuildDependencyManager Extension Methods UnsafeUtilities.As<T>(object?) Fields AssetCompilerRegistry The AssetCompilerRegistry, here mostly for ease of access public static readonly AssetCompilerRegistry AssetCompilerRegistry Field Value AssetCompilerRegistry Methods FindNode(AssetItem, Type) Finds a node, notice that this will not perform an analysis on the node, which must be explicitly called on the node public BuildAssetNode? FindNode(AssetItem item, Type compilationContext) Parameters item AssetItem The asset item to find compilationContext Type The context in which the asset is compiled. Returns BuildAssetNode The build node associated with item or null if it was not found FindNodes(AssetItem) Finds all the nodes associated with the asset public IEnumerable<BuildAssetNode> FindNodes(AssetItem item) Parameters item AssetItem The asset item to find Returns IEnumerable<BuildAssetNode> The build nodes associated with item or null if it was not found FindOrCreateNode(AssetItem, Type) Finds or creates a node, notice that this will not perform an analysis on the node, which must be explicitly called on the node public BuildAssetNode FindOrCreateNode(AssetItem item, Type compilationContext) Parameters item AssetItem The asset item to find or create compilationContext Type The context in which the asset is compiled. Returns BuildAssetNode The build node associated with item RemoveNode(BuildAssetNode) Removes the node from the build graph public void RemoveNode(BuildAssetNode node) Parameters node BuildAssetNode The node to remove RemoveNode(AssetItem) Removes the nodes associated with item from the build graph public void RemoveNode(AssetItem item) Parameters item AssetItem The item to use to find nodes to remove"
  },
  "api/Stride.Core.Assets.Analysis.BuildDependencyType.html": {
    "href": "api/Stride.Core.Assets.Analysis.BuildDependencyType.html",
    "title": "Enum BuildDependencyType | Stride API",
    "summary": "Enum BuildDependencyType Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll [Flags] public enum BuildDependencyType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields CompileAsset = 2 The uncompiled target asset is accessed during compilation. CompileContent = 4 The content compiled from the target asset is needed during compilation. Runtime = 1 The content generated during compilation needs the content compiled from the target asset to be loaded at runtime."
  },
  "api/Stride.Core.Assets.Analysis.CollectionItemIdsAnalysis.html": {
    "href": "api/Stride.Core.Assets.Analysis.CollectionItemIdsAnalysis.html",
    "title": "Class CollectionItemIdsAnalysis | Stride API",
    "summary": "Class CollectionItemIdsAnalysis Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll A static class that analyzes an AssetItem and fixes issues in CollectionItemIdentifiers of collections contained in this asset. public static class CollectionItemIdsAnalysis Inheritance object CollectionItemIdsAnalysis Methods FixupItemIds(AssetItem, ILogger?) Fixes up the CollectionItemIdentifiers of collections contained in the given asset. by generating new ids if there are any duplicate. public static void FixupItemIds(AssetItem assetItem, ILogger? logger) Parameters assetItem AssetItem The asset to analyze. logger ILogger A logger to output fixed entries. Remarks This method doesn't handle collections in derived assets that will be desynchronized afterwards."
  },
  "api/Stride.Core.Assets.Analysis.ContentLinkType.html": {
    "href": "api/Stride.Core.Assets.Analysis.ContentLinkType.html",
    "title": "Enum ContentLinkType | Stride API",
    "summary": "Enum ContentLinkType Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll The different possible types of link between elements. [Flags] public enum ContentLinkType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields All = 1 All type of links. Reference = 1 A simple reference to the asset."
  },
  "api/Stride.Core.Assets.Analysis.IAssetDependencyManager.html": {
    "href": "api/Stride.Core.Assets.Analysis.IAssetDependencyManager.html",
    "title": "Interface IAssetDependencyManager | Stride API",
    "summary": "Interface IAssetDependencyManager Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll public interface IAssetDependencyManager Extension Methods UnsafeUtilities.As<T>(object?) Methods ComputeDependencies(AssetId, AssetDependencySearchOptions, ContentLinkType, HashSet<AssetId>?) Computes the dependencies for the specified asset. AssetDependencies? ComputeDependencies(AssetId assetId, AssetDependencySearchOptions dependenciesOptions = AssetDependencySearchOptions.All, ContentLinkType linkTypes = ContentLinkType.All, HashSet<AssetId>? visited = null) Parameters assetId AssetId The asset id. dependenciesOptions AssetDependencySearchOptions The dependencies options. linkTypes ContentLinkType The type of links to visit while computing the dependencies visited HashSet<AssetId> The list of element already visited. Returns AssetDependencies The dependencies, or null if the object is not tracked."
  },
  "api/Stride.Core.Assets.Analysis.IContentLink.html": {
    "href": "api/Stride.Core.Assets.Analysis.IContentLink.html",
    "title": "Interface IContentLink | Stride API",
    "summary": "Interface IContentLink Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll The interface for types representing a link between elements. public interface IContentLink Extension Methods UnsafeUtilities.As<T>(object?) Properties Element The reference to the element at the opposite side of the link. IReference Element { get; } Property Value IReference Type The type of the link. ContentLinkType Type { get; } Property Value ContentLinkType"
  },
  "api/Stride.Core.Assets.Analysis.IdentifiableObjectAnalysis.html": {
    "href": "api/Stride.Core.Assets.Analysis.IdentifiableObjectAnalysis.html",
    "title": "Class IdentifiableObjectAnalysis | Stride API",
    "summary": "Class IdentifiableObjectAnalysis Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll A static class that visit an object and make sure that none of the IIdentifiable it references share the same identifier. In case there are duplicate identifier, the visitor can generate new identifiers for the duplicate public static class IdentifiableObjectAnalysis Inheritance object IdentifiableObjectAnalysis Methods Visit(object, bool, ILogger?) Visits the object and look up for duplicates identifier in IIdentifiable instances. public static bool Visit(object obj, bool fixDuplicate, ILogger? logger = null) Parameters obj object The object to visit. fixDuplicate bool If true, duplicate identifiers will be fixed by generating new identifiers. logger ILogger A logger to report duplicates and fixes. Returns bool True if the given object has been modified, false otherwise."
  },
  "api/Stride.Core.Assets.Analysis.PackageAnalysis.html": {
    "href": "api/Stride.Core.Assets.Analysis.PackageAnalysis.html",
    "title": "Class PackageAnalysis | Stride API",
    "summary": "Class PackageAnalysis Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll An analysis to check the validity of a Package, convert Stride.Core.IO.UFile or Stride.Core.IO.UDirectory references to absolute/relative paths, check asset references...etc, change IReference location if location changed. public sealed class PackageAnalysis Inheritance object PackageAnalysis Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageAnalysis(Package, PackageAnalysisParameters?) public PackageAnalysis(Package package, PackageAnalysisParameters? parameters = null) Parameters package Package parameters PackageAnalysisParameters Properties Parameters Gets the parameters used for this analysis. public PackageAnalysisParameters Parameters { get; } Property Value PackageAnalysisParameters The parameters. Methods CheckDependencies() Checks the package. public LoggerResult CheckDependencies() Returns LoggerResult LoggerResult. ProcessAssets() public LoggerResult ProcessAssets() Returns LoggerResult ProcessPackageUPaths() Processes the UPaths on package (but not on assets, use ProcessAssets() for this) public void ProcessPackageUPaths() Run() Runs a full analysis on this package. public LoggerResult Run() Returns LoggerResult LoggerResult. Run(ILogger) Runs a full analysis on this package. public void Run(ILogger log) Parameters log ILogger The log."
  },
  "api/Stride.Core.Assets.Analysis.PackageAnalysisParameters.html": {
    "href": "api/Stride.Core.Assets.Analysis.PackageAnalysisParameters.html",
    "title": "Class PackageAnalysisParameters | Stride API",
    "summary": "Class PackageAnalysisParameters Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Class PackageAnalysisParameters. This class cannot be inherited. public sealed class PackageAnalysisParameters : AssetAnalysisParameters Inheritance object AssetAnalysisParameters PackageAnalysisParameters Inherited Members AssetAnalysisParameters.IsLoggingAssetNotFoundAsError AssetAnalysisParameters.IsProcessingAssetReferences AssetAnalysisParameters.IsProcessingUPaths AssetAnalysisParameters.SetDirtyFlagOnAssetWhenFixingAbsoluteUFile AssetAnalysisParameters.SetDirtyFlagOnAssetWhenFixingUFile AssetAnalysisParameters.ConvertUPathTo AssetAnalysisParameters.Clone() Extension Methods UnsafeUtilities.As<T>(object?) Properties IsPackageCheckDependencies public bool IsPackageCheckDependencies { get; set; } Property Value bool"
  },
  "api/Stride.Core.Assets.Analysis.PackageSessionAnalysis.html": {
    "href": "api/Stride.Core.Assets.Analysis.PackageSessionAnalysis.html",
    "title": "Class PackageSessionAnalysis | Stride API",
    "summary": "Class PackageSessionAnalysis Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll A package analysis provides methods to validate the integrity of a whole package. public sealed class PackageSessionAnalysis : PackageSessionAnalysisBase Inheritance object PackageSessionAnalysisBase PackageSessionAnalysis Inherited Members PackageSessionAnalysisBase.Session PackageSessionAnalysisBase.Run() Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageSessionAnalysis(PackageSession, PackageAnalysisParameters) Initializes a new instance of the PackageSessionAnalysis class. public PackageSessionAnalysis(PackageSession packageSession, PackageAnalysisParameters parameters) Parameters packageSession PackageSession The package session. parameters PackageAnalysisParameters The parameters. Properties Parameters Gets the parameters. public PackageAnalysisParameters Parameters { get; } Property Value PackageAnalysisParameters The parameters. Methods Run(ILogger) Performs a wide package validation analysis. public override void Run(ILogger log) Parameters log ILogger The log to output the result of the validation."
  },
  "api/Stride.Core.Assets.Analysis.PackageSessionAnalysisBase.html": {
    "href": "api/Stride.Core.Assets.Analysis.PackageSessionAnalysisBase.html",
    "title": "Class PackageSessionAnalysisBase | Stride API",
    "summary": "Class PackageSessionAnalysisBase Namespace Stride.Core.Assets.Analysis Assembly Stride.Core.Assets.dll Base class for all Session and Asset integrity analysis. public abstract class PackageSessionAnalysisBase Inheritance object PackageSessionAnalysisBase Derived AssetBaseAnalysis PackageSessionAnalysis Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageSessionAnalysisBase(PackageSession) Initializes a new instance of the PackageSessionAnalysis class. protected PackageSessionAnalysisBase(PackageSession packageSession) Parameters packageSession PackageSession The package session. Exceptions ArgumentNullException packageSession Properties Session Gets the session. public PackageSession Session { get; set; } Property Value PackageSession The session. Methods Run() Performs a wide package validation analysis. public LoggerResult Run() Returns LoggerResult Result of the validation. Run(ILogger) Performs a wide package validation analysis. public abstract void Run(ILogger log) Parameters log ILogger The log to output the result of the validation."
  },
  "api/Stride.Core.Assets.Analysis.html": {
    "href": "api/Stride.Core.Assets.Analysis.html",
    "title": "Namespace Stride.Core.Assets.Analysis | Stride API",
    "summary": "Namespace Stride.Core.Assets.Analysis Classes AssetAnalysis Analysis for AssetItem. AssetAnalysisParameters Parameters for asset analysis. AssetBaseAnalysis An analysis to validate that all assets in a package have a valid Asset base. In order to be valid, this analysis must be run after a PackageAnalysis AssetCollision AssetDependencies Describes dependencies (in/out/broken) for a specific asset. AssetDependencyManager A class responsible for providing asset dependencies for a PackageSession and file tracking dependency. AssetFileChangedEvent An event that notifies the type of disk change for an asset. AssetPartsAnalysis AssetReferenceAnalysis This analysis provides a method for visiting asset and file references (IReference or Stride.Core.IO.UFile or Stride.Core.IO.UDirectory) AssetReferenceLink Updatable reference link returned by Visit(object). AssetResolver Helper to find available new asset locations and identifiers. BuildAssetNode BuildDependencyManager Build dependency manager Basically is a container of BuildAssetNode CollectionItemIdsAnalysis A static class that analyzes an AssetItem and fixes issues in CollectionItemIdentifiers of collections contained in this asset. IdentifiableObjectAnalysis A static class that visit an object and make sure that none of the IIdentifiable it references share the same identifier. In case there are duplicate identifier, the visitor can generate new identifiers for the duplicate PackageAnalysis An analysis to check the validity of a Package, convert Stride.Core.IO.UFile or Stride.Core.IO.UDirectory references to absolute/relative paths, check asset references...etc, change IReference location if location changed. PackageAnalysisParameters Class PackageAnalysisParameters. This class cannot be inherited. PackageSessionAnalysis A package analysis provides methods to validate the integrity of a whole package. PackageSessionAnalysisBase Base class for all Session and Asset integrity analysis. Structs AssetLink Represent a link between Assets. BuildAssetLink A structure representing a link (a dependency) between two BuildAssetNode instances (assets). BuildDependencyInfo A structure representing information related to a build dependency between one source assets and a target type of asset. Interfaces IAssetDependencyManager IContentLink The interface for types representing a link between elements. Enums AssetDependencySearchOptions Options used when searching asset dependencies. AssetFileChangedType Type of a change event for an asset. AssetInheritanceSearchOptions Possible options used when searching asset inheritance. BuildDependencyType ContentLinkType The different possible types of link between elements. Delegates AssetResolver.ContainsAssetWithIdDelegate Delegate to test if an asset id is already used."
  },
  "api/Stride.Core.Assets.Asset.html": {
    "href": "api/Stride.Core.Assets.Asset.html",
    "title": "Class Asset | Stride API",
    "summary": "Class Asset Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Base class for Asset. [DataContract(Inherited = true)] public abstract class Asset Inheritance object Asset Derived AssetComposite AssetWithSource SourceCodeAsset Extension Methods UnsafeUtilities.As<T>(object?) Constructors Asset() Initializes a new instance of the Asset class. protected Asset() Properties Archetype [DataMember(-500)] [Display(null, null, Browsable = false)] public AssetReference? Archetype { get; set; } Property Value AssetReference Id Gets or sets the unique identifier of this asset. [DataMember(-10000)] [Display(null, null, Browsable = false)] public AssetId Id { get; set; } Property Value AssetId The identifier. Exceptions InvalidOperationException Cannot change an Asset Object Id once it is locked MainSource Gets the main source file for this asset, used in the editor. public virtual UFile MainSource { get; } Property Value UFile SerializedVersion Gets or sets the version number for this asset, used internally when migrating assets. [DataMember(-8000, DataMemberMode.Assign)] [DataStyle(DataStyle.Compact)] [Display(null, null, Browsable = false)] public Dictionary<string, PackageVersion>? SerializedVersion { get; set; } Property Value Dictionary<string, PackageVersion> The version. Tags Gets the tags for this asset. [DataMember(-1000)] [Display(null, null, Browsable = false)] public TagCollection Tags { get; } Property Value TagCollection The tags for this asset. Methods CreateDerivedAsset(string) Creates an asset that inherits from this asset. public Asset CreateDerivedAsset(string baseLocation) Parameters baseLocation string The location of this asset. Returns Asset An asset that inherits this asset instance CreateDerivedAsset(string, out Dictionary<Guid, Guid>) Creates an asset that inherits from this asset. public virtual Asset CreateDerivedAsset(string baseLocation, out Dictionary<Guid, Guid> idRemapping) Parameters baseLocation string The location of this asset. idRemapping Dictionary<Guid, Guid> A dictionary in which will be stored all the Guid remapping done for the child asset. Returns Asset An asset that inherits this asset instance ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.AssetAliasAttribute.html": {
    "href": "api/Stride.Core.Assets.AssetAliasAttribute.html",
    "title": "Class AssetAliasAttribute | Stride API",
    "summary": "Class AssetAliasAttribute Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Associates a type name used in YAML content. public class AssetAliasAttribute : Attribute Inheritance object Attribute AssetAliasAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetAliasAttribute(string) Initializes a new instance of the AssetAliasAttribute class. public AssetAliasAttribute(string alias) Parameters alias string The type name. Properties Alias Gets the type name. public string Alias { get; } Property Value string The type name."
  },
  "api/Stride.Core.Assets.AssetCloner.html": {
    "href": "api/Stride.Core.Assets.AssetCloner.html",
    "title": "Class AssetCloner | Stride API",
    "summary": "Class AssetCloner Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Allows to clone an asset or values stored in an asset. public class AssetCloner Inheritance object AssetCloner Extension Methods UnsafeUtilities.As<T>(object?) Fields InvariantObjectListProperty public static PropertyKey<List<object>> InvariantObjectListProperty Field Value PropertyKey<List<object>> Properties ClonerSelector public static SerializerSelector ClonerSelector { get; } Property Value SerializerSelector Methods Clone(object?, AssetClonerFlags) Clones the specified asset using asset serialization. public static object? Clone(object? asset, AssetClonerFlags flags = AssetClonerFlags.None) Parameters asset object The asset. flags AssetClonerFlags Flags used to control the cloning process Returns object A clone of the asset. Clone(object?, AssetClonerFlags, out Dictionary<Guid, Guid>) Clones the specified asset using asset serialization. public static object? Clone(object? asset, AssetClonerFlags flags, out Dictionary<Guid, Guid> idRemapping) Parameters asset object The asset. flags AssetClonerFlags Flags used to control the cloning process idRemapping Dictionary<Guid, Guid> A dictionary containing the remapping of Id if GenerateNewIdsForIdentifiableObjects has been passed to the cloner. Returns object A clone of the asset. Clone(object?, AssetClonerFlags, HashSet<IIdentifiable>?, out Dictionary<Guid, Guid>) Clones the specified asset using asset serialization. public static object? Clone(object? asset, AssetClonerFlags flags, HashSet<IIdentifiable>? externalIdentifiable, out Dictionary<Guid, Guid> idRemapping) Parameters asset object The asset. flags AssetClonerFlags Flags used to control the cloning process externalIdentifiable HashSet<IIdentifiable> idRemapping Dictionary<Guid, Guid> A dictionary containing the remapping of Id if GenerateNewIdsForIdentifiableObjects has been passed to the cloner. Returns object A clone of the asset. Clone<T>(T?, AssetClonerFlags) Clones the specified asset using asset serialization. public static T? Clone<T>(T? asset, AssetClonerFlags flags = AssetClonerFlags.None) Parameters asset T The asset. flags AssetClonerFlags Flags used to control the cloning process Returns T A clone of the asset. Type Parameters T The type of the asset. Clone<T>(T?, AssetClonerFlags, out Dictionary<Guid, Guid>) Clones the specified asset using asset serialization. public static T? Clone<T>(T? asset, AssetClonerFlags flags, out Dictionary<Guid, Guid> idRemapping) Parameters asset T The asset. flags AssetClonerFlags Flags used to control the cloning process idRemapping Dictionary<Guid, Guid> A dictionary containing the remapping of Id if GenerateNewIdsForIdentifiableObjects has been passed to the cloner. Returns T A clone of the asset. Type Parameters T The type of the asset. Clone<T>(T?, AssetClonerFlags, HashSet<IIdentifiable>, out Dictionary<Guid, Guid>) Clones the specified asset using asset serialization. public static T? Clone<T>(T? asset, AssetClonerFlags flags, HashSet<IIdentifiable> externalIdentifiable, out Dictionary<Guid, Guid> idRemapping) Parameters asset T The asset. flags AssetClonerFlags Flags used to control the cloning process externalIdentifiable HashSet<IIdentifiable> idRemapping Dictionary<Guid, Guid> A dictionary containing the remapping of Id if GenerateNewIdsForIdentifiableObjects has been passed to the cloner. Returns T A clone of the asset. Type Parameters T The type of the asset."
  },
  "api/Stride.Core.Assets.AssetClonerFlags.html": {
    "href": "api/Stride.Core.Assets.AssetClonerFlags.html",
    "title": "Enum AssetClonerFlags | Stride API",
    "summary": "Enum AssetClonerFlags Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Flags used by AssetCloner [Flags] public enum AssetClonerFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ClearExternalReferences = 16 Clears any external references in the cloned object GenerateNewIdsForIdentifiableObjects = 8 Generates new ids for objects that implement IIdentifiable. KeepReferences = 32 Attached references will be kept as is None = 0 No special flags while cloning. ReferenceAsNull = 1 Attached references will be cloned as null RemoveItemIds = 2 Remove ids attached to item of collections when cloning RemoveUnloadableObjects = 4 Removes invalid objects"
  },
  "api/Stride.Core.Assets.AssetCollectionItemIdHelper.html": {
    "href": "api/Stride.Core.Assets.AssetCollectionItemIdHelper.html",
    "title": "Class AssetCollectionItemIdHelper | Stride API",
    "summary": "Class AssetCollectionItemIdHelper Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public static class AssetCollectionItemIdHelper Inheritance object AssetCollectionItemIdHelper Methods GenerateMissingItemIds(object?) public static void GenerateMissingItemIds(object? rootObject) Parameters rootObject object"
  },
  "api/Stride.Core.Assets.AssetComposite.html": {
    "href": "api/Stride.Core.Assets.AssetComposite.html",
    "title": "Class AssetComposite | Stride API",
    "summary": "Class AssetComposite Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Base class for an asset that supports inheritance by composition. public abstract class AssetComposite : Asset, IAssetComposite Inheritance object Asset AssetComposite Implements IAssetComposite Derived AssetCompositeHierarchy<TAssetPartDesign, TAssetPart> Inherited Members Asset.Id Asset.SerializedVersion Asset.Tags Asset.Archetype Asset.MainSource Asset.CreateDerivedAsset(string) Asset.CreateDerivedAsset(string, out Dictionary<Guid, Guid>) Asset.ToString() Extension Methods UnsafeUtilities.As<T>(object?) Methods CollectParts() Collects the part assets. [Obsolete(\"The AssetPart struct might be removed soon\")] public abstract IEnumerable<AssetPart> CollectParts() Returns IEnumerable<AssetPart> ContainsPart(Guid) Checks if this AssetPart container contains the part with the specified id. public abstract bool ContainsPart(Guid id) Parameters id Guid Unique identifier of the asset part Returns bool true if this asset contains the part with the specified id; otherwise false FindPart(Guid) public abstract IIdentifiable? FindPart(Guid partId) Parameters partId Guid Returns IIdentifiable"
  },
  "api/Stride.Core.Assets.AssetCompositeHierarchy-2.html": {
    "href": "api/Stride.Core.Assets.AssetCompositeHierarchy-2.html",
    "title": "Class AssetCompositeHierarchy<TAssetPartDesign, TAssetPart> | Stride API",
    "summary": "Class AssetCompositeHierarchy<TAssetPartDesign, TAssetPart> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public abstract class AssetCompositeHierarchy<TAssetPartDesign, TAssetPart> : AssetComposite, IAssetComposite where TAssetPartDesign : class, IAssetPartDesign<TAssetPart> where TAssetPart : class, IIdentifiable Type Parameters TAssetPartDesign TAssetPart Inheritance object Asset AssetComposite AssetCompositeHierarchy<TAssetPartDesign, TAssetPart> Implements IAssetComposite Inherited Members Asset.Id Asset.SerializedVersion Asset.Tags Asset.Archetype Asset.MainSource Asset.CreateDerivedAsset(string) Asset.ToString() Extension Methods UnsafeUtilities.As<T>(object?) Properties Hierarchy Gets or sets the container of the hierarchy of asset parts. [DataMember(100)] [Display(null, null, Browsable = false)] public AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> Hierarchy { get; set; } Property Value AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> Methods CollectParts() Collects the part assets. [Obsolete(\"The AssetPart struct might be removed soon\")] public override IEnumerable<AssetPart> CollectParts() Returns IEnumerable<AssetPart> ContainsPart(Guid) Checks if this AssetPart container contains the part with the specified id. public override bool ContainsPart(Guid id) Parameters id Guid Unique identifier of the asset part Returns bool true if this asset contains the part with the specified id; otherwise false CreateDerivedAsset(string, out Dictionary<Guid, Guid>) Creates an asset that inherits from this asset. public override Asset CreateDerivedAsset(string baseLocation, out Dictionary<Guid, Guid> idRemapping) Parameters baseLocation string The location of this asset. idRemapping Dictionary<Guid, Guid> A dictionary in which will be stored all the Guid remapping done for the child asset. Returns Asset An asset that inherits this asset instance EnumerateChildPartDesigns(TAssetPartDesign, AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart>, bool) Enumerates design parts that are children of the given design part. [Pure] public IEnumerable<TAssetPartDesign> EnumerateChildPartDesigns(TAssetPartDesign partDesign, AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> hierarchyData, bool isRecursive) Parameters partDesign TAssetPartDesign The design part for which to enumerate child parts. hierarchyData AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> The hierarchy data object in which the design parts can be retrieved. isRecursive bool If true, child design parts will be enumerated recursively. Returns IEnumerable<TAssetPartDesign> A sequence containing the child design parts of the given design part. EnumerateChildParts(TAssetPart, bool) Enumerates parts that are children of the given part. [Pure] public abstract IEnumerable<TAssetPart> EnumerateChildParts(TAssetPart part, bool isRecursive) Parameters part TAssetPart The part for which to enumerate child parts. isRecursive bool If true, child parts will be enumerated recursively. Returns IEnumerable<TAssetPart> A sequence containing the child parts of the given part. Remarks Implementations of this method should not rely on the Hierarchy property to enumerate. FindPart(Guid) public override IIdentifiable? FindPart(Guid partId) Parameters partId Guid Returns IIdentifiable GetChild(TAssetPart, int) Gets the child of the given part that matches the given index. [Pure] public abstract TAssetPart GetChild(TAssetPart part, int index) Parameters part TAssetPart The part for which to retrieve a child. index int The index of the child to retrieve. Returns TAssetPart The the child of the given part that matches the given index. Exceptions ArgumentNullException The given part is null. IndexOutOfRangeException The given index is out of range. GetChildCount(TAssetPart) Gets the number of children in the given part. [Pure] public abstract int GetChildCount(TAssetPart part) Parameters part TAssetPart The part for which to retrieve the number of children. Returns int The number of children in the given part. Exceptions ArgumentNullException The given part is null. GetParent(TAssetPart) Gets the parent of the given part. public abstract TAssetPart? GetParent(TAssetPart part) Parameters part TAssetPart Returns TAssetPart The part that is the parent of the given part, or null if the given part is at the root level. Remarks Implementations of this method should not rely on the Hierarchy property to determine the parent. Exceptions ArgumentNullException The given part is null. IndexOf(TAssetPart) Gets the index of the given part in the child list of its parent, or in the list of root if this part is a root part. [Pure] public abstract int IndexOf(TAssetPart part) Parameters part TAssetPart The part for which to retrieve the index. Returns int The index of the part, or a negative value if the part is an orphan part that is not a member of this asset. Exceptions ArgumentNullException The given part is null."
  },
  "api/Stride.Core.Assets.AssetCompositeHierarchyData-2.html": {
    "href": "api/Stride.Core.Assets.AssetCompositeHierarchyData-2.html",
    "title": "Class AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> | Stride API",
    "summary": "Class AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A class containing the information of a hierarchy of asset parts contained in an AssetCompositeHierarchy<TAssetPartDesign, TAssetPart>. [DataContract(\"AssetCompositeHierarchyData\")] public class AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> where TAssetPartDesign : class, IAssetPartDesign<TAssetPart> where TAssetPart : class, IIdentifiable Type Parameters TAssetPartDesign The type used for the design information of a part. TAssetPart The type used for the actual parts, Inheritance object AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> Extension Methods AssetCompositeHierarchyExtensions.EnumerateRootPartDesigns<TAssetPartDesign, TAssetPart>(AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart>) AssetCompositeHierarchyExtensions.MergeInto<TAssetPartDesign, TAssetPart>(AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart>, AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart>) UnsafeUtilities.As<T>(object?) Properties Parts Gets a collection of all the parts, root or not, contained in this hierarchy. [DataMember(20)] public AssetPartCollection<TAssetPartDesign, TAssetPart> Parts { get; } Property Value AssetPartCollection<TAssetPartDesign, TAssetPart> RootParts Gets a collection if identifier of all the parts that are root of this hierarchy. [DataMember(10)] public List<TAssetPart> RootParts { get; } Property Value List<TAssetPart>"
  },
  "api/Stride.Core.Assets.AssetCompositeHierarchyExtensions.html": {
    "href": "api/Stride.Core.Assets.AssetCompositeHierarchyExtensions.html",
    "title": "Class AssetCompositeHierarchyExtensions | Stride API",
    "summary": "Class AssetCompositeHierarchyExtensions Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Extension methods for AssetCompositeHierarchy<TAssetPartDesign, TAssetPart> and AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> public static class AssetCompositeHierarchyExtensions Inheritance object AssetCompositeHierarchyExtensions Methods EnumerateRootPartDesigns<TAssetPartDesign, TAssetPart>(AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart>) Enumerates the root design parts of this hierarchy. [Pure] public static IEnumerable<TAssetPartDesign> EnumerateRootPartDesigns<TAssetPartDesign, TAssetPart>(this AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> asset) where TAssetPartDesign : class, IAssetPartDesign<TAssetPart> where TAssetPart : class, IIdentifiable Parameters asset AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> This hierarchy. Returns IEnumerable<TAssetPartDesign> A sequence containing the root design parts of this hierarchy. Type Parameters TAssetPartDesign The type used for the design information of a part. TAssetPart The type used for the actual parts, MergeInto<TAssetPartDesign, TAssetPart>(AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart>, AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart>) Merges the other hierarchy into this hierarchy. public static void MergeInto<TAssetPartDesign, TAssetPart>(this AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> asset, AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> other) where TAssetPartDesign : class, IAssetPartDesign<TAssetPart> where TAssetPart : class, IIdentifiable Parameters asset AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> This hierarchy. other AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> The other hierarchy which parts will added to this hierarchy. Type Parameters TAssetPartDesign The type used for the design information of a part. TAssetPart The type used for the actual parts, Remarks This method does not check whether the two hierarchies have independent parts and will fail otherwise."
  },
  "api/Stride.Core.Assets.AssetContentTypeAttribute.html": {
    "href": "api/Stride.Core.Assets.AssetContentTypeAttribute.html",
    "title": "Class AssetContentTypeAttribute | Stride API",
    "summary": "Class AssetContentTypeAttribute Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Describes which runtime-type, loadable through the ContentManager, corresponds to the associated asset type. [AttributeUsage(AttributeTargets.Class)] public class AssetContentTypeAttribute : Attribute Inheritance object Attribute AssetContentTypeAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetContentTypeAttribute(Type) Initializes a new instance of the AssetContentTypeAttribute class. public AssetContentTypeAttribute(Type contentType) Parameters contentType Type The content type corresponding to the associated asset type. Properties ContentType The content type corresponding to the associated asset type. public Type ContentType { get; } Property Value Type"
  },
  "api/Stride.Core.Assets.AssetDescriptionAttribute.html": {
    "href": "api/Stride.Core.Assets.AssetDescriptionAttribute.html",
    "title": "Class AssetDescriptionAttribute | Stride API",
    "summary": "Class AssetDescriptionAttribute Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Associates meta-information to a particular Asset. [AttributeUsage(AttributeTargets.Class)] public class AssetDescriptionAttribute : Attribute Inheritance object Attribute AssetDescriptionAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetDescriptionAttribute(string) Initializes a new instance of the AssetDescriptionAttribute class. public AssetDescriptionAttribute(string fileExtensions) Parameters fileExtensions string The file extensions supported by a type of asset. Properties AllowArchetype Gets whether this asset can be an archetype. public bool AllowArchetype { get; set; } Property Value bool AlwaysMarkAsRoot Always mark this asset type as root. public bool AlwaysMarkAsRoot { get; set; } Property Value bool FileExtensions Gets the file extensions supported by a type of asset. public string FileExtensions { get; } Property Value string The extension. Referenceable Defines if an asset is referenceable through an AssetReference. Asset name collision is allowed in this case because they exist only at compile-time. public bool Referenceable { get; set; } Property Value bool"
  },
  "api/Stride.Core.Assets.AssetException.html": {
    "href": "api/Stride.Core.Assets.AssetException.html",
    "title": "Class AssetException | Stride API",
    "summary": "Class AssetException Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An AssetException. public class AssetException : Exception, ISerializable Inheritance object Exception AssetException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetException() Initializes a new instance of the AssetException class. public AssetException() AssetException(string) Initializes a new instance of the Exception class with a specified error message. public AssetException(string message) Parameters message string The message that describes the error. AssetException(string, Exception) Initializes a new instance of the Exception class with a specified error message and a reference to the inner exception that is the cause of this exception. public AssetException(string message, Exception innerException) Parameters message string The error message that explains the reason for the exception. innerException Exception The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. AssetException(string, params object[]) Initializes a new instance of the Exception class with a specified error message. public AssetException(string message, params object[] formattedArguments) Parameters message string The message that describes the error. formattedArguments object[] The formatted arguments."
  },
  "api/Stride.Core.Assets.AssetFactory-1.html": {
    "href": "api/Stride.Core.Assets.AssetFactory-1.html",
    "title": "Class AssetFactory<T> | Stride API",
    "summary": "Class AssetFactory<T> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A base implementation of the IAssetFactory<T> interface. public abstract class AssetFactory<T> : IAssetFactory<T> where T : Asset Type Parameters T The type of asset this factory can create. Inheritance object AssetFactory<T> Implements IAssetFactory<T> Derived DefaultAssetFactory<T> Extension Methods UnsafeUtilities.As<T>(object?) Properties AssetType Retrieve the asset type associated to this factory. public Type AssetType { get; } Property Value Type The asset type associated to this factory. Methods New() Creates a new instance of the asset type associated to this factory. public abstract T New() Returns T A new instance of the asset type associated to this factory."
  },
  "api/Stride.Core.Assets.AssetFileSerializer.html": {
    "href": "api/Stride.Core.Assets.AssetFileSerializer.html",
    "title": "Class AssetFileSerializer | Stride API",
    "summary": "Class AssetFileSerializer Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Main entry point for serializing/deserializing Asset. public static class AssetFileSerializer Inheritance object AssetFileSerializer Fields Default The default serializer. public static readonly IAssetSerializer Default Field Value IAssetSerializer Methods FindSerializer(string) Finds a serializer for the specified asset file extension. public static IAssetSerializer? FindSerializer(string assetFileExtension) Parameters assetFileExtension string The asset file extension. Returns IAssetSerializer IAssetSerializerFactory. Load<T>(Stream, UFile, ILogger?) public static AssetLoadResult<T> Load<T>(Stream stream, UFile filePath, ILogger? log = null) Parameters stream Stream filePath UFile log ILogger Returns AssetLoadResult<T> Type Parameters T Load<T>(string, ILogger?) Deserializes an Asset from the specified stream. public static AssetLoadResult<T> Load<T>(string filePath, ILogger? log = null) Parameters filePath string The file path. log ILogger The logger. Returns AssetLoadResult<T> An instance of Asset not a valid asset asset object file. Type Parameters T Type of the asset Register(IAssetSerializerFactory) Registers the specified serializer factory. public static void Register(IAssetSerializerFactory serializerFactory) Parameters serializerFactory IAssetSerializerFactory The serializer factory. Exceptions ArgumentNullException serializerFactory Save(Stream, object, AttachedYamlAssetMetadata?, ILogger?) Serializes an Asset to the specified stream. public static void Save(Stream stream, object asset, AttachedYamlAssetMetadata? yamlMetadata, ILogger? log = null) Parameters stream Stream The stream. asset object The asset object. yamlMetadata AttachedYamlAssetMetadata log ILogger The logger. Exceptions ArgumentNullException stream or assetFileExtension Save(string, object, AttachedYamlAssetMetadata?, ILogger?) Serializes an Asset to the specified file path. public static void Save(string filePath, object asset, AttachedYamlAssetMetadata? yamlMetadata, ILogger? log = null) Parameters filePath string The file path. asset object The asset object. yamlMetadata AttachedYamlAssetMetadata log ILogger The logger. Exceptions ArgumentNullException filePath"
  },
  "api/Stride.Core.Assets.AssetFolder.html": {
    "href": "api/Stride.Core.Assets.AssetFolder.html",
    "title": "Class AssetFolder | Stride API",
    "summary": "Class AssetFolder Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A location relative to a package from where assets will be loaded [DataContract(\"AssetFolder\")] public sealed class AssetFolder Inheritance object AssetFolder Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetFolder() Initializes a new instance of the AssetFolder class. public AssetFolder() AssetFolder(UDirectory) Initializes a new instance of the AssetFolder class. public AssetFolder(UDirectory path) Parameters path UDirectory The folder. Properties Path Gets or sets the folder. public UDirectory Path { get; set; } Property Value UDirectory The folder. Methods Clone() public AssetFolder Clone() Returns AssetFolder"
  },
  "api/Stride.Core.Assets.AssetFolderCollection.html": {
    "href": "api/Stride.Core.Assets.AssetFolderCollection.html",
    "title": "Class AssetFolderCollection | Stride API",
    "summary": "Class AssetFolderCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A collection of AssetFolder [DataContract(\"AssetFolderCollection\")] public sealed class AssetFolderCollection : IList<AssetFolder>, ICollection<AssetFolder>, IReadOnlyList<AssetFolder>, IReadOnlyCollection<AssetFolder>, IEnumerable<AssetFolder>, IEnumerable Inheritance object AssetFolderCollection Implements IList<AssetFolder> ICollection<AssetFolder> IReadOnlyList<AssetFolder> IReadOnlyCollection<AssetFolder> IEnumerable<AssetFolder> IEnumerable Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors AssetFolderCollection() Initializes a new instance of the AssetFolderCollection class. public AssetFolderCollection() Properties Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. this[int] Gets the element at the specified index in the read-only list. public AssetFolder this[int index] { get; } Parameters index int The zero-based index of the element to get. Property Value AssetFolder The element at the specified index in the read-only list. Methods Add(AssetFolder) Adds an item to the ICollection<T>. public void Add(AssetFolder item) Parameters item AssetFolder The object to add to the ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. CloneTo(AssetFolderCollection) Clones this instance to the specified instance. public void CloneTo(AssetFolderCollection foldersTo) Parameters foldersTo AssetFolderCollection The folders. Exceptions ArgumentNullException folders Contains(AssetFolder) Determines whether the ICollection<T> contains a specific value. public bool Contains(AssetFolder item) Parameters item AssetFolder The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. CopyTo(AssetFolder[], int) Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. public void CopyTo(AssetFolder[] array, int arrayIndex) Parameters array AssetFolder[] The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing. arrayIndex int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException arrayIndex is less than 0. ArgumentException The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array. Find(UDirectory) public AssetFolder? Find(UDirectory folder) Parameters folder UDirectory Returns AssetFolder GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<AssetFolder> GetEnumerator() Returns IEnumerator<AssetFolder> An enumerator that can be used to iterate through the collection. Remove(AssetFolder) Removes the first occurrence of a specific object from the ICollection<T>. public bool Remove(AssetFolder item) Parameters item AssetFolder The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only."
  },
  "api/Stride.Core.Assets.AssetFormatVersionAttribute.html": {
    "href": "api/Stride.Core.Assets.AssetFormatVersionAttribute.html",
    "title": "Class AssetFormatVersionAttribute | Stride API",
    "summary": "Class AssetFormatVersionAttribute Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Describes what format version this asset currently uses, for asset upgrading. [AttributeUsage(AttributeTargets.Class)] public class AssetFormatVersionAttribute : Attribute Inheritance object Attribute AssetFormatVersionAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetFormatVersionAttribute(string, int, int) Initializes a new instance of the AssetFormatVersionAttribute class. public AssetFormatVersionAttribute(string name, int version, int minUpgradableVersion = 0) Parameters name string The dependency name. version int The current format version of this asset. minUpgradableVersion int The minimum format version that supports upgrade for this asset. AssetFormatVersionAttribute(string, string, string?) Initializes a new instance of the AssetFormatVersionAttribute class. public AssetFormatVersionAttribute(string name, string version, string? minUpgradableVersion = null) Parameters name string The dependency name. version string The current format version of this asset. minUpgradableVersion string The minimum format version that supports upgrade for this asset. Properties MinUpgradableVersion Gets the minimum format version that supports upgrade for this asset. public PackageVersion MinUpgradableVersion { get; set; } Property Value PackageVersion The minimum format version that supports upgrade for this asset. Name Gets or sets the dependency name. public string Name { get; set; } Property Value string Version Gets the current format version of this asset. public PackageVersion Version { get; set; } Property Value PackageVersion The current format version of this asset."
  },
  "api/Stride.Core.Assets.AssetHash.html": {
    "href": "api/Stride.Core.Assets.AssetHash.html",
    "title": "Class AssetHash | Stride API",
    "summary": "Class AssetHash Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Helper to compute a stable hash from an asset including all meta informations (ids, overrides). public static class AssetHash Inheritance object AssetHash Methods Compute(object, AssetClonerFlags) Computes a stable hash from an asset including all meta informations (ids, overrides). public static ObjectId Compute(object asset, AssetClonerFlags flags = AssetClonerFlags.None) Parameters asset object An object instance flags AssetClonerFlags Flags used to control the serialization process Returns ObjectId a stable hash"
  },
  "api/Stride.Core.Assets.AssetId.html": {
    "href": "api/Stride.Core.Assets.AssetId.html",
    "title": "Struct AssetId | Stride API",
    "summary": "Struct AssetId Namespace Stride.Core.Assets Assembly Stride.Core.Serialization.dll [DataContract(\"AssetId\")] [DataSerializer(typeof(AssetId.Serializer))] public readonly struct AssetId : IComparable<AssetId>, IEquatable<AssetId> Implements IComparable<AssetId> IEquatable<AssetId> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors AssetId(Guid) public AssetId(Guid guid) Parameters guid Guid AssetId(string) public AssetId(string guid) Parameters guid string Fields Empty public static readonly AssetId Empty Field Value AssetId Methods CompareTo(AssetId) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. public int CompareTo(AssetId other) Parameters other AssetId An object to compare with this instance. Returns int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order. Equals(AssetId) Indicates whether the current object is equal to another object of the same type. public bool Equals(AssetId other) Parameters other AssetId An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. New() public static AssetId New() Returns AssetId Parse(string) public static AssetId Parse(string input) Parameters input string Returns AssetId ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. TryParse(string, out AssetId) public static bool TryParse(string input, out AssetId result) Parameters input string result AssetId Returns bool Operators operator ==(AssetId, AssetId) Implements the ==. public static bool operator ==(AssetId left, AssetId right) Parameters left AssetId The left. right AssetId The right. Returns bool The result of the operator. explicit operator Guid(AssetId) public static explicit operator Guid(AssetId id) Parameters id AssetId Returns Guid explicit operator AssetId(Guid) public static explicit operator AssetId(Guid guid) Parameters guid Guid Returns AssetId operator !=(AssetId, AssetId) Implements the !=. public static bool operator !=(AssetId left, AssetId right) Parameters left AssetId The left. right AssetId The right. Returns bool The result of the operator."
  },
  "api/Stride.Core.Assets.AssetImporterBase.html": {
    "href": "api/Stride.Core.Assets.AssetImporterBase.html",
    "title": "Class AssetImporterBase | Stride API",
    "summary": "Class AssetImporterBase Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public abstract class AssetImporterBase : IAssetImporter Inheritance object AssetImporterBase Implements IAssetImporter Derived RawAssetImporterBase<TAsset> Extension Methods UnsafeUtilities.As<T>(object?) Properties AdditionalAssetTypes Gets the additional types of asset that can be generated by this importer in complement of the root assets public virtual IEnumerable<Type> AdditionalAssetTypes { get; } Property Value IEnumerable<Type> Description Gets the description of this importer. public abstract string Description { get; } Property Value string The description. Id Gets an unique identifier to identify the importer. See remarks. public abstract Guid Id { get; } Property Value Guid The identifier. Remarks This identifier is used to recover the importer used for a particular asset. This Guid must be unique and stored statically in the definition of an importer. It is used to reimport an existing asset with the same importer. Name Gets the name of this importer. public virtual string Name { get; } Property Value string The name. Order Gets the order of precedence between the importers, so that an importer can override another one. public int Order { get; protected set; } Property Value int The order. RootAssetTypes Gets the types of asset that are mainly generated by this importer. public abstract IEnumerable<Type> RootAssetTypes { get; } Property Value IEnumerable<Type> SupportedFileExtensions Gets the supported file extensions (separated by ',' for multiple extensions) by this importer. This is used for display purpose only. The method IsSupportingFile(string) is used for matching extensions. public abstract string SupportedFileExtensions { get; } Property Value string Returns a list of supported file extensions handled by this importer. Methods GetDefaultParameters(bool) Gets the default parameters for this importer. public AssetImporterParameters GetDefaultParameters(bool isForReImport) Parameters isForReImport bool Returns AssetImporterParameters The supported types. Import(UFile, AssetImporterParameters) Imports a raw assets from the specified path into the specified package. public abstract IEnumerable<AssetItem> Import(UFile rawAssetPath, AssetImporterParameters importParameters) Parameters rawAssetPath UFile The path to a raw asset on the disk. importParameters AssetImporterParameters The parameters. It is mandatory to call GetDefaultParameters(bool) and pass the parameters instance here Returns IEnumerable<AssetItem> IsSupportingFile(string) Determines whether this importer is supporting the specified file. public virtual bool IsSupportingFile(string filePath) Parameters filePath string The file path. Returns bool true if this importer is supporting the specified file; otherwise, false."
  },
  "api/Stride.Core.Assets.AssetImporterParameters.html": {
    "href": "api/Stride.Core.Assets.AssetImporterParameters.html",
    "title": "Class AssetImporterParameters | Stride API",
    "summary": "Class AssetImporterParameters Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Parameters used by Import(UFile, AssetImporterParameters) public class AssetImporterParameters Inheritance object AssetImporterParameters Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetImporterParameters() Initializes a new instance of the AssetImporterParameters class. public AssetImporterParameters() AssetImporterParameters(IEnumerable<Type>) Initializes a new instance of the AssetImporterParameters class. public AssetImporterParameters(IEnumerable<Type> supportedTypes) Parameters supportedTypes IEnumerable<Type> The supported types. Exceptions ArgumentNullException supportedTypes ArgumentException Invalid type [{0}]. Type must be assignable to Asset.ToFormat(type);supportedTypes AssetImporterParameters(params Type[]) Initializes a new instance of the AssetImporterParameters class. public AssetImporterParameters(params Type[] supportedTypes) Parameters supportedTypes Type[] The supported types. Properties HasSelectedOutputTypes Gets a value indicating whether this instance has valid selected output types. public bool HasSelectedOutputTypes { get; } Property Value bool true if this instance has selected output types; otherwise, false. InputParameters Gets the import input parameters. public PropertyCollection InputParameters { get; } Property Value PropertyCollection The import input parameters. Logger Gets or sets the logger to use during the import. public Logger Logger { get; set; } Property Value Logger SelectedOutputTypes Gets the selected output types. public Dictionary<Type, bool> SelectedOutputTypes { get; } Property Value Dictionary<Type, bool> The selected output types. Methods IsTypeSelectedForOutput(Type) Determines whether the specified type is type selected for output by this importer. public bool IsTypeSelectedForOutput(Type type) Parameters type Type The type. Returns bool true if the specified type is type selected for output by this importer; otherwise, false. IsTypeSelectedForOutput<T>() Determines whether the specified type is type selected for output by this importer. public bool IsTypeSelectedForOutput<T>() where T : Asset Returns bool true if the specified type is type selected for output by this importer; otherwise, false. Type Parameters T A Type asset"
  },
  "api/Stride.Core.Assets.AssetItem.html": {
    "href": "api/Stride.Core.Assets.AssetItem.html",
    "title": "Class AssetItem | Stride API",
    "summary": "Class AssetItem Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An asset item part of a Package accessible through Assets. [DataContract(\"AssetItem\")] public sealed class AssetItem : IFileSynchronizable Inheritance object AssetItem Implements IFileSynchronizable Extension Methods AssetItemExtensions.GetGeneratedAbsolutePath(AssetItem) AssetItemExtensions.GetGeneratedInclude(AssetItem) AssetItemExtensions.GetProjectInclude(AssetItem) UnsafeUtilities.As<T>(object?) Constructors AssetItem(UFile, Asset) Initializes a new instance of the AssetItem class. public AssetItem(UFile location, Asset asset) Parameters location UFile The location inside the package. asset Asset The asset. Exceptions ArgumentNullException location ArgumentNullException asset Fields DefaultComparerById The default comparer use only the id of an assetitem to match assets. public static readonly IEqualityComparer<AssetItem> DefaultComparerById Field Value IEqualityComparer<AssetItem> Properties AlternativePath Gets or sets the real location of this asset if it is overriden (similar to Link in C# project files). public UFile? AlternativePath { get; set; } Property Value UFile Asset Gets or sets the asset. [DataMember] public Asset Asset { get; } Property Value Asset The asset. FullPath Gets the full absolute path of this asset on the disk, taking into account the SourceFolder, and the RootDirectory. See remarks. public UFile FullPath { get; } Property Value UFile The full absolute path of this asset on the disk. Remarks This value is only valid if this instance is attached to a Package, and that the package has a non null RootDirectory. Id Gets the unique identifier of this asset. public AssetId Id { get; } Property Value AssetId The unique identifier. IsDeleted public bool IsDeleted { get; set; } Property Value bool IsDirty Gets or sets a value indicating whether this instance is dirty. See remarks. public bool IsDirty { get; set; } Property Value bool true if this instance is dirty; otherwise, false. Remarks When an asset is modified, this property must be set to true in order to track assets changes. Location Gets the location of this asset. [DataMember] public UFile Location { get; } Property Value UFile The location. ModifiedTime Gets the modified time. See remarks. [DataMember] public DateTime ModifiedTime { get; } Property Value DateTime The modified time. Remarks By default, contains the last modified time of the asset from the disk. If IsDirty is also updated from false to true , this time will get current time of modification. Package Gets the package where this asset is stored. [DataMember] public Package? Package { get; } Property Value Package The package. SourceFolder Gets the directory where the assets will be stored on the disk relative to the Package. The directory will update the list found in AssetFolders public UDirectory? SourceFolder { get; set; } Property Value UDirectory The directory. Version Gets the asset version incremental counter, increased everytime the asset is edited. [DataMember] public long Version { get; } Property Value long YamlMetadata Gets the attached metadata for YAML serialization. public AttachedYamlAssetMetadata YamlMetadata { get; } Property Value AttachedYamlAssetMetadata Methods Clone(UFile?, Asset?, AssetClonerFlags) Clones this instance without the attached package. public AssetItem Clone(UFile? newLocation = null, Asset? newAsset = null, AssetClonerFlags flags = AssetClonerFlags.None) Parameters newLocation UFile The new location that will be used in the cloned AssetItem. If this parameter is null, it keeps the original location of the asset. newAsset Asset The new asset that will be used in the cloned AssetItem. If this parameter is null, it clones the original asset. otherwise, the specified asset is used as-is in the new AssetItem (no clone on newAsset is performed) flags AssetClonerFlags Flags used with Clone(object?, AssetClonerFlags). Returns AssetItem A clone of this instance. Clone(bool, UFile?, Asset?, AssetClonerFlags) Clones this instance without the attached package. public AssetItem Clone(bool keepPackage, UFile? newLocation = null, Asset? newAsset = null, AssetClonerFlags flags = AssetClonerFlags.None) Parameters keepPackage bool if set to true copy package information, only used by the AssetDependencyManager. newLocation UFile The new location that will be used in the cloned AssetItem. If this parameter is null, it keeps the original location of the asset. newAsset Asset The new asset that will be used in the cloned AssetItem. If this parameter is null, it clones the original asset. otherwise, the specified asset is used as-is in the new AssetItem (no clone on newAsset is performed) flags AssetClonerFlags Flags used with Clone(object?, AssetClonerFlags). Returns AssetItem A clone of this instance. CreateDerivedAsset() Creates a child asset that is inheriting the values of this asset. public Asset CreateDerivedAsset() Returns Asset A new asset inheriting the values of this asset. FindBase() Finds the base item referenced by this item from the current session (using the Package setup on this instance) public AssetItem? FindBase() Returns AssetItem The base item or null if not found. RetrieveCompilationInputFiles() public ISet<UFile> RetrieveCompilationInputFiles() Returns ISet<UFile> ToReference() Converts this item to a reference. public AssetReference ToReference() Returns AssetReference AssetReference. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. UpdateSourceFolders() In case SourceFolder was null, generates it. public void UpdateSourceFolders()"
  },
  "api/Stride.Core.Assets.AssetItemExtensions.html": {
    "href": "api/Stride.Core.Assets.AssetItemExtensions.html",
    "title": "Class AssetItemExtensions | Stride API",
    "summary": "Class AssetItemExtensions Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public static class AssetItemExtensions Inheritance object AssetItemExtensions Methods GetGeneratedAbsolutePath(AssetItem) If the asset is a IProjectFileGeneratorAsset, gets the generated file full path. public static UFile GetGeneratedAbsolutePath(this AssetItem assetItem) Parameters assetItem AssetItem The asset item. Returns UFile GetGeneratedInclude(AssetItem) If the asset is a IProjectFileGeneratorAsset, gets the generated file path relative to its containing .csproj. public static string GetGeneratedInclude(this AssetItem assetItem) Parameters assetItem AssetItem The asset item. Returns string GetProjectInclude(AssetItem) Gets the asset filename relative to its .csproj file for IProjectAsset. public static string GetProjectInclude(this AssetItem assetItem) Parameters assetItem AssetItem The asset item. Returns string"
  },
  "api/Stride.Core.Assets.AssetLoadResult-1.html": {
    "href": "api/Stride.Core.Assets.AssetLoadResult-1.html",
    "title": "Class AssetLoadResult<T> | Stride API",
    "summary": "Class AssetLoadResult<T> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class AssetLoadResult<T> Type Parameters T Inheritance object AssetLoadResult<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetLoadResult(T, ILogger?, bool, AttachedYamlAssetMetadata) public AssetLoadResult(T asset, ILogger? logger, bool aliasOccurred, AttachedYamlAssetMetadata yamlMetadata) Parameters asset T logger ILogger aliasOccurred bool yamlMetadata AttachedYamlAssetMetadata Properties AliasOccurred public bool AliasOccurred { get; } Property Value bool Asset public T Asset { get; } Property Value T Logger public ILogger? Logger { get; } Property Value ILogger YamlMetadata public AttachedYamlAssetMetadata YamlMetadata { get; } Property Value AttachedYamlAssetMetadata"
  },
  "api/Stride.Core.Assets.AssetMember.html": {
    "href": "api/Stride.Core.Assets.AssetMember.html",
    "title": "Struct AssetMember | Stride API",
    "summary": "Struct AssetMember Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Represents a member of an asset. public struct AssetMember Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Asset The asset. public Asset Asset Field Value Asset MemberPath The path to the member in the asset. public MemberPath MemberPath Field Value MemberPath"
  },
  "api/Stride.Core.Assets.AssetMigration.html": {
    "href": "api/Stride.Core.Assets.AssetMigration.html",
    "title": "Class AssetMigration | Stride API",
    "summary": "Class AssetMigration Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Helper for migrating asset to newer versions. public static class AssetMigration Inheritance object AssetMigration Methods MigrateAssetIfNeeded(AssetMigrationContext, PackageLoadingAssetFile, string, PackageVersion?) public static bool MigrateAssetIfNeeded(AssetMigrationContext context, PackageLoadingAssetFile loadAsset, string dependencyName, PackageVersion? untilVersion = null) Parameters context AssetMigrationContext loadAsset PackageLoadingAssetFile dependencyName string untilVersion PackageVersion Returns bool"
  },
  "api/Stride.Core.Assets.AssetMigrationContext.html": {
    "href": "api/Stride.Core.Assets.AssetMigrationContext.html",
    "title": "Class AssetMigrationContext | Stride API",
    "summary": "Class AssetMigrationContext Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Context used by IAssetUpgrader. public class AssetMigrationContext Inheritance object AssetMigrationContext Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetMigrationContext(Package?, IReference?, string, ILogger) Initializes a new instance of AssetMigrationContext. public AssetMigrationContext(Package? package, IReference? assetReference, string assetFullPath, ILogger log) Parameters package Package assetReference IReference assetFullPath string log ILogger Properties AssetFullPath public string AssetFullPath { get; } Property Value string AssetReference public IReference? AssetReference { get; } Property Value IReference Log The logger for this context. public ILogger Log { get; } Property Value ILogger Package The current package where the current asset is being migrated. This is null when the asset being migrated is a package. public Package? Package { get; } Property Value Package"
  },
  "api/Stride.Core.Assets.AssetPart.html": {
    "href": "api/Stride.Core.Assets.AssetPart.html",
    "title": "Struct AssetPart | Stride API",
    "summary": "Struct AssetPart Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A part asset contained by an asset that is IAssetComposite. [DataContract(\"AssetPart\")] [Obsolete(\"This struct might be removed soon\")] public readonly struct AssetPart : IEquatable<AssetPart> Implements IEquatable<AssetPart> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors AssetPart(Guid, BasePart?, Action<BasePart>) public AssetPart(Guid partId, BasePart? basePart, Action<BasePart> baseUpdater) Parameters partId Guid basePart BasePart baseUpdater Action<BasePart> Fields Base Base asset identifier. public readonly BasePart? Base Field Value BasePart PartId Asset identifier. public readonly Guid PartId Field Value Guid Methods Equals(AssetPart) Indicates whether the current object is equal to another object of the same type. public bool Equals(AssetPart other) Parameters other AssetPart An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. UpdateBase(BasePart) public void UpdateBase(BasePart newBase) Parameters newBase BasePart Operators operator ==(AssetPart, AssetPart) public static bool operator ==(AssetPart left, AssetPart right) Parameters left AssetPart right AssetPart Returns bool operator !=(AssetPart, AssetPart) public static bool operator !=(AssetPart left, AssetPart right) Parameters left AssetPart right AssetPart Returns bool"
  },
  "api/Stride.Core.Assets.AssetPartCollection-2.html": {
    "href": "api/Stride.Core.Assets.AssetPartCollection-2.html",
    "title": "Class AssetPartCollection<TAssetPartDesign, TAssetPart> | Stride API",
    "summary": "Class AssetPartCollection<TAssetPartDesign, TAssetPart> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll [DataSerializer(typeof(AssetPartCollectionSerializer<,>), Mode = DataSerializerGenericMode.GenericArguments)] public sealed class AssetPartCollection<TAssetPartDesign, TAssetPart> : SortedList<Guid, TAssetPartDesign>, IDictionary<Guid, TAssetPartDesign>, ICollection<KeyValuePair<Guid, TAssetPartDesign>>, IReadOnlyDictionary<Guid, TAssetPartDesign>, IReadOnlyCollection<KeyValuePair<Guid, TAssetPartDesign>>, IEnumerable<KeyValuePair<Guid, TAssetPartDesign>>, IDictionary, ICollection, IEnumerable where TAssetPartDesign : IAssetPartDesign<TAssetPart> where TAssetPart : IIdentifiable Type Parameters TAssetPartDesign TAssetPart Inheritance object SortedList<Guid, TAssetPartDesign> AssetPartCollection<TAssetPartDesign, TAssetPart> Implements IDictionary<Guid, TAssetPartDesign> ICollection<KeyValuePair<Guid, TAssetPartDesign>> IReadOnlyDictionary<Guid, TAssetPartDesign> IReadOnlyCollection<KeyValuePair<Guid, TAssetPartDesign>> IEnumerable<KeyValuePair<Guid, TAssetPartDesign>> IDictionary ICollection IEnumerable Inherited Members SortedList<Guid, TAssetPartDesign>.Add(Guid, TAssetPartDesign) SortedList<Guid, TAssetPartDesign>.Clear() SortedList<Guid, TAssetPartDesign>.ContainsKey(Guid) SortedList<Guid, TAssetPartDesign>.ContainsValue(TAssetPartDesign) SortedList<Guid, TAssetPartDesign>.GetEnumerator() SortedList<Guid, TAssetPartDesign>.GetKeyAtIndex(int) SortedList<Guid, TAssetPartDesign>.GetValueAtIndex(int) SortedList<Guid, TAssetPartDesign>.IndexOfKey(Guid) SortedList<Guid, TAssetPartDesign>.IndexOfValue(TAssetPartDesign) SortedList<Guid, TAssetPartDesign>.Remove(Guid) SortedList<Guid, TAssetPartDesign>.RemoveAt(int) SortedList<Guid, TAssetPartDesign>.SetValueAtIndex(int, TAssetPartDesign) SortedList<Guid, TAssetPartDesign>.TrimExcess() SortedList<Guid, TAssetPartDesign>.TryGetValue(Guid, out TAssetPartDesign) SortedList<Guid, TAssetPartDesign>.Capacity SortedList<Guid, TAssetPartDesign>.Comparer SortedList<Guid, TAssetPartDesign>.Count SortedList<Guid, TAssetPartDesign>.this[Guid] SortedList<Guid, TAssetPartDesign>.Keys SortedList<Guid, TAssetPartDesign>.Values Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods Add(KeyValuePair<Guid, TAssetPartDesign>) public void Add(KeyValuePair<Guid, TAssetPartDesign> part) Parameters part KeyValuePair<Guid, TAssetPartDesign> Add(TAssetPartDesign) public void Add(TAssetPartDesign part) Parameters part TAssetPartDesign RefreshKeys() Refreshes the keys of this collection. Must be called if some ids of the contained parts have changed. public void RefreshKeys()"
  },
  "api/Stride.Core.Assets.AssetPartCollectionSerializer-2.html": {
    "href": "api/Stride.Core.Assets.AssetPartCollectionSerializer-2.html",
    "title": "Class AssetPartCollectionSerializer<TAssetPartDesign, TAssetPart> | Stride API",
    "summary": "Class AssetPartCollectionSerializer<TAssetPartDesign, TAssetPart> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class AssetPartCollectionSerializer<TAssetPartDesign, TAssetPart> : DataSerializer<AssetPartCollection<TAssetPartDesign, TAssetPart>>, IDataSerializerGenericInstantiation where TAssetPartDesign : IAssetPartDesign<TAssetPart> where TAssetPart : IIdentifiable Type Parameters TAssetPartDesign TAssetPart Inheritance object DataSerializer DataSerializer<AssetPartCollection<TAssetPartDesign, TAssetPart>> AssetPartCollectionSerializer<TAssetPartDesign, TAssetPart> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<AssetPartCollection<TAssetPartDesign, TAssetPart>>.SerializationType DataSerializer<AssetPartCollection<TAssetPartDesign, TAssetPart>>.IsBlittable DataSerializer<AssetPartCollection<TAssetPartDesign, TAssetPart>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<AssetPartCollection<TAssetPartDesign, TAssetPart>>.Serialize(AssetPartCollection<TAssetPartDesign, TAssetPart>, SerializationStream) DataSerializer<AssetPartCollection<TAssetPartDesign, TAssetPart>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<AssetPartCollection<TAssetPartDesign, TAssetPart>>.PreSerialize(ref AssetPartCollection<TAssetPartDesign, TAssetPart>, ArchiveMode, SerializationStream) DataSerializer<AssetPartCollection<TAssetPartDesign, TAssetPart>>.Serialize(ref AssetPartCollection<TAssetPartDesign, TAssetPart>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref AssetPartCollection<TAssetPartDesign, TAssetPart>, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref AssetPartCollection<TAssetPartDesign, TAssetPart> obj, ArchiveMode mode, SerializationStream stream) Parameters obj AssetPartCollection<TAssetPartDesign, TAssetPart> The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref AssetPartCollection<TAssetPartDesign, TAssetPart>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref AssetPartCollection<TAssetPartDesign, TAssetPart> obj, ArchiveMode mode, SerializationStream stream) Parameters obj AssetPartCollection<TAssetPartDesign, TAssetPart> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Assets.AssetReference.html": {
    "href": "api/Stride.Core.Assets.AssetReference.html",
    "title": "Class AssetReference | Stride API",
    "summary": "Class AssetReference Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An asset reference. [DataContract(\"aref\")] [DataStyle(DataStyle.Compact)] [DataSerializer(typeof(AssetReferenceDataSerializer))] public sealed class AssetReference : IReference, IEquatable<AssetReference> Inheritance object AssetReference Implements IReference IEquatable<AssetReference> Extension Methods AssetReferenceExtensions.HasLocation(AssetReference) UnsafeUtilities.As<T>(object?) Constructors AssetReference(AssetId, UFile) Initializes a new instance of the AssetReference class. public AssetReference(AssetId id, UFile location) Parameters id AssetId The unique identifier of the asset. location UFile The location. Properties Id Gets or sets the unique identifier of the reference asset. [DataMember(10)] public AssetId Id { get; init; } Property Value AssetId The unique identifier of the reference asset.. Location Gets or sets the location of the asset. [DataMember(20)] public string Location { get; init; } Property Value string The location. Methods Equals(AssetReference?) Indicates whether the current object is equal to another object of the same type. public bool Equals(AssetReference? other) Parameters other AssetReference An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Determines whether the specified object is equal to the current object. public override bool Equals(object? obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. New(AssetId, UFile) Tries to parse an asset reference in the format \"GUID:Location\". public static AssetReference New(AssetId id, UFile location) Parameters id AssetId The identifier. location UFile The location. Returns AssetReference true if parsing was successful, false otherwise. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. TryParse(string, out AssetId, out UFile) Tries to parse an asset reference in the format \"[GUID/]GUID:Location\". The first GUID is optional and is used to store the ID of the reference. public static bool TryParse(string assetReferenceText, out AssetId id, out UFile location) Parameters assetReferenceText string The asset reference. id AssetId The unique identifier of asset pointed by this reference. location UFile The location. Returns bool true if parsing was successful, false otherwise. Exceptions ArgumentNullException assetReferenceText TryParse(string, out AssetReference) Tries to parse an asset reference in the format \"GUID:Location\". public static bool TryParse(string assetReferenceText, out AssetReference assetReference) Parameters assetReferenceText string The asset reference. assetReference AssetReference The reference. Returns bool true if parsing was successful, false otherwise. Operators operator ==(AssetReference?, AssetReference?) Implements the ==. public static bool operator ==(AssetReference? left, AssetReference? right) Parameters left AssetReference The left. right AssetReference The right. Returns bool The result of the operator. operator !=(AssetReference?, AssetReference?) Implements the !=. public static bool operator !=(AssetReference? left, AssetReference? right) Parameters left AssetReference The left. right AssetReference The right. Returns bool The result of the operator."
  },
  "api/Stride.Core.Assets.AssetReferenceDataSerializer.html": {
    "href": "api/Stride.Core.Assets.AssetReferenceDataSerializer.html",
    "title": "Class AssetReferenceDataSerializer | Stride API",
    "summary": "Class AssetReferenceDataSerializer Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Serializer for AssetReference. public sealed class AssetReferenceDataSerializer : DataSerializer<AssetReference> Inheritance object DataSerializer DataSerializer<AssetReference> AssetReferenceDataSerializer Inherited Members DataSerializer<AssetReference>.SerializationType DataSerializer<AssetReference>.IsBlittable DataSerializer<AssetReference>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<AssetReference>.Serialize(AssetReference, SerializationStream) DataSerializer<AssetReference>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<AssetReference>.PreSerialize(ref AssetReference, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref AssetReference, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref AssetReference assetReference, ArchiveMode mode, SerializationStream stream) Parameters assetReference AssetReference mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Assets.AssetReferenceExtensions.html": {
    "href": "api/Stride.Core.Assets.AssetReferenceExtensions.html",
    "title": "Class AssetReferenceExtensions | Stride API",
    "summary": "Class AssetReferenceExtensions Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Extension methods for AssetReference public static class AssetReferenceExtensions Inheritance object AssetReferenceExtensions Methods HasLocation(AssetReference) Determines whether the specified asset reference has location. If the reference is null, return false. public static bool HasLocation(this AssetReference assetReference) Parameters assetReference AssetReference The asset reference. Returns bool true if the specified asset reference has location; otherwise, false."
  },
  "api/Stride.Core.Assets.AssetRegistry.html": {
    "href": "api/Stride.Core.Assets.AssetRegistry.html",
    "title": "Class AssetRegistry | Stride API",
    "summary": "Class AssetRegistry Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A registry for various content associated with assets. public static class AssetRegistry Inheritance object AssetRegistry Properties AssetAssemblies Gets the list of asset assemblies currently registered. public static IEnumerable<Assembly> AssetAssemblies { get; } Property Value IEnumerable<Assembly> EngineAssemblies Gets the list of engine assemblies currently registered. public static IEnumerable<Assembly> EngineAssemblies { get; } Property Value IEnumerable<Assembly> RegisteredImporters Gets an enumeration of registered importers. public static IEnumerable<IAssetImporter> RegisteredImporters { get; } Property Value IEnumerable<IAssetImporter> The registered importers. SupportedPlatforms Gets the supported platforms. public static SolutionPlatformCollection SupportedPlatforms { get; } Property Value SolutionPlatformCollection The supported platforms. Methods CanBeAssignedToContentTypes(Type, bool) Can a property of this type hold content public static bool CanBeAssignedToContentTypes(Type type, bool checkIsUrlType) Parameters type Type checkIsUrlType bool Returns bool Remarks You may want to use IsExactContentType(Type?) instead if you're checking if this type is a concrete content type CanPropertyHandleAssets(Type, out HashSet<Type>) Whether a property of this type can be set to asset content, outputs the assets it can hold if true public static bool CanPropertyHandleAssets(Type propertyType, out HashSet<Type> assetTypes) Parameters propertyType Type assetTypes HashSet<Type> Returns bool Remarks The difference between this one and CanPropertyHandleContent(Type, out IReadOnlyList<Type>) is that this one returns the asset types, meaning the types that would be compiled into 'content' to be used at runtime. This means that the types contained in Stride.Core.Assets.AssetRegistry.AssetTypes are not directly assignable to propertyType CanPropertyHandleContent(Type, out IReadOnlyList<Type>) Whether a property of this type can be set to content, outputs the content types it can hold if true public static bool CanPropertyHandleContent(Type propertyType, out IReadOnlyList<Type> contentTypes) Parameters propertyType Type contentTypes IReadOnlyList<Type> Returns bool Remarks The difference between this one and CanPropertyHandleAssets(Type, out HashSet<Type>) is that this one returns the content types, meaning the concrete types that are types that would be compiled into 'content' to be used at runtime. The types contained in contentTypes are not guaranteed to be assignable to propertyType FindImporterById(Guid) Finds an importer by its id. public static IAssetImporter? FindImporterById(Guid importerId) Parameters importerId Guid The importer identifier. Returns IAssetImporter An instance of the importer of null if not found. FindImporterForFile(string) Finds the importer associated with an asset by the file of the file to import. public static IEnumerable<IAssetImporter> FindImporterForFile(string file) Parameters file string The file to import. Returns IEnumerable<IAssetImporter> An instance of the importer of null if not found. GetAllAssetFactories() public static IEnumerable<IAssetFactory<Asset>> GetAllAssetFactories() Returns IEnumerable<IAssetFactory<Asset>> GetAssetFactory(string) public static IAssetFactory<Asset>? GetAssetFactory(string typeName) Parameters typeName string Returns IAssetFactory<Asset> GetAssetTypeFromFileExtension(string) Gets the asset type from the extension. If no asset type is found, return null. public static Type? GetAssetTypeFromFileExtension(string extension) Parameters extension string The extension of the asset file. Returns Type Type of the associated asset or null if not found. GetAssetTypes(Type) public static IReadOnlyList<Type> GetAssetTypes(Type contentType) Parameters contentType Type Returns IReadOnlyList<Type> GetAssetUpgraders(Type, string) Gets the AssetUpgraderCollection of an asset type, if available. public static AssetUpgraderCollection? GetAssetUpgraders(Type assetType, string dependencyName) Parameters assetType Type The asset type. dependencyName string The dependency name. Returns AssetUpgraderCollection The AssetUpgraderCollection of an asset type if available, or null otherwise. GetContentType(Type) public static Type? GetContentType(Type assetType) Parameters assetType Type Returns Type GetContentTypes() public static IList<Type> GetContentTypes() Returns IList<Type> GetCurrentFormatVersions(Type) Gets the current format version of an asset. public static SortedList<string, PackageVersion>? GetCurrentFormatVersions(Type assetType) Parameters assetType Type The asset type. Returns SortedList<string, PackageVersion> The current format version of this asset. GetDataVisitNodes() public static IEnumerable<IDataCustomVisitor> GetDataVisitNodes() Returns IEnumerable<IDataCustomVisitor> GetDefaultExtension(Type) Gets the default file associated with an asset. public static string? GetDefaultExtension(Type assetType) Parameters assetType Type The type. Returns string System.String. GetDefaultExtension<T>() Gets the default file associated with an asset. public static string? GetDefaultExtension<T>() where T : Asset Returns string System.String. Type Parameters T Type of the asset. GetPackageSessionAnalysisTypes() public static IEnumerable<Type> GetPackageSessionAnalysisTypes() Returns IEnumerable<Type> GetPackageUpgrader(string) public static PackageUpgrader? GetPackageUpgrader(string packageName) Parameters packageName string Returns PackageUpgrader GetPublicTypes() Returns an array of asset types that are non-abstract and public. public static Type[] GetPublicTypes() Returns Type[] An array of Type elements. IsAssetFileExtension(string?) Determines whether the file is an asset file type. public static bool IsAssetFileExtension(string? extension) Parameters extension string The file. Returns bool true if [is asset file file] [the specified file]; otherwise, false. IsAssetOrPackageType(Type, bool) Check if the specified type is an asset. public static bool IsAssetOrPackageType(Type assetType, bool throwException = false) Parameters assetType Type Type of the asset. throwException bool A boolean indicating whether this method should throw an exception if the type is not an asset type. Returns bool true if the asset is an asset type, false otherwise. IsAssetType(Type, bool) Check if the specified type is an asset. public static bool IsAssetType(Type assetType, bool throwException = false) Parameters assetType Type Type of the asset. throwException bool A boolean indicating whether this method should throw an exception if the type is not an asset type. Returns bool true if the asset is an asset type, false otherwise. IsAssetTypeAlwaysMarkAsRoot(Type) public static bool IsAssetTypeAlwaysMarkAsRoot(Type type) Parameters type Type Returns bool IsExactContentType(Type?) Is this type a concrete content type, or derives from a concrete content type public static bool IsExactContentType(Type? type) Parameters type Type Returns bool Remarks You may want to use CanBeAssignedToContentTypes(Type, bool) instead if you're checking whether a property of this type could hold at least one type of content IsProjectAssetFileExtension(string?) public static bool IsProjectAssetFileExtension(string? extension) Parameters extension string Returns bool IsProjectCodeGeneratorAssetFileExtension(string?) public static bool IsProjectCodeGeneratorAssetFileExtension(string? extension) Parameters extension string Returns bool RegisterImporter(IAssetImporter) Registers a IAssetImporter for the specified asset type. public static void RegisterImporter(IAssetImporter importer) Parameters importer IAssetImporter The importer. Exceptions ArgumentNullException importer RegisterSupportedPlatforms(List<SolutionPlatform>) Registers the supported platforms. public static void RegisterSupportedPlatforms(List<SolutionPlatform> platforms) Parameters platforms List<SolutionPlatform> The platforms. Exceptions ArgumentNullException platforms"
  },
  "api/Stride.Core.Assets.AssetSelector.html": {
    "href": "api/Stride.Core.Assets.AssetSelector.html",
    "title": "Class AssetSelector | Stride API",
    "summary": "Class AssetSelector Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An asset selector [DataContract(Inherited = true)] public abstract class AssetSelector Inheritance object AssetSelector Derived PathSelector TagSelector Extension Methods UnsafeUtilities.As<T>(object?) Methods Select(PackageSession, IContentIndexMap) public abstract IEnumerable<string> Select(PackageSession packageSession, IContentIndexMap contentIndexMap) Parameters packageSession PackageSession contentIndexMap IContentIndexMap Returns IEnumerable<string>"
  },
  "api/Stride.Core.Assets.AssetTracker.html": {
    "href": "api/Stride.Core.Assets.AssetTracker.html",
    "title": "Class AssetTracker | Stride API",
    "summary": "Class AssetTracker Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Base class for tracking assets and executing an action on each change. public abstract class AssetTracker : IDisposable Inheritance object AssetTracker Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors AssetTracker(PackageSession) protected AssetTracker(PackageSession session) Parameters session PackageSession Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool NotifyAssetChanged(Asset) Called when an asset changes. public abstract void NotifyAssetChanged(Asset asset) Parameters asset Asset Start() protected void Start() TrackAsset(AssetItem) Called when a new asset is tracked. public abstract void TrackAsset(AssetItem assetItem) Parameters assetItem AssetItem UnTrackAsset(AssetItem) Called when an asset stop being tracked. public abstract void UnTrackAsset(AssetItem assetItem) Parameters assetItem AssetItem"
  },
  "api/Stride.Core.Assets.AssetUpgraderAttribute.html": {
    "href": "api/Stride.Core.Assets.AssetUpgraderAttribute.html",
    "title": "Class AssetUpgraderAttribute | Stride API",
    "summary": "Class AssetUpgraderAttribute Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Describes which upgrader type to use to upgrade an asset, depending on this current version number. [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] public class AssetUpgraderAttribute : Attribute Inheritance object Attribute AssetUpgraderAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetUpgraderAttribute(string, int, int, Type) Initializes a new instance of the AssetUpgraderAttribute with a single supported initial version number. public AssetUpgraderAttribute(string name, int startVersion, int targetVersion, Type assetUpgraderType) Parameters name string The dependency name. startVersion int The initial version number this upgrader can work on. targetVersion int The target version number of this upgrader. assetUpgraderType Type The type of upgrader to instantiate to upgrade the asset. AssetUpgraderAttribute(string, string, string, Type) Initializes a new instance of the AssetUpgraderAttribute with a range of supported initial version numbers. public AssetUpgraderAttribute(string name, string startMinVersion, string targetVersion, Type assetUpgraderType) Parameters name string The dependency name. startMinVersion string The minimal initial version number this upgrader can work on. targetVersion string The target version number of this upgrader. assetUpgraderType Type The type of upgrader to instantiate to upgrade the asset. Properties AssetUpgraderType Gets or sets the type of upgrader to instantiate to upgrade the asset. public Type AssetUpgraderType { get; set; } Property Value Type Name Gets or sets the dependency name. public string Name { get; set; } Property Value string StartVersion Gets or sets the minimal initial version number this upgrader can work on. public PackageVersion StartVersion { get; set; } Property Value PackageVersion TargetVersion Gets or sets the target version number of this upgrader. public PackageVersion TargetVersion { get; set; } Property Value PackageVersion"
  },
  "api/Stride.Core.Assets.AssetUpgraderBase.html": {
    "href": "api/Stride.Core.Assets.AssetUpgraderBase.html",
    "title": "Class AssetUpgraderBase | Stride API",
    "summary": "Class AssetUpgraderBase Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public abstract class AssetUpgraderBase : IAssetUpgrader Inheritance object AssetUpgraderBase Implements IAssetUpgrader Derived EmptyAssetUpgrader Extension Methods UnsafeUtilities.As<T>(object?) Methods SetSerializableVersion(dynamic, string, PackageVersion) public static void SetSerializableVersion(dynamic asset, string dependencyName, PackageVersion value) Parameters asset dynamic dependencyName string value PackageVersion Upgrade(AssetMigrationContext, string, PackageVersion, PackageVersion, YamlMappingNode, PackageLoadingAssetFile) public void Upgrade(AssetMigrationContext context, string dependencyName, PackageVersion currentVersion, PackageVersion targetVersion, YamlMappingNode yamlAssetNode, PackageLoadingAssetFile assetFile) Parameters context AssetMigrationContext dependencyName string currentVersion PackageVersion targetVersion PackageVersion yamlAssetNode YamlMappingNode assetFile PackageLoadingAssetFile UpgradeAsset(AssetMigrationContext, PackageVersion, PackageVersion, dynamic, PackageLoadingAssetFile, OverrideUpgraderHint) protected abstract void UpgradeAsset(AssetMigrationContext context, PackageVersion currentVersion, PackageVersion targetVersion, dynamic asset, PackageLoadingAssetFile assetFile, OverrideUpgraderHint overrideHint) Parameters context AssetMigrationContext currentVersion PackageVersion targetVersion PackageVersion asset dynamic assetFile PackageLoadingAssetFile overrideHint OverrideUpgraderHint"
  },
  "api/Stride.Core.Assets.AssetUpgraderCollection.html": {
    "href": "api/Stride.Core.Assets.AssetUpgraderCollection.html",
    "title": "Class AssetUpgraderCollection | Stride API",
    "summary": "Class AssetUpgraderCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class AssetUpgraderCollection Inheritance object AssetUpgraderCollection Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetUpgraderCollection(Type, PackageVersion) public AssetUpgraderCollection(Type assetType, PackageVersion currentVersion) Parameters assetType Type currentVersion PackageVersion Properties AssetType public Type AssetType { get; } Property Value Type Methods GetUpgrader(PackageVersion, out PackageVersion) public IAssetUpgrader GetUpgrader(PackageVersion initialVersion, out PackageVersion targetVersion) Parameters initialVersion PackageVersion targetVersion PackageVersion Returns IAssetUpgrader"
  },
  "api/Stride.Core.Assets.AssetWithSource.html": {
    "href": "api/Stride.Core.Assets.AssetWithSource.html",
    "title": "Class AssetWithSource | Stride API",
    "summary": "Class AssetWithSource Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An asset that references a source file used during the compilation of the asset. [DataContract] public abstract class AssetWithSource : Asset, IAssetWithSource Inheritance object Asset AssetWithSource Implements IAssetWithSource Derived RawAsset Inherited Members Asset.Id Asset.SerializedVersion Asset.Tags Asset.Archetype Asset.CreateDerivedAsset(string) Asset.CreateDerivedAsset(string, out Dictionary<Guid, Guid>) Asset.ToString() Extension Methods UnsafeUtilities.As<T>(object?) Properties MainSource Gets the main source file for this asset, used in the editor. public override UFile MainSource { get; } Property Value UFile Source Gets or sets the source file of this asset. [DataMember(-50)] [SourceFileMember(false)] public UFile Source { get; set; } Property Value UFile The source."
  },
  "api/Stride.Core.Assets.BasePart.html": {
    "href": "api/Stride.Core.Assets.BasePart.html",
    "title": "Class BasePart | Stride API",
    "summary": "Class BasePart Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll [DataContract] [DataSerializer(typeof(BasePartDataSerializer))] public sealed class BasePart : IEquatable<BasePart> Inheritance object BasePart Implements IEquatable<BasePart> Extension Methods UnsafeUtilities.As<T>(object?) Constructors BasePart(AssetReference, Guid, Guid) public BasePart(AssetReference basePartAsset, Guid basePartId, Guid instanceId) Parameters basePartAsset AssetReference basePartId Guid instanceId Guid Properties BasePartAsset [DataMember(10)] public AssetReference BasePartAsset { get; set; } Property Value AssetReference BasePartId [DataMember(20)] public Guid BasePartId { get; init; } Property Value Guid InstanceId [DataMember(30)] public Guid InstanceId { get; init; } Property Value Guid Methods Equals(BasePart?) Indicates whether the current object is equal to another object of the same type. public bool Equals(BasePart? other) Parameters other BasePart An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Determines whether the specified object is equal to the current object. public override bool Equals(object? obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. ResolvePart(PackageSession) public IIdentifiable? ResolvePart(PackageSession session) Parameters session PackageSession Returns IIdentifiable Operators operator ==(BasePart?, BasePart?) public static bool operator ==(BasePart? left, BasePart? right) Parameters left BasePart right BasePart Returns bool operator !=(BasePart?, BasePart?) public static bool operator !=(BasePart? left, BasePart? right) Parameters left BasePart right BasePart Returns bool"
  },
  "api/Stride.Core.Assets.BasePartDataSerializer.html": {
    "href": "api/Stride.Core.Assets.BasePartDataSerializer.html",
    "title": "Class BasePartDataSerializer | Stride API",
    "summary": "Class BasePartDataSerializer Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class BasePartDataSerializer : DataSerializer<BasePart> Inheritance object DataSerializer DataSerializer<BasePart> BasePartDataSerializer Inherited Members DataSerializer<BasePart>.SerializationType DataSerializer<BasePart>.IsBlittable DataSerializer<BasePart>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<BasePart>.Serialize(BasePart, SerializationStream) DataSerializer<BasePart>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<BasePart>.PreSerialize(ref BasePart, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref BasePart, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref BasePart basePart, ArchiveMode mode, SerializationStream stream) Parameters basePart BasePart mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Assets.Bundle.html": {
    "href": "api/Stride.Core.Assets.Bundle.html",
    "title": "Class Bundle | Stride API",
    "summary": "Class Bundle Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Description of an asset bundle. [DataContract(\"Bundle\")] public sealed class Bundle Inheritance object Bundle Extension Methods UnsafeUtilities.As<T>(object?) Properties Dependencies Gets the bundle dependencies. public List<string> Dependencies { get; } Property Value List<string> The dependencies. Name Gets or sets the name of this bundle. public string Name { get; set; } Property Value string The name. OutputGroup Gets the output group (used in conjonction with ProjectBuildProfile.OutputGroupDirectories to control where file will be put). public string? OutputGroup { get; set; } Property Value string The output group. Selectors Gets the selectors used by this bundle. public List<AssetSelector> Selectors { get; } Property Value List<AssetSelector> The selectors."
  },
  "api/Stride.Core.Assets.BundleCollection.html": {
    "href": "api/Stride.Core.Assets.BundleCollection.html",
    "title": "Class BundleCollection | Stride API",
    "summary": "Class BundleCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A collection of bundles. [DataContract(\"!Bundles\")] public class BundleCollection : List<Bundle>, IList<Bundle>, ICollection<Bundle>, IReadOnlyList<Bundle>, IReadOnlyCollection<Bundle>, IEnumerable<Bundle>, IList, ICollection, IEnumerable Inheritance object List<Bundle> BundleCollection Implements IList<Bundle> ICollection<Bundle> IReadOnlyList<Bundle> IReadOnlyCollection<Bundle> IEnumerable<Bundle> IList ICollection IEnumerable Inherited Members List<Bundle>.Add(Bundle) List<Bundle>.AddRange(IEnumerable<Bundle>) List<Bundle>.AsReadOnly() List<Bundle>.BinarySearch(int, int, Bundle, IComparer<Bundle>) List<Bundle>.BinarySearch(Bundle) List<Bundle>.BinarySearch(Bundle, IComparer<Bundle>) List<Bundle>.Clear() List<Bundle>.Contains(Bundle) List<Bundle>.ConvertAll<TOutput>(Converter<Bundle, TOutput>) List<Bundle>.CopyTo(int, Bundle[], int, int) List<Bundle>.CopyTo(Bundle[]) List<Bundle>.CopyTo(Bundle[], int) List<Bundle>.EnsureCapacity(int) List<Bundle>.Exists(Predicate<Bundle>) List<Bundle>.Find(Predicate<Bundle>) List<Bundle>.FindAll(Predicate<Bundle>) List<Bundle>.FindIndex(int, int, Predicate<Bundle>) List<Bundle>.FindIndex(int, Predicate<Bundle>) List<Bundle>.FindIndex(Predicate<Bundle>) List<Bundle>.FindLast(Predicate<Bundle>) List<Bundle>.FindLastIndex(int, int, Predicate<Bundle>) List<Bundle>.FindLastIndex(int, Predicate<Bundle>) List<Bundle>.FindLastIndex(Predicate<Bundle>) List<Bundle>.ForEach(Action<Bundle>) List<Bundle>.GetEnumerator() List<Bundle>.GetRange(int, int) List<Bundle>.IndexOf(Bundle) List<Bundle>.IndexOf(Bundle, int) List<Bundle>.IndexOf(Bundle, int, int) List<Bundle>.Insert(int, Bundle) List<Bundle>.InsertRange(int, IEnumerable<Bundle>) List<Bundle>.LastIndexOf(Bundle) List<Bundle>.LastIndexOf(Bundle, int) List<Bundle>.LastIndexOf(Bundle, int, int) List<Bundle>.Remove(Bundle) List<Bundle>.RemoveAll(Predicate<Bundle>) List<Bundle>.RemoveAt(int) List<Bundle>.RemoveRange(int, int) List<Bundle>.Reverse() List<Bundle>.Reverse(int, int) List<Bundle>.Slice(int, int) List<Bundle>.Sort() List<Bundle>.Sort(IComparer<Bundle>) List<Bundle>.Sort(Comparison<Bundle>) List<Bundle>.Sort(int, int, IComparer<Bundle>) List<Bundle>.ToArray() List<Bundle>.TrimExcess() List<Bundle>.TrueForAll(Predicate<Bundle>) List<Bundle>.Capacity List<Bundle>.Count List<Bundle>.this[int] Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Assets.CollectionIdGenerator.html": {
    "href": "api/Stride.Core.Assets.CollectionIdGenerator.html",
    "title": "Class CollectionIdGenerator | Stride API",
    "summary": "Class CollectionIdGenerator Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A visitor that will generate a CollectionItemIdentifiers collection for each collection or dictionary of the visited object, and attach it to the related collection. public class CollectionIdGenerator : DataVisitorBase, IDataVisitor Inheritance object DataVisitorBase CollectionIdGenerator Implements IDataVisitor Inherited Members DataVisitorBase.TypeDescriptorFactory DataVisitorBase.CustomVisitors DataVisitorBase.CurrentPath DataVisitorBase.AttributeRegistry DataVisitorBase.Reset() DataVisitorBase.Visit(object) DataVisitorBase.Visit(object, ITypeDescriptor) DataVisitorBase.VisitNull() DataVisitorBase.VisitPrimitive(object, PrimitiveDescriptor) DataVisitorBase.VisitArrayItem(Array, ArrayDescriptor, int, object, ITypeDescriptor) DataVisitorBase.VisitCollectionItem(IEnumerable, CollectionDescriptor, int, object, ITypeDescriptor) DataVisitorBase.VisitDictionaryKeyValue(object, DictionaryDescriptor, object, ITypeDescriptor, object, ITypeDescriptor) DataVisitorBase.VisitSetItem(IEnumerable, SetDescriptor, object, ITypeDescriptor) Extension Methods UnsafeUtilities.As<T>(object?) Methods CanVisit(object) protected override bool CanVisit(object obj) Parameters obj object Returns bool VisitArray(Array, ArrayDescriptor) Visits an array. public override void VisitArray(Array array, ArrayDescriptor descriptor) Parameters array Array The array. descriptor ArrayDescriptor The descriptor. VisitCollection(IEnumerable, CollectionDescriptor) Visits a collection. public override void VisitCollection(IEnumerable collection, CollectionDescriptor descriptor) Parameters collection IEnumerable The collection. descriptor CollectionDescriptor The descriptor. VisitDictionary(object, DictionaryDescriptor) Visits a dictionary. public override void VisitDictionary(object dictionary, DictionaryDescriptor descriptor) Parameters dictionary object The dictionary. descriptor DictionaryDescriptor The descriptor. VisitObject(object, ObjectDescriptor, bool) Visits an object (either a class or a struct) public override void VisitObject(object obj, ObjectDescriptor descriptor, bool visitMembers) Parameters obj object The object. descriptor ObjectDescriptor The descriptor. visitMembers bool VisitObjectMember(object, ObjectDescriptor, IMemberDescriptor, object?) Visits an object member. public override void VisitObjectMember(object container, ObjectDescriptor containerDescriptor, IMemberDescriptor member, object? value) Parameters container object The container. containerDescriptor ObjectDescriptor The container descriptor. member IMemberDescriptor The member. value object The value. VisitSet(IEnumerable, SetDescriptor) Visits a set. public override void VisitSet(IEnumerable set, SetDescriptor descriptor) Parameters set IEnumerable The set. descriptor SetDescriptor The descriptor."
  },
  "api/Stride.Core.Assets.Compiler.AssetBuildStep.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetBuildStep.html",
    "title": "Class AssetBuildStep | Stride API",
    "summary": "Class AssetBuildStep Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll Represents a list of Stride.Core.BuildEngine.BuildStep instances that compiles a given asset. public class AssetBuildStep : ListBuildStep Inheritance object BuildStep ListBuildStep AssetBuildStep Inherited Members ListBuildStep.Title ListBuildStep.InputObjects ListBuildStep.OutputObjects ListBuildStep.OutputObjectIds ListBuildStep.Steps ListBuildStep.Execute(IExecuteContext, BuilderContext) ListBuildStep.ComputeResultStatusFromExecutedSteps() ListBuildStep.CompleteCommands(IExecuteContext, List<BuildStep>) ListBuildStep.WaitCommands(List<BuildStep>) ListBuildStep.Count ListBuildStep.GetEnumerator() ListBuildStep.Add(Command) ListBuildStep.Add(IEnumerable<Command>) ListBuildStep.Add(BuildStep) BuildStep.TransformExecuteContextLogger BuildStep.Priority BuildStep.Description BuildStep.Status BuildStep.Processed BuildStep.Succeeded BuildStep.Failed BuildStep.Tag BuildStep.PrerequisiteSteps BuildStep.Parent BuildStep.ExecutionId BuildStep.ArePrerequisitesCompleted BuildStep.ArePrerequisitesSuccessful BuildStep.Logger BuildStep.StepProcessed BuildStep.Clean(IExecuteContext, BuilderContext, bool) BuildStep.LinkBuildSteps(BuildStep, BuildStep) BuildStep.ExecutedAsync() BuildStep.GetOutputObjectsGroups() Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetBuildStep(AssetItem) Initializes a new instance of the AssetBuildStep class. public AssetBuildStep(AssetItem assetItem) Parameters assetItem AssetItem The asset that can be build by this build step. Properties AssetItem Gets the AssetItem corresponding to the asset being built by this build step. public AssetItem AssetItem { get; } Property Value AssetItem OutputLocation The object this build step write (if any). public override string OutputLocation { get; } Property Value string Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.Compiler.AssetCommand-1.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetCommand-1.html",
    "title": "Class AssetCommand<T> | Stride API",
    "summary": "Class AssetCommand<T> Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll public abstract class AssetCommand<T> : AssetCommand Type Parameters T Inheritance object Command IndexFileCommand AssetCommand AssetCommand<T> Derived DummyAssetCommand<TAsset, TContent> Inherited Members AssetCommand.Url IndexFileCommand.PreCommand(ICommandContext) IndexFileCommand.PostCommand(ICommandContext, ResultStatus) Command.CommandCacheVersion Command.OutputLocation Command.CancellationToken Command.DoCommandOverride(ICommandContext) Command.DoCommand(ICommandContext) Command.Clone() Command.GetInputFiles() Command.InputFilesGetter Command.ShouldForceExecution() Command.ShouldSpawnNewProcess() Command.Cancel() Command.ComputeInputFilesHash(BinarySerializationWriter, IPrepareContext) Command.ComputeCommandHash(Stream, IPrepareContext) Command.ComputeAssemblyHash(BinarySerializationWriter) Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetCommand(string, T, IAssetFinder) protected AssetCommand(string url, T parameters, IAssetFinder assetFinder) Parameters url string parameters T assetFinder IAssetFinder Fields AssetFinder protected readonly IAssetFinder AssetFinder Field Value IAssetFinder Version This is useful if the asset binary format has changed and we want to bump the version to force re-evaluation/compilation of the command protected int Version Field Value int Properties Parameters public T Parameters { get; set; } Property Value T Title Title (short description) of the command public override string Title { get; } Property Value string Methods ComputeParameterHash(BinarySerializationWriter) protected override void ComputeParameterHash(BinarySerializationWriter writer) Parameters writer BinarySerializationWriter ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.Compiler.AssetCommand.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetCommand.html",
    "title": "Class AssetCommand | Stride API",
    "summary": "Class AssetCommand Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll A command processing an Asset. public abstract class AssetCommand : IndexFileCommand Inheritance object Command IndexFileCommand AssetCommand Derived AssetCommand<T> Inherited Members IndexFileCommand.PreCommand(ICommandContext) IndexFileCommand.PostCommand(ICommandContext, ResultStatus) Command.CommandCacheVersion Command.Title Command.OutputLocation Command.CancellationToken Command.DoCommandOverride(ICommandContext) Command.DoCommand(ICommandContext) Command.Clone() Command.ToString() Command.GetInputFiles() Command.InputFilesGetter Command.ShouldForceExecution() Command.ShouldSpawnNewProcess() Command.Cancel() Command.ComputeParameterHash(BinarySerializationWriter) Command.ComputeInputFilesHash(BinarySerializationWriter, IPrepareContext) Command.ComputeCommandHash(Stream, IPrepareContext) Command.ComputeAssemblyHash(BinarySerializationWriter) Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetCommand(string) protected AssetCommand(string url) Parameters url string Properties Url public string Url { get; set; } Property Value string"
  },
  "api/Stride.Core.Assets.Compiler.AssetCompilationContext.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetCompilationContext.html",
    "title": "Class AssetCompilationContext | Stride API",
    "summary": "Class AssetCompilationContext Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll public class AssetCompilationContext : ICompilationContext Inheritance object AssetCompilationContext Implements ICompilationContext Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Assets.Compiler.AssetCompiledArgs.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetCompiledArgs.html",
    "title": "Class AssetCompiledArgs | Stride API",
    "summary": "Class AssetCompiledArgs Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll The class represents the argument of the AssetCompiled event raised by the ItemListCompiler class. public class AssetCompiledArgs : EventArgs Inheritance object EventArgs AssetCompiledArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetCompiledArgs(AssetItem, AssetCompilerResult) Constructs an AssetCompiledArgs instance. public AssetCompiledArgs(AssetItem asset, AssetCompilerResult result) Parameters asset AssetItem The asset that has been compiled. Cannot be null. result AssetCompilerResult The result of the asset compilation. Cannot be null. Properties Asset The asset item that has just been compiled. public AssetItem Asset { get; set; } Property Value AssetItem Result The result of the asset compilation. public AssetCompilerResult Result { get; set; } Property Value AssetCompilerResult"
  },
  "api/Stride.Core.Assets.Compiler.AssetCompilerAttribute.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetCompilerAttribute.html",
    "title": "Class AssetCompilerAttribute | Stride API",
    "summary": "Class AssetCompilerAttribute Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll Attribute to define an asset compiler for a Asset. [AttributeUsage(AttributeTargets.Class)] [BaseTypeRequired(typeof(IAssetCompiler))] public class AssetCompilerAttribute : DynamicTypeAttributeBase Inheritance object Attribute DynamicTypeAttributeBase AssetCompilerAttribute Inherited Members DynamicTypeAttributeBase.TypeName Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetCompilerAttribute(string, Type) public AssetCompilerAttribute(string typeName, Type compilationContextType) Parameters typeName string compilationContextType Type AssetCompilerAttribute(Type, Type) public AssetCompilerAttribute(Type type, Type compilationContextType) Parameters type Type compilationContextType Type Properties CompilationContext public Type CompilationContext { get; } Property Value Type"
  },
  "api/Stride.Core.Assets.Compiler.AssetCompilerBase.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetCompilerBase.html",
    "title": "Class AssetCompilerBase | Stride API",
    "summary": "Class AssetCompilerBase Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll Base implementation for IAssetCompiler suitable to compile a single type of Asset. public abstract class AssetCompilerBase : IAssetCompiler Inheritance object AssetCompilerBase Implements IAssetCompiler Extension Methods UnsafeUtilities.As<T>(object?) Properties AlwaysCheckRuntimeTypes public virtual bool AlwaysCheckRuntimeTypes { get; } Property Value bool Methods GetAbsolutePath(AssetItem, UFile) Returns the absolute path on the disk of an Stride.Core.IO.UFile that is relative to the asset location. protected static UFile GetAbsolutePath(AssetItem assetItem, UFile relativePath) Parameters assetItem AssetItem The asset on which is based the relative path. relativePath UFile The path relative to the asset path that must be converted to an absolute path. Returns UFile The absolute path on the disk of the relativePath argument. Exceptions ArgumentException The relativePath argument is a null or empty Stride.Core.IO.UFile. GetInputFiles(AssetItem) Enumerates all the dependencies required to compile this asset public virtual IEnumerable<ObjectUrl> GetInputFiles(AssetItem assetItem) Parameters assetItem AssetItem The asset for which dependencies are enumerated Returns IEnumerable<ObjectUrl> The dependencies GetInputTypes(AssetItem) Enumerates all the asset types required to compile this asset public virtual IEnumerable<BuildDependencyInfo> GetInputTypes(AssetItem assetItem) Parameters assetItem AssetItem The asset for which types are enumerated Returns IEnumerable<BuildDependencyInfo> The dependencies GetInputTypesToExclude(AssetItem) Enumerates all the asset types to exclude when compiling this asset public virtual IEnumerable<Type> GetInputTypesToExclude(AssetItem assetItem) Parameters assetItem AssetItem The asset for which types are enumerated Returns IEnumerable<Type> The types to exclude Remarks This method takes higher priority, it will exclude assets included with inclusion methods even in the same compiler GetRuntimeTypes(AssetItem) public virtual IEnumerable<Type> GetRuntimeTypes(AssetItem assetItem) Parameters assetItem AssetItem Returns IEnumerable<Type> Prepare(AssetCompilerContext, AssetItem) Compiles a list of assets from the specified package. public AssetCompilerResult Prepare(AssetCompilerContext context, AssetItem assetItem) Parameters context AssetCompilerContext assetItem AssetItem The asset reference. Returns AssetCompilerResult The result of the compilation. Prepare(AssetCompilerContext, AssetItem, string, AssetCompilerResult) Compiles the asset from the specified package. protected abstract void Prepare(AssetCompilerContext context, AssetItem assetItem, string targetUrlInStorage, AssetCompilerResult result) Parameters context AssetCompilerContext The context to use to compile the asset. assetItem AssetItem The asset to compile targetUrlInStorage string The absolute URL to the asset, relative to the storage. result AssetCompilerResult The result where the commands and logs should be output."
  },
  "api/Stride.Core.Assets.Compiler.AssetCompilerContext.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetCompilerContext.html",
    "title": "Class AssetCompilerContext | Stride API",
    "summary": "Class AssetCompilerContext Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll The context used when compiling an asset in a Package. public class AssetCompilerContext : CompilerContext, IDisposable Inheritance object CompilerContext AssetCompilerContext Implements IDisposable Inherited Members CompilerContext.OptionProperties CompilerContext.Properties CompilerContext.Clone() CompilerContext.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields CompilationContext The compilation context type of this compiler context public Type CompilationContext Field Value Type Properties BuildConfiguration Gets or sets the build configuration (Debug, Release, AppStore, Testing) public string BuildConfiguration { get; set; } Property Value string Package Gets or sets the entry package this build was called upon. public Package Package { get; set; } Property Value Package Platform Gets or sets the target platform for compiler is being used for. public PlatformType Platform { get; set; } Property Value PlatformType The platform. Profile Gets or sets the name of the profile being built. public string Profile { get; set; } Property Value string"
  },
  "api/Stride.Core.Assets.Compiler.AssetCompilerRegistry.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetCompilerRegistry.html",
    "title": "Class AssetCompilerRegistry | Stride API",
    "summary": "Class AssetCompilerRegistry Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll A registry containing the asset compilers of the assets. public sealed class AssetCompilerRegistry Inheritance object AssetCompilerRegistry Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetCompilerRegistry() Create an instance of that registry public AssetCompilerRegistry() Properties DefaultCompiler Gets or sets the default compiler to use when no compiler are explicitly registered for a type. public IAssetCompiler? DefaultCompiler { get; set; } Property Value IAssetCompiler Methods GetCompiler(Type, Type) Gets the compiler associated to an Asset type. public IAssetCompiler? GetCompiler(Type type, Type context) Parameters type Type The type of the Asset context Type Returns IAssetCompiler The compiler associated the provided asset type or null if no compiler exists for that type. RegisterCompiler(Type, IAssetCompiler, Type) Register a compiler for a given Asset type. public void RegisterCompiler(Type type, IAssetCompiler compiler, Type context) Parameters type Type The type of asset the compiler can compile compiler IAssetCompiler The compiler to use context Type"
  },
  "api/Stride.Core.Assets.Compiler.AssetCompilerResult.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetCompilerResult.html",
    "title": "Class AssetCompilerResult | Stride API",
    "summary": "Class AssetCompilerResult Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll Result of a compilation of assets when using Prepare(AssetCompilerContext, AssetItem) public class AssetCompilerResult : LoggerResult, ILogger, IProgressStatus Inheritance object Logger LoggerResult AssetCompilerResult Implements ILogger IProgressStatus Inherited Members LoggerResult.ProgressChanged LoggerResult.Module LoggerResult.Clear() LoggerResult.IsLoggingProgressAsInfo LoggerResult.Progress(string) LoggerResult.Progress(string, int, int) LoggerResult.Messages LoggerResult.LogRaw(ILogMessage) LoggerResult.CopyTo(ILogger) LoggerResult.ToText() Logger.EnableTypes Logger.MessageLogged Logger.MinimumLevelEnabled Logger.IsDebugEnabled Logger.IsVerboseEnabled Logger.HasErrors Logger.ActivateLog(LogMessageType, LogMessageType, bool) Logger.ActivateLog(LogMessageType, bool) Logger.Activated(LogMessageType) Logger.Log(ILogMessage) Logger.Verbose(string, Exception, CallerInfo) Logger.Verbose(string, CallerInfo) Logger.Debug(string, Exception, CallerInfo) Logger.Debug(string, CallerInfo) Logger.Info(string, Exception, CallerInfo) Logger.Info(string, CallerInfo) Logger.Warning(string, Exception, CallerInfo) Logger.Warning(string, CallerInfo) Logger.Error(string, Exception, CallerInfo) Logger.Error(string, CallerInfo) Logger.Fatal(string, Exception, CallerInfo) Logger.Fatal(string, CallerInfo) Extension Methods AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, IReference[], Exception?) AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, Exception?) AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, Exception?, params object?[]) AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, params object?[]) AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, Exception, params object?[]) AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, params object?[]) AssetLoggerExtensions.Warning(ILogger, Package?, IReference?, AssetMessageCode) AssetLoggerExtensions.Warning(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?) AssetLoggerExtensions.Warning(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, params object?[]) AssetLoggerExtensions.Warning(ILogger, Package?, IReference?, AssetMessageCode, params object?[]) UnsafeUtilities.As<T>(object?) Constructors AssetCompilerResult(string?) Initializes a new instance of the LoggerResult class. public AssetCompilerResult(string? moduleName = null) Parameters moduleName string Name of the module. Properties BuildSteps Gets or sets the build steps generated for the build engine. This can be null if HasErrors is true. public ListBuildStep BuildSteps { get; set; } Property Value ListBuildStep The build step."
  },
  "api/Stride.Core.Assets.Compiler.AssetDependenciesCompiler.html": {
    "href": "api/Stride.Core.Assets.Compiler.AssetDependenciesCompiler.html",
    "title": "Class AssetDependenciesCompiler | Stride API",
    "summary": "Class AssetDependenciesCompiler Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll An asset compiler that will compile an asset with all its dependencies. public class AssetDependenciesCompiler Inheritance object AssetDependenciesCompiler Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetDependenciesCompiler(Type) public AssetDependenciesCompiler(Type compilationContext) Parameters compilationContext Type Fields BuildDependencyManager public readonly BuildDependencyManager BuildDependencyManager Field Value BuildDependencyManager Methods Prepare(AssetCompilerContext, AssetItem) Prepare a single asset to be built public AssetCompilerResult Prepare(AssetCompilerContext context, AssetItem assetItem) Parameters context AssetCompilerContext The AssetCompilerContext assetItem AssetItem The asset to build Returns AssetCompilerResult PrepareMany(AssetCompilerContext, List<AssetItem>) Prepare the list of assets to be built, building all the steps and linking them properly public AssetCompilerResult PrepareMany(AssetCompilerContext context, List<AssetItem> assetItems) Parameters context AssetCompilerContext The AssetCompilerContext assetItems List<AssetItem> The assets to prepare for build Returns AssetCompilerResult Events AssetCompiled Raised when a single asset has been compiled. public event EventHandler<AssetCompiledArgs>? AssetCompiled Event Type EventHandler<AssetCompiledArgs>"
  },
  "api/Stride.Core.Assets.Compiler.CompilerContext.html": {
    "href": "api/Stride.Core.Assets.Compiler.CompilerContext.html",
    "title": "Class CompilerContext | Stride API",
    "summary": "Class CompilerContext Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll The context used when compiling an asset in a Package. public class CompilerContext : IDisposable Inheritance object CompilerContext Implements IDisposable Derived AssetCompilerContext Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors CompilerContext() Initializes a new instance of the CompilerContext class. public CompilerContext() Properties OptionProperties Properties passed on the command line. public Dictionary<string, string> OptionProperties { get; } Property Value Dictionary<string, string> Properties Gets the attributes attached to this context. public PropertyCollection Properties { get; } Property Value PropertyCollection The attributes. Methods Clone() public CompilerContext Clone() Returns CompilerContext Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose()"
  },
  "api/Stride.Core.Assets.Compiler.DummyAssetCommand-2.html": {
    "href": "api/Stride.Core.Assets.Compiler.DummyAssetCommand-2.html",
    "title": "Class DummyAssetCommand<TAsset, TContent> | Stride API",
    "summary": "Class DummyAssetCommand<TAsset, TContent> Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll An AssetCommand that will create a default instance of the content type for a given asset, rather than compiling it. public class DummyAssetCommand<TAsset, TContent> : AssetCommand<TAsset> where TAsset : Asset where TContent : new() Type Parameters TAsset The type of asset for which to generate a default instance of content. TContent The type of content to generate. Inheritance object Command IndexFileCommand AssetCommand AssetCommand<TAsset> DummyAssetCommand<TAsset, TContent> Inherited Members AssetCommand<TAsset>.AssetFinder AssetCommand<TAsset>.Version AssetCommand<TAsset>.Parameters AssetCommand<TAsset>.Title AssetCommand<TAsset>.ComputeParameterHash(BinarySerializationWriter) AssetCommand<TAsset>.ToString() AssetCommand.Url IndexFileCommand.PreCommand(ICommandContext) IndexFileCommand.PostCommand(ICommandContext, ResultStatus) Command.CommandCacheVersion Command.OutputLocation Command.CancellationToken Command.DoCommand(ICommandContext) Command.Clone() Command.GetInputFiles() Command.InputFilesGetter Command.ShouldForceExecution() Command.ShouldSpawnNewProcess() Command.Cancel() Command.ComputeInputFilesHash(BinarySerializationWriter, IPrepareContext) Command.ComputeCommandHash(Stream, IPrepareContext) Command.ComputeAssemblyHash(BinarySerializationWriter) Extension Methods UnsafeUtilities.As<T>(object?) Constructors DummyAssetCommand(AssetItem) Initializes a new instance of the DummyAssetCommand<TAsset, TContent> class. public DummyAssetCommand(AssetItem assetItem) Parameters assetItem AssetItem The asset to compile. Methods DoCommandOverride(ICommandContext) The method to override containing the actual command code. It is called by the Stride.Core.BuildEngine.Command.DoCommand(Stride.Core.BuildEngine.ICommandContext) function protected override Task<ResultStatus> DoCommandOverride(ICommandContext commandContext) Parameters commandContext ICommandContext Returns Task<ResultStatus>"
  },
  "api/Stride.Core.Assets.Compiler.FailedCommand.html": {
    "href": "api/Stride.Core.Assets.Compiler.FailedCommand.html",
    "title": "Class FailedCommand | Stride API",
    "summary": "Class FailedCommand Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll public class FailedCommand : Command Inheritance object Command FailedCommand Inherited Members Command.CommandCacheVersion Command.OutputLocation Command.CancellationToken Command.DoCommand(ICommandContext) Command.PreCommand(ICommandContext) Command.PostCommand(ICommandContext, ResultStatus) Command.Clone() Command.GetInputFiles() Command.InputFilesGetter Command.ShouldForceExecution() Command.ShouldSpawnNewProcess() Command.Cancel() Command.ComputeInputFilesHash(BinarySerializationWriter, IPrepareContext) Command.ComputeCommandHash(Stream, IPrepareContext) Command.ComputeAssemblyHash(BinarySerializationWriter) Extension Methods UnsafeUtilities.As<T>(object?) Constructors FailedCommand(string) public FailedCommand(string objectThatFailed) Parameters objectThatFailed string Properties Title Title (short description) of the command public override string Title { get; } Property Value string Methods ComputeParameterHash(BinarySerializationWriter) protected override void ComputeParameterHash(BinarySerializationWriter writer) Parameters writer BinarySerializationWriter DoCommandOverride(ICommandContext) The method to override containing the actual command code. It is called by the Stride.Core.BuildEngine.Command.DoCommand(Stride.Core.BuildEngine.ICommandContext) function protected override Task<ResultStatus> DoCommandOverride(ICommandContext commandContext) Parameters commandContext ICommandContext Returns Task<ResultStatus> ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.Compiler.IAssetCompiler.html": {
    "href": "api/Stride.Core.Assets.Compiler.IAssetCompiler.html",
    "title": "Interface IAssetCompiler | Stride API",
    "summary": "Interface IAssetCompiler Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll Main interface for compiling an Asset. public interface IAssetCompiler Extension Methods UnsafeUtilities.As<T>(object?) Properties AlwaysCheckRuntimeTypes bool AlwaysCheckRuntimeTypes { get; } Property Value bool Methods GetInputFiles(AssetItem) Enumerates all the dependencies required to compile this asset IEnumerable<ObjectUrl> GetInputFiles(AssetItem assetItem) Parameters assetItem AssetItem The asset for which dependencies are enumerated Returns IEnumerable<ObjectUrl> The dependencies GetInputTypes(AssetItem) Enumerates all the asset types required to compile this asset IEnumerable<BuildDependencyInfo> GetInputTypes(AssetItem assetItem) Parameters assetItem AssetItem The asset for which types are enumerated Returns IEnumerable<BuildDependencyInfo> The dependencies GetInputTypesToExclude(AssetItem) Enumerates all the asset types to exclude when compiling this asset IEnumerable<Type> GetInputTypesToExclude(AssetItem assetItem) Parameters assetItem AssetItem The asset for which types are enumerated Returns IEnumerable<Type> The types to exclude Remarks This method takes higher priority, it will exclude assets included with inclusion methods even in the same compiler GetRuntimeTypes(AssetItem) IEnumerable<Type> GetRuntimeTypes(AssetItem assetItem) Parameters assetItem AssetItem Returns IEnumerable<Type> Prepare(AssetCompilerContext, AssetItem) Compiles a list of assets from the specified package. AssetCompilerResult Prepare(AssetCompilerContext context, AssetItem assetItem) Parameters context AssetCompilerContext assetItem AssetItem The asset reference. Returns AssetCompilerResult The result of the compilation."
  },
  "api/Stride.Core.Assets.Compiler.ICompilationContext.html": {
    "href": "api/Stride.Core.Assets.Compiler.ICompilationContext.html",
    "title": "Interface ICompilationContext | Stride API",
    "summary": "Interface ICompilationContext Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll public interface ICompilationContext Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Assets.Compiler.IPackageCompiler.html": {
    "href": "api/Stride.Core.Assets.Compiler.IPackageCompiler.html",
    "title": "Interface IPackageCompiler | Stride API",
    "summary": "Interface IPackageCompiler Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll Interface for compiling a package. public interface IPackageCompiler Extension Methods UnsafeUtilities.As<T>(object?) Methods Prepare(AssetCompilerContext) Prepares a package with the specified compiler context. AssetCompilerResult Prepare(AssetCompilerContext compilerContext) Parameters compilerContext AssetCompilerContext The compiler context. Returns AssetCompilerResult Result of compilation."
  },
  "api/Stride.Core.Assets.Compiler.IPackageCompilerSource.html": {
    "href": "api/Stride.Core.Assets.Compiler.IPackageCompilerSource.html",
    "title": "Interface IPackageCompilerSource | Stride API",
    "summary": "Interface IPackageCompilerSource Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll Enumerate assets that PackageCompiler will process. public interface IPackageCompilerSource Extension Methods UnsafeUtilities.As<T>(object?) Methods GetAssets(AssetCompilerResult) Enumerates assets. IEnumerable<AssetItem> GetAssets(AssetCompilerResult assetCompilerResult) Parameters assetCompilerResult AssetCompilerResult Returns IEnumerable<AssetItem>"
  },
  "api/Stride.Core.Assets.Compiler.ImportStreamCommand.html": {
    "href": "api/Stride.Core.Assets.Compiler.ImportStreamCommand.html",
    "title": "Class ImportStreamCommand | Stride API",
    "summary": "Class ImportStreamCommand Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll public sealed class ImportStreamCommand : SingleFileImportCommand Inheritance object Command IndexFileCommand SingleFileImportCommand ImportStreamCommand Inherited Members SingleFileImportCommand.SourcePath SingleFileImportCommand.Location SingleFileImportCommand.GetInputFiles() IndexFileCommand.PreCommand(ICommandContext) IndexFileCommand.PostCommand(ICommandContext, ResultStatus) Command.OutputLocation Command.CancellationToken Command.DoCommand(ICommandContext) Command.Clone() Command.InputFilesGetter Command.ShouldForceExecution() Command.ShouldSpawnNewProcess() Command.Cancel() Command.ComputeCommandHash(Stream, IPrepareContext) Extension Methods UnsafeUtilities.As<T>(object?) Constructors ImportStreamCommand() public ImportStreamCommand() ImportStreamCommand(UFile, UFile) public ImportStreamCommand(UFile location, UFile sourcePath) Parameters location UFile sourcePath UFile Properties DisableCompression public bool DisableCompression { get; set; } Property Value bool SaveSourcePath public bool SaveSourcePath { get; set; } Property Value bool Title Title (short description) of the command public override string Title { get; } Property Value string Methods DoCommandOverride(ICommandContext) The method to override containing the actual command code. It is called by the Stride.Core.BuildEngine.Command.DoCommand(Stride.Core.BuildEngine.ICommandContext) function protected override Task<ResultStatus> DoCommandOverride(ICommandContext commandContext) Parameters commandContext ICommandContext Returns Task<ResultStatus> ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.Compiler.ItemListCompiler.html": {
    "href": "api/Stride.Core.Assets.Compiler.ItemListCompiler.html",
    "title": "Class ItemListCompiler | Stride API",
    "summary": "Class ItemListCompiler Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll The base class to compile a series of AssetItems using associated IAssetCompilers. An item list compiler only creates the build steps required to creates some output items. The result of a compilation has then to be executed by the build engine to effectively create the outputs items. public abstract class ItemListCompiler Inheritance object ItemListCompiler Extension Methods UnsafeUtilities.As<T>(object?) Constructors ItemListCompiler(AssetCompilerRegistry, Type) Create an instance of ItemListCompiler using the provided compiler registry. protected ItemListCompiler(AssetCompilerRegistry compilerRegistry, Type compilationContext) Parameters compilerRegistry AssetCompilerRegistry The registry that contains the compiler to use for each asset type compilationContext Type The context in which this list will compile the assets (Asset, Preview, thumbnail etc) Methods CompileItem(AssetCompilerContext, AssetCompilerResult, AssetItem) Compile the required build step necessary to produce the desired output item. public ListBuildStep? CompileItem(AssetCompilerContext context, AssetCompilerResult compilationResult, AssetItem assetItem) Parameters context AssetCompilerContext The context. compilationResult AssetCompilerResult The compilation result. assetItem AssetItem The asset item. Returns ListBuildStep Prepare(AssetCompilerContext, IEnumerable<AssetItem>, AssetCompilerResult) Compile the required build steps necessary to produce the desired outputs items. protected void Prepare(AssetCompilerContext context, IEnumerable<AssetItem> assetItems, AssetCompilerResult compilationResult) Parameters context AssetCompilerContext The context source. assetItems IEnumerable<AssetItem> The list of items to compile compilationResult AssetCompilerResult The current compilation result, containing the build steps and the logging Events AssetCompiled Raised when a single asset has been compiled. public event EventHandler<AssetCompiledArgs>? AssetCompiled Event Type EventHandler<AssetCompiledArgs>"
  },
  "api/Stride.Core.Assets.Compiler.PackageAssetEnumerator.html": {
    "href": "api/Stride.Core.Assets.Compiler.PackageAssetEnumerator.html",
    "title": "Class PackageAssetEnumerator | Stride API",
    "summary": "Class PackageAssetEnumerator Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll Enumerate all assets of this package and its references. public class PackageAssetEnumerator : IPackageCompilerSource Inheritance object PackageAssetEnumerator Implements IPackageCompilerSource Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageAssetEnumerator(Package) public PackageAssetEnumerator(Package package) Parameters package Package Methods GetAssets(AssetCompilerResult) Enumerates assets. public IEnumerable<AssetItem> GetAssets(AssetCompilerResult assetCompilerResult) Parameters assetCompilerResult AssetCompilerResult Returns IEnumerable<AssetItem>"
  },
  "api/Stride.Core.Assets.Compiler.PackageCompiler.html": {
    "href": "api/Stride.Core.Assets.Compiler.PackageCompiler.html",
    "title": "Class PackageCompiler | Stride API",
    "summary": "Class PackageCompiler Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll A package assets compiler. Creates the build steps necessary to produce the assets of a package. public class PackageCompiler : IPackageCompiler Inheritance object PackageCompiler Implements IPackageCompiler Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageCompiler(IPackageCompilerSource) public PackageCompiler(IPackageCompilerSource packageCompilerSource) Parameters packageCompilerSource IPackageCompilerSource Properties SdkDirectory Gets or sets the SDK directory. Default is bound to env variable StrideSdkDir public static string SdkDirectory { get; set; } Property Value string The SDK directory. Methods Prepare(AssetCompilerContext) Compile the current package session. That is generate the list of build steps to execute to create the package assets. public AssetCompilerResult Prepare(AssetCompilerContext compilerContext) Parameters compilerContext AssetCompilerContext Returns AssetCompilerResult Events AssetCompiled Raised when a single asset has been compiled. public event EventHandler<AssetCompiledArgs>? AssetCompiled Event Type EventHandler<AssetCompiledArgs>"
  },
  "api/Stride.Core.Assets.Compiler.RootPackageAssetEnumerator.html": {
    "href": "api/Stride.Core.Assets.Compiler.RootPackageAssetEnumerator.html",
    "title": "Class RootPackageAssetEnumerator | Stride API",
    "summary": "Class RootPackageAssetEnumerator Namespace Stride.Core.Assets.Compiler Assembly Stride.Core.Assets.dll Only enumerates assets that are marked as roots and their dependencies. public class RootPackageAssetEnumerator : IPackageCompilerSource Inheritance object RootPackageAssetEnumerator Implements IPackageCompilerSource Extension Methods UnsafeUtilities.As<T>(object?) Constructors RootPackageAssetEnumerator(Package) Initializes a new instance. public RootPackageAssetEnumerator(Package package) Parameters package Package The start package. Methods GetAssets(AssetCompilerResult) Enumerates assets. public IEnumerable<AssetItem> GetAssets(AssetCompilerResult assetCompilerResult) Parameters assetCompilerResult AssetCompilerResult Returns IEnumerable<AssetItem>"
  },
  "api/Stride.Core.Assets.Compiler.html": {
    "href": "api/Stride.Core.Assets.Compiler.html",
    "title": "Namespace Stride.Core.Assets.Compiler | Stride API",
    "summary": "Namespace Stride.Core.Assets.Compiler Classes AssetBuildStep Represents a list of Stride.Core.BuildEngine.BuildStep instances that compiles a given asset. AssetCommand A command processing an Asset. AssetCommand<T> AssetCompilationContext AssetCompiledArgs The class represents the argument of the AssetCompiled event raised by the ItemListCompiler class. AssetCompilerAttribute Attribute to define an asset compiler for a Asset. AssetCompilerBase Base implementation for IAssetCompiler suitable to compile a single type of Asset. AssetCompilerContext The context used when compiling an asset in a Package. AssetCompilerRegistry A registry containing the asset compilers of the assets. AssetCompilerResult Result of a compilation of assets when using Prepare(AssetCompilerContext, AssetItem) AssetDependenciesCompiler An asset compiler that will compile an asset with all its dependencies. CompilerContext The context used when compiling an asset in a Package. DummyAssetCommand<TAsset, TContent> An AssetCommand that will create a default instance of the content type for a given asset, rather than compiling it. FailedCommand ImportStreamCommand ItemListCompiler The base class to compile a series of AssetItems using associated IAssetCompilers. An item list compiler only creates the build steps required to creates some output items. The result of a compilation has then to be executed by the build engine to effectively create the outputs items. PackageAssetEnumerator Enumerate all assets of this package and its references. PackageCompiler A package assets compiler. Creates the build steps necessary to produce the assets of a package. RootPackageAssetEnumerator Only enumerates assets that are marked as roots and their dependencies. Interfaces IAssetCompiler Main interface for compiling an Asset. ICompilationContext IPackageCompiler Interface for compiling a package. IPackageCompilerSource Enumerate assets that PackageCompiler will process."
  },
  "api/Stride.Core.Assets.DefaultAssetFactory-1.html": {
    "href": "api/Stride.Core.Assets.DefaultAssetFactory-1.html",
    "title": "Class DefaultAssetFactory<T> | Stride API",
    "summary": "Class DefaultAssetFactory<T> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An implementation of the AssetFactory<T> class that uses the default public parameterless constructor of the associated asset type. public class DefaultAssetFactory<T> : AssetFactory<T>, IAssetFactory<T> where T : Asset Type Parameters T The type of asset this factory can create. Inheritance object AssetFactory<T> DefaultAssetFactory<T> Implements IAssetFactory<T> Inherited Members AssetFactory<T>.AssetType Extension Methods UnsafeUtilities.As<T>(object?) Methods Create() public static T Create() Returns T New() Creates a new instance of the asset type associated to this factory. public override T New() Returns T A new instance of the asset type associated to this factory."
  },
  "api/Stride.Core.Assets.Dependency.html": {
    "href": "api/Stride.Core.Assets.Dependency.html",
    "title": "Class Dependency | Stride API",
    "summary": "Class Dependency Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class Dependency Inheritance object Dependency Extension Methods UnsafeUtilities.As<T>(object?) Constructors Dependency(Package) public Dependency(Package package) Parameters package Package Dependency(string, PackageVersion, DependencyType) public Dependency(string name, PackageVersion version, DependencyType type) Parameters name string version PackageVersion type DependencyType Properties Assemblies public List<string> Assemblies { get; } Property Value List<string> MSBuildProject public string MSBuildProject { get; set; } Property Value string Name public string Name { get; set; } Property Value string Package public Package Package { get; set; } Property Value Package Type public DependencyType Type { get; set; } Property Value DependencyType Version public PackageVersion Version { get; set; } Property Value PackageVersion Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.DependencyRange.html": {
    "href": "api/Stride.Core.Assets.DependencyRange.html",
    "title": "Class DependencyRange | Stride API",
    "summary": "Class DependencyRange Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class DependencyRange Inheritance object DependencyRange Extension Methods UnsafeUtilities.As<T>(object?) Constructors DependencyRange(string, PackageVersionRange, DependencyType) public DependencyRange(string name, PackageVersionRange versionRange, DependencyType type) Parameters name string versionRange PackageVersionRange type DependencyType Properties MSBuildProject public string MSBuildProject { get; set; } Property Value string Name public string Name { get; set; } Property Value string Type public DependencyType Type { get; set; } Property Value DependencyType VersionRange public PackageVersionRange VersionRange { get; set; } Property Value PackageVersionRange"
  },
  "api/Stride.Core.Assets.DependencyType.html": {
    "href": "api/Stride.Core.Assets.DependencyType.html",
    "title": "Enum DependencyType | Stride API",
    "summary": "Enum DependencyType Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public enum DependencyType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Package = 0 Project = 1"
  },
  "api/Stride.Core.Assets.Diagnostics.AssetLogMessage.html": {
    "href": "api/Stride.Core.Assets.Diagnostics.AssetLogMessage.html",
    "title": "Class AssetLogMessage | Stride API",
    "summary": "Class AssetLogMessage Namespace Stride.Core.Assets.Diagnostics Assembly Stride.Core.Assets.dll Provides a specialized LogMessage to give specific information about an asset. public class AssetLogMessage : LogMessage, ILogMessage Inheritance object LogMessage AssetLogMessage Implements ILogMessage Inherited Members LogMessage.Module LogMessage.Type LogMessage.Text LogMessage.Exception LogMessage.CallerInfo LogMessage.ExceptionInfo Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetLogMessage(Package?, IReference?, LogMessageType, AssetMessageCode) Initializes a new instance of the AssetLogMessage class. public AssetLogMessage(Package? package, IReference? assetReference, LogMessageType type, AssetMessageCode messageCode) Parameters package Package The package. assetReference IReference The asset reference. type LogMessageType The type. messageCode AssetMessageCode The message code. Exceptions ArgumentNullException asset AssetLogMessage(Package?, IReference?, LogMessageType, AssetMessageCode, params object?[]) Initializes a new instance of the AssetLogMessage class. public AssetLogMessage(Package? package, IReference? assetReference, LogMessageType type, AssetMessageCode messageCode, params object?[] arguments) Parameters package Package The package. assetReference IReference The asset reference. type LogMessageType The type. messageCode AssetMessageCode The message code. arguments object[] The arguments. Exceptions ArgumentNullException asset AssetLogMessage(Package?, IReference?, LogMessageType, string) Initializes a new instance of the AssetLogMessage class. public AssetLogMessage(Package? package, IReference? assetReference, LogMessageType type, string text) Parameters package Package The package. assetReference IReference The asset reference. type LogMessageType The type. text string Exceptions ArgumentNullException asset Properties AssetReference Gets or sets the asset this message applies to (optional). public IReference? AssetReference { get; set; } Property Value IReference The asset. Character public int Character { get; set; } Property Value int File public string File { get; set; } Property Value string Line public int Line { get; set; } Property Value int Member Gets or sets the member of the asset this message applies to. May be null. public IMemberDescriptor Member { get; set; } Property Value IMemberDescriptor The member. MessageCode Gets or sets the message code. public AssetMessageCode MessageCode { get; set; } Property Value AssetMessageCode The message code. Package Gets or sets the package. public Package? Package { get; } Property Value Package The package. Related Gets or sets the related references. public List<IReference> Related { get; } Property Value List<IReference> The related. Methods From(Package?, IReference?, ILogMessage, string, int, int) public static AssetLogMessage From(Package? package, IReference? assetReference, ILogMessage logMessage, string assetPath, int line = 0, int character = 0) Parameters package Package assetReference IReference logMessage ILogMessage assetPath string line int character int Returns AssetLogMessage ToString() Returns a string that represents this instance. public override string ToString() Returns string A string that represents this instance."
  },
  "api/Stride.Core.Assets.Diagnostics.AssetLoggerExtensions.html": {
    "href": "api/Stride.Core.Assets.Diagnostics.AssetLoggerExtensions.html",
    "title": "Class AssetLoggerExtensions | Stride API",
    "summary": "Class AssetLoggerExtensions Namespace Stride.Core.Assets.Diagnostics Assembly Stride.Core.Assets.dll Extension to Logger for loggin specific error with assets. public static class AssetLoggerExtensions Inheritance object AssetLoggerExtensions Methods Error(ILogger, Package?, IReference?, AssetMessageCode, IReference[], Exception?) public static void Error(this ILogger logger, Package? package, IReference? assetReference, AssetMessageCode code, IReference[] relatedGuids, Exception? exception = null) Parameters logger ILogger package Package assetReference IReference code AssetMessageCode relatedGuids IReference[] exception Exception Error(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, Exception?) public static void Error(this ILogger logger, Package? package, IReference? assetReference, AssetMessageCode code, IEnumerable<IReference>? relatedGuids, Exception? exception = null) Parameters logger ILogger package Package assetReference IReference code AssetMessageCode relatedGuids IEnumerable<IReference> exception Exception Error(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, Exception?, params object?[]) public static void Error(this ILogger logger, Package? package, IReference? assetReference, AssetMessageCode code, IEnumerable<IReference>? relatedGuids, Exception? exception, params object?[] arguments) Parameters logger ILogger package Package assetReference IReference code AssetMessageCode relatedGuids IEnumerable<IReference> exception Exception arguments object[] Error(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, params object?[]) public static void Error(this ILogger logger, Package? package, IReference? assetReference, AssetMessageCode code, IEnumerable<IReference>? relatedGuids, params object?[] arguments) Parameters logger ILogger package Package assetReference IReference code AssetMessageCode relatedGuids IEnumerable<IReference> arguments object[] Error(ILogger, Package?, IReference?, AssetMessageCode, Exception, params object?[]) public static void Error(this ILogger logger, Package? package, IReference? assetReference, AssetMessageCode code, Exception exception, params object?[] arguments) Parameters logger ILogger package Package assetReference IReference code AssetMessageCode exception Exception arguments object[] Error(ILogger, Package?, IReference?, AssetMessageCode, params object?[]) public static void Error(this ILogger logger, Package? package, IReference? assetReference, AssetMessageCode code, params object?[] arguments) Parameters logger ILogger package Package assetReference IReference code AssetMessageCode arguments object[] Warning(ILogger, Package?, IReference?, AssetMessageCode) public static void Warning(this ILogger logger, Package? package, IReference? assetReference, AssetMessageCode code) Parameters logger ILogger package Package assetReference IReference code AssetMessageCode Warning(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?) public static void Warning(this ILogger logger, Package? package, IReference? assetReference, AssetMessageCode code, IEnumerable<IReference>? relatedGuids) Parameters logger ILogger package Package assetReference IReference code AssetMessageCode relatedGuids IEnumerable<IReference> Warning(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, params object?[]) public static void Warning(this ILogger logger, Package? package, IReference? assetReference, AssetMessageCode code, IEnumerable<IReference>? relatedGuids, params object?[] arguments) Parameters logger ILogger package Package assetReference IReference code AssetMessageCode relatedGuids IEnumerable<IReference> arguments object[] Warning(ILogger, Package?, IReference?, AssetMessageCode, params object?[]) public static void Warning(this ILogger logger, Package? package, IReference? assetReference, AssetMessageCode code, params object?[] arguments) Parameters logger ILogger package Package assetReference IReference code AssetMessageCode arguments object[]"
  },
  "api/Stride.Core.Assets.Diagnostics.AssetMessageCode.html": {
    "href": "api/Stride.Core.Assets.Diagnostics.AssetMessageCode.html",
    "title": "Enum AssetMessageCode | Stride API",
    "summary": "Enum AssetMessageCode Namespace Stride.Core.Assets.Diagnostics Assembly Stride.Core.Assets.dll A message code used by AssetLogMessage to identify an error/warning. public enum AssetMessageCode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AssetCannotDelete = 5 The asset cannot be deleted AssetCannotSave = 6 The asset cannot be saved AssetForPackageNotFound = 1 The asset required for the current package was not found AssetFoundInDifferentPackage = 2 The asset required for the current package was found in a different package AssetLoadingFailed = 4 The asset loading failed AssetReferenceChanged = 3 The asset reference has been changed for a particular location AssetUpToDate = 21 The asset has not been compiled because it is already up-to-date. BaseChanged = 16 The base was changed BaseInvalidType = 17 The base is not the same type as the current asset. BaseNotFound = 15 The base not found BuildProfileCannotBeNull = 12 The package build profile cannot be null BuildProfileFileExtensionCannotBeNull = 13 The package build profile should not have a File extension null CompilationCancelled = 20 The asset compilation has been cancelled. CompilationError = 26 An error that caused the asset compilation to fail. CompilationFailed = 19 The asset compilation failed. CompilationFatal = 24 A fatal error that caused the asset compilation to fail. CompilationMessage = 25 A message log happened inside the asset compiler. CompilationSucceeded = 18 The asset has been successfully compiled. CompilationWarning = 27 A warning that occurred in the asset compilation. DefaultSceneNotFound = 28 A default scene was not found in the package. InternalCompilerError = 23 An unexpected internal error occurred. InvalidBasePartInstance = 29 Occurs when a asset templating instance is duplicated. InvalidCircularReferences = 14 Asset contains invalid circular references PackageCannotSave = 10 The package cannot be saved PackageDependencyModified = 11 The package dependency is modified PackageFilePathNotSet = 8 The package filepath is not set for saving PackageLocationChanged = 9 The package not found PackageNotFound = 7 The package not found PrerequisiteFailed = 22 The asset has not been compiled because its prerequisites failed to compile. RawAssetNotFound = 0 A raw asset was not found"
  },
  "api/Stride.Core.Assets.Diagnostics.AssetSerializableLogMessage.html": {
    "href": "api/Stride.Core.Assets.Diagnostics.AssetSerializableLogMessage.html",
    "title": "Class AssetSerializableLogMessage | Stride API",
    "summary": "Class AssetSerializableLogMessage Namespace Stride.Core.Assets.Diagnostics Assembly Stride.Core.Assets.dll [DataContract] public class AssetSerializableLogMessage : SerializableLogMessage, ILogMessage Inheritance object SerializableLogMessage AssetSerializableLogMessage Implements ILogMessage Inherited Members SerializableLogMessage.Module SerializableLogMessage.Type SerializableLogMessage.Text SerializableLogMessage.ExceptionInfo Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetSerializableLogMessage() public AssetSerializableLogMessage() AssetSerializableLogMessage(AssetId, UFile, LogMessageType, string, ExceptionInfo) public AssetSerializableLogMessage(AssetId assetId, UFile assetUrl, LogMessageType type, string text, ExceptionInfo exceptionInfo = null) Parameters assetId AssetId assetUrl UFile type LogMessageType text string exceptionInfo ExceptionInfo AssetSerializableLogMessage(AssetLogMessage) public AssetSerializableLogMessage(AssetLogMessage logMessage) Parameters logMessage AssetLogMessage Properties AssetId public AssetId AssetId { get; set; } Property Value AssetId AssetUrl public UFile AssetUrl { get; set; } Property Value UFile Character public int Character { get; set; } Property Value int File public string File { get; set; } Property Value string Line public int Line { get; set; } Property Value int Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.Diagnostics.html": {
    "href": "api/Stride.Core.Assets.Diagnostics.html",
    "title": "Namespace Stride.Core.Assets.Diagnostics | Stride API",
    "summary": "Namespace Stride.Core.Assets.Diagnostics Classes AssetLogMessage Provides a specialized LogMessage to give specific information about an asset. AssetLoggerExtensions Extension to Logger for loggin specific error with assets. AssetSerializableLogMessage Enums AssetMessageCode A message code used by AssetLogMessage to identify an error/warning."
  },
  "api/Stride.Core.Assets.DirectoryHelper.html": {
    "href": "api/Stride.Core.Assets.DirectoryHelper.html",
    "title": "Class DirectoryHelper | Stride API",
    "summary": "Class DirectoryHelper Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Helper class that contains methods to retrieve and manipulate SDK locations. public static class DirectoryHelper Inheritance object DirectoryHelper Methods GetPackageFile(string, string) Gets the path to the file corresponding to the given package name in the given directory. public static string GetPackageFile(string directory, string packageName) Parameters directory string The directory where the package file is located. packageName string The name of the package. Returns string The path to the file corresponding to the given package name in the given directory. IsRootDevDirectory(string) Indicates whether the given directory is the root directory of the repository, when executing from a development build. public static bool IsRootDevDirectory(string directory) Parameters directory string The directory to check. Returns bool True if the given directory is the root directory of the repository, false otherwise."
  },
  "api/Stride.Core.Assets.DirtyFlagChangedDelegate-1.html": {
    "href": "api/Stride.Core.Assets.DirtyFlagChangedDelegate-1.html",
    "title": "Delegate DirtyFlagChangedDelegate<T> | Stride API",
    "summary": "Delegate DirtyFlagChangedDelegate<T> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A delegate used for events raised when the dirty flag of an object has changed public delegate void DirtyFlagChangedDelegate<in T>(T sender, bool oldValue, bool newValue) Parameters sender T The object that had its dirty flag changed. oldValue bool The old value of the dirty flag. newValue bool The new value of the dirty flag. Type Parameters T Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Assets.EmptyAssetUpgrader.html": {
    "href": "api/Stride.Core.Assets.EmptyAssetUpgrader.html",
    "title": "Class EmptyAssetUpgrader | Stride API",
    "summary": "Class EmptyAssetUpgrader Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Empty asset upgrader (useful when we want to bump version without changing anything). public class EmptyAssetUpgrader : AssetUpgraderBase, IAssetUpgrader Inheritance object AssetUpgraderBase EmptyAssetUpgrader Implements IAssetUpgrader Inherited Members AssetUpgraderBase.Upgrade(AssetMigrationContext, string, PackageVersion, PackageVersion, YamlMappingNode, PackageLoadingAssetFile) AssetUpgraderBase.SetSerializableVersion(dynamic, string, PackageVersion) Extension Methods UnsafeUtilities.As<T>(object?) Methods UpgradeAsset(AssetMigrationContext, PackageVersion, PackageVersion, dynamic, PackageLoadingAssetFile, OverrideUpgraderHint) protected override void UpgradeAsset(AssetMigrationContext context, PackageVersion currentVersion, PackageVersion targetVersion, dynamic asset, PackageLoadingAssetFile assetFile, OverrideUpgraderHint overrideHint) Parameters context AssetMigrationContext currentVersion PackageVersion targetVersion PackageVersion asset dynamic assetFile PackageLoadingAssetFile overrideHint OverrideUpgraderHint"
  },
  "api/Stride.Core.Assets.FileUtility.html": {
    "href": "api/Stride.Core.Assets.FileUtility.html",
    "title": "Class FileUtility | Stride API",
    "summary": "Class FileUtility Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll File Utilities methods. public class FileUtility Inheritance object FileUtility Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateDirectories(string, SearchDirection) public static IEnumerable<DirectoryInfo> EnumerateDirectories(string rootDirectory, SearchDirection direction) Parameters rootDirectory string direction SearchDirection Returns IEnumerable<DirectoryInfo> GetAbsolutePath(string) Converts a relative path to an absolute path using the current working directoy. public static string? GetAbsolutePath(string filePath) Parameters filePath string The file path. Returns string An absolute path. GetFileExtensions(string) Gets the file extensions normalized separated by ',' ';'. public static string[] GetFileExtensions(string fileExtensions) Parameters fileExtensions string The file extensions separated by ',' ';'. Returns string[] An array of file extensions. GetFileExtensionsAsSet(string) Gets the file extensions normalized separated by ',' ';'. public static HashSet<string> GetFileExtensionsAsSet(string fileExtensions) Parameters fileExtensions string The file extensions separated by ',' ';'. Returns HashSet<string> An array of file extensions. IsFileLocked(FileInfo) Determines whether the specified file is locked. public static bool IsFileLocked(FileInfo file) Parameters file FileInfo The file. Returns bool true if the specified file is locked; otherwise, false. Exceptions ArgumentNullException file is null IsFileLocked(string) Determines whether the specified file is locked. public static bool IsFileLocked(string filePath) Parameters filePath string The file path. Returns bool true if the specified file is locked; otherwise, false. Exceptions ArgumentNullException filePath is null NormalizeFileExtension(string) Normalizes the file extension by adding a '.' prefix and making it lowercase. public static string NormalizeFileExtension(string fileExtension) Parameters fileExtension string The file extension. Returns string A normalized file extension."
  },
  "api/Stride.Core.Assets.FileVersionManager.html": {
    "href": "api/Stride.Core.Assets.FileVersionManager.html",
    "title": "Class FileVersionManager | Stride API",
    "summary": "Class FileVersionManager Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class FileVersionManager Inheritance object FileVersionManager Extension Methods UnsafeUtilities.As<T>(object?) Properties Instance public static FileVersionManager Instance { get; } Property Value FileVersionManager PeekAsyncRequestsLeft Returns the amount of items scheduled left to process public long PeekAsyncRequestsLeft { get; } Property Value long Remarks It may already be out of date as soon as it returns. Do not rely on this to check for completion, use the callbacks instead. Methods ComputeFileHash(UFile) public ObjectId ComputeFileHash(UFile path) Parameters path UFile Returns ObjectId ComputeFileHashAsync(UFile, Action<UFile, ObjectId>?, CancellationToken?) public void ComputeFileHashAsync(UFile path, Action<UFile, ObjectId>? fileHashCallback = null, CancellationToken? cancellationToken = null) Parameters path UFile fileHashCallback Action<UFile, ObjectId> cancellationToken CancellationToken? ComputeFileHashAsync(IEnumerable<UFile>, Action<UFile, ObjectId>?, CancellationToken?) public void ComputeFileHashAsync(IEnumerable<UFile> paths, Action<UFile, ObjectId>? fileHashCallback = null, CancellationToken? cancellationToken = null) Parameters paths IEnumerable<UFile> fileHashCallback Action<UFile, ObjectId> cancellationToken CancellationToken? Shutdown() public static void Shutdown()"
  },
  "api/Stride.Core.Assets.IAssetComposite.html": {
    "href": "api/Stride.Core.Assets.IAssetComposite.html",
    "title": "Interface IAssetComposite | Stride API",
    "summary": "Interface IAssetComposite Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An interface that defines the composition declared by an asset inheriting from another asset. public interface IAssetComposite Extension Methods UnsafeUtilities.As<T>(object?) Methods CollectParts() Collects the part assets. IEnumerable<AssetPart> CollectParts() Returns IEnumerable<AssetPart> ContainsPart(Guid) Checks if this AssetPart container contains the part with the specified id. bool ContainsPart(Guid id) Parameters id Guid Unique identifier of the asset part Returns bool true if this asset contains the part with the specified id; otherwise false"
  },
  "api/Stride.Core.Assets.IAssetFactory-1.html": {
    "href": "api/Stride.Core.Assets.IAssetFactory-1.html",
    "title": "Interface IAssetFactory<T> | Stride API",
    "summary": "Interface IAssetFactory<T> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An interface that represents an asset factory. public interface IAssetFactory<out T> where T : Asset Type Parameters T The type of asset this factory can create. Extension Methods UnsafeUtilities.As<T>(object?) Properties AssetType Retrieve the asset type associated to this factory. Type AssetType { get; } Property Value Type The asset type associated to this factory. Methods New() Creates a new instance of the asset type associated to this factory. T New() Returns T A new instance of the asset type associated to this factory."
  },
  "api/Stride.Core.Assets.IAssetFinder.html": {
    "href": "api/Stride.Core.Assets.IAssetFinder.html",
    "title": "Interface IAssetFinder | Stride API",
    "summary": "Interface IAssetFinder Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public interface IAssetFinder Extension Methods UnsafeUtilities.As<T>(object?) Methods FindAsset(AssetId) Finds an asset by its identifier. AssetItem? FindAsset(AssetId assetId) Parameters assetId AssetId The identifier of the asset. Returns AssetItem The corresponding AssetItem if found; otherwise, null. FindAsset(UFile) Finds an asset by its location. AssetItem? FindAsset(UFile location) Parameters location UFile The location of the asset. Returns AssetItem The corresponding AssetItem if found; otherwise, null. FindAssetFromProxyObject(object?) Finds an asset from a proxy object. AssetItem? FindAssetFromProxyObject(object? proxyObject) Parameters proxyObject object The proxy object which is represent the targeted asset. Returns AssetItem The corresponding AssetItem if found; otherwise, null."
  },
  "api/Stride.Core.Assets.IAssetImporter.html": {
    "href": "api/Stride.Core.Assets.IAssetImporter.html",
    "title": "Interface IAssetImporter | Stride API",
    "summary": "Interface IAssetImporter Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Imports a raw asset into the asset system. public interface IAssetImporter Extension Methods UnsafeUtilities.As<T>(object?) Properties AdditionalAssetTypes Gets the additional types of asset that can be generated by this importer in complement of the root assets IEnumerable<Type> AdditionalAssetTypes { get; } Property Value IEnumerable<Type> Description Gets the description of this importer. string Description { get; } Property Value string The description. Id Gets an unique identifier to identify the importer. See remarks. Guid Id { get; } Property Value Guid The identifier. Remarks This identifier is used to recover the importer used for a particular asset. This Guid must be unique and stored statically in the definition of an importer. It is used to reimport an existing asset with the same importer. Name Gets the name of this importer. string Name { get; } Property Value string The name. Order Gets the order of precedence between the importers, so that an importer can override another one. int Order { get; } Property Value int The order. RootAssetTypes Gets the types of asset that are mainly generated by this importer. IEnumerable<Type> RootAssetTypes { get; } Property Value IEnumerable<Type> SupportedFileExtensions Gets the supported file extensions (separated by ',' for multiple extensions) by this importer. This is used for display purpose only. The method IsSupportingFile(string) is used for matching extensions. string SupportedFileExtensions { get; } Property Value string Returns a list of supported file extensions handled by this importer. Methods GetDefaultParameters(bool) Gets the default parameters for this importer. AssetImporterParameters GetDefaultParameters(bool isForReImport) Parameters isForReImport bool Returns AssetImporterParameters The supported types. Import(UFile, AssetImporterParameters) Imports a raw assets from the specified path into the specified package. IEnumerable<AssetItem> Import(UFile rawAssetPath, AssetImporterParameters importParameters) Parameters rawAssetPath UFile The path to a raw asset on the disk. importParameters AssetImporterParameters The parameters. It is mandatory to call GetDefaultParameters(bool) and pass the parameters instance here Returns IEnumerable<AssetItem> IsSupportingFile(string) Determines whether this importer is supporting the specified file. bool IsSupportingFile(string filePath) Parameters filePath string The file path. Returns bool true if this importer is supporting the specified file; otherwise, false."
  },
  "api/Stride.Core.Assets.IAssetPartDesign-1.html": {
    "href": "api/Stride.Core.Assets.IAssetPartDesign-1.html",
    "title": "Interface IAssetPartDesign<TAssetPart> | Stride API",
    "summary": "Interface IAssetPartDesign<TAssetPart> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An interface representing a design-time part in an AssetComposite. public interface IAssetPartDesign<out TAssetPart> : IAssetPartDesign where TAssetPart : IIdentifiable Type Parameters TAssetPart The underlying type of part. Inherited Members IAssetPartDesign.Base Extension Methods UnsafeUtilities.As<T>(object?) Properties Part The actual part. TAssetPart Part { get; } Property Value TAssetPart"
  },
  "api/Stride.Core.Assets.IAssetPartDesign.html": {
    "href": "api/Stride.Core.Assets.IAssetPartDesign.html",
    "title": "Interface IAssetPartDesign | Stride API",
    "summary": "Interface IAssetPartDesign Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An interface representing a design-time part in an AssetComposite. public interface IAssetPartDesign Extension Methods UnsafeUtilities.As<T>(object?) Properties Base BasePart? Base { get; set; } Property Value BasePart Part IIdentifiable Part { get; } Property Value IIdentifiable"
  },
  "api/Stride.Core.Assets.IAssetUpgrader.html": {
    "href": "api/Stride.Core.Assets.IAssetUpgrader.html",
    "title": "Interface IAssetUpgrader | Stride API",
    "summary": "Interface IAssetUpgrader Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public interface IAssetUpgrader Extension Methods UnsafeUtilities.As<T>(object?) Methods Upgrade(AssetMigrationContext, string, PackageVersion, PackageVersion, YamlMappingNode, PackageLoadingAssetFile) void Upgrade(AssetMigrationContext context, string dependencyName, PackageVersion currentVersion, PackageVersion targetVersion, YamlMappingNode yamlAssetNode, PackageLoadingAssetFile assetFile) Parameters context AssetMigrationContext dependencyName string currentVersion PackageVersion targetVersion PackageVersion yamlAssetNode YamlMappingNode assetFile PackageLoadingAssetFile"
  },
  "api/Stride.Core.Assets.IAssetWithSource.html": {
    "href": "api/Stride.Core.Assets.IAssetWithSource.html",
    "title": "Interface IAssetWithSource | Stride API",
    "summary": "Interface IAssetWithSource Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public interface IAssetWithSource Extension Methods UnsafeUtilities.As<T>(object?) Properties Source The source file of this asset. UFile Source { get; set; } Property Value UFile"
  },
  "api/Stride.Core.Assets.ICancellableAsyncBuild.html": {
    "href": "api/Stride.Core.Assets.ICancellableAsyncBuild.html",
    "title": "Interface ICancellableAsyncBuild | Stride API",
    "summary": "Interface ICancellableAsyncBuild Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public interface ICancellableAsyncBuild Extension Methods UnsafeUtilities.As<T>(object?) Properties AssemblyPath string AssemblyPath { get; } Property Value string BuildTask Task<BuildResult> BuildTask { get; } Property Value Task<BuildResult> IsCanceled bool IsCanceled { get; } Property Value bool Methods Cancel() void Cancel()"
  },
  "api/Stride.Core.Assets.IFileSynchronizable.html": {
    "href": "api/Stride.Core.Assets.IFileSynchronizable.html",
    "title": "Interface IFileSynchronizable | Stride API",
    "summary": "Interface IFileSynchronizable Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Identify an object that is associated with an anchor file on the disk where all the Stride.Core.IO.UPath members of this instance are relative to the FullPath of this instance. public interface IFileSynchronizable Extension Methods UnsafeUtilities.As<T>(object?) Properties FullPath Gets the full path on disk where this instance is stored. UFile FullPath { get; } Property Value UFile The full path. IsDirty Gets or sets a value indicating whether this instance is dirty. bool IsDirty { get; set; } Property Value bool true if this instance is dirty; otherwise, false."
  },
  "api/Stride.Core.Assets.IO.FileExtensionCollection.html": {
    "href": "api/Stride.Core.Assets.IO.FileExtensionCollection.html",
    "title": "Class FileExtensionCollection | Stride API",
    "summary": "Class FileExtensionCollection Namespace Stride.Core.Assets.IO Assembly Stride.Core.Assets.dll A class describing a collection of file extensions, with a facultative description string. public sealed class FileExtensionCollection Inheritance object FileExtensionCollection Extension Methods UnsafeUtilities.As<T>(object?) Constructors FileExtensionCollection(string) Initializes a new instance of the FileExtensionCollection class. public FileExtensionCollection(string extensions) Parameters extensions string The extensions to add in this collection. Extensions must be separated with the semi-colon character (;). FileExtensionCollection(string, string, params string[]) Initializes a new instance of the FileExtensionCollection class. public FileExtensionCollection(string description, string extensions, params string[] additionalExtensions) Parameters description string The description of this file extension collection. Can be null. extensions string The extensions to add in this collection. Extensions must be separated with the semi-colon character (;). additionalExtensions string[] Additional extensions to add in this collection. Extensions inside each string must be separated with the semi-colon character (;). Properties ConcatenatedExtensions Gets a string containing all extensions separated with the semi-colon character (;). public string ConcatenatedExtensions { get; } Property Value string Description Gets the description of this file extension collection. public string Description { get; } Property Value string SingleExtensions Gets each extension in this collection individually splitted in an IEnumerable<T>. public IEnumerable<string> SingleExtensions { get; } Property Value IEnumerable<string> Methods Contains(string) Indicates whether the given extension matches any of the extension in this collection. public bool Contains(string extension) Parameters extension string The extension to match. Can contain wildcards. Returns bool True if the given extension matches, false otherwise."
  },
  "api/Stride.Core.Assets.IO.html": {
    "href": "api/Stride.Core.Assets.IO.html",
    "title": "Namespace Stride.Core.Assets.IO | Stride API",
    "summary": "Namespace Stride.Core.Assets.IO Classes FileExtensionCollection A class describing a collection of file extensions, with a facultative description string."
  },
  "api/Stride.Core.Assets.IProjectAsset.html": {
    "href": "api/Stride.Core.Assets.IProjectAsset.html",
    "title": "Interface IProjectAsset | Stride API",
    "summary": "Interface IProjectAsset Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An asset that is stored in a project file (such as .csproj). public interface IProjectAsset Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Assets.IProjectFileGeneratorAsset.html": {
    "href": "api/Stride.Core.Assets.IProjectFileGeneratorAsset.html",
    "title": "Interface IProjectFileGeneratorAsset | Stride API",
    "summary": "Interface IProjectFileGeneratorAsset Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An asset that generates another file. public interface IProjectFileGeneratorAsset : IProjectAsset Extension Methods UnsafeUtilities.As<T>(object?) Properties Generator string Generator { get; } Property Value string Methods SaveGeneratedAsset(AssetItem) void SaveGeneratedAsset(AssetItem assetItem) Parameters assetItem AssetItem"
  },
  "api/Stride.Core.Assets.IReadOnlyPackageCollection.html": {
    "href": "api/Stride.Core.Assets.IReadOnlyPackageCollection.html",
    "title": "Interface IReadOnlyPackageCollection | Stride API",
    "summary": "Interface IReadOnlyPackageCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public interface IReadOnlyPackageCollection : IReadOnlyCollection<Package>, IEnumerable<Package>, IEnumerable, INotifyCollectionChanged Inherited Members IReadOnlyCollection<Package>.Count IEnumerable<Package>.GetEnumerator() INotifyCollectionChanged.CollectionChanged Extension Methods PackageExtensions.ContainsAsset(IEnumerable<Package>, AssetId) PackageExtensions.ContainsAsset(IEnumerable<Package>, UFile) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods Find(Dependency) Package? Find(Dependency dependency) Parameters dependency Dependency Returns Package Find(PackageDependency) Package? Find(PackageDependency packageDependency) Parameters packageDependency PackageDependency Returns Package Find(string, PackageVersionRange) Package? Find(string name, PackageVersionRange versionRange) Parameters name string versionRange PackageVersionRange Returns Package"
  },
  "api/Stride.Core.Assets.OverrideUpgraderHint.html": {
    "href": "api/Stride.Core.Assets.OverrideUpgraderHint.html",
    "title": "Enum OverrideUpgraderHint | Stride API",
    "summary": "Enum OverrideUpgraderHint Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Defines a context for overrides when upgrading an asset. public enum OverrideUpgraderHint Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Base = 2 The upgrader is performed on the base asset of an asset being upgraded (AssetItem or BasePart) Derived = 1 The upgrader is performed on an asset that has at least one base asset (for asset templating) Unknown = 0 The upgrader is performed on an asset that may be used as the base for another asset"
  },
  "api/Stride.Core.Assets.Package.html": {
    "href": "api/Stride.Core.Assets.Package.html",
    "title": "Class Package | Stride API",
    "summary": "Class Package Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A package managing assets. [DataContract(\"Package\")] [AssetDescription(\".sdpkg\")] [AssetFormatVersion(\"Assets\", \"3.1.0.0\", \"0.0.0.4\")] [AssetUpgrader(\"Assets\", \"0.0.0.4\", \"3.1.0.0\", typeof(Package.MovePackageInsideProject))] public sealed class Package : IFileSynchronizable, IAssetFinder Inheritance object Package Implements IFileSynchronizable IAssetFinder Extension Methods PackageExtensions.FindAsset(Package, IReference) PackageExtensions.FindDependencies(Package, bool) UnsafeUtilities.As<T>(object?) Constructors Package() Initializes a new instance of the Package class. public Package() Fields PackageFileExtension The file extension used for Package. public const string PackageFileExtension = \".sdpkg\" Field Value string Properties AssetFolders Gets the asset directories to lookup. [DataMember(40, DataMemberMode.Assign)] public AssetFolderCollection AssetFolders { get; set; } Property Value AssetFolderCollection The asset directories. Assets Gets the assets stored in this package. public PackageAssetCollection Assets { get; } Property Value PackageAssetCollection The assets. Bundles Gets the bundles defined for this package. [DataMember(80)] public BundleCollection Bundles { get; } Property Value BundleCollection The bundles. Container public PackageContainer Container { get; } Property Value PackageContainer ExplicitFolders Gets or sets the list of folders that are explicitly created but contains no assets. [DataMember(70)] public List<UDirectory> ExplicitFolders { get; } Property Value List<UDirectory> FullPath Gets the path to the package file. May be null if the package was not loaded or saved. public UFile FullPath { get; set; } Property Value UFile The package path. IsDirty Gets or sets a value indicating whether this instance has been modified since last saving. public bool IsDirty { get; set; } Property Value bool true if this instance is dirty; otherwise, false. IsImplicitProject public bool IsImplicitProject { get; } Property Value bool IsSystem Gets or sets a value indicating whether this package is a system package. public bool IsSystem { get; } Property Value bool true if this package is a system package; otherwise, false. LoadedAssemblies Gets the list of assemblies loaded by this package. public List<PackageLoadedAssembly> LoadedAssemblies { get; } Property Value List<PackageLoadedAssembly> The loaded assemblies. Meta Gets or sets the metadata associated with this package. [DataMember(10)] public PackageMeta Meta { get; set; } Property Value PackageMeta The meta. OutputGroupDirectories Gets the output group directories. [DataMember(50, DataMemberMode.Assign)] public Dictionary<string, UDirectory> OutputGroupDirectories { get; set; } Property Value Dictionary<string, UDirectory> The output group directories. ResourceFolders Gets the resource directories to lookup. [DataMember(45, DataMemberMode.Assign)] public List<UDirectory> ResourceFolders { get; set; } Property Value List<UDirectory> The resource directories. RootAssets Asset references that needs to be compiled even if not directly or indirectly referenced (useful for explicit code references). [DataMember(100)] public RootAssetCollection RootAssets { get; } Property Value RootAssetCollection RootDirectory Gets the top directory of this package on the local disk. public UDirectory? RootDirectory { get; } Property Value UDirectory The top directory. RootNamespace public string? RootNamespace { get; } Property Value string SerializedVersion Gets or sets the version number for this asset, used internally when migrating assets. [DataMember(-8000, DataMemberMode.Assign)] [DataStyle(DataStyle.Compact)] [Display(null, null, Browsable = false)] public Dictionary<string, PackageVersion>? SerializedVersion { get; set; } Property Value Dictionary<string, PackageVersion> The version. Session Gets the session. public PackageSession? Session { get; } Property Value PackageSession The session. Exceptions InvalidOperationException Cannot attach a package to more than one session State public PackageState State { get; set; } Property Value PackageState TemplateFolders Gets the template folders. [DataMember(90)] public List<TemplateFolder> TemplateFolders { get; } Property Value List<TemplateFolder> The template folders. Templates Gets the loaded templates from the TemplateFolders public List<TemplateDescription> Templates { get; } Property Value List<TemplateDescription> The templates. TemporaryAssets Gets the temporary assets list loaded from disk before they are going into Assets. public List<AssetItem> TemporaryAssets { get; } Property Value List<AssetItem> The temporary assets. UserSettings Gets the package user settings. Usually stored in a .user file alongside the package. Lazily loaded on first time. public PackageUserSettings UserSettings { get; } Property Value PackageUserSettings The package user settings. Methods AddExistingProject(UFile) Adds an existing project to this package. public LoggerResult AddExistingProject(UFile pathToMsproj) Parameters pathToMsproj UFile The path to msproj. Returns LoggerResult LoggerResult. AddExistingProject(UFile, LoggerResult) Adds an existing project to this package. public void AddExistingProject(UFile pathToMsproj, LoggerResult logger) Parameters pathToMsproj UFile The path to msproj. logger LoggerResult The logger. Clone() Deep clone this package. public Package Clone() Returns Package The package cloned. FindAsset(AssetId) Finds an asset by its identifier. public AssetItem? FindAsset(AssetId assetId) Parameters assetId AssetId The identifier of the asset. Returns AssetItem The corresponding AssetItem if found; otherwise, null. Remarks Looks for the asset amongst the current package and its dependencies. FindAsset(UFile) Finds an asset by its location. public AssetItem? FindAsset(UFile location) Parameters location UFile The location of the asset. Returns AssetItem The corresponding AssetItem if found; otherwise, null. Remarks Looks for the asset amongst the current package and its dependencies. FindAssetFromProxyObject(object?) Finds an asset from a proxy object. public AssetItem? FindAssetFromProxyObject(object? proxyObject) Parameters proxyObject object The proxy object which is represent the targeted asset. Returns AssetItem The corresponding AssetItem if found; otherwise, null. Remarks Looks for the asset amongst the current package and its dependencies. FindAssetsInProject(string, out string?) public static List<(UFile FilePath, UFile? Link)> FindAssetsInProject(string projectFullPath, out string? nameSpace) Parameters projectFullPath string nameSpace string Returns List<(UFile FilePath, UFile Link)> GetDefaultAssetFolder() public UDirectory GetDefaultAssetFolder() Returns UDirectory GetPackageIdFromFile(string) Gets the package identifier from file. public static Guid GetPackageIdFromFile(string filePath) Parameters filePath string The file path. Returns Guid Guid. Exceptions ArgumentNullException log or filePath ListAssetFiles(Package, bool, bool) public static List<PackageLoadingAssetFile> ListAssetFiles(Package package, bool listAssetsInMsbuild, bool listUnregisteredAssets) Parameters package Package listAssetsInMsbuild bool listUnregisteredAssets bool Returns List<PackageLoadingAssetFile> Load(ILogger, string, PackageLoadParameters?) Loads only the package description but not assets or plugins. public static Package? Load(ILogger log, string filePath, PackageLoadParameters? loadParametersArg = null) Parameters log ILogger The log to receive error messages. filePath string The file path. loadParametersArg PackageLoadParameters The load parameters argument. Returns Package A package. Exceptions ArgumentNullException log or filePath LoadProject(ILogger, string) public static PackageContainer LoadProject(ILogger log, string filePath) Parameters log ILogger filePath string Returns PackageContainer LoadTemporaryAssets(ILogger, List<PackageLoadingAssetFile>?, bool, Func<PackageLoadingAssetFile, bool>?, CancellationToken) Refreshes this package from the disk by loading or reloading all assets. public void LoadTemporaryAssets(ILogger log, List<PackageLoadingAssetFile>? assetFiles = null, bool listAssetsInMsbuild = true, Func<PackageLoadingAssetFile, bool>? filterFunc = null, CancellationToken cancellationToken = default) Parameters log ILogger The log. assetFiles List<PackageLoadingAssetFile> The asset files (loaded from ListAssetFiles(Package, bool, bool) if null). listAssetsInMsbuild bool Specifies if we need to evaluate MSBuild files for assets. filterFunc Func<PackageLoadingAssetFile, bool> A function that will filter assets loading cancellationToken CancellationToken The cancellation token. Exceptions InvalidOperationException Package RootDirectory is null or Package RootDirectory [{0}] does not exist.ToFormat(RootDirectory) SaveSingleAsset(AssetItem, ILogger) public static bool SaveSingleAsset(AssetItem asset, ILogger log) Parameters asset AssetItem log ILogger Returns bool SetPackagePath(UFile, bool) Sets the package path. public void SetPackagePath(UFile newPath, bool copyAssets = true) Parameters newPath UFile The new path. copyAssets bool if set to true assets will be copied relatively to the new location. UpdateAssemblyReferences(ILogger, PackageLoadParameters?) Loads the assembly references that were not loaded before. public void UpdateAssemblyReferences(ILogger log, PackageLoadParameters? loadParametersArg = null) Parameters log ILogger The log. loadParametersArg PackageLoadParameters The load parameters argument. ValidateAssets(bool, bool, ILogger) public void ValidateAssets(bool alwaysGenerateNewAssetId, bool removeUnloadableObjects, ILogger log) Parameters alwaysGenerateNewAssetId bool removeUnloadableObjects bool log ILogger Events AssetDirtyChanged Occurs when an asset dirty changed occurred. public event DirtyFlagChangedDelegate<AssetItem> AssetDirtyChanged Event Type DirtyFlagChangedDelegate<AssetItem> PackageDirtyChanged Occurs when package dirty changed occurred. public event DirtyFlagChangedDelegate<Package> PackageDirtyChanged Event Type DirtyFlagChangedDelegate<Package>"
  },
  "api/Stride.Core.Assets.PackageAssetCollection.html": {
    "href": "api/Stride.Core.Assets.PackageAssetCollection.html",
    "title": "Class PackageAssetCollection | Stride API",
    "summary": "Class PackageAssetCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A collection of AssetItem that contains only absolute location without any drive information. This class cannot be inherited. public sealed class PackageAssetCollection : ICollection<AssetItem>, IReadOnlyCollection<AssetItem>, IEnumerable<AssetItem>, ICollection, IEnumerable, INotifyCollectionChanged Inheritance object PackageAssetCollection Implements ICollection<AssetItem> IReadOnlyCollection<AssetItem> IEnumerable<AssetItem> ICollection IEnumerable INotifyCollectionChanged Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors PackageAssetCollection(Package) Initializes a new instance of the PackageAssetCollection class. public PackageAssetCollection(Package package) Parameters package Package The package that will contain assets. Properties Count Gets the number of elements contained in this instance. public int Count { get; } Property Value int The number of elements contained in this instance. IsDirty Gets or sets a value indicating whether this instance is dirty. Sets this flag when moving assets between packages or removing assets. public bool IsDirty { get; set; } Property Value bool true if this instance is dirty; otherwise, false. IsReadOnly Gets a value indicating whether this collection is read-only. Default is false. public bool IsReadOnly { get; } Property Value bool false Package Gets the package this collection is attached to. public Package Package { get; } Property Value Package The package. Methods Add(AssetItem) Adds an AssetItem to this instance. public void Add(AssetItem item) Parameters item AssetItem The item to add to this instance. CheckCanAdd(AssetItem) Checks if the specified item can be add to this collection. public void CheckCanAdd(AssetItem item) Parameters item AssetItem The item. Exceptions ArgumentNullException item;Cannot add an empty asset item reference or item;Cannot add an item with an empty asset or item;Cannot add an asset with an empty Id or item;Location cannot be null when adding an asset reference ArgumentException An asset with the same location is already registered [{0}].ToFormat(location.Path);item or An asset with the same id [{0}] is already registered with the location [{1}].ToFormat(item.Id, location.Path);item or Asset location [{0}] cannot contain drive information.ToFormat(location);item or Asset location [{0}] must be relative and not absolute (not start with '/').ToFormat(location);item or Asset location [{0}] cannot start with relative '..'.ToFormat(location);item Clear() Removes all items from this instance. public void Clear() Contains(AssetItem) Checks this collection contains the specified asset reference, throws an exception if not found. public bool Contains(AssetItem assetItem) Parameters assetItem AssetItem The asset item. Returns bool Exceptions ArgumentNullException assetItem KeyNotFoundException Asset [{0}] was not found.ToFormat(assetItem) ContainsById(AssetId) Determines whether this instance contains an asset with the specified identifier. public bool ContainsById(AssetId assetId) Parameters assetId AssetId The asset identifier. Returns bool true if this instance contains an asset with the specified identifier; otherwise, false. CopyTo(AssetItem[], int) Copies items to the specified array. public void CopyTo(AssetItem[] array, int arrayIndex) Parameters array AssetItem[] The array. arrayIndex int Index of the array. Find(AssetId) Finds an asset by its location. public AssetItem? Find(AssetId assetId) Parameters assetId AssetId The asset unique identifier. Returns AssetItem AssetItem. Find(string) Finds an asset by its location. public AssetItem? Find(string location) Parameters location string The location of the assets. Returns AssetItem AssetItem. GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<AssetItem> GetEnumerator() Returns IEnumerator<AssetItem> An enumerator that can be used to iterate through the collection. Remove(AssetItem) Removes an AssetItem from this instance. public bool Remove(AssetItem item) Parameters item AssetItem The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. RemoveById(AssetId) Removes an AssetItem from this instance. public bool RemoveById(AssetId itemId) Parameters itemId AssetId The item identifier. Returns bool true if itemId was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. ResumeCollectionChanged() Resumes the collection changed that happened on this collection and fire a Reset public void ResumeCollectionChanged() SuspendCollectionChanged() Suspends the collection changed that can happen on this collection. public void SuspendCollectionChanged() Events CollectionChanged Occurs when the collection changes. public event NotifyCollectionChangedEventHandler? CollectionChanged Event Type NotifyCollectionChangedEventHandler"
  },
  "api/Stride.Core.Assets.PackageCollection.html": {
    "href": "api/Stride.Core.Assets.PackageCollection.html",
    "title": "Class PackageCollection | Stride API",
    "summary": "Class PackageCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A collection of Package. [DataContract(\"PackageCollection\")] public sealed class PackageCollection : ICollection<Package>, IReadOnlyPackageCollection, IReadOnlyCollection<Package>, IEnumerable<Package>, IEnumerable, INotifyCollectionChanged Inheritance object PackageCollection Implements ICollection<Package> IReadOnlyPackageCollection IReadOnlyCollection<Package> IEnumerable<Package> IEnumerable INotifyCollectionChanged Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) PackageExtensions.ContainsAsset(IEnumerable<Package>, AssetId) PackageExtensions.ContainsAsset(IEnumerable<Package>, UFile) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors PackageCollection() Initializes a new instance of the PackageCollection class. public PackageCollection() Properties Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. Methods Add(Package) Adds an item to the ICollection<T>. public void Add(Package item) Parameters item Package The object to add to the ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. Contains(Package) Determines whether the ICollection<T> contains a specific value. public bool Contains(Package item) Parameters item Package The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. CopyTo(Package[], int) Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. public void CopyTo(Package[] array, int arrayIndex) Parameters array Package[] The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing. arrayIndex int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException arrayIndex is less than 0. ArgumentException The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array. Find(Dependency) Finds the a package already in this collection from the specified dependency. public Package? Find(Dependency dependency) Parameters dependency Dependency Returns Package Package. Find(PackageDependency) Finds the a package already in this collection from the specified dependency. public Package? Find(PackageDependency packageDependency) Parameters packageDependency PackageDependency The package dependency. Returns Package Package. Find(string, PackageVersionRange) Finds a package with the specified name and Stride.Core.PackageVersionRange. public Package? Find(string name, PackageVersionRange versionRange) Parameters name string The name. versionRange PackageVersionRange The version range. Returns Package Package. GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<Package> GetEnumerator() Returns IEnumerator<Package> An enumerator that can be used to iterate through the collection. Remove(Package) Removes the first occurrence of a specific object from the ICollection<T>. public bool Remove(Package item) Parameters item Package The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. Events CollectionChanged Occurs when the collection changes. public event NotifyCollectionChangedEventHandler? CollectionChanged Event Type NotifyCollectionChangedEventHandler"
  },
  "api/Stride.Core.Assets.PackageContainer.html": {
    "href": "api/Stride.Core.Assets.PackageContainer.html",
    "title": "Class PackageContainer | Stride API",
    "summary": "Class PackageContainer Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public abstract class PackageContainer Inheritance object PackageContainer Derived SolutionProject StandalonePackage Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageContainer(Package) public PackageContainer(Package package) Parameters package Package Properties DirectDependencies public ObservableCollection<DependencyRange> DirectDependencies { get; } Property Value ObservableCollection<DependencyRange> FlattenedDependencies public ObservableCollection<Dependency> FlattenedDependencies { get; } Property Value ObservableCollection<Dependency> Package public Package Package { get; } Property Value Package Session Gets the session. public PackageSession? Session { get; } Property Value PackageSession Methods Save(ILogger, PackageSaveParameters?) Saves this package and all dirty assets. See remarks. public void Save(ILogger log, PackageSaveParameters? saveParameters = null) Parameters log ILogger The log. saveParameters PackageSaveParameters Remarks When calling this method directly, it does not handle moving assets between packages. Call Save(ILogger, PackageSaveParameters?) instead. Exceptions ArgumentNullException log SavePackage() protected virtual void SavePackage()"
  },
  "api/Stride.Core.Assets.PackageDependency.html": {
    "href": "api/Stride.Core.Assets.PackageDependency.html",
    "title": "Class PackageDependency | Stride API",
    "summary": "Class PackageDependency Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A reference to a package either internal (directly to a Package inside the same solution) or external (to a package distributed on the store). [DataContract(\"PackageDependency\")] public sealed class PackageDependency : PackageReferenceBase, IEquatable<PackageDependency> Inheritance object PackageReferenceBase PackageDependency Implements IEquatable<PackageDependency> Inherited Members PackageReferenceBase.RootAssets Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageDependency() Initializes a new instance of the PackageDependency class. public PackageDependency() Remarks This constructor is used only for serialization. PackageDependency(string, PackageVersionRange) Initializes a new instance of the PackageDependency class. public PackageDependency(string name, PackageVersionRange version) Parameters name string The name. version PackageVersionRange The version. Properties Name Gets or sets the package name Id. [DataMember(10)] public string? Name { get; set; } Property Value string The name. Remarks The setter should only be used during serialization. Version Gets or sets the version. [DataMember(20)] public PackageVersionRange? Version { get; set; } Property Value PackageVersionRange The version. Methods Clone() Clones this instance. public PackageDependency Clone() Returns PackageDependency PackageDependency. Equals(PackageDependency?) Indicates whether the current object is equal to another object of the same type. public bool Equals(PackageDependency? other) Parameters other PackageDependency An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Determines whether the specified object is equal to the current object. public override bool Equals(object? obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. ToString() public override string ToString() Returns string Operators operator ==(PackageDependency, PackageDependency) public static bool operator ==(PackageDependency left, PackageDependency right) Parameters left PackageDependency right PackageDependency Returns bool operator !=(PackageDependency, PackageDependency) public static bool operator !=(PackageDependency left, PackageDependency right) Parameters left PackageDependency right PackageDependency Returns bool"
  },
  "api/Stride.Core.Assets.PackageDependencyCollection.html": {
    "href": "api/Stride.Core.Assets.PackageDependencyCollection.html",
    "title": "Class PackageDependencyCollection | Stride API",
    "summary": "Class PackageDependencyCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A collection of PackageDependency. [DataContract(\"PackageDependencyCollection\")] public sealed class PackageDependencyCollection : KeyedCollection<string, PackageDependency>, IList<PackageDependency>, ICollection<PackageDependency>, IReadOnlyList<PackageDependency>, IReadOnlyCollection<PackageDependency>, IEnumerable<PackageDependency>, IList, ICollection, IEnumerable Inheritance object Collection<PackageDependency> KeyedCollection<string, PackageDependency> PackageDependencyCollection Implements IList<PackageDependency> ICollection<PackageDependency> IReadOnlyList<PackageDependency> IReadOnlyCollection<PackageDependency> IEnumerable<PackageDependency> IList ICollection IEnumerable Inherited Members KeyedCollection<string, PackageDependency>.Contains(string) KeyedCollection<string, PackageDependency>.Remove(string) KeyedCollection<string, PackageDependency>.TryGetValue(string, out PackageDependency) KeyedCollection<string, PackageDependency>.Comparer KeyedCollection<string, PackageDependency>.this[string] Collection<PackageDependency>.Add(PackageDependency) Collection<PackageDependency>.Clear() Collection<PackageDependency>.Contains(PackageDependency) Collection<PackageDependency>.CopyTo(PackageDependency[], int) Collection<PackageDependency>.GetEnumerator() Collection<PackageDependency>.IndexOf(PackageDependency) Collection<PackageDependency>.Insert(int, PackageDependency) Collection<PackageDependency>.Remove(PackageDependency) Collection<PackageDependency>.RemoveAt(int) Collection<PackageDependency>.Count Collection<PackageDependency>.this[int] Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods GetKeyForItem(PackageDependency) When implemented in a derived class, extracts the key from the specified element. protected override string GetKeyForItem(PackageDependency item) Parameters item PackageDependency The element from which to extract the key. Returns string The key for the specified element."
  },
  "api/Stride.Core.Assets.PackageExtensions.html": {
    "href": "api/Stride.Core.Assets.PackageExtensions.html",
    "title": "Class PackageExtensions | Stride API",
    "summary": "Class PackageExtensions Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Extensions for Package public static class PackageExtensions Inheritance object PackageExtensions Methods ContainsAsset(IEnumerable<Package>, AssetId) Determines whether the specified packages contains an asset by its guid. public static bool ContainsAsset(this IEnumerable<Package> packages, AssetId assetId) Parameters packages IEnumerable<Package> The packages. assetId AssetId The asset unique identifier. Returns bool true if the specified packages contains asset; otherwise, false. ContainsAsset(IEnumerable<Package>, UFile) Determines whether the specified packages contains an asset by its location. public static bool ContainsAsset(this IEnumerable<Package> packages, UFile location) Parameters packages IEnumerable<Package> The packages. location UFile The location. Returns bool true if the specified packages contains asset; otherwise, false. FindAsset(Package, IReference) Finds an asset from all the packages by its asset reference. It will first try by id, then location. public static AssetItem? FindAsset(this Package package, IReference reference) Parameters package Package The package. reference IReference The reference to the asset. Returns AssetItem An AssetItem or null if not found. FindDependencies(Package, bool) Finds the package dependencies for the specified Package. See remarks. public static PackageCollection FindDependencies(this Package rootPackage, bool includeRootPackage = false) Parameters rootPackage Package The root package. includeRootPackage bool if set to true [include root package]. Returns PackageCollection List<Package>. Exceptions ArgumentNullException rootPackage ArgumentException Root package must be part of a session;rootPackage"
  },
  "api/Stride.Core.Assets.PackageLoadParameters.html": {
    "href": "api/Stride.Core.Assets.PackageLoadParameters.html",
    "title": "Class PackageLoadParameters | Stride API",
    "summary": "Class PackageLoadParameters Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Parameters used for loading a package. public sealed class PackageLoadParameters Inheritance object PackageLoadParameters Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageLoadParameters() Initializes a new instance of the PackageLoadParameters class. public PackageLoadParameters() Fields PackageUpgradeRequested Occurs when one or more package upgrades are required for a single package. Returning false will cancel upgrades on this package. public Func<Package, IList<PackageSession.PendingPackageUpgrade>, PackageUpgradeRequestedAnswer> PackageUpgradeRequested Field Value Func<Package, IList<PackageSession.PendingPackageUpgrade>, PackageUpgradeRequestedAnswer> TemporaryAssetFilter Occurs when an asset is about to be loaded, if false is returned the asset will be ignored and not loaded. public Func<PackageLoadingAssetFile, bool> TemporaryAssetFilter Field Value Func<PackageLoadingAssetFile, bool> Properties AssemblyContainer Gets or sets the assembly container used to load assemblies referenced by the package. If null, will use the Stride.Core.Reflection.AssemblyContainer.Default public AssemblyContainer AssemblyContainer { get; set; } Property Value AssemblyContainer The assembly container. AssetFiles Gets or sets the asset files to load, if you want to not rely on the default ListAssetFiles(Package, bool, bool). public List<PackageLoadingAssetFile> AssetFiles { get; set; } Property Value List<PackageLoadingAssetFile> The load asset files. AutoCompileProjects Gets or sets a value indicating whether to automatically compile projects that don't have their assembly generated. public bool AutoCompileProjects { get; set; } Property Value bool true if [automatic compile projects]; otherwise, false. AutoLoadTemporaryAssets Gets or sets a value indicating whether to automatically load assets. Default is true public bool AutoLoadTemporaryAssets { get; set; } Property Value bool true if [automatic load assets]; otherwise, false. BuildConfiguration Gets or sets the build configuration used to AutoCompileProjects. public string BuildConfiguration { get; set; } Property Value string The build configuration. CancelToken Gets or sets the cancelation token. public CancellationToken? CancelToken { get; set; } Property Value CancellationToken? The cancel token. ConvertUPathToAbsolute Gets or sets a value indicating whether to convert all Stride.Core.IO.UPath to absolute paths when loading. Default is true public bool ConvertUPathToAbsolute { get; set; } Property Value bool true if [convert u path to absolute]; otherwise, false. ExtraCompileProperties Gets or sets the extra compile properties, used when AutoCompileProjects is true. public Dictionary<string, string> ExtraCompileProperties { get; set; } Property Value Dictionary<string, string> The extra compile parameters. GenerateNewAssetIds Gets or sets the generate new asset ids. public bool GenerateNewAssetIds { get; set; } Property Value bool The generate new asset ids. Remarks Only makes sense for AddExistingProject(UFile, ILogger, PackageLoadParameters?). LoadAssemblyReferences Gets or sets a value indicating whether [load assembly references]. public bool LoadAssemblyReferences { get; set; } Property Value bool true if [load assembly references]; otherwise, false. LoadMissingDependencies Gets or sets a value indicating whether [load missing dependencies]. public bool LoadMissingDependencies { get; set; } Property Value bool true if [load missing dependencies]; otherwise, false. RemoveUnloadableObjects If true, unloadable objects will be removed, similar to RemoveUnloadableObjects. public bool RemoveUnloadableObjects { get; set; } Property Value bool TemporaryAssetsInMsbuild Gets a boolean telling if MSBuild files should be evaluated when listing assets. public bool TemporaryAssetsInMsbuild { get; set; } Property Value bool Methods Clone() Clones this instance. public PackageLoadParameters Clone() Returns PackageLoadParameters PackageLoadParameters. Default() Gets the default parameters. public static PackageLoadParameters Default() Returns PackageLoadParameters PackageLoadParameters. ShouldUpgrade(PackageUpgradeRequestedAnswer) Indicates if the given value of PackageUpgradeRequestedAnswer should trigger an upgrade. public static bool ShouldUpgrade(PackageUpgradeRequestedAnswer answer) Parameters answer PackageUpgradeRequestedAnswer The value to evaluate. Returns bool True if it should trigger an upgrade, false otherwise."
  },
  "api/Stride.Core.Assets.PackageLoadedAssembly.html": {
    "href": "api/Stride.Core.Assets.PackageLoadedAssembly.html",
    "title": "Class PackageLoadedAssembly | Stride API",
    "summary": "Class PackageLoadedAssembly Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Represents an assembly that is loaded at runtime by the package. public class PackageLoadedAssembly Inheritance object PackageLoadedAssembly Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageLoadedAssembly(ProjectReference, string) public PackageLoadedAssembly(ProjectReference projectReference, string path) Parameters projectReference ProjectReference path string Properties Assembly Gets or sets the loaded assembly. Could be null if not properly loaded. public Assembly Assembly { get; set; } Property Value Assembly The assembly. Path Gets the path of the assembly. public string Path { get; set; } Property Value string The path. ProjectReference Gets the project reference for this assembly. public ProjectReference ProjectReference { get; } Property Value ProjectReference The project reference."
  },
  "api/Stride.Core.Assets.PackageLoadingAssetFile.FileSizeComparer.html": {
    "href": "api/Stride.Core.Assets.PackageLoadingAssetFile.FileSizeComparer.html",
    "title": "Class PackageLoadingAssetFile.FileSizeComparer | Stride API",
    "summary": "Class PackageLoadingAssetFile.FileSizeComparer Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class PackageLoadingAssetFile.FileSizeComparer : Comparer<PackageLoadingAssetFile>, IComparer<PackageLoadingAssetFile>, IComparer Inheritance object Comparer<PackageLoadingAssetFile> PackageLoadingAssetFile.FileSizeComparer Implements IComparer<PackageLoadingAssetFile> IComparer Inherited Members Comparer<PackageLoadingAssetFile>.Create(Comparison<PackageLoadingAssetFile>) Extension Methods UnsafeUtilities.As<T>(object?) Fields Default public static readonly PackageLoadingAssetFile.FileSizeComparer Default Field Value PackageLoadingAssetFile.FileSizeComparer Methods Compare(PackageLoadingAssetFile?, PackageLoadingAssetFile?) When overridden in a derived class, performs a comparison of two objects of the same type and returns a value indicating whether one object is less than, equal to, or greater than the other. public override int Compare(PackageLoadingAssetFile? x, PackageLoadingAssetFile? y) Parameters x PackageLoadingAssetFile The first object to compare. y PackageLoadingAssetFile The second object to compare. Returns int A signed integer that indicates the relative values of x and y, as shown in the following table. Value Meaning Less than zero x is less than y. Zero x equals y. Greater than zero x is greater than y. Exceptions ArgumentException Type T does not implement either the IComparable<T> generic interface or the IComparable interface."
  },
  "api/Stride.Core.Assets.PackageLoadingAssetFile.YamlAsset.html": {
    "href": "api/Stride.Core.Assets.PackageLoadingAssetFile.YamlAsset.html",
    "title": "Class PackageLoadingAssetFile.YamlAsset | Stride API",
    "summary": "Class PackageLoadingAssetFile.YamlAsset Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public sealed class PackageLoadingAssetFile.YamlAsset : DynamicYaml, IDisposable Inheritance object DynamicYaml PackageLoadingAssetFile.YamlAsset Implements IDisposable Inherited Members DynamicYaml.RootNode DynamicYaml.DynamicRootNode DynamicYaml.WriteTo(Stream, SerializerSettings) DynamicYaml.WriteTo(TextWriter, SerializerSettings) DynamicYaml.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors YamlAsset(PackageLoadingAssetFile) public YamlAsset(PackageLoadingAssetFile packageLoadingAssetFile) Parameters packageLoadingAssetFile PackageLoadingAssetFile Properties Asset public PackageLoadingAssetFile Asset { get; } Property Value PackageLoadingAssetFile Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose()"
  },
  "api/Stride.Core.Assets.PackageLoadingAssetFile.html": {
    "href": "api/Stride.Core.Assets.PackageLoadingAssetFile.html",
    "title": "Class PackageLoadingAssetFile | Stride API",
    "summary": "Class PackageLoadingAssetFile Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Represents an asset before being loaded. Used mostly for asset upgrading. public class PackageLoadingAssetFile Inheritance object PackageLoadingAssetFile Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageLoadingAssetFile(Package, UFile, UDirectory) Initializes a new instance of the PackageLoadingAssetFile class. public PackageLoadingAssetFile(Package package, UFile filePath, UDirectory sourceFolder) Parameters package Package The package this asset will be part of. filePath UFile The relative file path (from default asset folder). sourceFolder UDirectory The source folder (optional, can be null). Exceptions ArgumentException filePath must be relative PackageLoadingAssetFile(UFile, UDirectory) Initializes a new instance of the PackageLoadingAssetFile class. public PackageLoadingAssetFile(UFile filePath, UDirectory sourceFolder) Parameters filePath UFile The file path. sourceFolder UDirectory The source folder. Fields CachedFileSize public long CachedFileSize Field Value long Deleted public bool Deleted Field Value bool SourceFolder public readonly UDirectory SourceFolder Field Value UDirectory Properties AssetContent public byte[] AssetContent { get; set; } Property Value byte[] AssetLocation public UFile? AssetLocation { get; } Property Value UFile FilePath public UFile FilePath { get; set; } Property Value UFile Link public UFile? Link { get; set; } Property Value UFile OriginalFilePath public UFile OriginalFilePath { get; set; } Property Value UFile Methods AsYamlAsset() public PackageLoadingAssetFile.YamlAsset? AsYamlAsset() Returns PackageLoadingAssetFile.YamlAsset OpenStream() public Stream OpenStream() Returns Stream ToReference() public IReference ToReference() Returns IReference ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.PackageMeta.html": {
    "href": "api/Stride.Core.Assets.PackageMeta.html",
    "title": "Class PackageMeta | Stride API",
    "summary": "Class PackageMeta Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Metadata for a Package accessible from PackageMeta. [DataContract(\"PackageMeta\")] public sealed class PackageMeta Inheritance object PackageMeta Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageMeta() Initializes a new instance of the PackageMeta class. public PackageMeta() Properties Authors Gets the authors. [DataMember(40)] public List<string> Authors { get; } Property Value List<string> The authors. Copyright Gets or sets the copyright. [DataMember(150)] public string? Copyright { get; set; } Property Value string The copyright. Dependencies Gets the package dependencies. [DataMember(160)] public PackageDependencyCollection Dependencies { get; } Property Value PackageDependencyCollection The package dependencies. Description Gets or sets the description of this package. [DataMember(100)] public string? Description { get; set; } Property Value string The description. DownloadCount Gets the download count. Only valid for store packages. public long DownloadCount { get; } Property Value long The download count. IconUrl Gets or sets the icon URL. [DataMember(60)] public Uri? IconUrl { get; set; } Property Value Uri The icon URL. Language Gets or sets the language supported by this package. [DataMember(130)] public string? Language { get; set; } Property Value string The language. LicenseUrl Gets or sets the license URL. [DataMember(70)] public Uri? LicenseUrl { get; set; } Property Value Uri The license URL. Listed Gets a value indicating whether this PackageMeta is listed. public bool Listed { get; } Property Value bool true if listed; otherwise, false. Name Gets or sets the identifier name of this package. [DataMember(10)] public string? Name { get; set; } Property Value string The name. Owners Gets the owners. [DataMember(50)] public List<string> Owners { get; } Property Value List<string> The owners. ProjectUrl Gets or sets the project URL. [DataMember(80)] public Uri? ProjectUrl { get; set; } Property Value Uri The project URL. Published Gets the published time. public DateTimeOffset? Published { get; } Property Value DateTimeOffset? The published. ReleaseNotes Gets or sets the release notes of this package. [DataMember(120)] public string? ReleaseNotes { get; set; } Property Value string The release notes. ReportAbuseUrl Gets the report abuse URL. Only valid for store packages. public Uri ReportAbuseUrl { get; } Property Value Uri The report abuse URL. RequireLicenseAcceptance Gets or sets a value indicating whether it requires license acceptance. [DataMember(90)] public bool RequireLicenseAcceptance { get; set; } Property Value bool true if it requires license acceptance; otherwise, false. RootNamespace Gets or sets the default namespace for this package. [DataMember(155)] public string? RootNamespace { get; set; } Property Value string The default namespace. Summary Gets or sets the summary of this package. [DataMember(110)] public string? Summary { get; set; } Property Value string The summary. Tags Gets or sets the tags associated to this package. [DataMember(140)] public string? Tags { get; set; } Property Value string The tags. Title Gets or sets the title. [DataMember(30)] public string? Title { get; set; } Property Value string The title. Version Gets or sets the version of this package. [DataMember(20)] public PackageVersion? Version { get; set; } Property Value PackageVersion The version. Methods NewDefault(string) Creates a new PackageMeta with default values. public static PackageMeta NewDefault(string packageName) Parameters packageName string Name of the package. Returns PackageMeta PackageMeta. Exceptions ArgumentNullException packageName"
  },
  "api/Stride.Core.Assets.PackageReferenceBase.html": {
    "href": "api/Stride.Core.Assets.PackageReferenceBase.html",
    "title": "Class PackageReferenceBase | Stride API",
    "summary": "Class PackageReferenceBase Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Common class used by PackageDependency. [DataContract(\"PackageReferenceBase\")] public abstract class PackageReferenceBase Inheritance object PackageReferenceBase Derived PackageDependency Extension Methods UnsafeUtilities.As<T>(object?) Properties RootAssets Asset references that needs to be compiled even if not directly or indirectly referenced (useful for explicit code references). [DataMember(100)] public RootAssetCollection RootAssets { get; } Property Value RootAssetCollection"
  },
  "api/Stride.Core.Assets.PackageSaveParameters.html": {
    "href": "api/Stride.Core.Assets.PackageSaveParameters.html",
    "title": "Class PackageSaveParameters | Stride API",
    "summary": "Class PackageSaveParameters Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class PackageSaveParameters Inheritance object PackageSaveParameters Extension Methods UnsafeUtilities.As<T>(object?) Fields AssetFilter public Func<AssetItem, bool>? AssetFilter Field Value Func<AssetItem, bool> Methods Clone() Clones this instance. public PackageSaveParameters Clone() Returns PackageSaveParameters PackageLoadParameters. Default() public static PackageSaveParameters Default() Returns PackageSaveParameters"
  },
  "api/Stride.Core.Assets.PackageSession.PendingPackageUpgrade.html": {
    "href": "api/Stride.Core.Assets.PackageSession.PendingPackageUpgrade.html",
    "title": "Class PackageSession.PendingPackageUpgrade | Stride API",
    "summary": "Class PackageSession.PendingPackageUpgrade Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class PackageSession.PendingPackageUpgrade : IEquatable<PackageSession.PendingPackageUpgrade> Inheritance object PackageSession.PendingPackageUpgrade Implements IEquatable<PackageSession.PendingPackageUpgrade> Extension Methods UnsafeUtilities.As<T>(object?) Constructors PendingPackageUpgrade(PackageUpgrader, PackageDependency, Package) public PendingPackageUpgrade(PackageUpgrader packageUpgrader, PackageDependency dependency, Package dependencyPackage) Parameters packageUpgrader PackageUpgrader dependency PackageDependency dependencyPackage Package Fields Dependency public readonly PackageDependency Dependency Field Value PackageDependency DependencyPackage public readonly Package DependencyPackage Field Value Package DependencyVersionBeforeUpgrade public readonly PackageVersionRange DependencyVersionBeforeUpgrade Field Value PackageVersionRange PackageUpgrader public readonly PackageUpgrader PackageUpgrader Field Value PackageUpgrader Methods Clone() public PackageSession.PendingPackageUpgrade Clone() Returns PackageSession.PendingPackageUpgrade Equals(PendingPackageUpgrade?) Indicates whether the current object is equal to another object of the same type. public bool Equals(PackageSession.PendingPackageUpgrade? other) Parameters other PackageSession.PendingPackageUpgrade An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Determines whether the specified object is equal to the current object. public override bool Equals(object? obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false."
  },
  "api/Stride.Core.Assets.PackageSession.html": {
    "href": "api/Stride.Core.Assets.PackageSession.html",
    "title": "Class PackageSession | Stride API",
    "summary": "Class PackageSession Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A session for editing a package. public sealed class PackageSession : IDisposable, IAssetFinder Inheritance object PackageSession Implements IDisposable IAssetFinder Extension Methods PackageSessionExtensions.AddAssetToCompilePackage(PackageSession, AssetItem, Package) PackageSessionExtensions.CreateCompilePackageFromAsset(PackageSession, AssetItem) ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors PackageSession() Initializes a new instance of the PackageSession class. public PackageSession() PackageSession(Package) Initializes a new instance of the PackageSession class. public PackageSession(Package package) Parameters package Package Fields DefaultVisualStudioVersion The visual studio version property used for newly created project solution files public static readonly Version DefaultVisualStudioVersion Field Value Version Properties AssemblyContainer public AssemblyContainer AssemblyContainer { get; } Property Value AssemblyContainer CurrentProject Gets or sets the selected current package. public SolutionProject CurrentProject { get; set; } Property Value SolutionProject The selected current package. Exceptions InvalidOperationException Expecting a package that is already registered in this session DependencyManager Gets the dependency manager. public AssetDependencyManager DependencyManager { get; } Property Value AssetDependencyManager AssetDependencyManager. HasDependencyManager Gets a value indicating whether this instance has dependency manager. public bool HasDependencyManager { get; } Property Value bool true if this instance has dependency manager; otherwise, false. IsDirty public bool IsDirty { get; set; } Property Value bool LocalPackages Gets the user packages (excluding system packages). public IEnumerable<Package> LocalPackages { get; } Property Value IEnumerable<Package> The user packages. Packages Gets the packages referenced by the solution. public IReadOnlyPackageCollection Packages { get; } Property Value IReadOnlyPackageCollection The packages. Projects The projects referenced by the solution. public ProjectCollection Projects { get; } Property Value ProjectCollection SaveCompletion Gets a task that completes when the session is finished saving. public Task SaveCompletion { get; } Property Value Task SolutionPath Gets or sets the solution path (sln) in case the session was loaded from a solution. public UFile SolutionPath { get; set; } Property Value UFile The solution path. SourceTracker public AssetSourceTracker SourceTracker { get; } Property Value AssetSourceTracker VisualStudioVersion The targeted visual studio version (if specified by the loaded package) public Version? VisualStudioVersion { get; set; } Property Value Version Methods AddExistingPackage(Package, ILogger) Adds an existing package to the current session and runs the package analysis before adding it. public void AddExistingPackage(Package package, ILogger logger) Parameters package Package The package to add logger ILogger The logger AddExistingProject(UFile, ILogger, PackageLoadParameters?) Adds an existing package to the current session. public PackageContainer AddExistingProject(UFile projectPath, ILogger logger, PackageLoadParameters? loadParametersArg = null) Parameters projectPath UFile The project or package path. logger ILogger The session result. loadParametersArg PackageLoadParameters The load parameters argument. Returns PackageContainer Exceptions ArgumentNullException packagePath ArgumentException Invalid relative path. Expecting an absolute package path;packagePath FileNotFoundException Unable to find package Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() FindAsset(AssetId) Finds an asset by its identifier. public AssetItem? FindAsset(AssetId assetId) Parameters assetId AssetId The identifier of the asset. Returns AssetItem The corresponding AssetItem if found; otherwise, null. Remarks Looks for the asset amongst all the packages of this session. FindAsset(UFile) Finds an asset by its location. public AssetItem? FindAsset(UFile location) Parameters location UFile The location of the asset. Returns AssetItem The corresponding AssetItem if found; otherwise, null. Remarks Looks for the asset amongst all the packages of this session. FindAssetFromProxyObject(object?) Finds an asset from a proxy object. public AssetItem? FindAssetFromProxyObject(object? proxyObject) Parameters proxyObject object The proxy object which is represent the targeted asset. Returns AssetItem The corresponding AssetItem if found; otherwise, null. Remarks Looks for the asset amongst all the packages of this session. GetPackagesFromCurrent() Gets the packages referenced by the current package. public IEnumerable<Package> GetPackagesFromCurrent() Returns IEnumerable<Package> IEnumerable<Package>. Load(string, PackageLoadParameters?) Loads a package from specified file path. public static PackageSessionResult Load(string filePath, PackageLoadParameters? loadParameters = null) Parameters filePath string The file path to a package file. loadParameters PackageLoadParameters The load parameters. Returns PackageSessionResult A package. Exceptions ArgumentNullException filePath Load(string, PackageSessionResult, PackageLoadParameters?) Loads a package from specified file path. public static void Load(string filePath, PackageSessionResult sessionResult, PackageLoadParameters? loadParameters = null) Parameters filePath string The file path to a package file. sessionResult PackageSessionResult The session result. loadParameters PackageLoadParameters The load parameters. Exceptions ArgumentNullException filePath ArgumentException File [{0}] must exist.ToFormat(filePath);filePath LoadMissingAssets(ILogger, IEnumerable<Package>, PackageLoadParameters?) Make sure packages have their assets loaded. public void LoadMissingAssets(ILogger log, IEnumerable<Package> packages, PackageLoadParameters? loadParametersArg = null) Parameters log ILogger The log. packages IEnumerable<Package> The packages to try to load missing assets from. loadParametersArg PackageLoadParameters The load parameters argument. LoadMissingDependencies(ILogger, PackageLoadParameters?) Make sure packages have their dependencies loaded. public void LoadMissingDependencies(ILogger log, PackageLoadParameters? loadParametersArg = null) Parameters log ILogger The log. loadParametersArg PackageLoadParameters The load parameters argument. LoadMissingReferences(ILogger, PackageLoadParameters?) Make sure packages have their dependencies and assets loaded. public void LoadMissingReferences(ILogger log, PackageLoadParameters? loadParameters = null) Parameters log ILogger The log. loadParameters PackageLoadParameters The load parameters. Save(ILogger, PackageSaveParameters?) Saves all packages and assets. public void Save(ILogger log, PackageSaveParameters? saveParameters = null) Parameters log ILogger The LoggerResult in which to report result. saveParameters PackageSaveParameters The parameters for the save operation. UpdateAssemblyReferences(LoggerResult) Loads the assembly references that were not loaded before. public void UpdateAssemblyReferences(LoggerResult log) Parameters log LoggerResult The log. UpdateDependencies(SolutionProject, bool, bool) public static void UpdateDependencies(SolutionProject project, bool directDependencies, bool flattenedDependencies) Parameters project SolutionProject directDependencies bool flattenedDependencies bool Events AssetDirtyChanged public event DirtyFlagChangedDelegate<AssetItem> AssetDirtyChanged Event Type DirtyFlagChangedDelegate<AssetItem>"
  },
  "api/Stride.Core.Assets.PackageSessionExtensions.html": {
    "href": "api/Stride.Core.Assets.PackageSessionExtensions.html",
    "title": "Class PackageSessionExtensions | Stride API",
    "summary": "Class PackageSessionExtensions Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Extension methods for PackageSession. public static class PackageSessionExtensions Inheritance object PackageSessionExtensions Methods AddAssetToCompilePackage(PackageSession, AssetItem, Package) public static void AddAssetToCompilePackage(this PackageSession session, AssetItem originalAssetItem, Package assetPackageCloned) Parameters session PackageSession originalAssetItem AssetItem assetPackageCloned Package CreateCompilePackageFromAsset(PackageSession, AssetItem) Create a Package that can be used to compile an AssetItem by analyzing and resolving its dependencies. public static Package CreateCompilePackageFromAsset(this PackageSession session, AssetItem originalAssetItem) Parameters session PackageSession originalAssetItem AssetItem Returns Package The package packageSession that can be used to compile the asset item."
  },
  "api/Stride.Core.Assets.PackageSessionProfilingKeys.html": {
    "href": "api/Stride.Core.Assets.PackageSessionProfilingKeys.html",
    "title": "Class PackageSessionProfilingKeys | Stride API",
    "summary": "Class PackageSessionProfilingKeys Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Keys used for profiling the game class. public static class PackageSessionProfilingKeys Inheritance object PackageSessionProfilingKeys Fields Loading Profiling load of a session. public static readonly ProfilingKey Loading Field Value ProfilingKey Saving Profiling save of a session. public static readonly ProfilingKey Saving Field Value ProfilingKey Session public static readonly ProfilingKey Session Field Value ProfilingKey"
  },
  "api/Stride.Core.Assets.PackageSessionPublicHelper.html": {
    "href": "api/Stride.Core.Assets.PackageSessionPublicHelper.html",
    "title": "Class PackageSessionPublicHelper | Stride API",
    "summary": "Class PackageSessionPublicHelper Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Helper class to load/save a VisualStudio solution. public static class PackageSessionPublicHelper Inheritance object PackageSessionPublicHelper Properties NetMajorVersion The current major .NET version that Stride will use. public static int NetMajorVersion { get; } Property Value int Methods FindAndSetMSBuildVersion() This method finds a compatible version of MSBuild. public static void FindAndSetMSBuildVersion()"
  },
  "api/Stride.Core.Assets.PackageSessionResult.html": {
    "href": "api/Stride.Core.Assets.PackageSessionResult.html",
    "title": "Class PackageSessionResult | Stride API",
    "summary": "Class PackageSessionResult Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Result returned when loading a session using Load(string, PackageLoadParameters?) public sealed class PackageSessionResult : LoggerResult, ILogger, IProgressStatus Inheritance object Logger LoggerResult PackageSessionResult Implements ILogger IProgressStatus Inherited Members LoggerResult.ProgressChanged LoggerResult.Module LoggerResult.IsLoggingProgressAsInfo LoggerResult.Progress(string) LoggerResult.Progress(string, int, int) LoggerResult.Messages LoggerResult.CopyTo(ILogger) LoggerResult.ToText() Logger.MessageLogged Logger.MinimumLevelEnabled Logger.IsDebugEnabled Logger.IsVerboseEnabled Logger.HasErrors Logger.ActivateLog(LogMessageType, LogMessageType, bool) Logger.ActivateLog(LogMessageType, bool) Logger.Activated(LogMessageType) Logger.Log(ILogMessage) Logger.Verbose(string, Exception, CallerInfo) Logger.Verbose(string, CallerInfo) Logger.Debug(string, Exception, CallerInfo) Logger.Debug(string, CallerInfo) Logger.Info(string, Exception, CallerInfo) Logger.Info(string, CallerInfo) Logger.Warning(string, Exception, CallerInfo) Logger.Warning(string, CallerInfo) Logger.Error(string, Exception, CallerInfo) Logger.Error(string, CallerInfo) Logger.Fatal(string, Exception, CallerInfo) Logger.Fatal(string, CallerInfo) Extension Methods AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, IReference[], Exception?) AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, Exception?) AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, Exception?, params object?[]) AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, params object?[]) AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, Exception, params object?[]) AssetLoggerExtensions.Error(ILogger, Package?, IReference?, AssetMessageCode, params object?[]) AssetLoggerExtensions.Warning(ILogger, Package?, IReference?, AssetMessageCode) AssetLoggerExtensions.Warning(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?) AssetLoggerExtensions.Warning(ILogger, Package?, IReference?, AssetMessageCode, IEnumerable<IReference>?, params object?[]) AssetLoggerExtensions.Warning(ILogger, Package?, IReference?, AssetMessageCode, params object?[]) UnsafeUtilities.As<T>(object?) Properties OperationCancelled Gets or sets whether the operation has been cancelled by user. public bool OperationCancelled { get; set; } Property Value bool Session Gets or sets the loaded session. public PackageSession Session { get; } Property Value PackageSession The session. Methods Clear() Clears all messages. public override void Clear()"
  },
  "api/Stride.Core.Assets.PackageState.html": {
    "href": "api/Stride.Core.Assets.PackageState.html",
    "title": "Enum PackageState | Stride API",
    "summary": "Enum PackageState Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public enum PackageState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AssetsReady = 3 Assembly references and assets have all been loaded. DependenciesReady = 1 Dependencies have all been resolved and are also in DependenciesReady state. Raw = 0 Package has been deserialized. References and assets are not ready. UpgradeFailed = 2 Package upgrade has been failed (either error or denied by user). Dependencies are ready, but not assets. Should be manually switched back to DependenciesReady to try upgrade again."
  },
  "api/Stride.Core.Assets.PackageStore.html": {
    "href": "api/Stride.Core.Assets.PackageStore.html",
    "title": "Class PackageStore | Stride API",
    "summary": "Class PackageStore Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Manage packages locally installed and accessible on the store. public class PackageStore Inheritance object PackageStore Extension Methods UnsafeUtilities.As<T>(object?) Remarks This class is the frontend to the packaging/distribution system. It is currently using nuget for its packaging but may change in the future. Properties Instance Gets the default package manager. public static PackageStore Instance { get; } Property Value PackageStore A default instance. Methods FindLocalPackage(string, PackageVersionRange?, ConstraintProvider?, bool, bool) public NugetLocalPackage? FindLocalPackage(string packageName, PackageVersionRange? versionRange = null, ConstraintProvider? constraintProvider = null, bool allowPreleaseVersion = true, bool allowUnlisted = false) Parameters packageName string versionRange PackageVersionRange constraintProvider ConstraintProvider allowPreleaseVersion bool allowUnlisted bool Returns NugetLocalPackage GetPackageFileName(string, PackageVersionRange?, ConstraintProvider?, bool, bool) Gets the filename to the specific package packageName using the version versionRange if not null, otherwise the constraintProvider if specified. If no constraints are specified, the first entry if any are founds is used to get the filename. public UFile? GetPackageFileName(string packageName, PackageVersionRange? versionRange = null, ConstraintProvider? constraintProvider = null, bool allowPreleaseVersion = true, bool allowUnlisted = false) Parameters packageName string Name of the package. versionRange PackageVersionRange The version range. constraintProvider ConstraintProvider The package constraint provider. allowPreleaseVersion bool if set to true [allow prelease version]. allowUnlisted bool if set to true [allow unlisted]. Returns UFile A location on the disk to the specified package or null if not found. Exceptions ArgumentNullException packageName GetPackageWithFileName(string) Gets the filename to the specific package using just a package name. public UFile? GetPackageWithFileName(string packageName) Parameters packageName string Name of the package. Returns UFile A location on the disk to the specified package or null if not found. Exceptions ArgumentNullException packageName GetPackages() Gets the packages available online. public Task<IEnumerable<PackageMeta>> GetPackages() Returns Task<IEnumerable<PackageMeta>> IEnumerable<PackageMeta>. PackageMetaFromNugetPackage(NugetPackage) New instance of PackageMeta from a nuget package metadata. public static PackageMeta PackageMetaFromNugetPackage(NugetPackage metadata) Parameters metadata NugetPackage The nuget metadata used to initialized an instance of PackageMeta. Returns PackageMeta ToNugetManifest(PackageMeta, ManifestMetadata) public static void ToNugetManifest(PackageMeta meta, ManifestMetadata manifestMeta) Parameters meta PackageMeta manifestMeta ManifestMetadata"
  },
  "api/Stride.Core.Assets.PackageUpgradeRequestedAnswer.html": {
    "href": "api/Stride.Core.Assets.PackageUpgradeRequestedAnswer.html",
    "title": "Enum PackageUpgradeRequestedAnswer | Stride API",
    "summary": "Enum PackageUpgradeRequestedAnswer Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An enum representing the user answer to a package upgrade request. public enum PackageUpgradeRequestedAnswer Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields DoNotUpgrade = 2 The related package should not be upgraded. DoNotUpgradeAny = 3 The related package and all following packages should not be upgraded. Upgrade = 0 The related package should be upgraded. UpgradeAll = 1 The related package and all following packages should be upgraded."
  },
  "api/Stride.Core.Assets.PackageUpgrader.html": {
    "href": "api/Stride.Core.Assets.PackageUpgrader.html",
    "title": "Class PackageUpgrader | Stride API",
    "summary": "Class PackageUpgrader Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Offers a way for package to upgrade dependent packages. For example, if you write package A and Game1 depends on it, you might want to offer a new version of package A that would automatically perform some upgrades on Game1. public abstract class PackageUpgrader Inheritance object PackageUpgrader Extension Methods UnsafeUtilities.As<T>(object?) Properties Attribute public PackageUpgraderAttribute Attribute { get; } Property Value PackageUpgraderAttribute Methods Upgrade(PackageLoadParameters, PackageSession, ILogger, Package, PackageDependency, Package, IList<PackageLoadingAssetFile>) Performs the package migration, before assets are loaded public abstract bool Upgrade(PackageLoadParameters loadParameters, PackageSession session, ILogger log, Package dependentPackage, PackageDependency dependency, Package dependencyPackage, IList<PackageLoadingAssetFile> assetFiles) Parameters loadParameters PackageLoadParameters The load parameters. session PackageSession The session. log ILogger The log. dependentPackage Package The source package. dependency PackageDependency The dependency. dependencyPackage Package The dependency package. assetFiles IList<PackageLoadingAssetFile> The asset files. Returns bool UpgradeAfterAssetsLoaded(PackageLoadParameters, PackageSession, ILogger, Package, PackageDependency, Package, PackageVersionRange) Performs the second step of package migration, after assets have been loaded. public virtual bool UpgradeAfterAssetsLoaded(PackageLoadParameters loadParameters, PackageSession session, ILogger log, Package dependentPackage, PackageDependency dependency, Package dependencyPackage, PackageVersionRange dependencyVersionBeforeUpdate) Parameters loadParameters PackageLoadParameters The load parameters. session PackageSession The session. log ILogger The log. dependentPackage Package The source package. dependency PackageDependency The dependency. dependencyPackage Package The dependency package. dependencyVersionBeforeUpdate PackageVersionRange The version before the update. Returns bool UpgradeBeforeAssembliesLoaded(PackageLoadParameters, PackageSession, ILogger, Package, PackageDependency, Package) Performs a preprocessing step of package migration, before assembly references are loaded. public virtual bool UpgradeBeforeAssembliesLoaded(PackageLoadParameters loadParameters, PackageSession session, ILogger log, Package dependentPackage, PackageDependency dependency, Package dependencyPackage) Parameters loadParameters PackageLoadParameters The load parameters. session PackageSession The session. log ILogger The log. dependentPackage Package The source package. dependency PackageDependency The dependency. dependencyPackage Package The dependency package. Returns bool"
  },
  "api/Stride.Core.Assets.PackageUpgraderAttribute.html": {
    "href": "api/Stride.Core.Assets.PackageUpgraderAttribute.html",
    "title": "Class PackageUpgraderAttribute | Stride API",
    "summary": "Class PackageUpgraderAttribute Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Attribute that describes what a package upgrader can do. [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] [BaseTypeRequired(typeof(PackageUpgrader))] public class PackageUpgraderAttribute : Attribute Inheritance object Attribute PackageUpgraderAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageUpgraderAttribute(string[], string, string) public PackageUpgraderAttribute(string[] packageNames, string packageMinimumVersion, string packageUpdatedVersionRange) Parameters packageNames string[] packageMinimumVersion string packageUpdatedVersionRange string Properties PackageMinimumVersion public PackageVersion PackageMinimumVersion { get; } Property Value PackageVersion PackageNames public string[] PackageNames { get; } Property Value string[] UpdatedVersionRange public PackageVersionRange? UpdatedVersionRange { get; } Property Value PackageVersionRange"
  },
  "api/Stride.Core.Assets.PackageUserSettings.html": {
    "href": "api/Stride.Core.Assets.PackageUserSettings.html",
    "title": "Class PackageUserSettings | Stride API",
    "summary": "Class PackageUserSettings Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A class representing the user settings related to a Package. These settings are stored in a .user file along the package file. public class PackageUserSettings Inheritance object PackageUserSettings Extension Methods UnsafeUtilities.As<T>(object?) Fields SettingsContainer public static SettingsContainer SettingsContainer Field Value SettingsContainer Properties Profile public SettingsProfile Profile { get; } Property Value SettingsProfile Methods GetValue<T>(SettingsKey<T>) public T GetValue<T>(SettingsKey<T> key) Parameters key SettingsKey<T> Returns T Type Parameters T Save() public bool Save() Returns bool SetValue<T>(SettingsKey<T>, T) public void SetValue<T>(SettingsKey<T> key, T value) Parameters key SettingsKey<T> value T Type Parameters T"
  },
  "api/Stride.Core.Assets.PackageVersionRangeExtensions.html": {
    "href": "api/Stride.Core.Assets.PackageVersionRangeExtensions.html",
    "title": "Class PackageVersionRangeExtensions | Stride API",
    "summary": "Class PackageVersionRangeExtensions Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public static class PackageVersionRangeExtensions Inheritance object PackageVersionRangeExtensions Methods ToFilter(PackageVersionRange) public static Func<Package, bool> ToFilter(this PackageVersionRange versionInfo) Parameters versionInfo PackageVersionRange Returns Func<Package, bool>"
  },
  "api/Stride.Core.Assets.ProjectCollection.html": {
    "href": "api/Stride.Core.Assets.ProjectCollection.html",
    "title": "Class ProjectCollection | Stride API",
    "summary": "Class ProjectCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public sealed class ProjectCollection : ObservableCollection<PackageContainer>, IList<PackageContainer>, ICollection<PackageContainer>, IReadOnlyList<PackageContainer>, IReadOnlyCollection<PackageContainer>, IEnumerable<PackageContainer>, IList, ICollection, IEnumerable, INotifyCollectionChanged, INotifyPropertyChanged Inheritance object Collection<PackageContainer> ObservableCollection<PackageContainer> ProjectCollection Implements IList<PackageContainer> ICollection<PackageContainer> IReadOnlyList<PackageContainer> IReadOnlyCollection<PackageContainer> IEnumerable<PackageContainer> IList ICollection IEnumerable INotifyCollectionChanged INotifyPropertyChanged Inherited Members ObservableCollection<PackageContainer>.Move(int, int) ObservableCollection<PackageContainer>.CollectionChanged Collection<PackageContainer>.Add(PackageContainer) Collection<PackageContainer>.Clear() Collection<PackageContainer>.Contains(PackageContainer) Collection<PackageContainer>.CopyTo(PackageContainer[], int) Collection<PackageContainer>.GetEnumerator() Collection<PackageContainer>.IndexOf(PackageContainer) Collection<PackageContainer>.Insert(int, PackageContainer) Collection<PackageContainer>.Remove(PackageContainer) Collection<PackageContainer>.RemoveAt(int) Collection<PackageContainer>.Count Collection<PackageContainer>.this[int] Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Assets.ProjectReference.html": {
    "href": "api/Stride.Core.Assets.ProjectReference.html",
    "title": "Class ProjectReference | Stride API",
    "summary": "Class ProjectReference Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A reference to a Visual Studio project that is part of a Package [DataContract(\"ProjectReference\")] public sealed class ProjectReference : IEquatable<ProjectReference>, IIdentifiable Inheritance object ProjectReference Implements IEquatable<ProjectReference> IIdentifiable Extension Methods UnsafeUtilities.As<T>(object?) Constructors ProjectReference() Initializes a new instance of the ProjectReference class. public ProjectReference() Remarks This constructor is used only for serialization. ProjectReference(Guid, UFile, ProjectType) Initializes a new instance of the ProjectReference class. public ProjectReference(Guid id, UFile location, ProjectType type) Parameters id Guid The identifier. location UFile The location. type ProjectType The type. Properties Id Gets or sets the unique identifier of the VS project. [DataMember(10)] public Guid Id { get; set; } Property Value Guid The identifier. Remarks The setter should only be used during serialization. Location Gets or sets the location of the file on the disk. [DataMember(20)] public UFile Location { get; set; } Property Value UFile The location. Remarks The setter should only be used during serialization. RootNamespace Gets or set the root namespace of the project public string RootNamespace { get; } Property Value string Type Gets or sets the type of project. [DataMember(30)] public ProjectType Type { get; set; } Property Value ProjectType The type. Remarks The setter should only be used during serialization. Methods Equals(ProjectReference?) Indicates whether the current object is equal to another object of the same type. public bool Equals(ProjectReference? other) Parameters other ProjectReference An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Determines whether the specified object is equal to the current object. public override bool Equals(object? obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Operators operator ==(ProjectReference?, ProjectReference?) public static bool operator ==(ProjectReference? left, ProjectReference? right) Parameters left ProjectReference right ProjectReference Returns bool operator !=(ProjectReference?, ProjectReference?) public static bool operator !=(ProjectReference? left, ProjectReference? right) Parameters left ProjectReference right ProjectReference Returns bool"
  },
  "api/Stride.Core.Assets.ProjectSourceCodeAsset.html": {
    "href": "api/Stride.Core.Assets.ProjectSourceCodeAsset.html",
    "title": "Class ProjectSourceCodeAsset | Stride API",
    "summary": "Class ProjectSourceCodeAsset Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll [DataContract(\"ProjectSourceCodeAsset\")] public abstract class ProjectSourceCodeAsset : SourceCodeAsset, IProjectAsset Inheritance object Asset SourceCodeAsset ProjectSourceCodeAsset Implements IProjectAsset Derived ProjectSourceCodeWithFileGeneratorAsset Inherited Members SourceCodeAsset.TextAccessor SourceCodeAsset.InternalSerializableTextAccessor SourceCodeAsset.Text SourceCodeAsset.Save(Stream) SourceCodeAsset.GenerateIdFromLocation(string, string) Asset.Id Asset.SerializedVersion Asset.Tags Asset.Archetype Asset.MainSource Asset.CreateDerivedAsset(string) Asset.CreateDerivedAsset(string, out Dictionary<Guid, Guid>) Asset.ToString() Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Assets.ProjectSourceCodeWithFileGeneratorAsset.html": {
    "href": "api/Stride.Core.Assets.ProjectSourceCodeWithFileGeneratorAsset.html",
    "title": "Class ProjectSourceCodeWithFileGeneratorAsset | Stride API",
    "summary": "Class ProjectSourceCodeWithFileGeneratorAsset Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll [DataContract(\"ProjectSourceCodeWithFileGeneratorAsset\")] public abstract class ProjectSourceCodeWithFileGeneratorAsset : ProjectSourceCodeAsset, IProjectFileGeneratorAsset, IProjectAsset Inheritance object Asset SourceCodeAsset ProjectSourceCodeAsset ProjectSourceCodeWithFileGeneratorAsset Implements IProjectFileGeneratorAsset IProjectAsset Inherited Members SourceCodeAsset.TextAccessor SourceCodeAsset.InternalSerializableTextAccessor SourceCodeAsset.Text SourceCodeAsset.Save(Stream) SourceCodeAsset.GenerateIdFromLocation(string, string) Asset.Id Asset.SerializedVersion Asset.Tags Asset.Archetype Asset.MainSource Asset.CreateDerivedAsset(string) Asset.CreateDerivedAsset(string, out Dictionary<Guid, Guid>) Asset.ToString() Extension Methods UnsafeUtilities.As<T>(object?) Properties Generator [DataMember(Mask = 4026531840)] [Display(null, null, Browsable = false)] public abstract string Generator { get; } Property Value string Methods SaveGeneratedAsset(AssetItem) public abstract void SaveGeneratedAsset(AssetItem assetItem) Parameters assetItem AssetItem"
  },
  "api/Stride.Core.Assets.ProjectType.html": {
    "href": "api/Stride.Core.Assets.ProjectType.html",
    "title": "Enum ProjectType | Stride API",
    "summary": "Enum ProjectType Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Type of the project. [DataContract(\"ProjectType\")] public enum ProjectType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Executable = 1 An executable. Library = 0 A library."
  },
  "api/Stride.Core.Assets.PropertyCollection.html": {
    "href": "api/Stride.Core.Assets.PropertyCollection.html",
    "title": "Class PropertyCollection | Stride API",
    "summary": "Class PropertyCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A collection of properties. [DataContract(\"PropertyCollection\")] public sealed class PropertyCollection : ConcurrentDictionary<PropertyKey, object>, IDictionary<PropertyKey, object>, ICollection<KeyValuePair<PropertyKey, object>>, IReadOnlyDictionary<PropertyKey, object>, IReadOnlyCollection<KeyValuePair<PropertyKey, object>>, IEnumerable<KeyValuePair<PropertyKey, object>>, IDictionary, ICollection, IEnumerable Inheritance object ConcurrentDictionary<PropertyKey, object> PropertyCollection Implements IDictionary<PropertyKey, object> ICollection<KeyValuePair<PropertyKey, object>> IReadOnlyDictionary<PropertyKey, object> IReadOnlyCollection<KeyValuePair<PropertyKey, object>> IEnumerable<KeyValuePair<PropertyKey, object>> IDictionary ICollection IEnumerable Inherited Members ConcurrentDictionary<PropertyKey, object>.AddOrUpdate(PropertyKey, Func<PropertyKey, object>, Func<PropertyKey, object, object>) ConcurrentDictionary<PropertyKey, object>.AddOrUpdate(PropertyKey, object, Func<PropertyKey, object, object>) ConcurrentDictionary<PropertyKey, object>.AddOrUpdate<TArg>(PropertyKey, Func<PropertyKey, TArg, object>, Func<PropertyKey, object, TArg, object>, TArg) ConcurrentDictionary<PropertyKey, object>.Clear() ConcurrentDictionary<PropertyKey, object>.ContainsKey(PropertyKey) ConcurrentDictionary<PropertyKey, object>.GetAlternateLookup<TAlternateKey>() ConcurrentDictionary<PropertyKey, object>.GetEnumerator() ConcurrentDictionary<PropertyKey, object>.GetOrAdd(PropertyKey, Func<PropertyKey, object>) ConcurrentDictionary<PropertyKey, object>.GetOrAdd(PropertyKey, object) ConcurrentDictionary<PropertyKey, object>.GetOrAdd<TArg>(PropertyKey, Func<PropertyKey, TArg, object>, TArg) ConcurrentDictionary<PropertyKey, object>.ToArray() ConcurrentDictionary<PropertyKey, object>.TryAdd(PropertyKey, object) ConcurrentDictionary<PropertyKey, object>.TryGetAlternateLookup<TAlternateKey>(out ConcurrentDictionary<PropertyKey, object>.AlternateLookup<TAlternateKey>) ConcurrentDictionary<PropertyKey, object>.TryGetValue(PropertyKey, out object) ConcurrentDictionary<PropertyKey, object>.TryRemove(KeyValuePair<PropertyKey, object>) ConcurrentDictionary<PropertyKey, object>.TryRemove(PropertyKey, out object) ConcurrentDictionary<PropertyKey, object>.TryUpdate(PropertyKey, object, object) ConcurrentDictionary<PropertyKey, object>.Comparer ConcurrentDictionary<PropertyKey, object>.Count ConcurrentDictionary<PropertyKey, object>.IsEmpty ConcurrentDictionary<PropertyKey, object>.this[PropertyKey] ConcurrentDictionary<PropertyKey, object>.Keys ConcurrentDictionary<PropertyKey, object>.Values Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors PropertyCollection() Initializes a new instance of the PropertyCollection class. public PropertyCollection() PropertyCollection(IEnumerable<KeyValuePair<PropertyKey, object>>) Initializes a new instance of the PropertyCollection class. public PropertyCollection(IEnumerable<KeyValuePair<PropertyKey, object>> dictionary) Parameters dictionary IEnumerable<KeyValuePair<PropertyKey, object>> The dictionary. Methods CopyTo(IDictionary<PropertyKey, object>, bool) Copies this properties to a output dictionary. public void CopyTo(IDictionary<PropertyKey, object> properties, bool overrideValues) Parameters properties IDictionary<PropertyKey, object> The dictionary to receive a copy of the properties of this instance. overrideValues bool if set to true [override values]. Exceptions ArgumentNullException properties Get(PropertyKey) Gets a value for the specified key, null if not found. public object? Get(PropertyKey key) Parameters key PropertyKey The key. Returns object A value for the specified key, null if not found. Get<T>(PropertyKey<T>) Gets a value for the specified key, null if not found. public T? Get<T>(PropertyKey<T> key) Parameters key PropertyKey<T> The key. Returns T a value for the specified key, null if not found. Type Parameters T Type of the value Set(PropertyKey, object) Sets a value for the specified key. public void Set(PropertyKey key, object value) Parameters key PropertyKey The key. value object The value. Set<T>(PropertyKey<T>, T) Sets a value for the specified key. public void Set<T>(PropertyKey<T> key, T value) Parameters key PropertyKey<T> The key. value T The value. Type Parameters T Type of the value. TryGet<T>(PropertyKey<T>, out T) Gets a value for the specified key, null if not found. public bool TryGet<T>(PropertyKey<T> key, out T value) Parameters key PropertyKey<T> The key. value T The value. Returns bool A value for the specified key, null if not found. Type Parameters T Type of the value"
  },
  "api/Stride.Core.Assets.RawAsset.html": {
    "href": "api/Stride.Core.Assets.RawAsset.html",
    "title": "Class RawAsset | Stride API",
    "summary": "Class RawAsset Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A raw asset, an asset that is imported as-is. [DataContract(\"RawAsset\")] [AssetDescription(\".sdraw\")] [Display(1050, \"Raw Asset\", null)] public sealed class RawAsset : AssetWithSource, IAssetWithSource Inheritance object Asset AssetWithSource RawAsset Implements IAssetWithSource Inherited Members AssetWithSource.Source AssetWithSource.MainSource Asset.Id Asset.SerializedVersion Asset.Tags Asset.Archetype Asset.CreateDerivedAsset(string) Asset.CreateDerivedAsset(string, out Dictionary<Guid, Guid>) Asset.ToString() Extension Methods UnsafeUtilities.As<T>(object?) Constructors RawAsset() Initializes a new instance of the RawAsset class. public RawAsset() Fields FileExtension public const string FileExtension = \".sdraw\" Field Value string Properties Compress Gets or sets a value indicating whether this RawAsset will be compressed when compiled. public bool Compress { get; set; } Property Value bool true if this asset will be compressed when compiled; otherwise, false."
  },
  "api/Stride.Core.Assets.RawAssetImporter.html": {
    "href": "api/Stride.Core.Assets.RawAssetImporter.html",
    "title": "Class RawAssetImporter | Stride API",
    "summary": "Class RawAssetImporter Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public sealed class RawAssetImporter : RawAssetImporterBase<RawAsset>, IAssetImporter Inheritance object AssetImporterBase RawAssetImporterBase<RawAsset> RawAssetImporter Implements IAssetImporter Inherited Members RawAssetImporterBase<RawAsset>.RootAssetTypes RawAssetImporterBase<RawAsset>.Import(UFile, AssetImporterParameters) AssetImporterBase.Name AssetImporterBase.Order AssetImporterBase.AdditionalAssetTypes AssetImporterBase.GetDefaultParameters(bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors RawAssetImporter() public RawAssetImporter() Properties Description Gets the description of this importer. public override string Description { get; } Property Value string The description. Id Gets an unique identifier to identify the importer. See remarks. public override Guid Id { get; } Property Value Guid The identifier. Remarks This identifier is used to recover the importer used for a particular asset. This Guid must be unique and stored statically in the definition of an importer. It is used to reimport an existing asset with the same importer. SupportedFileExtensions Gets the supported file extensions (separated by ',' for multiple extensions) by this importer. This is used for display purpose only. The method IsSupportingFile(string) is used for matching extensions. public override string SupportedFileExtensions { get; } Property Value string Returns a list of supported file extensions handled by this importer. Methods IsSupportingFile(string) Determines whether this importer is supporting the specified file. public override bool IsSupportingFile(string filePath) Parameters filePath string The file path. Returns bool true if this importer is supporting the specified file; otherwise, false."
  },
  "api/Stride.Core.Assets.RawAssetImporterBase-1.html": {
    "href": "api/Stride.Core.Assets.RawAssetImporterBase-1.html",
    "title": "Class RawAssetImporterBase<TAsset> | Stride API",
    "summary": "Class RawAssetImporterBase<TAsset> Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public abstract class RawAssetImporterBase<TAsset> : AssetImporterBase, IAssetImporter where TAsset : Asset, IAssetWithSource, new() Type Parameters TAsset Inheritance object AssetImporterBase RawAssetImporterBase<TAsset> Implements IAssetImporter Derived RawAssetImporter Inherited Members AssetImporterBase.Id AssetImporterBase.Name AssetImporterBase.Description AssetImporterBase.Order AssetImporterBase.SupportedFileExtensions AssetImporterBase.IsSupportingFile(string) AssetImporterBase.AdditionalAssetTypes AssetImporterBase.GetDefaultParameters(bool) Extension Methods UnsafeUtilities.As<T>(object?) Properties RootAssetTypes Gets the types of asset that are mainly generated by this importer. public override sealed IEnumerable<Type> RootAssetTypes { get; } Property Value IEnumerable<Type> Methods Import(UFile, AssetImporterParameters) Imports a raw assets from the specified path into the specified package. public override sealed IEnumerable<AssetItem> Import(UFile rawAssetPath, AssetImporterParameters importParameters) Parameters rawAssetPath UFile The path to a raw asset on the disk. importParameters AssetImporterParameters The parameters. It is mandatory to call GetDefaultParameters(bool) and pass the parameters instance here Returns IEnumerable<AssetItem>"
  },
  "api/Stride.Core.Assets.RootAssetCollection.html": {
    "href": "api/Stride.Core.Assets.RootAssetCollection.html",
    "title": "Class RootAssetCollection | Stride API",
    "summary": "Class RootAssetCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll [DataSerializer(typeof(KeyedSortedListSerializer<RootAssetCollection, AssetId, AssetReference>))] public class RootAssetCollection : KeyedSortedList<AssetId, AssetReference>, ICollection<AssetReference>, IEnumerable<AssetReference>, ICollection, IEnumerable Inheritance object KeyedSortedList<AssetId, AssetReference> RootAssetCollection Implements ICollection<AssetReference> IEnumerable<AssetReference> ICollection IEnumerable Inherited Members KeyedSortedList<AssetId, AssetReference>.items KeyedSortedList<AssetId, AssetReference>.GetKeyForItem(AssetReference) KeyedSortedList<AssetId, AssetReference>.InsertItem(int, AssetReference) KeyedSortedList<AssetId, AssetReference>.RemoveItem(int) KeyedSortedList<AssetId, AssetReference>.Sort() KeyedSortedList<AssetId, AssetReference>.Add(AssetReference) KeyedSortedList<AssetId, AssetReference>.ContainsKey(AssetId) KeyedSortedList<AssetId, AssetReference>.Remove(AssetId) KeyedSortedList<AssetId, AssetReference>.this[int] KeyedSortedList<AssetId, AssetReference>.this[AssetId] KeyedSortedList<AssetId, AssetReference>.TryGetValue(AssetId, out AssetReference) KeyedSortedList<AssetId, AssetReference>.Clear() KeyedSortedList<AssetId, AssetReference>.Contains(AssetReference) KeyedSortedList<AssetId, AssetReference>.Count KeyedSortedList<AssetId, AssetReference>.IsReadOnly KeyedSortedList<AssetId, AssetReference>.IndexOf(AssetReference) KeyedSortedList<AssetId, AssetReference>.Remove(AssetReference) KeyedSortedList<AssetId, AssetReference>.GetEnumerator() KeyedSortedList<AssetId, AssetReference>.BinarySearch(AssetId) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods GetKeyForItem(AssetReference) Extracts the key for the specified element. protected override AssetId GetKeyForItem(AssetReference item) Parameters item AssetReference The element from which to extract the key. Returns AssetId The key for the specified item."
  },
  "api/Stride.Core.Assets.SearchDirection.html": {
    "href": "api/Stride.Core.Assets.SearchDirection.html",
    "title": "Enum SearchDirection | Stride API",
    "summary": "Enum SearchDirection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A direction to search for files in directories public enum SearchDirection Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Down = 0 Search files in all sub-directories. Up = 1 Searchg files going upward in the directory hierarchy."
  },
  "api/Stride.Core.Assets.Selectors.PathSelector.html": {
    "href": "api/Stride.Core.Assets.Selectors.PathSelector.html",
    "title": "Class PathSelector | Stride API",
    "summary": "Class PathSelector Namespace Stride.Core.Assets.Selectors Assembly Stride.Core.Assets.dll Matches asset depending on their URL, using a gitignore-like format (based on fnmatch()). [DataContract(\"PathSelector\")] public class PathSelector : AssetSelector Inheritance object AssetSelector PathSelector Extension Methods UnsafeUtilities.As<T>(object?) Constructors PathSelector() public PathSelector() Properties Paths Gets or sets the paths (gitignore format). public List<string> Paths { get; set; } Property Value List<string> The paths (gitignore format). Methods Select(PackageSession, IContentIndexMap) public override IEnumerable<string> Select(PackageSession packageSession, IContentIndexMap contentIndexMap) Parameters packageSession PackageSession contentIndexMap IContentIndexMap Returns IEnumerable<string>"
  },
  "api/Stride.Core.Assets.Selectors.TagSelector.html": {
    "href": "api/Stride.Core.Assets.Selectors.TagSelector.html",
    "title": "Class TagSelector | Stride API",
    "summary": "Class TagSelector Namespace Stride.Core.Assets.Selectors Assembly Stride.Core.Assets.dll An AssetSelector using tags stored in Tags [DataContract(\"TagSelector\")] public class TagSelector : AssetSelector Inheritance object AssetSelector TagSelector Extension Methods UnsafeUtilities.As<T>(object?) Properties Tags Gets the tags that will be used to select an asset. public TagCollection Tags { get; } Property Value TagCollection The tags. Methods Select(PackageSession, IContentIndexMap) public override IEnumerable<string> Select(PackageSession packageSession, IContentIndexMap contentIndexMap) Parameters packageSession PackageSession contentIndexMap IContentIndexMap Returns IEnumerable<string>"
  },
  "api/Stride.Core.Assets.Selectors.html": {
    "href": "api/Stride.Core.Assets.Selectors.html",
    "title": "Namespace Stride.Core.Assets.Selectors | Stride API",
    "summary": "Namespace Stride.Core.Assets.Selectors Classes PathSelector Matches asset depending on their URL, using a gitignore-like format (based on fnmatch()). TagSelector An AssetSelector using tags stored in Tags"
  },
  "api/Stride.Core.Assets.Serializers.AssetPartContainedAttribute.html": {
    "href": "api/Stride.Core.Assets.Serializers.AssetPartContainedAttribute.html",
    "title": "Class AssetPartContainedAttribute | Stride API",
    "summary": "Class AssetPartContainedAttribute Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll Changes rules on what types can be naturally contained inside a given member. All other types will be serialized as references. [AttributeUsage(AttributeTargets.Property|AttributeTargets.Field)] public class AssetPartContainedAttribute : Attribute Inheritance object Attribute AssetPartContainedAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetPartContainedAttribute(params Type[]) Initializes a new instance of the AssetPartContainedAttribute. public AssetPartContainedAttribute(params Type[] containedTypes) Parameters containedTypes Type[] The collection of asset part types that are naturally contained in the member having this attribute. Properties ContainedTypes Gets the types of asset part that will still be fully serialized if contained in a part of the member having this attribute. public Type[] ContainedTypes { get; } Property Value Type[]"
  },
  "api/Stride.Core.Assets.Serializers.ContentReferenceSerializer.html": {
    "href": "api/Stride.Core.Assets.Serializers.ContentReferenceSerializer.html",
    "title": "Class ContentReferenceSerializer | Stride API",
    "summary": "Class ContentReferenceSerializer Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll [YamlSerializerFactory(new string[] { \"Assets\" })] public class ContentReferenceSerializer : AssetScalarSerializerBase, IYamlSerializable, IYamlSerializableFactory, IDataCustomVisitor Inheritance object ScalarSerializerBase AssetScalarSerializerBase ContentReferenceSerializer Implements IYamlSerializable IYamlSerializableFactory IDataCustomVisitor Inherited Members AssetScalarSerializerBase.TryCreate(SerializerContext, ITypeDescriptor) AssetScalarSerializerBase.Visit(ref VisitorContext) ScalarSerializerBase.ReadYaml(ref ObjectContext) ScalarSerializerBase.WriteYaml(ref ObjectContext) ScalarSerializerBase.WriteScalar(ref ObjectContext, ScalarEventInfo) Extension Methods UnsafeUtilities.As<T>(object?) Fields Default public static readonly ContentReferenceSerializer Default Field Value ContentReferenceSerializer Methods CanVisit(Type) Determines whether this instance can visit the specified object. public override bool CanVisit(Type type) Parameters type Type Returns bool true if this instance can visit the specified object; otherwise, false. ConvertFrom(ref ObjectContext, Scalar) public override object ConvertFrom(ref ObjectContext context, Scalar fromScalar) Parameters context ObjectContext fromScalar Scalar Returns object ConvertTo(ref ObjectContext) public override string ConvertTo(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns string"
  },
  "api/Stride.Core.Assets.Serializers.FixupObjectReferences.html": {
    "href": "api/Stride.Core.Assets.Serializers.FixupObjectReferences.html",
    "title": "Class FixupObjectReferences | Stride API",
    "summary": "Class FixupObjectReferences Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll A static class that can be used to fix up object references. public static class FixupObjectReferences Inheritance object FixupObjectReferences Methods CollectReferenceableObjects(object, YamlAssetMetadata<Guid>, bool, ILogger?) public static Dictionary<Guid, IIdentifiable> CollectReferenceableObjects(object root, YamlAssetMetadata<Guid> objectReferences, bool throwOnDuplicateIds, ILogger? logger = null) Parameters root object objectReferences YamlAssetMetadata<Guid> throwOnDuplicateIds bool logger ILogger Returns Dictionary<Guid, IIdentifiable> FixupReferences(object, YamlAssetMetadata<Guid>, Dictionary<Guid, IIdentifiable>, bool, ILogger?) public static void FixupReferences(object root, YamlAssetMetadata<Guid> objectReferences, Dictionary<Guid, IIdentifiable> referenceTargets, bool clearMissingReferences, ILogger? logger = null) Parameters root object objectReferences YamlAssetMetadata<Guid> referenceTargets Dictionary<Guid, IIdentifiable> clearMissingReferences bool logger ILogger FixupReferences(object, YamlAssetMetadata<Guid>, Dictionary<Guid, IIdentifiable>, bool, Action<MemberPath, object, object?>, ILogger?) public static void FixupReferences(object root, YamlAssetMetadata<Guid> objectReferences, Dictionary<Guid, IIdentifiable> referenceTargets, bool clearMissingReferences, Action<MemberPath, object, object?> applyAction, ILogger? logger = null) Parameters root object objectReferences YamlAssetMetadata<Guid> referenceTargets Dictionary<Guid, IIdentifiable> clearMissingReferences bool applyAction Action<MemberPath, object, object> logger ILogger RunFixupPass(object, YamlAssetMetadata<Guid>, bool, bool, ILogger?) Fix up references represented by the objectReferences dictionary into the root object, by visiting the object to find all IIdentifiable instances it references, and modify the references described by objectReferences to point to the proper identifiable object matching the same Guid. public static void RunFixupPass(object root, YamlAssetMetadata<Guid> objectReferences, bool clearBrokenObjectReferences, bool throwOnDuplicateIds, ILogger? logger = null) Parameters root object The root object to fix up. objectReferences YamlAssetMetadata<Guid> The path to each object reference and the Guid of the tar clearBrokenObjectReferences bool If true, any object refernce that cannot be resolved will be reset to null. throwOnDuplicateIds bool If true, an exception will be thrown if two IIdentifiable logger ILogger An optional logger."
  },
  "api/Stride.Core.Assets.Serializers.IAssetPartReference.html": {
    "href": "api/Stride.Core.Assets.Serializers.IAssetPartReference.html",
    "title": "Interface IAssetPartReference | Stride API",
    "summary": "Interface IAssetPartReference Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll An interface representing a reference to an asset part that is used for serialization. public interface IAssetPartReference Extension Methods UnsafeUtilities.As<T>(object?) Properties InstanceType Gets or sets the actual type of object that is being deserialized. Type InstanceType { get; set; } Property Value Type Remarks This property is transient and used only during serialization. Therefore, implementations should have the DataMemberIgnoreAttribute set on this property. Methods FillFromPart(object) Fills properties of this object from the actual asset part being referenced. void FillFromPart(object assetPart) Parameters assetPart object The actual asset part being referenced. GenerateProxyPart(Type) Generates a proxy asset part from the information contained in this instance. object? GenerateProxyPart(Type partType) Parameters partType Type The type of asset part to generate. Returns object A proxy asset part built from this instance."
  },
  "api/Stride.Core.Assets.Serializers.IAssetSerializer.html": {
    "href": "api/Stride.Core.Assets.Serializers.IAssetSerializer.html",
    "title": "Interface IAssetSerializer | Stride API",
    "summary": "Interface IAssetSerializer Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll public interface IAssetSerializer Extension Methods UnsafeUtilities.As<T>(object?) Methods Load(Stream, UFile, ILogger?, bool, out bool, out AttachedYamlAssetMetadata) object Load(Stream stream, UFile filePath, ILogger? log, bool clearBrokenObjectReferences, out bool aliasOccurred, out AttachedYamlAssetMetadata yamlMetadata) Parameters stream Stream filePath UFile log ILogger clearBrokenObjectReferences bool aliasOccurred bool yamlMetadata AttachedYamlAssetMetadata Returns object Save(Stream, object, AttachedYamlAssetMetadata?, ILogger?) void Save(Stream stream, object asset, AttachedYamlAssetMetadata? yamlMetadata, ILogger? log = null) Parameters stream Stream asset object yamlMetadata AttachedYamlAssetMetadata log ILogger"
  },
  "api/Stride.Core.Assets.Serializers.IAssetSerializerFactory.html": {
    "href": "api/Stride.Core.Assets.Serializers.IAssetSerializerFactory.html",
    "title": "Interface IAssetSerializerFactory | Stride API",
    "summary": "Interface IAssetSerializerFactory Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll public interface IAssetSerializerFactory Extension Methods UnsafeUtilities.As<T>(object?) Methods TryCreate(string) IAssetSerializer? TryCreate(string assetFileExtension) Parameters assetFileExtension string Returns IAssetSerializer"
  },
  "api/Stride.Core.Assets.Serializers.IdentifiableAssetPartReference.html": {
    "href": "api/Stride.Core.Assets.Serializers.IdentifiableAssetPartReference.html",
    "title": "Class IdentifiableAssetPartReference | Stride API",
    "summary": "Class IdentifiableAssetPartReference Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll An implementation of IAssetPartReference that represents an asset part implementing IIdentifiable. [DataContract] [DataStyle(DataStyle.Compact)] public class IdentifiableAssetPartReference : IAssetPartReference Inheritance object IdentifiableAssetPartReference Implements IAssetPartReference Extension Methods UnsafeUtilities.As<T>(object?) Remarks This type is the default type used when AssetPartReferenceAttribute.ReferenceType is undefined. Properties Id Gets or sets the identifier of the asset part represented by this reference. public Guid Id { get; set; } Property Value Guid InstanceType Gets or sets the actual type of object that is being deserialized. public Type InstanceType { get; set; } Property Value Type Remarks This property is transient and used only during serialization. Therefore, implementations should have the DataMemberIgnoreAttribute set on this property. Methods FillFromPart(object) Fills properties of this object from the actual asset part being referenced. public void FillFromPart(object assetPart) Parameters assetPart object The actual asset part being referenced. GenerateProxyPart(Type) Generates a proxy asset part from the information contained in this instance. public object? GenerateProxyPart(Type partType) Parameters partType Type The type of asset part to generate. Returns object A proxy asset part built from this instance. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.Serializers.IdentifiableAssetPartReferenceSerializer.html": {
    "href": "api/Stride.Core.Assets.Serializers.IdentifiableAssetPartReferenceSerializer.html",
    "title": "Class IdentifiableAssetPartReferenceSerializer | Stride API",
    "summary": "Class IdentifiableAssetPartReferenceSerializer Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll [YamlSerializerFactory(new string[] { \"Assets\" })] public sealed class IdentifiableAssetPartReferenceSerializer : ScalarOrObjectSerializer, IYamlSerializableFactory, IYamlSerializable, IDataCustomVisitor Inheritance object ScalarOrObjectSerializer IdentifiableAssetPartReferenceSerializer Implements IYamlSerializableFactory IYamlSerializable IDataCustomVisitor Inherited Members ScalarOrObjectSerializer.TryCreate(SerializerContext, ITypeDescriptor) ScalarOrObjectSerializer.Visit(ref VisitorContext) ScalarOrObjectSerializer.ReadYaml(ref ObjectContext) ScalarOrObjectSerializer.WriteYaml(ref ObjectContext) Extension Methods UnsafeUtilities.As<T>(object?) Methods CanVisit(Type) Determines whether this instance can visit the specified object. public override bool CanVisit(Type type) Parameters type Type Returns bool true if this instance can visit the specified object; otherwise, false. ConvertFrom(ref ObjectContext, Scalar) public override object ConvertFrom(ref ObjectContext context, Scalar fromScalar) Parameters context ObjectContext fromScalar Scalar Returns object ConvertTo(ref ObjectContext) public override string ConvertTo(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns string"
  },
  "api/Stride.Core.Assets.Serializers.IdentifiableObjectSerializer.html": {
    "href": "api/Stride.Core.Assets.Serializers.IdentifiableObjectSerializer.html",
    "title": "Class IdentifiableObjectSerializer | Stride API",
    "summary": "Class IdentifiableObjectSerializer Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll A serializer for IIdentifiable instances, that can either serialize them directly or as an object reference. public sealed class IdentifiableObjectSerializer : ChainedSerializer, IYamlSerializable Inheritance object ChainedSerializer IdentifiableObjectSerializer Implements IYamlSerializable Inherited Members ChainedSerializer.Prev ChainedSerializer.Next ChainedSerializer.First ChainedSerializer.Last ChainedSerializer.FindPrevious<T>() ChainedSerializer.FindNext<T>() ChainedSerializer.Prepend(ChainedSerializer) ChainedSerializer.Append(ChainedSerializer) Extension Methods UnsafeUtilities.As<T>(object?) Fields Prefix public const string Prefix = \"ref!! \" Field Value string Methods ReadYaml(ref ObjectContext) Reads this object's state from a YAML parser. public override object ReadYaml(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns object A instance of the object deserialized from Yaml. TryCreate(SerializerContext, ITypeDescriptor) public IYamlSerializable? TryCreate(SerializerContext context, ITypeDescriptor typeDescriptor) Parameters context SerializerContext typeDescriptor ITypeDescriptor Returns IYamlSerializable Visit(ref VisitorContext) public void Visit(ref VisitorContext context) Parameters context VisitorContext WriteYaml(ref ObjectContext) Writes the specified object context to a YAML emitter. public override void WriteYaml(ref ObjectContext objectContext) Parameters objectContext ObjectContext The object context."
  },
  "api/Stride.Core.Assets.Serializers.InvariantObjectCloneSerializer-1.html": {
    "href": "api/Stride.Core.Assets.Serializers.InvariantObjectCloneSerializer-1.html",
    "title": "Class InvariantObjectCloneSerializer<T> | Stride API",
    "summary": "Class InvariantObjectCloneSerializer<T> Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll A fake serializer used for cloning invariant objects. Instead of actually cloning the invariant object, this serializer store it in a list of the context and restore when deserializing. [DataSerializerGlobal(typeof(InvariantObjectCloneSerializer<string>), null, DataSerializerGenericMode.None, false, false, Profile = \"AssetClone\")] public class InvariantObjectCloneSerializer<T> : DataSerializer<T> Type Parameters T Inheritance object DataSerializer DataSerializer<T> InvariantObjectCloneSerializer<T> Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Assets.Serializers.ScalarOrObjectSerializer.html": {
    "href": "api/Stride.Core.Assets.Serializers.ScalarOrObjectSerializer.html",
    "title": "Class ScalarOrObjectSerializer | Stride API",
    "summary": "Class ScalarOrObjectSerializer Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll Serializer that works with scalar, but could still read older ObjectSerializer format. public abstract class ScalarOrObjectSerializer : IYamlSerializableFactory, IYamlSerializable, IDataCustomVisitor Inheritance object ScalarOrObjectSerializer Implements IYamlSerializableFactory IYamlSerializable IDataCustomVisitor Derived IdentifiableAssetPartReferenceSerializer Extension Methods UnsafeUtilities.As<T>(object?) Constructors ScalarOrObjectSerializer() protected ScalarOrObjectSerializer() Methods CanVisit(Type) Determines whether this instance can visit the specified object. public abstract bool CanVisit(Type type) Parameters type Type Returns bool true if this instance can visit the specified object; otherwise, false. ConvertFrom(ref ObjectContext, Scalar) public abstract object ConvertFrom(ref ObjectContext context, Scalar fromScalar) Parameters context ObjectContext fromScalar Scalar Returns object ConvertTo(ref ObjectContext) public abstract string ConvertTo(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns string ReadYaml(ref ObjectContext) Reads this object's state from a YAML parser. public object ReadYaml(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns object A instance of the object deserialized from Yaml. ShouldSerializeAsScalar(ref ObjectContext) protected virtual bool ShouldSerializeAsScalar(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns bool TryCreate(SerializerContext, ITypeDescriptor) Try to create a Stride.Core.Yaml.Serialization.IYamlSerializable or return null if not supported for a particular .NET typeDescriptor. public IYamlSerializable? TryCreate(SerializerContext context, ITypeDescriptor typeDescriptor) Parameters context SerializerContext typeDescriptor ITypeDescriptor The typeDescriptor. Returns IYamlSerializable If supported, return an instance of Stride.Core.Yaml.Serialization.IYamlSerializable else return null. Visit(ref VisitorContext) Visits the specified object. public void Visit(ref VisitorContext context) Parameters context VisitorContext The context. WriteScalar(ref ObjectContext, ScalarEventInfo) protected virtual void WriteScalar(ref ObjectContext objectContext, ScalarEventInfo scalar) Parameters objectContext ObjectContext scalar ScalarEventInfo WriteYaml(ref ObjectContext) Writes the specified object context to a YAML emitter. public void WriteYaml(ref ObjectContext objectContext) Parameters objectContext ObjectContext The object context."
  },
  "api/Stride.Core.Assets.Serializers.YamlAssetProfile.html": {
    "href": "api/Stride.Core.Assets.Serializers.YamlAssetProfile.html",
    "title": "Class YamlAssetProfile | Stride API",
    "summary": "Class YamlAssetProfile Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll public static class YamlAssetProfile Inheritance object YamlAssetProfile Fields Name public const string Name = \"Assets\" Field Value string"
  },
  "api/Stride.Core.Assets.Serializers.YamlAssetSerializer.html": {
    "href": "api/Stride.Core.Assets.Serializers.YamlAssetSerializer.html",
    "title": "Class YamlAssetSerializer | Stride API",
    "summary": "Class YamlAssetSerializer Namespace Stride.Core.Assets.Serializers Assembly Stride.Core.Assets.dll Default serializer used for all Yaml content public class YamlAssetSerializer : IAssetSerializer, IAssetSerializerFactory Inheritance object YamlAssetSerializer Implements IAssetSerializer IAssetSerializerFactory Extension Methods UnsafeUtilities.As<T>(object?) Methods CreateAndProcessMetadata(PropertyContainer, object, bool, ILogger?) public static AttachedYamlAssetMetadata CreateAndProcessMetadata(PropertyContainer yamlPropertyContainer, object deserializedObject, bool clearBrokenObjectReferences, ILogger? log = null) Parameters yamlPropertyContainer PropertyContainer deserializedObject object clearBrokenObjectReferences bool log ILogger Returns AttachedYamlAssetMetadata Load(Stream, UFile, ILogger?, bool, out bool, out AttachedYamlAssetMetadata) public object Load(Stream stream, UFile filePath, ILogger? log, bool clearBrokenObjectReferences, out bool aliasOccurred, out AttachedYamlAssetMetadata yamlMetadata) Parameters stream Stream filePath UFile log ILogger clearBrokenObjectReferences bool aliasOccurred bool yamlMetadata AttachedYamlAssetMetadata Returns object Save(Stream, object, AttachedYamlAssetMetadata?, ILogger?) public void Save(Stream stream, object asset, AttachedYamlAssetMetadata? yamlMetadata, ILogger? log = null) Parameters stream Stream asset object yamlMetadata AttachedYamlAssetMetadata log ILogger TryCreate(string) public IAssetSerializer TryCreate(string assetFileExtension) Parameters assetFileExtension string Returns IAssetSerializer"
  },
  "api/Stride.Core.Assets.Serializers.html": {
    "href": "api/Stride.Core.Assets.Serializers.html",
    "title": "Namespace Stride.Core.Assets.Serializers | Stride API",
    "summary": "Namespace Stride.Core.Assets.Serializers Classes AssetPartContainedAttribute Changes rules on what types can be naturally contained inside a given member. All other types will be serialized as references. ContentReferenceSerializer FixupObjectReferences A static class that can be used to fix up object references. IdentifiableAssetPartReference An implementation of IAssetPartReference that represents an asset part implementing IIdentifiable. IdentifiableAssetPartReferenceSerializer IdentifiableObjectSerializer A serializer for IIdentifiable instances, that can either serialize them directly or as an object reference. InvariantObjectCloneSerializer<T> A fake serializer used for cloning invariant objects. Instead of actually cloning the invariant object, this serializer store it in a list of the context and restore when deserializing. ScalarOrObjectSerializer Serializer that works with scalar, but could still read older ObjectSerializer format. YamlAssetProfile YamlAssetSerializer Default serializer used for all Yaml content Interfaces IAssetPartReference An interface representing a reference to an asset part that is used for serialization. IAssetSerializer IAssetSerializerFactory"
  },
  "api/Stride.Core.Assets.SolutionConfiguration.html": {
    "href": "api/Stride.Core.Assets.SolutionConfiguration.html",
    "title": "Class SolutionConfiguration | Stride API",
    "summary": "Class SolutionConfiguration Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A solution configuration used by SolutionPlatform [DataContract(\"SolutionConfiguration\")] public class SolutionConfiguration Inheritance object SolutionConfiguration Extension Methods UnsafeUtilities.As<T>(object?) Constructors SolutionConfiguration(string) Initializes a new instance of the SolutionConfiguration class. public SolutionConfiguration(string name) Parameters name string Properties IsDebug Gets or sets a value indicating whether this instance is a debug configuration. public bool IsDebug { get; set; } Property Value bool true if this instance is debug; otherwise, false. Name Gets or sets the configuration name (e.g. Debug, Release) public string Name { get; init; } Property Value string The name. Properties Gets the additional msbuild properties for a specific configuration (Debug or Release) public List<string> Properties { get; } Property Value List<string> The msbuild configuration properties."
  },
  "api/Stride.Core.Assets.SolutionConfigurationCollection.html": {
    "href": "api/Stride.Core.Assets.SolutionConfigurationCollection.html",
    "title": "Class SolutionConfigurationCollection | Stride API",
    "summary": "Class SolutionConfigurationCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A collection of SolutionConfiguration [DataContract(\"SolutionConfigurationCollection\")] public class SolutionConfigurationCollection : KeyedCollection<string, SolutionConfiguration>, IList<SolutionConfiguration>, ICollection<SolutionConfiguration>, IReadOnlyList<SolutionConfiguration>, IReadOnlyCollection<SolutionConfiguration>, IEnumerable<SolutionConfiguration>, IList, ICollection, IEnumerable Inheritance object Collection<SolutionConfiguration> KeyedCollection<string, SolutionConfiguration> SolutionConfigurationCollection Implements IList<SolutionConfiguration> ICollection<SolutionConfiguration> IReadOnlyList<SolutionConfiguration> IReadOnlyCollection<SolutionConfiguration> IEnumerable<SolutionConfiguration> IList ICollection IEnumerable Inherited Members KeyedCollection<string, SolutionConfiguration>.ChangeItemKey(SolutionConfiguration, string) KeyedCollection<string, SolutionConfiguration>.ClearItems() KeyedCollection<string, SolutionConfiguration>.Contains(string) KeyedCollection<string, SolutionConfiguration>.GetKeyForItem(SolutionConfiguration) KeyedCollection<string, SolutionConfiguration>.InsertItem(int, SolutionConfiguration) KeyedCollection<string, SolutionConfiguration>.Remove(string) KeyedCollection<string, SolutionConfiguration>.RemoveItem(int) KeyedCollection<string, SolutionConfiguration>.SetItem(int, SolutionConfiguration) KeyedCollection<string, SolutionConfiguration>.TryGetValue(string, out SolutionConfiguration) KeyedCollection<string, SolutionConfiguration>.Comparer KeyedCollection<string, SolutionConfiguration>.Dictionary KeyedCollection<string, SolutionConfiguration>.this[string] Collection<SolutionConfiguration>.Add(SolutionConfiguration) Collection<SolutionConfiguration>.Clear() Collection<SolutionConfiguration>.ClearItems() Collection<SolutionConfiguration>.Contains(SolutionConfiguration) Collection<SolutionConfiguration>.CopyTo(SolutionConfiguration[], int) Collection<SolutionConfiguration>.GetEnumerator() Collection<SolutionConfiguration>.IndexOf(SolutionConfiguration) Collection<SolutionConfiguration>.Insert(int, SolutionConfiguration) Collection<SolutionConfiguration>.InsertItem(int, SolutionConfiguration) Collection<SolutionConfiguration>.Remove(SolutionConfiguration) Collection<SolutionConfiguration>.RemoveAt(int) Collection<SolutionConfiguration>.RemoveItem(int) Collection<SolutionConfiguration>.SetItem(int, SolutionConfiguration) Collection<SolutionConfiguration>.Count Collection<SolutionConfiguration>.this[int] Collection<SolutionConfiguration>.Items Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods GetKeyForItem(SolutionConfiguration) When implemented in a derived class, extracts the key from the specified element. protected override string GetKeyForItem(SolutionConfiguration item) Parameters item SolutionConfiguration The element from which to extract the key. Returns string The key for the specified element."
  },
  "api/Stride.Core.Assets.SolutionPlatform.html": {
    "href": "api/Stride.Core.Assets.SolutionPlatform.html",
    "title": "Class SolutionPlatform | Stride API",
    "summary": "Class SolutionPlatform Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Defines a solution platform. [DataContract(\"SolutionPlatform\")] public class SolutionPlatform : SolutionPlatformPart Inheritance object SolutionPlatformPart SolutionPlatform Inherited Members SolutionPlatformPart.Name SolutionPlatformPart.SolutionName SolutionPlatformPart.DisplayName SolutionPlatformPart.SafeSolutionName SolutionPlatformPart.Cpu SolutionPlatformPart.Alias SolutionPlatformPart.InheritConfigurations SolutionPlatformPart.Configurations SolutionPlatformPart.UseWithExecutables SolutionPlatformPart.UseWithLibraries SolutionPlatformPart.IncludeInSolution SolutionPlatformPart.LibraryProjectName SolutionPlatformPart.ExecutableProjectName SolutionPlatformPart.IsProjectHandled(ProjectType) SolutionPlatformPart.GetProjectName(ProjectType) Extension Methods UnsafeUtilities.As<T>(object?) Properties DefineConstants Gets the define constants that will be used by the csproj of the platform. [DataMember(40)] public List<string> DefineConstants { get; } Property Value List<string> The define constants. IsAvailable Gets or sets a value indicating whether this SolutionPlatform is available on this machine. [DataMember(50)] public bool IsAvailable { get; set; } Property Value bool true if available; otherwise, false. PlatformsPart Gets the alternative names that will appear in the .sln file equivalent to this platform. [DataMember(20)] public SolutionPlatformPartCollection PlatformsPart { get; } Property Value SolutionPlatformPartCollection The alternative names. RuntimeIdentifier Gets or sets the runtime identifier. [DataMember(35)] public string RuntimeIdentifier { get; set; } Property Value string The runtime identifier. TargetFramework Gets or sets the type of the platform. [DataMember(35)] public string TargetFramework { get; set; } Property Value string The type. Templates The list of templates. If empty, no choice will be given to user and default one will be created by concatening ProjectExecutable and Name. [DataMember(60)] public List<SolutionPlatformTemplate> Templates { get; } Property Value List<SolutionPlatformTemplate> Type Gets or sets the type of the platform. [DataMember(30)] public PlatformType Type { get; set; } Property Value PlatformType The type. Methods GetConfigurationProperties(SolutionPlatformPart, string) public IEnumerable<string> GetConfigurationProperties(SolutionPlatformPart part, string configuration) Parameters part SolutionPlatformPart configuration string Returns IEnumerable<string> GetParts() Gets the all SolutionPlatformPart. public IEnumerable<SolutionPlatformPart> GetParts() Returns IEnumerable<SolutionPlatformPart> IEnumerable<SolutionPlatformPart>. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.SolutionPlatformCollection.html": {
    "href": "api/Stride.Core.Assets.SolutionPlatformCollection.html",
    "title": "Class SolutionPlatformCollection | Stride API",
    "summary": "Class SolutionPlatformCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A collection of SolutionPlatform. public sealed class SolutionPlatformCollection : KeyedCollection<PlatformType, SolutionPlatform>, IList<SolutionPlatform>, ICollection<SolutionPlatform>, IReadOnlyList<SolutionPlatform>, IReadOnlyCollection<SolutionPlatform>, IEnumerable<SolutionPlatform>, IList, ICollection, IEnumerable Inheritance object Collection<SolutionPlatform> KeyedCollection<PlatformType, SolutionPlatform> SolutionPlatformCollection Implements IList<SolutionPlatform> ICollection<SolutionPlatform> IReadOnlyList<SolutionPlatform> IReadOnlyCollection<SolutionPlatform> IEnumerable<SolutionPlatform> IList ICollection IEnumerable Inherited Members KeyedCollection<PlatformType, SolutionPlatform>.Contains(PlatformType) KeyedCollection<PlatformType, SolutionPlatform>.Remove(PlatformType) KeyedCollection<PlatformType, SolutionPlatform>.TryGetValue(PlatformType, out SolutionPlatform) KeyedCollection<PlatformType, SolutionPlatform>.Comparer KeyedCollection<PlatformType, SolutionPlatform>.this[PlatformType] Collection<SolutionPlatform>.Add(SolutionPlatform) Collection<SolutionPlatform>.Clear() Collection<SolutionPlatform>.Contains(SolutionPlatform) Collection<SolutionPlatform>.CopyTo(SolutionPlatform[], int) Collection<SolutionPlatform>.GetEnumerator() Collection<SolutionPlatform>.IndexOf(SolutionPlatform) Collection<SolutionPlatform>.Insert(int, SolutionPlatform) Collection<SolutionPlatform>.Remove(SolutionPlatform) Collection<SolutionPlatform>.RemoveAt(int) Collection<SolutionPlatform>.Count Collection<SolutionPlatform>.this[int] Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods GetKeyForItem(SolutionPlatform) When implemented in a derived class, extracts the key from the specified element. protected override PlatformType GetKeyForItem(SolutionPlatform item) Parameters item SolutionPlatform The element from which to extract the key. Returns PlatformType The key for the specified element."
  },
  "api/Stride.Core.Assets.SolutionPlatformPart.html": {
    "href": "api/Stride.Core.Assets.SolutionPlatformPart.html",
    "title": "Class SolutionPlatformPart | Stride API",
    "summary": "Class SolutionPlatformPart Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Class SolutionAlternativePlatform. public class SolutionPlatformPart Inheritance object SolutionPlatformPart Derived SolutionPlatform Extension Methods UnsafeUtilities.As<T>(object?) Constructors SolutionPlatformPart() Initializes a new instance of the SolutionPlatformPart class. public SolutionPlatformPart() SolutionPlatformPart(string) Initializes a new instance of the SolutionPlatformPart class. public SolutionPlatformPart(string name) Parameters name string The name. Exceptions ArgumentNullException name Properties Alias Gets or sets the name of the alias. If != null, then this platform is only available in the solution and remapped to the platform with this Alias public string Alias { get; set; } Property Value string The name of the alias. Configurations Gets the configurations supported by this platform (by default contains 'Debug' and 'Release') public SolutionConfigurationCollection Configurations { get; } Property Value SolutionConfigurationCollection Cpu Gets or sets the CPU name, if this platform is CPU specific. public string Cpu { get; set; } Property Value string The CPU name. DisplayName Gets or sets the display name. If null, use the Name. public string DisplayName { get; set; } Property Value string The display name. ExecutableProjectName public string ExecutableProjectName { get; set; } Property Value string IncludeInSolution public bool IncludeInSolution { get; set; } Property Value bool InheritConfigurations Gets or sets a value indicating whether inherit configurations from parent SolutionPlatform public bool InheritConfigurations { get; set; } Property Value bool true if [inherit configurations]; otherwise, false. LibraryProjectName public string LibraryProjectName { get; set; } Property Value string Name Gets or sets the name of the alternative platform. public string Name { get; set; } Property Value string The name. SafeSolutionName Gets the name of the solution from SolutionName, using Name as a fallback. public string SafeSolutionName { get; } Property Value string The name of the safe solution. SolutionName Gets or sets the solution name. If null, use the Name public string SolutionName { get; set; } Property Value string The name. UseWithExecutables public bool UseWithExecutables { get; set; } Property Value bool UseWithLibraries public bool UseWithLibraries { get; set; } Property Value bool Methods GetProjectName(ProjectType) Gets the name of the project configuration from Alias, with SafeSolutionName as a fallback. public string GetProjectName(ProjectType projectType) Parameters projectType ProjectType Returns string The name of the safe solution. IsProjectHandled(ProjectType) Determines whether the project is handled by this platform. public bool IsProjectHandled(ProjectType projectType) Parameters projectType ProjectType Type of the project. Returns bool true if the project is handled by this platform; otherwise, false. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.SolutionPlatformPartCollection.html": {
    "href": "api/Stride.Core.Assets.SolutionPlatformPartCollection.html",
    "title": "Class SolutionPlatformPartCollection | Stride API",
    "summary": "Class SolutionPlatformPartCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A collection of SolutionPlatformPart [DataContract(\"SolutionPlatformPartCollection\")] public class SolutionPlatformPartCollection : KeyedCollection<string, SolutionPlatformPart>, IList<SolutionPlatformPart>, ICollection<SolutionPlatformPart>, IReadOnlyList<SolutionPlatformPart>, IReadOnlyCollection<SolutionPlatformPart>, IEnumerable<SolutionPlatformPart>, IList, ICollection, IEnumerable Inheritance object Collection<SolutionPlatformPart> KeyedCollection<string, SolutionPlatformPart> SolutionPlatformPartCollection Implements IList<SolutionPlatformPart> ICollection<SolutionPlatformPart> IReadOnlyList<SolutionPlatformPart> IReadOnlyCollection<SolutionPlatformPart> IEnumerable<SolutionPlatformPart> IList ICollection IEnumerable Inherited Members KeyedCollection<string, SolutionPlatformPart>.ChangeItemKey(SolutionPlatformPart, string) KeyedCollection<string, SolutionPlatformPart>.ClearItems() KeyedCollection<string, SolutionPlatformPart>.Contains(string) KeyedCollection<string, SolutionPlatformPart>.GetKeyForItem(SolutionPlatformPart) KeyedCollection<string, SolutionPlatformPart>.InsertItem(int, SolutionPlatformPart) KeyedCollection<string, SolutionPlatformPart>.Remove(string) KeyedCollection<string, SolutionPlatformPart>.RemoveItem(int) KeyedCollection<string, SolutionPlatformPart>.SetItem(int, SolutionPlatformPart) KeyedCollection<string, SolutionPlatformPart>.TryGetValue(string, out SolutionPlatformPart) KeyedCollection<string, SolutionPlatformPart>.Comparer KeyedCollection<string, SolutionPlatformPart>.Dictionary KeyedCollection<string, SolutionPlatformPart>.this[string] Collection<SolutionPlatformPart>.Add(SolutionPlatformPart) Collection<SolutionPlatformPart>.Clear() Collection<SolutionPlatformPart>.ClearItems() Collection<SolutionPlatformPart>.Contains(SolutionPlatformPart) Collection<SolutionPlatformPart>.CopyTo(SolutionPlatformPart[], int) Collection<SolutionPlatformPart>.GetEnumerator() Collection<SolutionPlatformPart>.IndexOf(SolutionPlatformPart) Collection<SolutionPlatformPart>.Insert(int, SolutionPlatformPart) Collection<SolutionPlatformPart>.InsertItem(int, SolutionPlatformPart) Collection<SolutionPlatformPart>.Remove(SolutionPlatformPart) Collection<SolutionPlatformPart>.RemoveAt(int) Collection<SolutionPlatformPart>.RemoveItem(int) Collection<SolutionPlatformPart>.SetItem(int, SolutionPlatformPart) Collection<SolutionPlatformPart>.Count Collection<SolutionPlatformPart>.this[int] Collection<SolutionPlatformPart>.Items Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods GetKeyForItem(SolutionPlatformPart) When implemented in a derived class, extracts the key from the specified element. protected override string GetKeyForItem(SolutionPlatformPart item) Parameters item SolutionPlatformPart The element from which to extract the key. Returns string The key for the specified element."
  },
  "api/Stride.Core.Assets.SolutionPlatformTemplate.html": {
    "href": "api/Stride.Core.Assets.SolutionPlatformTemplate.html",
    "title": "Class SolutionPlatformTemplate | Stride API",
    "summary": "Class SolutionPlatformTemplate Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Defines a custom project template for a SolutionPlatform. [DataContract(\"SolutionPlatformTemplate\")] public class SolutionPlatformTemplate Inheritance object SolutionPlatformTemplate Extension Methods UnsafeUtilities.As<T>(object?) Constructors SolutionPlatformTemplate(string, string) public SolutionPlatformTemplate(string templatePath, string displayName) Parameters templatePath string displayName string Properties DisplayName The display name, which will be shown to user when choosing template. public string DisplayName { get; set; } Property Value string TemplatePath The template path. public string TemplatePath { get; set; } Property Value string"
  },
  "api/Stride.Core.Assets.SolutionProject.html": {
    "href": "api/Stride.Core.Assets.SolutionProject.html",
    "title": "Class SolutionProject | Stride API",
    "summary": "Class SolutionProject Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class SolutionProject : PackageContainer Inheritance object PackageContainer SolutionProject Inherited Members PackageContainer.Session PackageContainer.Package PackageContainer.DirectDependencies PackageContainer.FlattenedDependencies PackageContainer.Save(ILogger, PackageSaveParameters) Extension Methods UnsafeUtilities.As<T>(object?) Constructors SolutionProject(Package) protected SolutionProject(Package package) Parameters package Package SolutionProject(Package, Project) public SolutionProject(Package package, Project vsProject) Parameters package Package vsProject Project SolutionProject(Package, Guid, string) public SolutionProject(Package package, Guid projectGuid, string fullPath) Parameters package Package projectGuid Guid fullPath string Properties AssemblyProcessorSerializationHashFile public string AssemblyProcessorSerializationHashFile { get; set; } Property Value string FullPath public UFile FullPath { get; } Property Value UFile Id public Guid Id { get; } Property Value Guid IsImplicitProject public bool IsImplicitProject { get; set; } Property Value bool Name public string Name { get; } Property Value string Platform public PlatformType Platform { get; set; } Property Value PlatformType TargetPath public string TargetPath { get; set; } Property Value string TrackDirectDependencies public bool TrackDirectDependencies { get; set; } Property Value bool Type public ProjectType Type { get; set; } Property Value ProjectType VSProject public Project VSProject { get; set; } Property Value Project Methods SavePackage() protected override void SavePackage() ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.SourceCodeAsset.html": {
    "href": "api/Stride.Core.Assets.SourceCodeAsset.html",
    "title": "Class SourceCodeAsset | Stride API",
    "summary": "Class SourceCodeAsset Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Class SourceCodeAsset. [DataContract(\"SourceCodeAsset\")] public abstract class SourceCodeAsset : Asset Inheritance object Asset SourceCodeAsset Derived ProjectSourceCodeAsset Inherited Members Asset.Id Asset.SerializedVersion Asset.Tags Asset.Archetype Asset.MainSource Asset.CreateDerivedAsset(string) Asset.CreateDerivedAsset(string, out Dictionary<Guid, Guid>) Asset.ToString() Extension Methods UnsafeUtilities.As<T>(object?) Properties InternalSerializableTextAccessor Used internally by serialization. [DataMember(DataMemberMode.Assign)] [Display(null, null, Browsable = false)] public ISerializableTextAccessor InternalSerializableTextAccessor { get; set; } Property Value ISerializableTextAccessor Text Gets the sourcecode text. [Display(null, null, Browsable = false)] public string Text { get; set; } Property Value string The sourcecode text. TextAccessor [Display(null, null, Browsable = false)] public ITextAccessor TextAccessor { get; set; } Property Value ITextAccessor Methods GenerateIdFromLocation(string, string) Generates a unique identifier from location. public static AssetId GenerateIdFromLocation(string packageName, string location) Parameters packageName string location string The location. Returns AssetId Guid. Save(Stream) Saves the content to a stream. public virtual void Save(Stream stream) Parameters stream Stream"
  },
  "api/Stride.Core.Assets.SourceFileMemberAttribute.html": {
    "href": "api/Stride.Core.Assets.SourceFileMemberAttribute.html",
    "title": "Class SourceFileMemberAttribute | Stride API",
    "summary": "Class SourceFileMemberAttribute Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll An attribute indicating whether a member of an asset represents the path to a source file for this asset. [AttributeUsage(AttributeTargets.Property|AttributeTargets.Field)] public sealed class SourceFileMemberAttribute : Attribute Inheritance object Attribute SourceFileMemberAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors SourceFileMemberAttribute(bool) Initializes a new instance of the SourceFileMemberAttribute class. public SourceFileMemberAttribute(bool updateAssetIfChanged) Parameters updateAssetIfChanged bool If true, the asset should be updated when the related source file changes. Properties Optional Gets or sets whether this source file is optional for the compilation of the asset. public bool Optional { get; set; } Property Value bool UpdateAssetIfChanged Gets whether the asset should be updated when the related source file changes. public bool UpdateAssetIfChanged { get; } Property Value bool"
  },
  "api/Stride.Core.Assets.StandalonePackage.html": {
    "href": "api/Stride.Core.Assets.StandalonePackage.html",
    "title": "Class StandalonePackage | Stride API",
    "summary": "Class StandalonePackage Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public class StandalonePackage : PackageContainer Inheritance object PackageContainer StandalonePackage Inherited Members PackageContainer.Session PackageContainer.Package PackageContainer.DirectDependencies PackageContainer.FlattenedDependencies PackageContainer.Save(ILogger, PackageSaveParameters) PackageContainer.SavePackage() Extension Methods UnsafeUtilities.As<T>(object?) Constructors StandalonePackage(Package) public StandalonePackage(Package package) Parameters package Package Properties Assemblies Optional list of assemblies to load, typically filled using NuGet. public List<string> Assemblies { get; } Property Value List<string> Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.StridePackagesToSkipUpgrade.html": {
    "href": "api/Stride.Core.Assets.StridePackagesToSkipUpgrade.html",
    "title": "Class StridePackagesToSkipUpgrade | Stride API",
    "summary": "Class StridePackagesToSkipUpgrade Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public static class StridePackagesToSkipUpgrade Inheritance object StridePackagesToSkipUpgrade Fields PackageNames public static string[] PackageNames Field Value string[]"
  },
  "api/Stride.Core.Assets.SupportedProgrammingLanguage.html": {
    "href": "api/Stride.Core.Assets.SupportedProgrammingLanguage.html",
    "title": "Class SupportedProgrammingLanguage | Stride API",
    "summary": "Class SupportedProgrammingLanguage Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Represents a programming language supported by the system. public record SupportedProgrammingLanguage : IEquatable<SupportedProgrammingLanguage> Inheritance object SupportedProgrammingLanguage Implements IEquatable<SupportedProgrammingLanguage> Extension Methods UnsafeUtilities.As<T>(object?) Constructors SupportedProgrammingLanguage(string, string) Represents a programming language supported by the system. public SupportedProgrammingLanguage(string Name, string Extension) Parameters Name string The name of the programming language. Extension string The associated project file extension. Properties Extension The associated project file extension. public string Extension { get; init; } Property Value string Name The name of the programming language. public string Name { get; init; } Property Value string"
  },
  "api/Stride.Core.Assets.SupportedProgrammingLanguages.html": {
    "href": "api/Stride.Core.Assets.SupportedProgrammingLanguages.html",
    "title": "Class SupportedProgrammingLanguages | Stride API",
    "summary": "Class SupportedProgrammingLanguages Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Provides a list of programming languages supported by the system. public static class SupportedProgrammingLanguages Inheritance object SupportedProgrammingLanguages Properties Languages Gets the list of supported programming languages. public static IReadOnlyList<SupportedProgrammingLanguage> Languages { get; } Property Value IReadOnlyList<SupportedProgrammingLanguage> A list of SupportedProgrammingLanguage objects. Remarks Use this list to check for supported programming languages when needed. The list is initialized with common programming languages and their respective project file extensions. Methods IsProjectExtensionSupported(string) Determines if a given project file extension is supported. public static bool IsProjectExtensionSupported(string extension) Parameters extension string The project file extension to check. Returns bool True if the extension is supported, otherwise false."
  },
  "api/Stride.Core.Assets.TagCollection.html": {
    "href": "api/Stride.Core.Assets.TagCollection.html",
    "title": "Class TagCollection | Stride API",
    "summary": "Class TagCollection Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll A collection of tags. [DataContract(\"TagCollection\")] public class TagCollection : List<string>, IList<string>, ICollection<string>, IReadOnlyList<string>, IReadOnlyCollection<string>, IEnumerable<string>, IList, ICollection, IEnumerable Inheritance object List<string> TagCollection Implements IList<string> ICollection<string> IReadOnlyList<string> IReadOnlyCollection<string> IEnumerable<string> IList ICollection IEnumerable Inherited Members List<string>.Add(string) List<string>.AddRange(IEnumerable<string>) List<string>.AsReadOnly() List<string>.BinarySearch(int, int, string, IComparer<string>) List<string>.BinarySearch(string) List<string>.BinarySearch(string, IComparer<string>) List<string>.Clear() List<string>.Contains(string) List<string>.ConvertAll<TOutput>(Converter<string, TOutput>) List<string>.CopyTo(int, string[], int, int) List<string>.CopyTo(string[]) List<string>.CopyTo(string[], int) List<string>.EnsureCapacity(int) List<string>.Exists(Predicate<string>) List<string>.Find(Predicate<string>) List<string>.FindAll(Predicate<string>) List<string>.FindIndex(int, int, Predicate<string>) List<string>.FindIndex(int, Predicate<string>) List<string>.FindIndex(Predicate<string>) List<string>.FindLast(Predicate<string>) List<string>.FindLastIndex(int, int, Predicate<string>) List<string>.FindLastIndex(int, Predicate<string>) List<string>.FindLastIndex(Predicate<string>) List<string>.ForEach(Action<string>) List<string>.GetEnumerator() List<string>.GetRange(int, int) List<string>.IndexOf(string) List<string>.IndexOf(string, int) List<string>.IndexOf(string, int, int) List<string>.Insert(int, string) List<string>.InsertRange(int, IEnumerable<string>) List<string>.LastIndexOf(string) List<string>.LastIndexOf(string, int) List<string>.LastIndexOf(string, int, int) List<string>.Remove(string) List<string>.RemoveAll(Predicate<string>) List<string>.RemoveAt(int) List<string>.RemoveRange(int, int) List<string>.Reverse() List<string>.Reverse(int, int) List<string>.Slice(int, int) List<string>.Sort() List<string>.Sort(IComparer<string>) List<string>.Sort(Comparison<string>) List<string>.Sort(int, int, IComparer<string>) List<string>.ToArray() List<string>.TrimExcess() List<string>.TrueForAll(Predicate<string>) List<string>.Capacity List<string>.Count List<string>.this[int] Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Assets.TemplateFolder.html": {
    "href": "api/Stride.Core.Assets.TemplateFolder.html",
    "title": "Class TemplateFolder | Stride API",
    "summary": "Class TemplateFolder Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Describes a template folder. [DataContract(\"TemplateFolder\")] public sealed class TemplateFolder Inheritance object TemplateFolder Extension Methods UnsafeUtilities.As<T>(object?) Constructors TemplateFolder() Initializes a new instance of the TemplateFolder class. public TemplateFolder() TemplateFolder(UDirectory) Initializes a new instance of the TemplateFolder class. public TemplateFolder(UDirectory path) Parameters path UDirectory The path. Properties Exclude Gets or sets the exclude pattern to exclude files from package archive. [DataMember(30)] public string? Exclude { get; set; } Property Value string The exclude. Files Gets or sets the files. [DataMember(40)] public List<UFile> Files { get; } Property Value List<UFile> The files. Group Gets or sets the group (used when building a package archive) [DataMember(20)] [UPath(UPathRelativeTo.None)] public UDirectory? Group { get; set; } Property Value UDirectory The group. Path Gets or sets the folder relative to the package where templates are available. [DataMember(10)] public UDirectory Path { get; set; } Property Value UDirectory The path."
  },
  "api/Stride.Core.Assets.Templates.AssetTemplateGeneratorParameters.html": {
    "href": "api/Stride.Core.Assets.Templates.AssetTemplateGeneratorParameters.html",
    "title": "Class AssetTemplateGeneratorParameters | Stride API",
    "summary": "Class AssetTemplateGeneratorParameters Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll public class AssetTemplateGeneratorParameters : PackageTemplateGeneratorParameters Inheritance object TemplateGeneratorParameters PackageTemplateGeneratorParameters AssetTemplateGeneratorParameters Inherited Members PackageTemplateGeneratorParameters.Package TemplateGeneratorParameters.Name TemplateGeneratorParameters.Id TemplateGeneratorParameters.Namespace TemplateGeneratorParameters.OutputDirectory TemplateGeneratorParameters.Description TemplateGeneratorParameters.Unattended TemplateGeneratorParameters.Logger TemplateGeneratorParameters.Tags TemplateGeneratorParameters.Validate() TemplateGeneratorParameters.GetTag<T>(PropertyKey<T>) TemplateGeneratorParameters.TryGetTag<T>(PropertyKey<T>) TemplateGeneratorParameters.HasTag<T>(PropertyKey<T>) TemplateGeneratorParameters.SetTag<T>(PropertyKey<T>, T) Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetTemplateGeneratorParameters(UDirectory, IEnumerable<UFile>?) public AssetTemplateGeneratorParameters(UDirectory targetLocation, IEnumerable<UFile>? sourceFiles = null) Parameters targetLocation UDirectory sourceFiles IEnumerable<UFile> Properties RequestSessionSave Indicates whether the session has to be saved after the asset template generator has completed. The default is false. public bool RequestSessionSave { get; set; } Property Value bool Remarks This is an out parameter that asset template generator should set if needed. SourceFiles public List<UFile> SourceFiles { get; } Property Value List<UFile> TargetLocation public UDirectory TargetLocation { get; } Property Value UDirectory Methods ValidateParameters() protected override void ValidateParameters()"
  },
  "api/Stride.Core.Assets.Templates.ITemplateGenerator-1.html": {
    "href": "api/Stride.Core.Assets.Templates.ITemplateGenerator-1.html",
    "title": "Interface ITemplateGenerator<TParameters> | Stride API",
    "summary": "Interface ITemplateGenerator<TParameters> Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll The interface to represent a template generator. public interface ITemplateGenerator<in TParameters> : ITemplateGenerator where TParameters : TemplateGeneratorParameters Type Parameters TParameters The type of parameters this generator uses. Inherited Members ITemplateGenerator.IsSupportingTemplate(TemplateDescription) Extension Methods UnsafeUtilities.As<T>(object?) Methods PrepareForRun(TParameters) Prepares this generator with the specified parameters. Task<bool> PrepareForRun(TParameters parameters) Parameters parameters TParameters The parameters for the template generator. Returns Task<bool> A task completing when the preparation is finished, with the result True if the preparation was successful, false otherwise. Remarks This method should be used to verify that the parameters are correct, and to ask user for additional information before running the template. Run(TParameters) Runs the generator with the given parameter. bool Run(TParameters parameters) Parameters parameters TParameters The parameters for the template generator. Returns bool True if the generation was successful, false otherwise. Remarks This method should work in unattended mode and should not ask user for information anymore."
  },
  "api/Stride.Core.Assets.Templates.ITemplateGenerator.html": {
    "href": "api/Stride.Core.Assets.Templates.ITemplateGenerator.html",
    "title": "Interface ITemplateGenerator | Stride API",
    "summary": "Interface ITemplateGenerator Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll The interface to represent a template generator. public interface ITemplateGenerator Extension Methods UnsafeUtilities.As<T>(object?) Methods IsSupportingTemplate(TemplateDescription) Determines whether this generator is supporting the specified template bool IsSupportingTemplate(TemplateDescription templateDescription) Parameters templateDescription TemplateDescription The template description. Returns bool true if this generator is supporting the specified template; otherwise, false."
  },
  "api/Stride.Core.Assets.Templates.PackageTemplateGeneratorParameters.html": {
    "href": "api/Stride.Core.Assets.Templates.PackageTemplateGeneratorParameters.html",
    "title": "Class PackageTemplateGeneratorParameters | Stride API",
    "summary": "Class PackageTemplateGeneratorParameters Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll public class PackageTemplateGeneratorParameters : TemplateGeneratorParameters Inheritance object TemplateGeneratorParameters PackageTemplateGeneratorParameters Derived AssetTemplateGeneratorParameters Inherited Members TemplateGeneratorParameters.Name TemplateGeneratorParameters.Id TemplateGeneratorParameters.Namespace TemplateGeneratorParameters.OutputDirectory TemplateGeneratorParameters.Description TemplateGeneratorParameters.Unattended TemplateGeneratorParameters.Logger TemplateGeneratorParameters.Tags TemplateGeneratorParameters.Validate() TemplateGeneratorParameters.GetTag<T>(PropertyKey<T>) TemplateGeneratorParameters.TryGetTag<T>(PropertyKey<T>) TemplateGeneratorParameters.HasTag<T>(PropertyKey<T>) TemplateGeneratorParameters.SetTag<T>(PropertyKey<T>, T) Extension Methods UnsafeUtilities.As<T>(object?) Constructors PackageTemplateGeneratorParameters() public PackageTemplateGeneratorParameters() PackageTemplateGeneratorParameters(TemplateGeneratorParameters, Package) public PackageTemplateGeneratorParameters(TemplateGeneratorParameters parameters, Package package) Parameters parameters TemplateGeneratorParameters package Package Properties Package Gets or sets the package in which to execute this template public Package Package { get; set; } Property Value Package The package. Methods ValidateParameters() protected override void ValidateParameters()"
  },
  "api/Stride.Core.Assets.Templates.RunGeneratorDelegate.html": {
    "href": "api/Stride.Core.Assets.Templates.RunGeneratorDelegate.html",
    "title": "Delegate RunGeneratorDelegate | Stride API",
    "summary": "Delegate RunGeneratorDelegate Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll public delegate bool RunGeneratorDelegate() Returns bool Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Assets.Templates.SessionTemplateGeneratorParameters.html": {
    "href": "api/Stride.Core.Assets.Templates.SessionTemplateGeneratorParameters.html",
    "title": "Class SessionTemplateGeneratorParameters | Stride API",
    "summary": "Class SessionTemplateGeneratorParameters Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll public sealed class SessionTemplateGeneratorParameters : TemplateGeneratorParameters Inheritance object TemplateGeneratorParameters SessionTemplateGeneratorParameters Inherited Members TemplateGeneratorParameters.Name TemplateGeneratorParameters.Id TemplateGeneratorParameters.Namespace TemplateGeneratorParameters.OutputDirectory TemplateGeneratorParameters.Description TemplateGeneratorParameters.Unattended TemplateGeneratorParameters.Logger TemplateGeneratorParameters.Tags TemplateGeneratorParameters.Validate() TemplateGeneratorParameters.GetTag<T>(PropertyKey<T>) TemplateGeneratorParameters.TryGetTag<T>(PropertyKey<T>) TemplateGeneratorParameters.HasTag<T>(PropertyKey<T>) TemplateGeneratorParameters.SetTag<T>(PropertyKey<T>, T) Extension Methods UnsafeUtilities.As<T>(object?) Properties Session Gets or sets the current session. public PackageSession Session { get; set; } Property Value PackageSession The session. Methods ValidateParameters() protected override void ValidateParameters()"
  },
  "api/Stride.Core.Assets.Templates.TemplateAssetDescription.html": {
    "href": "api/Stride.Core.Assets.Templates.TemplateAssetDescription.html",
    "title": "Class TemplateAssetDescription | Stride API",
    "summary": "Class TemplateAssetDescription Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll A template for creating assets. [DataContract(\"TemplateAsset\")] public class TemplateAssetDescription : TemplateDescription, IFileSynchronizable Inheritance object TemplateDescription TemplateAssetDescription Implements IFileSynchronizable Derived TemplateAssetFactoryDescription Inherited Members TemplateDescription.FileExtension TemplateDescription.Id TemplateDescription.Name TemplateDescription.Scope TemplateDescription.Order TemplateDescription.Group TemplateDescription.Icon TemplateDescription.Screenshots TemplateDescription.Description TemplateDescription.FullDescription TemplateDescription.DefaultOutputName TemplateDescription.Status TemplateDescription.IsDirty TemplateDescription.FullPath TemplateDescription.TemplateDirectory Extension Methods UnsafeUtilities.As<T>(object?) Properties AssetTypeName public string AssetTypeName { get; set; } Property Value string ImportSource public bool ImportSource { get; set; } Property Value bool RequireName public bool RequireName { get; set; } Property Value bool Methods GetAssetType() public Type GetAssetType() Returns Type GetSupportedExtensions() public FileExtensionCollection GetSupportedExtensions() Returns FileExtensionCollection"
  },
  "api/Stride.Core.Assets.Templates.TemplateAssetFactoryDescription.html": {
    "href": "api/Stride.Core.Assets.Templates.TemplateAssetFactoryDescription.html",
    "title": "Class TemplateAssetFactoryDescription | Stride API",
    "summary": "Class TemplateAssetFactoryDescription Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll [DataContract(\"TemplateAssetFactory\")] public class TemplateAssetFactoryDescription : TemplateAssetDescription, IFileSynchronizable Inheritance object TemplateDescription TemplateAssetDescription TemplateAssetFactoryDescription Implements IFileSynchronizable Inherited Members TemplateAssetDescription.AssetTypeName TemplateAssetDescription.RequireName TemplateAssetDescription.ImportSource TemplateAssetDescription.GetAssetType() TemplateAssetDescription.GetSupportedExtensions() TemplateDescription.FileExtension TemplateDescription.Id TemplateDescription.Name TemplateDescription.Scope TemplateDescription.Order TemplateDescription.Group TemplateDescription.Icon TemplateDescription.Screenshots TemplateDescription.Description TemplateDescription.FullDescription TemplateDescription.DefaultOutputName TemplateDescription.Status TemplateDescription.IsDirty TemplateDescription.FullPath TemplateDescription.TemplateDirectory Extension Methods UnsafeUtilities.As<T>(object?) Properties FactoryTypeName public string? FactoryTypeName { get; set; } Property Value string Methods GetFactory() public IAssetFactory<Asset>? GetFactory() Returns IAssetFactory<Asset>"
  },
  "api/Stride.Core.Assets.Templates.TemplateDescription.html": {
    "href": "api/Stride.Core.Assets.Templates.TemplateDescription.html",
    "title": "Class TemplateDescription | Stride API",
    "summary": "Class TemplateDescription Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll Description of a template generator that can be displayed in the GameStudio. [DataContract(\"Template\")] public class TemplateDescription : IFileSynchronizable Inheritance object TemplateDescription Implements IFileSynchronizable Derived TemplateAssetDescription TemplateSampleDescription Extension Methods UnsafeUtilities.As<T>(object?) Fields FileExtension The file extension used when loading/saving this template description. public const string FileExtension = \".sdtpl\" Field Value string Properties DefaultOutputName Gets or set the default name for the output package/library. [DataMember(45)] public string? DefaultOutputName { get; set; } Property Value string The default output name. Description Gets or sets the description. [DataMember(40)] public string? Description { get; set; } Property Value string The description. FullDescription Gets or sets a longer description. [DataMember(43)] public string? FullDescription { get; set; } Property Value string The longer description. FullPath Gets the full path on disk where this instance is stored. public UFile FullPath { get; set; } Property Value UFile The full path. Group Gets or sets the group. [DataMember(20)] public string? Group { get; set; } Property Value string The group. Icon Gets or sets the icon/bitmap. [DataMember(30)] public UFile? Icon { get; set; } Property Value UFile The icon. Id Gets or sets the unique identifier. [DataMember(0)] public Guid Id { get; set; } Property Value Guid The identifier. IsDirty Gets or sets a value indicating whether this instance is dirty. public bool IsDirty { get; set; } Property Value bool true if this instance is dirty; otherwise, false. Name Gets or sets the short name of this template [DataMember(10)] public string Name { get; set; } Property Value string The name. Order Gets or sets the order (lower value means higher order) [DataMember(17)] public int Order { get; set; } Property Value int The order. Scope Gets or sets the scope of this template. [DataMember(15)] public TemplateScope Scope { get; set; } Property Value TemplateScope The context. Screenshots Gets the screenshots. [DataMember(30)] public List<UFile> Screenshots { get; } Property Value List<UFile> The screenshots. Status Gets or sets the status. [DataMember(60)] public TemplateStatus Status { get; set; } Property Value TemplateStatus The status. TemplateDirectory Gets the directory from where this template was loaded public UDirectory? TemplateDirectory { get; } Property Value UDirectory The resource directory."
  },
  "api/Stride.Core.Assets.Templates.TemplateGeneratorBase-1.html": {
    "href": "api/Stride.Core.Assets.Templates.TemplateGeneratorBase-1.html",
    "title": "Class TemplateGeneratorBase<TParameters> | Stride API",
    "summary": "Class TemplateGeneratorBase<TParameters> Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll Base implementation for ITemplateGenerator and ITemplateGenerator<TParameters>. public abstract class TemplateGeneratorBase<TParameters> : ITemplateGenerator<TParameters>, ITemplateGenerator where TParameters : TemplateGeneratorParameters Type Parameters TParameters The type of parameters this generator uses. Inheritance object TemplateGeneratorBase<TParameters> Implements ITemplateGenerator<TParameters> ITemplateGenerator Extension Methods UnsafeUtilities.As<T>(object?) Methods IsSupportingTemplate(TemplateDescription) Determines whether this generator is supporting the specified template public abstract bool IsSupportingTemplate(TemplateDescription templateDescription) Parameters templateDescription TemplateDescription The template description. Returns bool true if this generator is supporting the specified template; otherwise, false. PrepareForRun(TParameters) Prepares this generator with the specified parameters. public abstract Task<bool> PrepareForRun(TParameters parameters) Parameters parameters TParameters The parameters for the template generator. Returns Task<bool> A task completing when the preparation is finished, with the result True if the preparation was successful, false otherwise. Remarks This method should be used to verify that the parameters are correct, and to ask user for additional information before running the template. Run(TParameters) Runs the generator with the given parameter. public abstract bool Run(TParameters parameters) Parameters parameters TParameters The parameters for the template generator. Returns bool True if the generation was successful, false otherwise. Remarks This method should work in unattended mode and should not ask user for information anymore."
  },
  "api/Stride.Core.Assets.Templates.TemplateGeneratorContext.html": {
    "href": "api/Stride.Core.Assets.Templates.TemplateGeneratorContext.html",
    "title": "Class TemplateGeneratorContext | Stride API",
    "summary": "Class TemplateGeneratorContext Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll Context that will be used to run the tempplate generator. public sealed class TemplateGeneratorContext Inheritance object TemplateGeneratorContext Extension Methods UnsafeUtilities.As<T>(object?) Constructors TemplateGeneratorContext(Package) Initializes a new instance of the TemplateGeneratorContext class. public TemplateGeneratorContext(Package package) Parameters package Package The package. TemplateGeneratorContext(PackageSession) Initializes a new instance of the TemplateGeneratorContext class. public TemplateGeneratorContext(PackageSession session) Parameters session PackageSession The session. Properties Package Gets or sets the current package (may be null) public Package? Package { get; } Property Value Package The package. Session Gets or sets the current session. public PackageSession Session { get; } Property Value PackageSession The session."
  },
  "api/Stride.Core.Assets.Templates.TemplateGeneratorParameters.html": {
    "href": "api/Stride.Core.Assets.Templates.TemplateGeneratorParameters.html",
    "title": "Class TemplateGeneratorParameters | Stride API",
    "summary": "Class TemplateGeneratorParameters Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll Parameters used by ITemplateGenerator<TParameters> public abstract class TemplateGeneratorParameters Inheritance object TemplateGeneratorParameters Derived PackageTemplateGeneratorParameters SessionTemplateGeneratorParameters Extension Methods UnsafeUtilities.As<T>(object?) Constructors TemplateGeneratorParameters() protected TemplateGeneratorParameters() TemplateGeneratorParameters(TemplateGeneratorParameters) protected TemplateGeneratorParameters(TemplateGeneratorParameters parameters) Parameters parameters TemplateGeneratorParameters Fields Tags Contains extra properties that can be consumed by template generators. public PropertyContainer Tags Field Value PropertyContainer Properties Description The actual template description. public TemplateDescription Description { get; set; } Property Value TemplateDescription Id Gets or sets the project ID used to generate the template. public Guid Id { get; set; } Property Value Guid The ID Logger Gets or sets the logger. public LoggerResult Logger { get; set; } Property Value LoggerResult The logger. Name Gets or sets the project name used to generate the template. public string Name { get; set; } Property Value string The name. Namespace Gets or sets the default namespace of this project. public string Namespace { get; set; } Property Value string The namespace. OutputDirectory Gets or sets the output directory. public UDirectory OutputDirectory { get; set; } Property Value UDirectory The output directory. Unattended Specifies if the template generator should run in unattended mode (no UI). public bool Unattended { get; set; } Property Value bool Methods GetTag<T>(PropertyKey<T>) Gets the tag corresponding to the given property key. This will fail if key doesn't exist. public T GetTag<T>(PropertyKey<T> key) Parameters key PropertyKey<T> The property key for which to retrieve the value. Returns T The value of the tag corresponding to the given property key. Type Parameters T The generic type of the property key. Exceptions KeyNotFoundException Tag not found in template generator parameters. HasTag<T>(PropertyKey<T>) public bool HasTag<T>(PropertyKey<T> key) Parameters key PropertyKey<T> Returns bool Type Parameters T SetTag<T>(PropertyKey<T>, T) public void SetTag<T>(PropertyKey<T> key, T value) Parameters key PropertyKey<T> value T Type Parameters T TryGetTag<T>(PropertyKey<T>) Gets the tag corresponding to the given property key if available, otherwise returns default value. public T? TryGetTag<T>(PropertyKey<T> key) Parameters key PropertyKey<T> The property key for which to retrieve the value. Returns T The value of the tag corresponding to the given property key if available, the default value of the property key otherwise. Type Parameters T The generic type of the property key. Validate() Validates this instance (all fields must be setup) public void Validate() ValidateParameters() protected virtual void ValidateParameters()"
  },
  "api/Stride.Core.Assets.Templates.TemplateManager.html": {
    "href": "api/Stride.Core.Assets.Templates.TemplateManager.html",
    "title": "Class TemplateManager | Stride API",
    "summary": "Class TemplateManager Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll Handle templates for creating Package, ProjectReference public class TemplateManager Inheritance object TemplateManager Extension Methods UnsafeUtilities.As<T>(object?) Methods FindTemplateGenerator<TParameters>(TemplateDescription) Finds a template generator supporting the specified template description public static ITemplateGenerator<TParameters>? FindTemplateGenerator<TParameters>(TemplateDescription description) where TParameters : TemplateGeneratorParameters Parameters description TemplateDescription The description. Returns ITemplateGenerator<TParameters> A template generator supporting the specified description or null if not found. Type Parameters TParameters FindTemplateGenerator<TParameters>(TParameters) Finds a template generator supporting the specified template description public static ITemplateGenerator<TParameters>? FindTemplateGenerator<TParameters>(TParameters parameters) where TParameters : TemplateGeneratorParameters Parameters parameters TParameters The parameters. Returns ITemplateGenerator<TParameters> A template generator supporting the specified description or null if not found. Type Parameters TParameters FindTemplates(PackageSession?) Finds all template descriptions. public static IEnumerable<TemplateDescription> FindTemplates(PackageSession? session = null) Parameters session PackageSession Returns IEnumerable<TemplateDescription> A sequence containing all registered template descriptions. FindTemplates(TemplateScope, PackageSession?) Finds template descriptions that match the given scope. public static IEnumerable<TemplateDescription> FindTemplates(TemplateScope scope, PackageSession? session = null) Parameters scope TemplateScope session PackageSession Returns IEnumerable<TemplateDescription> A sequence containing all registered template descriptions that match the given scope. Register(ITemplateGenerator) Registers the specified factory. public static void Register(ITemplateGenerator generator) Parameters generator ITemplateGenerator The factory. Exceptions ArgumentNullException factory RegisterPackage(Package) public static void RegisterPackage(Package package) Parameters package Package Unregister(ITemplateGenerator) Unregisters the specified factory. public static void Unregister(ITemplateGenerator generator) Parameters generator ITemplateGenerator The factory. Exceptions ArgumentNullException factory"
  },
  "api/Stride.Core.Assets.Templates.TemplateSampleDescription.html": {
    "href": "api/Stride.Core.Assets.Templates.TemplateSampleDescription.html",
    "title": "Class TemplateSampleDescription | Stride API",
    "summary": "Class TemplateSampleDescription Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll A template for using an existing package as a template, expecting a Package to be accessible from FullPath with the same name as this template. [DataContract(\"TemplateSample\")] public class TemplateSampleDescription : TemplateDescription, IFileSynchronizable Inheritance object TemplateDescription TemplateSampleDescription Implements IFileSynchronizable Inherited Members TemplateDescription.FileExtension TemplateDescription.Id TemplateDescription.Name TemplateDescription.Scope TemplateDescription.Order TemplateDescription.Group TemplateDescription.Icon TemplateDescription.Screenshots TemplateDescription.Description TemplateDescription.FullDescription TemplateDescription.DefaultOutputName TemplateDescription.Status TemplateDescription.IsDirty TemplateDescription.FullPath TemplateDescription.TemplateDirectory Extension Methods UnsafeUtilities.As<T>(object?) Properties PatternName Gets or sets the name of the pattern used to substitute files and content. If null, use the DefaultOutputName. [DataMember(70)] public string? PatternName { get; set; } Property Value string The name of the pattern."
  },
  "api/Stride.Core.Assets.Templates.TemplateScope.html": {
    "href": "api/Stride.Core.Assets.Templates.TemplateScope.html",
    "title": "Enum TemplateScope | Stride API",
    "summary": "Enum TemplateScope Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll Describes if a template is supporting a particular context [DataContract(\"TemplateScope\")] public enum TemplateScope Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Asset = 2 The template can be applied to certain types of Assets Asset. Package = 1 The template can be applied to an existing Package. Session = 0 The template can be applied to an existing PackageSession."
  },
  "api/Stride.Core.Assets.Templates.TemplateStatus.html": {
    "href": "api/Stride.Core.Assets.Templates.TemplateStatus.html",
    "title": "Enum TemplateStatus | Stride API",
    "summary": "Enum TemplateStatus Namespace Stride.Core.Assets.Templates Assembly Stride.Core.Assets.dll Status of the template public enum TemplateStatus Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields New = 1 The template is new None = 0 Nothing particular. Updated = 2 The template has been updated"
  },
  "api/Stride.Core.Assets.Templates.html": {
    "href": "api/Stride.Core.Assets.Templates.html",
    "title": "Namespace Stride.Core.Assets.Templates | Stride API",
    "summary": "Namespace Stride.Core.Assets.Templates Classes AssetTemplateGeneratorParameters PackageTemplateGeneratorParameters SessionTemplateGeneratorParameters TemplateAssetDescription A template for creating assets. TemplateAssetFactoryDescription TemplateDescription Description of a template generator that can be displayed in the GameStudio. TemplateGeneratorBase<TParameters> Base implementation for ITemplateGenerator and ITemplateGenerator<TParameters>. TemplateGeneratorContext Context that will be used to run the tempplate generator. TemplateGeneratorParameters Parameters used by ITemplateGenerator<TParameters> TemplateManager Handle templates for creating Package, ProjectReference TemplateSampleDescription A template for using an existing package as a template, expecting a Package to be accessible from FullPath with the same name as this template. Interfaces ITemplateGenerator The interface to represent a template generator. ITemplateGenerator<TParameters> The interface to represent a template generator. Enums TemplateScope Describes if a template is supporting a particular context TemplateStatus Status of the template Delegates RunGeneratorDelegate"
  },
  "api/Stride.Core.Assets.TextAccessors.DefaultTextAccessor.html": {
    "href": "api/Stride.Core.Assets.TextAccessors.DefaultTextAccessor.html",
    "title": "Class DefaultTextAccessor | Stride API",
    "summary": "Class DefaultTextAccessor Namespace Stride.Core.Assets.TextAccessors Assembly Stride.Core.Assets.dll public class DefaultTextAccessor : ITextAccessor Inheritance object DefaultTextAccessor Implements ITextAccessor Extension Methods UnsafeUtilities.As<T>(object?) Properties FilePath public string? FilePath { get; } Property Value string Methods Get() Gets the underlying text. public string Get() Returns string GetSerializableVersion() public ISerializableTextAccessor GetSerializableVersion() Returns ISerializableTextAccessor Save(Stream) Writes the text to the given StreamWriter. public Task Save(Stream stream) Parameters stream Stream Returns Task Set(string?) Sets the underlying text. public void Set(string? value) Parameters value string"
  },
  "api/Stride.Core.Assets.TextAccessors.FileTextAccessor.html": {
    "href": "api/Stride.Core.Assets.TextAccessors.FileTextAccessor.html",
    "title": "Class FileTextAccessor | Stride API",
    "summary": "Class FileTextAccessor Namespace Stride.Core.Assets.TextAccessors Assembly Stride.Core.Assets.dll [DataContract] public class FileTextAccessor : ISerializableTextAccessor Inheritance object FileTextAccessor Implements ISerializableTextAccessor Extension Methods UnsafeUtilities.As<T>(object?) Properties FilePath [DataMember] public string? FilePath { get; set; } Property Value string Methods Create() public ITextAccessor Create() Returns ITextAccessor"
  },
  "api/Stride.Core.Assets.TextAccessors.ISerializableTextAccessor.html": {
    "href": "api/Stride.Core.Assets.TextAccessors.ISerializableTextAccessor.html",
    "title": "Interface ISerializableTextAccessor | Stride API",
    "summary": "Interface ISerializableTextAccessor Namespace Stride.Core.Assets.TextAccessors Assembly Stride.Core.Assets.dll public interface ISerializableTextAccessor Extension Methods UnsafeUtilities.As<T>(object?) Methods Create() ITextAccessor Create() Returns ITextAccessor"
  },
  "api/Stride.Core.Assets.TextAccessors.ITextAccessor.html": {
    "href": "api/Stride.Core.Assets.TextAccessors.ITextAccessor.html",
    "title": "Interface ITextAccessor | Stride API",
    "summary": "Interface ITextAccessor Namespace Stride.Core.Assets.TextAccessors Assembly Stride.Core.Assets.dll public interface ITextAccessor Extension Methods UnsafeUtilities.As<T>(object?) Methods Get() Gets the underlying text. string Get() Returns string GetSerializableVersion() ISerializableTextAccessor GetSerializableVersion() Returns ISerializableTextAccessor Save(Stream) Writes the text to the given StreamWriter. Task Save(Stream streamWriter) Parameters streamWriter Stream Returns Task Set(string) Sets the underlying text. void Set(string value) Parameters value string"
  },
  "api/Stride.Core.Assets.TextAccessors.StringTextAccessor.html": {
    "href": "api/Stride.Core.Assets.TextAccessors.StringTextAccessor.html",
    "title": "Class StringTextAccessor | Stride API",
    "summary": "Class StringTextAccessor Namespace Stride.Core.Assets.TextAccessors Assembly Stride.Core.Assets.dll [DataContract] public class StringTextAccessor : ISerializableTextAccessor Inheritance object StringTextAccessor Implements ISerializableTextAccessor Extension Methods UnsafeUtilities.As<T>(object?) Properties Text [DataMember] public string? Text { get; set; } Property Value string Methods Create() public ITextAccessor Create() Returns ITextAccessor"
  },
  "api/Stride.Core.Assets.TextAccessors.html": {
    "href": "api/Stride.Core.Assets.TextAccessors.html",
    "title": "Namespace Stride.Core.Assets.TextAccessors | Stride API",
    "summary": "Namespace Stride.Core.Assets.TextAccessors Classes DefaultTextAccessor FileTextAccessor StringTextAccessor Interfaces ISerializableTextAccessor ITextAccessor"
  },
  "api/Stride.Core.Assets.Tracking.AssetSourceTracker.html": {
    "href": "api/Stride.Core.Assets.Tracking.AssetSourceTracker.html",
    "title": "Class AssetSourceTracker | Stride API",
    "summary": "Class AssetSourceTracker Namespace Stride.Core.Assets.Tracking Assembly Stride.Core.Assets.dll public sealed class AssetSourceTracker : IDisposable Inheritance object AssetSourceTracker Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties EnableTracking Gets or sets a value indicating whether this instance should track file disk changed events. Default is false public bool EnableTracking { get; set; } Property Value bool true if this instance should track file disk changed events; otherwise, false. IsTrackingPaused Gets or sets a value indicating whether this instance is processing tracking events or it is paused. Default is false. public bool IsTrackingPaused { get; set; } Property Value bool true if this instance is tracking paused; otherwise, false. SourceFileChanged Gets a source dataflow block in which notifications that a source file has changed are pushed. public BroadcastBlock<IReadOnlyList<SourceFileChangedData>> SourceFileChanged { get; } Property Value BroadcastBlock<IReadOnlyList<SourceFileChangedData>> TrackingSleepTime Gets or sets the number of ms the file tracker should sleep before checking changes. Default is 1000ms. public int TrackingSleepTime { get; set; } Property Value int The tracking sleep time. Methods BeginSavingSession() public void BeginSavingSession() Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() EndSavingSession() public void EndSavingSession() GetCurrentHash(UFile) public ObjectId GetCurrentHash(UFile file) Parameters file UFile Returns ObjectId"
  },
  "api/Stride.Core.Assets.Tracking.SourceFileChangeType.html": {
    "href": "api/Stride.Core.Assets.Tracking.SourceFileChangeType.html",
    "title": "Enum SourceFileChangeType | Stride API",
    "summary": "Enum SourceFileChangeType Namespace Stride.Core.Assets.Tracking Assembly Stride.Core.Assets.dll Describes a change related to the source files used by an asset. public enum SourceFileChangeType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Asset = 0 The change occurred in an asset that now has a different list of source files. SourceFile = 1 The change occurred in an source file that has been modified externally."
  },
  "api/Stride.Core.Assets.Tracking.SourceFileChangedData.html": {
    "href": "api/Stride.Core.Assets.Tracking.SourceFileChangedData.html",
    "title": "Struct SourceFileChangedData | Stride API",
    "summary": "Struct SourceFileChangedData Namespace Stride.Core.Assets.Tracking Assembly Stride.Core.Assets.dll Data structure for the SourceFileChanged block. public struct SourceFileChangedData Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors SourceFileChangedData(SourceFileChangeType, AssetId, IReadOnlyList<UFile>, bool) Initializes a new instance of the SourceFileChangedData structure. public SourceFileChangedData(SourceFileChangeType type, AssetId assetId, IReadOnlyList<UFile> files, bool needUpdate) Parameters type SourceFileChangeType The type of change that occurred. assetId AssetId The id of the asset affected by this change. files IReadOnlyList<UFile> The list of files that changed. needUpdate bool Indicate whether the asset needs to be updated from its sources due to this change. Properties AssetId Gets the id of the asset affected by this change. public readonly AssetId AssetId { get; } Property Value AssetId Files Gets the list of files that changed public readonly IReadOnlyList<UFile> Files { get; } Property Value IReadOnlyList<UFile> NeedUpdate Gets whether the asset needs to be updated from its sources due to this change. public readonly bool NeedUpdate { get; } Property Value bool Type Gets the type of change that occurred. public readonly SourceFileChangeType Type { get; } Property Value SourceFileChangeType"
  },
  "api/Stride.Core.Assets.Tracking.SourceFilesCollector.html": {
    "href": "api/Stride.Core.Assets.Tracking.SourceFilesCollector.html",
    "title": "Class SourceFilesCollector | Stride API",
    "summary": "Class SourceFilesCollector Namespace Stride.Core.Assets.Tracking Assembly Stride.Core.Assets.dll public class SourceFilesCollector : AssetVisitorBase, IDataVisitor Inheritance object DataVisitorBase AssetVisitorBase SourceFilesCollector Implements IDataVisitor Inherited Members DataVisitorBase.TypeDescriptorFactory DataVisitorBase.CustomVisitors DataVisitorBase.CurrentPath DataVisitorBase.AttributeRegistry DataVisitorBase.Reset() DataVisitorBase.Visit(object) DataVisitorBase.Visit(object, ITypeDescriptor) DataVisitorBase.VisitNull() DataVisitorBase.VisitPrimitive(object, PrimitiveDescriptor) DataVisitorBase.VisitObject(object, ObjectDescriptor, bool) DataVisitorBase.VisitArray(Array, ArrayDescriptor) DataVisitorBase.VisitArrayItem(Array, ArrayDescriptor, int, object, ITypeDescriptor) DataVisitorBase.VisitCollection(IEnumerable, CollectionDescriptor) DataVisitorBase.VisitCollectionItem(IEnumerable, CollectionDescriptor, int, object, ITypeDescriptor) DataVisitorBase.VisitDictionary(object, DictionaryDescriptor) DataVisitorBase.VisitDictionaryKeyValue(object, DictionaryDescriptor, object, ITypeDescriptor, object, ITypeDescriptor) DataVisitorBase.VisitSet(IEnumerable, SetDescriptor) DataVisitorBase.VisitSetItem(IEnumerable, SetDescriptor, object, ITypeDescriptor) DataVisitorBase.CanVisit(object) Extension Methods UnsafeUtilities.As<T>(object?) Methods GetCompilationInputFiles(Asset) public HashSet<UFile> GetCompilationInputFiles(Asset asset) Parameters asset Asset Returns HashSet<UFile> GetSourceFiles(Asset) public Dictionary<UFile, bool> GetSourceFiles(Asset asset) Parameters asset Asset Returns Dictionary<UFile, bool> GetSourceMembers(Asset) public Dictionary<MemberPath, UFile> GetSourceMembers(Asset asset) Parameters asset Asset Returns Dictionary<MemberPath, UFile> VisitObjectMember(object, ObjectDescriptor, IMemberDescriptor, object?) Visits an object member. public override void VisitObjectMember(object container, ObjectDescriptor containerDescriptor, IMemberDescriptor member, object? value) Parameters container object The container. containerDescriptor ObjectDescriptor The container descriptor. member IMemberDescriptor The member. value object The value."
  },
  "api/Stride.Core.Assets.Tracking.SourceHashesHelper.html": {
    "href": "api/Stride.Core.Assets.Tracking.SourceHashesHelper.html",
    "title": "Class SourceHashesHelper | Stride API",
    "summary": "Class SourceHashesHelper Namespace Stride.Core.Assets.Tracking Assembly Stride.Core.Assets.dll public static class SourceHashesHelper Inheritance object SourceHashesHelper Fields MemberName public const string MemberName = \"~SourceHashes\" Field Value string Methods GetAllHashes(Asset) public static Dictionary<UFile, ObjectId> GetAllHashes(Asset asset) Parameters asset Asset Returns Dictionary<UFile, ObjectId> UpdateHashes(Asset, IReadOnlyDictionary<UFile, ObjectId>) public static void UpdateHashes(Asset asset, IReadOnlyDictionary<UFile, ObjectId> newHashes) Parameters asset Asset newHashes IReadOnlyDictionary<UFile, ObjectId>"
  },
  "api/Stride.Core.Assets.Tracking.html": {
    "href": "api/Stride.Core.Assets.Tracking.html",
    "title": "Namespace Stride.Core.Assets.Tracking | Stride API",
    "summary": "Namespace Stride.Core.Assets.Tracking Classes AssetSourceTracker SourceFilesCollector SourceHashesHelper Structs SourceFileChangedData Data structure for the SourceFileChanged block. Enums SourceFileChangeType Describes a change related to the source files used by an asset."
  },
  "api/Stride.Core.Assets.UPathAttribute.html": {
    "href": "api/Stride.Core.Assets.UPathAttribute.html",
    "title": "Class UPathAttribute | Stride API",
    "summary": "Class UPathAttribute Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Specifies how to normalize a UPath stored in a class after loading/saving an asset. [AttributeUsage(AttributeTargets.Property|AttributeTargets.Field)] public class UPathAttribute : Attribute Inheritance object Attribute UPathAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors UPathAttribute(UPathRelativeTo) Initializes a new instance of the UPathAttribute class. public UPathAttribute(UPathRelativeTo relativeTo) Parameters relativeTo UPathRelativeTo The relative to. Properties RelativeTo Gets how to normalize the path relative to. public UPathRelativeTo RelativeTo { get; } Property Value UPathRelativeTo The relative to."
  },
  "api/Stride.Core.Assets.UPathRelativeTo.html": {
    "href": "api/Stride.Core.Assets.UPathRelativeTo.html",
    "title": "Enum UPathRelativeTo | Stride API",
    "summary": "Enum UPathRelativeTo Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Enum UPathRelativeTo public enum UPathRelativeTo Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields None = 0 The UPath is stored as-is without post-processing Package = 1 The UPath is stored in relative mode when storing on the disk and relative to the current package."
  },
  "api/Stride.Core.Assets.UnloadableObjectRemover.UnloadableItem.html": {
    "href": "api/Stride.Core.Assets.UnloadableObjectRemover.UnloadableItem.html",
    "title": "Struct UnloadableObjectRemover.UnloadableItem | Stride API",
    "summary": "Struct UnloadableObjectRemover.UnloadableItem Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public readonly struct UnloadableObjectRemover.UnloadableItem Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors UnloadableItem(IUnloadable, MemberPath) public UnloadableItem(IUnloadable o, MemberPath memberPath) Parameters o IUnloadable memberPath MemberPath Fields MemberPath public readonly MemberPath MemberPath Field Value MemberPath UnloadableObject public readonly IUnloadable UnloadableObject Field Value IUnloadable"
  },
  "api/Stride.Core.Assets.UnloadableObjectRemover.html": {
    "href": "api/Stride.Core.Assets.UnloadableObjectRemover.html",
    "title": "Class UnloadableObjectRemover | Stride API",
    "summary": "Class UnloadableObjectRemover Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll Removes objects implementing 'IYamlProxy' from the object. public class UnloadableObjectRemover : AssetVisitorBase, IDataVisitor Inheritance object DataVisitorBase AssetVisitorBase UnloadableObjectRemover Implements IDataVisitor Inherited Members DataVisitorBase.TypeDescriptorFactory DataVisitorBase.CustomVisitors DataVisitorBase.CurrentPath DataVisitorBase.AttributeRegistry DataVisitorBase.Reset() DataVisitorBase.Visit(object) DataVisitorBase.Visit(object, ITypeDescriptor) DataVisitorBase.VisitNull() DataVisitorBase.VisitPrimitive(object, PrimitiveDescriptor) DataVisitorBase.VisitObject(object, ObjectDescriptor, bool) DataVisitorBase.VisitArray(Array, ArrayDescriptor) DataVisitorBase.VisitCollection(IEnumerable, CollectionDescriptor) DataVisitorBase.VisitDictionary(object, DictionaryDescriptor) DataVisitorBase.VisitSet(IEnumerable, SetDescriptor) DataVisitorBase.CanVisit(object) Extension Methods UnsafeUtilities.As<T>(object?) Methods Discover(object) public static IReadOnlyList<UnloadableObjectRemover.UnloadableItem> Discover(object obj) Parameters obj object Returns IReadOnlyList<UnloadableObjectRemover.UnloadableItem> Run(object) public static IReadOnlyList<UnloadableObjectRemover.UnloadableItem> Run(object obj) Parameters obj object Returns IReadOnlyList<UnloadableObjectRemover.UnloadableItem> VisitArrayItem(Array, ArrayDescriptor, int, object?, ITypeDescriptor?) Visits an array item. public override void VisitArrayItem(Array array, ArrayDescriptor descriptor, int index, object? item, ITypeDescriptor? itemDescriptor) Parameters array Array The array. descriptor ArrayDescriptor The descriptor. index int The index. item object The item. itemDescriptor ITypeDescriptor The item descriptor. VisitCollectionItem(IEnumerable, CollectionDescriptor, int, object?, ITypeDescriptor?) Visits a collection item. public override void VisitCollectionItem(IEnumerable collection, CollectionDescriptor descriptor, int index, object? item, ITypeDescriptor? itemDescriptor) Parameters collection IEnumerable The collection. descriptor CollectionDescriptor The descriptor. index int The index. item object The item. itemDescriptor ITypeDescriptor The item descriptor. VisitDictionaryKeyValue(object, DictionaryDescriptor, object, ITypeDescriptor?, object?, ITypeDescriptor?) Visits a dictionary key-value. public override void VisitDictionaryKeyValue(object dictionary, DictionaryDescriptor descriptor, object key, ITypeDescriptor? keyDescriptor, object? value, ITypeDescriptor? valueDescriptor) Parameters dictionary object The dictionary. descriptor DictionaryDescriptor The descriptor. key object The key. keyDescriptor ITypeDescriptor The key descriptor. value object The value. valueDescriptor ITypeDescriptor The value descriptor. VisitObjectMember(object, ObjectDescriptor, IMemberDescriptor, object?) Visits an object member. public override void VisitObjectMember(object container, ObjectDescriptor containerDescriptor, IMemberDescriptor member, object? value) Parameters container object The container. containerDescriptor ObjectDescriptor The container descriptor. member IMemberDescriptor The member. value object The value. VisitSetItem(IEnumerable, SetDescriptor, object?, ITypeDescriptor?) Visits a set item. public override void VisitSetItem(IEnumerable set, SetDescriptor descriptor, object? item, ITypeDescriptor? itemDescriptor) Parameters set IEnumerable The set. descriptor SetDescriptor The descriptor. item object The item. itemDescriptor ITypeDescriptor The item descriptor."
  },
  "api/Stride.Core.Assets.VSProjectHelper.html": {
    "href": "api/Stride.Core.Assets.VSProjectHelper.html",
    "title": "Class VSProjectHelper | Stride API",
    "summary": "Class VSProjectHelper Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public static class VSProjectHelper Inheritance object VSProjectHelper Methods CompileProjectAssemblyAsync(string, ILogger, string, string, string, Dictionary<string, string>?, BuildRequestDataFlags) public static ICancellableAsyncBuild? CompileProjectAssemblyAsync(string fullProjectLocation, ILogger logger, string targets = \"Build\", string configuration = \"Debug\", string platform = \"AnyCPU\", Dictionary<string, string>? extraProperties = null, BuildRequestDataFlags flags = BuildRequestDataFlags.None) Parameters fullProjectLocation string logger ILogger targets string configuration string platform string extraProperties Dictionary<string, string> flags BuildRequestDataFlags Returns ICancellableAsyncBuild GenerateRestoreGraphFile(ILogger, string) public static Task<DependencyGraphSpec> GenerateRestoreGraphFile(ILogger logger, string projectPath) Parameters logger ILogger projectPath string Returns Task<DependencyGraphSpec> GetOrCompileProjectAssembly(string, ILogger, string, bool, string, string, Dictionary<string, string>?, bool, BuildRequestDataFlags) public static string GetOrCompileProjectAssembly(string fullProjectLocation, ILogger logger, string targets, bool autoCompileProject, string configuration, string platform = \"AnyCPU\", Dictionary<string, string>? extraProperties = null, bool onlyErrors = false, BuildRequestDataFlags flags = BuildRequestDataFlags.None) Parameters fullProjectLocation string logger ILogger targets string autoCompileProject bool configuration string platform string extraProperties Dictionary<string, string> onlyErrors bool flags BuildRequestDataFlags Returns string GetPlatformTypeFromProject(Project) public static PlatformType? GetPlatformTypeFromProject(Project project) Parameters project Project Returns PlatformType? GetProjectGuid(Project) public static Guid GetProjectGuid(Project project) Parameters project Project Returns Guid GetProjectTypeFromProject(Project) public static ProjectType? GetProjectTypeFromProject(Project project) Parameters project Project Returns ProjectType? LoadProject(string, string, string, Dictionary<string, string>?) public static Project LoadProject(string fullProjectLocation, string configuration = \"Debug\", string platform = \"AnyCPU\", Dictionary<string, string>? extraProperties = null) Parameters fullProjectLocation string configuration string platform string extraProperties Dictionary<string, string> Returns Project Reset() public static void Reset() RestoreNugetPackages(ILogger, string) public static Task RestoreNugetPackages(ILogger logger, string projectPath) Parameters logger ILogger projectPath string Returns Task"
  },
  "api/Stride.Core.Assets.Visitors.AssetMemberVisitorBase.html": {
    "href": "api/Stride.Core.Assets.Visitors.AssetMemberVisitorBase.html",
    "title": "Class AssetMemberVisitorBase | Stride API",
    "summary": "Class AssetMemberVisitorBase Namespace Stride.Core.Assets.Visitors Assembly Stride.Core.Assets.dll public abstract class AssetMemberVisitorBase : AssetVisitorBase, IDataVisitor Inheritance object DataVisitorBase AssetVisitorBase AssetMemberVisitorBase Implements IDataVisitor Inherited Members DataVisitorBase.TypeDescriptorFactory DataVisitorBase.CustomVisitors DataVisitorBase.CurrentPath DataVisitorBase.AttributeRegistry DataVisitorBase.Reset() DataVisitorBase.Visit(object) DataVisitorBase.Visit(object, ITypeDescriptor) DataVisitorBase.VisitNull() DataVisitorBase.VisitArray(Array, ArrayDescriptor) DataVisitorBase.VisitCollection(IEnumerable, CollectionDescriptor) DataVisitorBase.VisitDictionary(object, DictionaryDescriptor) DataVisitorBase.VisitSet(IEnumerable, SetDescriptor) DataVisitorBase.CanVisit(object) Extension Methods UnsafeUtilities.As<T>(object?) Properties MemberPath Gets the Stride.Core.Reflection.MemberPath that will be checked against when visiting. protected MemberPath? MemberPath { get; set; } Property Value MemberPath See Also CurrentPath Methods VisitArrayItem(Array, ArrayDescriptor, int, object?, ITypeDescriptor?) Visits an array item. public override void VisitArrayItem(Array array, ArrayDescriptor descriptor, int index, object? item, ITypeDescriptor? itemDescriptor) Parameters array Array The array. descriptor ArrayDescriptor The descriptor. index int The index. item object The item. itemDescriptor ITypeDescriptor The item descriptor. VisitAssetMember(object?, ITypeDescriptor?) Called when Stride.Core.Reflection.DataVisitorBase.CurrentPath matches the MemberPath given when creating this instance. protected abstract void VisitAssetMember(object? value, ITypeDescriptor? descriptor) Parameters value object descriptor ITypeDescriptor VisitCollectionItem(IEnumerable, CollectionDescriptor, int, object?, ITypeDescriptor?) Visits a collection item. public override void VisitCollectionItem(IEnumerable collection, CollectionDescriptor descriptor, int index, object? item, ITypeDescriptor? itemDescriptor) Parameters collection IEnumerable The collection. descriptor CollectionDescriptor The descriptor. index int The index. item object The item. itemDescriptor ITypeDescriptor The item descriptor. VisitDictionaryKeyValue(object, DictionaryDescriptor, object, ITypeDescriptor?, object?, ITypeDescriptor?) Visits a dictionary key-value. public override void VisitDictionaryKeyValue(object dictionary, DictionaryDescriptor descriptor, object key, ITypeDescriptor? keyDescriptor, object? value, ITypeDescriptor? valueDescriptor) Parameters dictionary object The dictionary. descriptor DictionaryDescriptor The descriptor. key object The key. keyDescriptor ITypeDescriptor The key descriptor. value object The value. valueDescriptor ITypeDescriptor The value descriptor. VisitObject(object, ObjectDescriptor, bool) Visits an object (either a class or a struct) public override void VisitObject(object obj, ObjectDescriptor descriptor, bool visitMembers) Parameters obj object The object. descriptor ObjectDescriptor The descriptor. visitMembers bool VisitObjectMember(object, ObjectDescriptor, IMemberDescriptor, object?) Visits an object member. public override void VisitObjectMember(object container, ObjectDescriptor containerDescriptor, IMemberDescriptor member, object? value) Parameters container object The container. containerDescriptor ObjectDescriptor The container descriptor. member IMemberDescriptor The member. value object The value. VisitPrimitive(object, PrimitiveDescriptor) Visits a primitive (int, float, string...etc.) public override void VisitPrimitive(object primitive, PrimitiveDescriptor descriptor) Parameters primitive object The primitive. descriptor PrimitiveDescriptor The descriptor. VisitSetItem(IEnumerable, SetDescriptor, object?, ITypeDescriptor?) Visits a set item. public override void VisitSetItem(IEnumerable set, SetDescriptor descriptor, object? item, ITypeDescriptor? itemDescriptor) Parameters set IEnumerable The set. descriptor SetDescriptor The descriptor. item object The item. itemDescriptor ITypeDescriptor The item descriptor."
  },
  "api/Stride.Core.Assets.Visitors.AssetVisitorBase.html": {
    "href": "api/Stride.Core.Assets.Visitors.AssetVisitorBase.html",
    "title": "Class AssetVisitorBase | Stride API",
    "summary": "Class AssetVisitorBase Namespace Stride.Core.Assets.Visitors Assembly Stride.Core.Assets.dll Visitor for assets. public abstract class AssetVisitorBase : DataVisitorBase, IDataVisitor Inheritance object DataVisitorBase AssetVisitorBase Implements IDataVisitor Derived SourceFilesCollector UnloadableObjectRemover AssetMemberVisitorBase Inherited Members DataVisitorBase.TypeDescriptorFactory DataVisitorBase.CustomVisitors DataVisitorBase.CurrentPath DataVisitorBase.AttributeRegistry DataVisitorBase.Reset() DataVisitorBase.Visit(object) DataVisitorBase.Visit(object, ITypeDescriptor) DataVisitorBase.VisitNull() DataVisitorBase.VisitPrimitive(object, PrimitiveDescriptor) DataVisitorBase.VisitObject(object, ObjectDescriptor, bool) DataVisitorBase.VisitObjectMember(object, ObjectDescriptor, IMemberDescriptor, object) DataVisitorBase.VisitArray(Array, ArrayDescriptor) DataVisitorBase.VisitArrayItem(Array, ArrayDescriptor, int, object, ITypeDescriptor) DataVisitorBase.VisitCollection(IEnumerable, CollectionDescriptor) DataVisitorBase.VisitCollectionItem(IEnumerable, CollectionDescriptor, int, object, ITypeDescriptor) DataVisitorBase.VisitDictionary(object, DictionaryDescriptor) DataVisitorBase.VisitDictionaryKeyValue(object, DictionaryDescriptor, object, ITypeDescriptor, object, ITypeDescriptor) DataVisitorBase.VisitSet(IEnumerable, SetDescriptor) DataVisitorBase.VisitSetItem(IEnumerable, SetDescriptor, object, ITypeDescriptor) DataVisitorBase.CanVisit(object) Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetVisitorBase() protected AssetVisitorBase() AssetVisitorBase(ITypeDescriptorFactory) protected AssetVisitorBase(ITypeDescriptorFactory typeDescriptorFactory) Parameters typeDescriptorFactory ITypeDescriptorFactory"
  },
  "api/Stride.Core.Assets.Visitors.html": {
    "href": "api/Stride.Core.Assets.Visitors.html",
    "title": "Namespace Stride.Core.Assets.Visitors | Stride API",
    "summary": "Namespace Stride.Core.Assets.Visitors Classes AssetMemberVisitorBase AssetVisitorBase Visitor for assets."
  },
  "api/Stride.Core.Assets.XenkoToStrideRenameHelper.StrideContentType.html": {
    "href": "api/Stride.Core.Assets.XenkoToStrideRenameHelper.StrideContentType.html",
    "title": "Enum XenkoToStrideRenameHelper.StrideContentType | Stride API",
    "summary": "Enum XenkoToStrideRenameHelper.StrideContentType Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public enum XenkoToStrideRenameHelper.StrideContentType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Asset = 0 Code = 2 Package = 3 Project = 1"
  },
  "api/Stride.Core.Assets.XenkoToStrideRenameHelper.html": {
    "href": "api/Stride.Core.Assets.XenkoToStrideRenameHelper.html",
    "title": "Class XenkoToStrideRenameHelper | Stride API",
    "summary": "Class XenkoToStrideRenameHelper Namespace Stride.Core.Assets Assembly Stride.Core.Assets.dll public static class XenkoToStrideRenameHelper Inheritance object XenkoToStrideRenameHelper Methods RenameStrideFile(string, StrideContentType) public static string RenameStrideFile(string filePath, XenkoToStrideRenameHelper.StrideContentType type) Parameters filePath string type XenkoToStrideRenameHelper.StrideContentType Returns string ReplaceStrideContent(string, StrideContentType) public static string ReplaceStrideContent(string content, XenkoToStrideRenameHelper.StrideContentType type) Parameters content string type XenkoToStrideRenameHelper.StrideContentType Returns string"
  },
  "api/Stride.Core.Assets.Yaml.AttachedYamlAssetMetadata.html": {
    "href": "api/Stride.Core.Assets.Yaml.AttachedYamlAssetMetadata.html",
    "title": "Class AttachedYamlAssetMetadata | Stride API",
    "summary": "Class AttachedYamlAssetMetadata Namespace Stride.Core.Assets.Yaml Assembly Stride.Core.Assets.dll An interface representing an object that has Stride.Core.Assets.Yaml.IYamlAssetMetadata attached to it. public class AttachedYamlAssetMetadata Inheritance object AttachedYamlAssetMetadata Extension Methods UnsafeUtilities.As<T>(object?) Methods AttachMetadata<T>(PropertyKey<YamlAssetMetadata<T>>, YamlAssetMetadata<T>) Attaches metadata to this object. public void AttachMetadata<T>(PropertyKey<YamlAssetMetadata<T>> key, YamlAssetMetadata<T> metadata) Parameters key PropertyKey<YamlAssetMetadata<T>> The property key that identifies this type of metadata. metadata YamlAssetMetadata<T> The metadata to attach. Type Parameters T The type of metadata being attached. CopyInto(AttachedYamlAssetMetadata) public void CopyInto(AttachedYamlAssetMetadata target) Parameters target AttachedYamlAssetMetadata RetrieveMetadata<T>(PropertyKey<YamlAssetMetadata<T>>) Retrieves metadata attached to this object. public YamlAssetMetadata<T>? RetrieveMetadata<T>(PropertyKey<YamlAssetMetadata<T>> key) Parameters key PropertyKey<YamlAssetMetadata<T>> The property key that identifies this type of metadata. Returns YamlAssetMetadata<T> The corresponding metadata attached to this object, or null if it couldn't be found. Type Parameters T The type of metadata being attached."
  },
  "api/Stride.Core.Assets.Yaml.YamlAssetMetadata-1.html": {
    "href": "api/Stride.Core.Assets.Yaml.YamlAssetMetadata-1.html",
    "title": "Class YamlAssetMetadata<T> | Stride API",
    "summary": "Class YamlAssetMetadata<T> Namespace Stride.Core.Assets.Yaml Assembly Stride.Core.Assets.dll A container class to transfer metadata between the asset and the YAML serializer. public class YamlAssetMetadata<T> : IEnumerable<KeyValuePair<YamlAssetPath, T>>, IEnumerable Type Parameters T The type of metadata. Inheritance object YamlAssetMetadata<T> Implements IEnumerable<KeyValuePair<YamlAssetPath, T>> IEnumerable Extension Methods EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Properties Count Gets the number of key/value pairs contained in the YamlAssetMetadata<T> public int Count { get; } Property Value int Methods GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<KeyValuePair<YamlAssetPath, T>> GetEnumerator() Returns IEnumerator<KeyValuePair<YamlAssetPath, T>> An enumerator that can be used to iterate through the collection. Remove(YamlAssetPath) Removes attached metadata from the given YAML path. public void Remove(YamlAssetPath path) Parameters path YamlAssetPath The path at which to remove metadata. Set(YamlAssetPath, T) Attaches the given metadata value to the given YAML path. public void Set(YamlAssetPath path, T value) Parameters path YamlAssetPath The path at which to attach metadata. value T The metadata to attach. TryGet(YamlAssetPath) Tries to retrieve the metadata for the given path. public T? TryGet(YamlAssetPath path) Parameters path YamlAssetPath The path at which to retrieve metadata. Returns T The metadata attached to the given path, or the default value of T if no metadata is attached at the given path."
  },
  "api/Stride.Core.Assets.Yaml.YamlAssetPath.Element.html": {
    "href": "api/Stride.Core.Assets.Yaml.YamlAssetPath.Element.html",
    "title": "Struct YamlAssetPath.Element | Stride API",
    "summary": "Struct YamlAssetPath.Element Namespace Stride.Core.Assets.Yaml Assembly Stride.Core.Assets.dll A structure representing an element of a YamlAssetPath. public readonly struct YamlAssetPath.Element : IEquatable<YamlAssetPath.Element> Implements IEquatable<YamlAssetPath.Element> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Element(ElementType, object) Initializes a new instance of the YamlAssetPath.Element structure. public Element(YamlAssetPath.ElementType type, object value) Parameters type YamlAssetPath.ElementType The type of element. value object The value of the element. Fields Type The type of the element. public readonly YamlAssetPath.ElementType Type Field Value YamlAssetPath.ElementType Value The value of the element, corresonding to its Type. public readonly object Value Field Value object Methods AsItemId() Returns the ItemId of this element, considering this element is a ItemId. public ItemId AsItemId() Returns ItemId The ItemId of the item. AsMember() Fetches the name of the member, considering this element is a Member. public string AsMember() Returns string The name of the member. Equals(Element) Indicates whether the current object is equal to another object of the same type. public bool Equals(YamlAssetPath.Element other) Parameters other YamlAssetPath.Element An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(Element, Element) public static bool operator ==(YamlAssetPath.Element left, YamlAssetPath.Element right) Parameters left YamlAssetPath.Element right YamlAssetPath.Element Returns bool operator !=(Element, Element) public static bool operator !=(YamlAssetPath.Element left, YamlAssetPath.Element right) Parameters left YamlAssetPath.Element right YamlAssetPath.Element Returns bool"
  },
  "api/Stride.Core.Assets.Yaml.YamlAssetPath.ElementType.html": {
    "href": "api/Stride.Core.Assets.Yaml.YamlAssetPath.ElementType.html",
    "title": "Enum YamlAssetPath.ElementType | Stride API",
    "summary": "Enum YamlAssetPath.ElementType Namespace Stride.Core.Assets.Yaml Assembly Stride.Core.Assets.dll An enum representing the type of an element of the path. public enum YamlAssetPath.ElementType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Index = 1 An element that is an index or a key. ItemId = 2 An element that is an item identifier of a collection with ids Member = 0 An element that is a member."
  },
  "api/Stride.Core.Assets.Yaml.YamlAssetPath.html": {
    "href": "api/Stride.Core.Assets.Yaml.YamlAssetPath.html",
    "title": "Class YamlAssetPath | Stride API",
    "summary": "Class YamlAssetPath Namespace Stride.Core.Assets.Yaml Assembly Stride.Core.Assets.dll A class representing the path of a member or item of an Asset as it is created/consumed by the YAML asset serializers. [DataContract] public sealed class YamlAssetPath Inheritance object YamlAssetPath Extension Methods UnsafeUtilities.As<T>(object?) Constructors YamlAssetPath() Initializes a new instance of the YamlAssetPath class. public YamlAssetPath() YamlAssetPath(IEnumerable<Element>) Initializes a new instance of the YamlAssetPath class. public YamlAssetPath(IEnumerable<YamlAssetPath.Element> elements) Parameters elements IEnumerable<YamlAssetPath.Element> The elements constituting this path, in proper order. Properties Elements The elements constituting this path. [DataMember] public IReadOnlyList<YamlAssetPath.Element> Elements { get; } Property Value IReadOnlyList<YamlAssetPath.Element> Methods Append(YamlAssetPath?) Appends the given YamlAssetPath to this instance. [Pure] public YamlAssetPath Append(YamlAssetPath? other) Parameters other YamlAssetPath The YamlAssetPath Returns YamlAssetPath A new instance of YamlAssetPath corresonding to the given instance appended to this instance. Clone() Creates a clone of this YamlAssetPath instance. public YamlAssetPath Clone() Returns YamlAssetPath A new copy of this YamlAssetPath. FromMemberPath(MemberPath, object) Creates a YamlAssetPath out of a Stride.Core.Reflection.MemberPath instance. public static YamlAssetPath FromMemberPath(MemberPath path, object root) Parameters path MemberPath The Stride.Core.Reflection.MemberPath from which to create a YamlAssetPath. root object The root object of the given Stride.Core.Reflection.MemberPath. Returns YamlAssetPath An instance of YamlAssetPath corresponding to the same target than the given Stride.Core.Reflection.MemberPath. Match(YamlAssetPath) Indicates whether the current path represents the same path of another object. public bool Match(YamlAssetPath other) Parameters other YamlAssetPath An object to compare with this path. Returns bool true if the current path matches the other parameter; otherwise, false. Push(Element) Adds an additional element. public void Push(YamlAssetPath.Element element) Parameters element YamlAssetPath.Element The YamlAssetPath.Element to add. PushIndex(object) Adds an additional element to the path representing an access to an item of a collection or a value of a dictionary that does not use ItemId. public void PushIndex(object index) Parameters index object The index of the item. See Also ItemId PushItemId(ItemId) Adds an additional element to the path representing an access to an item of an collection or a value of a dictionary. public void PushItemId(ItemId itemId) Parameters itemId ItemId The ItemId of the item. PushMember(string) Adds an additional element to the path representing an access to a member of an object. public void PushMember(string memberName) Parameters memberName string The name of the member. StartsWith(YamlAssetPath) public bool StartsWith(YamlAssetPath path) Parameters path YamlAssetPath Returns bool ToMemberPath(object) Convert this YamlAssetPath into a Stride.Core.Reflection.MemberPath. [Pure] public MemberPath ToMemberPath(object root) Parameters root object The actual instance that is root of this path. Returns MemberPath An instance of Stride.Core.Reflection.MemberPath corresponding to the same target than this YamlAssetPath. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Assets.Yaml.YamlAssetPathComparer.html": {
    "href": "api/Stride.Core.Assets.Yaml.YamlAssetPathComparer.html",
    "title": "Class YamlAssetPathComparer | Stride API",
    "summary": "Class YamlAssetPathComparer Namespace Stride.Core.Assets.Yaml Assembly Stride.Core.Assets.dll Equality comparer for YamlAssetPath hwne used as a key in a hashing collection (e.g. Dictionary<TKey, TValue>. public class YamlAssetPathComparer : EqualityComparer<YamlAssetPath>, IEqualityComparer<YamlAssetPath>, IEqualityComparer Inheritance object EqualityComparer<YamlAssetPath> YamlAssetPathComparer Implements IEqualityComparer<YamlAssetPath> IEqualityComparer Inherited Members EqualityComparer<YamlAssetPath>.Create(Func<YamlAssetPath, YamlAssetPath, bool>, Func<YamlAssetPath, int>) Extension Methods UnsafeUtilities.As<T>(object?) Remarks To stay valid the compared YamlAssetPath must not change while used as keys in the hashing collection. Properties Default public static YamlAssetPathComparer Default { get; } Property Value YamlAssetPathComparer Methods Equals(YamlAssetPath?, YamlAssetPath?) When overridden in a derived class, determines whether two objects of type YamlAssetPath are equal. public override bool Equals(YamlAssetPath? x, YamlAssetPath? y) Parameters x YamlAssetPath The first object to compare. y YamlAssetPath The second object to compare. Returns bool true if the specified objects are equal; otherwise, false. GetHashCode(YamlAssetPath) When overridden in a derived class, serves as a hash function for the specified object for hashing algorithms and data structures, such as a hash table. public override int GetHashCode(YamlAssetPath obj) Parameters obj YamlAssetPath The object for which to get a hash code. Returns int A hash code for the specified object. Exceptions ArgumentNullException The type of obj is a reference type and obj is null."
  },
  "api/Stride.Core.Assets.Yaml.html": {
    "href": "api/Stride.Core.Assets.Yaml.html",
    "title": "Namespace Stride.Core.Assets.Yaml | Stride API",
    "summary": "Namespace Stride.Core.Assets.Yaml Classes AttachedYamlAssetMetadata An interface representing an object that has Stride.Core.Assets.Yaml.IYamlAssetMetadata attached to it. YamlAssetMetadata<T> A container class to transfer metadata between the asset and the YAML serializer. YamlAssetPath A class representing the path of a member or item of an Asset as it is created/consumed by the YAML asset serializers. YamlAssetPathComparer Equality comparer for YamlAssetPath hwne used as a key in a hashing collection (e.g. Dictionary<TKey, TValue>. Structs YamlAssetPath.Element A structure representing an element of a YamlAssetPath. Enums YamlAssetPath.ElementType An enum representing the type of an element of the path."
  },
  "api/Stride.Core.Assets.html": {
    "href": "api/Stride.Core.Assets.html",
    "title": "Namespace Stride.Core.Assets | Stride API",
    "summary": "Namespace Stride.Core.Assets Classes Asset Base class for Asset. AssetAliasAttribute Associates a type name used in YAML content. AssetCloner Allows to clone an asset or values stored in an asset. AssetCollectionItemIdHelper AssetComposite Base class for an asset that supports inheritance by composition. AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> A class containing the information of a hierarchy of asset parts contained in an AssetCompositeHierarchy<TAssetPartDesign, TAssetPart>. AssetCompositeHierarchyExtensions Extension methods for AssetCompositeHierarchy<TAssetPartDesign, TAssetPart> and AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart> AssetCompositeHierarchy<TAssetPartDesign, TAssetPart> AssetContentTypeAttribute Describes which runtime-type, loadable through the ContentManager, corresponds to the associated asset type. AssetDescriptionAttribute Associates meta-information to a particular Asset. AssetException An AssetException. AssetFactory<T> A base implementation of the IAssetFactory<T> interface. AssetFileSerializer Main entry point for serializing/deserializing Asset. AssetFolder A location relative to a package from where assets will be loaded AssetFolderCollection A collection of AssetFolder AssetFormatVersionAttribute Describes what format version this asset currently uses, for asset upgrading. AssetHash Helper to compute a stable hash from an asset including all meta informations (ids, overrides). AssetImporterBase AssetImporterParameters Parameters used by Import(UFile, AssetImporterParameters) AssetItem An asset item part of a Package accessible through Assets. AssetItemExtensions AssetLoadResult<T> AssetMigration Helper for migrating asset to newer versions. AssetMigrationContext Context used by IAssetUpgrader. AssetPartCollectionSerializer<TAssetPartDesign, TAssetPart> AssetPartCollection<TAssetPartDesign, TAssetPart> AssetReference An asset reference. AssetReferenceDataSerializer Serializer for AssetReference. AssetReferenceExtensions Extension methods for AssetReference AssetRegistry A registry for various content associated with assets. AssetSelector An asset selector AssetTracker Base class for tracking assets and executing an action on each change. AssetUpgraderAttribute Describes which upgrader type to use to upgrade an asset, depending on this current version number. AssetUpgraderBase AssetUpgraderCollection AssetWithSource An asset that references a source file used during the compilation of the asset. BasePart BasePartDataSerializer Bundle Description of an asset bundle. BundleCollection A collection of bundles. CollectionIdGenerator A visitor that will generate a CollectionItemIdentifiers collection for each collection or dictionary of the visited object, and attach it to the related collection. DefaultAssetFactory<T> An implementation of the AssetFactory<T> class that uses the default public parameterless constructor of the associated asset type. Dependency DependencyRange DirectoryHelper Helper class that contains methods to retrieve and manipulate SDK locations. EmptyAssetUpgrader Empty asset upgrader (useful when we want to bump version without changing anything). FileUtility File Utilities methods. FileVersionManager Package A package managing assets. PackageAssetCollection A collection of AssetItem that contains only absolute location without any drive information. This class cannot be inherited. PackageCollection A collection of Package. PackageContainer PackageDependency A reference to a package either internal (directly to a Package inside the same solution) or external (to a package distributed on the store). PackageDependencyCollection A collection of PackageDependency. PackageExtensions Extensions for Package PackageLoadParameters Parameters used for loading a package. PackageLoadedAssembly Represents an assembly that is loaded at runtime by the package. PackageLoadingAssetFile Represents an asset before being loaded. Used mostly for asset upgrading. PackageLoadingAssetFile.FileSizeComparer PackageLoadingAssetFile.YamlAsset PackageMeta Metadata for a Package accessible from PackageMeta. PackageReferenceBase Common class used by PackageDependency. PackageSaveParameters PackageSession A session for editing a package. PackageSession.PendingPackageUpgrade PackageSessionExtensions Extension methods for PackageSession. PackageSessionProfilingKeys Keys used for profiling the game class. PackageSessionPublicHelper Helper class to load/save a VisualStudio solution. PackageSessionResult Result returned when loading a session using Load(string, PackageLoadParameters?) PackageStore Manage packages locally installed and accessible on the store. PackageUpgrader Offers a way for package to upgrade dependent packages. For example, if you write package A and Game1 depends on it, you might want to offer a new version of package A that would automatically perform some upgrades on Game1. PackageUpgraderAttribute Attribute that describes what a package upgrader can do. PackageUserSettings A class representing the user settings related to a Package. These settings are stored in a .user file along the package file. PackageVersionRangeExtensions ProjectCollection ProjectReference A reference to a Visual Studio project that is part of a Package ProjectSourceCodeAsset ProjectSourceCodeWithFileGeneratorAsset PropertyCollection A collection of properties. RawAsset A raw asset, an asset that is imported as-is. RawAssetImporter RawAssetImporterBase<TAsset> RootAssetCollection SolutionConfiguration A solution configuration used by SolutionPlatform SolutionConfigurationCollection A collection of SolutionConfiguration SolutionPlatform Defines a solution platform. SolutionPlatformCollection A collection of SolutionPlatform. SolutionPlatformPart Class SolutionAlternativePlatform. SolutionPlatformPartCollection A collection of SolutionPlatformPart SolutionPlatformTemplate Defines a custom project template for a SolutionPlatform. SolutionProject SourceCodeAsset Class SourceCodeAsset. SourceFileMemberAttribute An attribute indicating whether a member of an asset represents the path to a source file for this asset. StandalonePackage StridePackagesToSkipUpgrade SupportedProgrammingLanguage Represents a programming language supported by the system. SupportedProgrammingLanguages Provides a list of programming languages supported by the system. TagCollection A collection of tags. TemplateFolder Describes a template folder. UPathAttribute Specifies how to normalize a UPath stored in a class after loading/saving an asset. UnloadableObjectRemover Removes objects implementing 'IYamlProxy' from the object. VSProjectHelper XenkoToStrideRenameHelper Structs AssetId AssetMember Represents a member of an asset. AssetPart A part asset contained by an asset that is IAssetComposite. UnloadableObjectRemover.UnloadableItem Interfaces IAssetComposite An interface that defines the composition declared by an asset inheriting from another asset. IAssetFactory<T> An interface that represents an asset factory. IAssetFinder IAssetImporter Imports a raw asset into the asset system. IAssetPartDesign An interface representing a design-time part in an AssetComposite. IAssetPartDesign<TAssetPart> An interface representing a design-time part in an AssetComposite. IAssetUpgrader IAssetWithSource ICancellableAsyncBuild IFileSynchronizable Identify an object that is associated with an anchor file on the disk where all the Stride.Core.IO.UPath members of this instance are relative to the FullPath of this instance. IProjectAsset An asset that is stored in a project file (such as .csproj). IProjectFileGeneratorAsset An asset that generates another file. IReadOnlyPackageCollection Enums AssetClonerFlags Flags used by AssetCloner DependencyType OverrideUpgraderHint Defines a context for overrides when upgrading an asset. PackageState PackageUpgradeRequestedAnswer An enum representing the user answer to a package upgrade request. ProjectType Type of the project. SearchDirection A direction to search for files in directories UPathRelativeTo Enum UPathRelativeTo XenkoToStrideRenameHelper.StrideContentType Delegates DirtyFlagChangedDelegate<T> A delegate used for events raised when the dirty flag of an object has changed"
  },
  "api/Stride.Core.Collections.ConstrainedList-1.html": {
    "href": "api/Stride.Core.Collections.ConstrainedList-1.html",
    "title": "Class ConstrainedList<T> | Stride API",
    "summary": "Class ConstrainedList<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represent a collection associated with a constraint. When an item is added to this collection, it is tested against the constraint. If the test fails, the item can either be discarded, or an exception can be thrown. The desired behavior can be defined with ThrowException. [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] public class ConstrainedList<T> : IList<T>, ICollection<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable Type Parameters T Inheritance object ConstrainedList<T> Implements IList<T> ICollection<T> IReadOnlyList<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable Derived SafeList<T> Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors ConstrainedList() public ConstrainedList() ConstrainedList(Func<ConstrainedList<T>, T, bool>?, bool, string?) public ConstrainedList(Func<ConstrainedList<T>, T, bool>? constraint = null, bool throwException = true, string? errorMessage = null) Parameters constraint Func<ConstrainedList<T>, T, bool> throwException bool errorMessage string Properties Constraint Gets or sets the constraint for items added to the collection. If null, this collection behaves like a List<T>. public Func<ConstrainedList<T>, T, bool>? Constraint { get; set; } Property Value Func<ConstrainedList<T>, T, bool> Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. this[int] Gets or sets the element at the specified index. public T this[int index] { get; set; } Parameters index int The zero-based index of the element to get or set. Property Value T The element at the specified index. Exceptions ArgumentOutOfRangeException index is not a valid index in the IList<T>. NotSupportedException The property is set and the IList<T> is read-only. ThrowException Gets or sets whether the collection should throw an ArgumentException when an item to add or insert doesn't pass the constraint. public bool ThrowException { get; set; } Property Value bool Methods Add(T) Adds an item to the ICollection<T>. public void Add(T item) Parameters item T The object to add to the ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. Contains(T) Determines whether the ICollection<T> contains a specific value. public bool Contains(T item) Parameters item T The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. CopyTo(T[], int) Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. public void CopyTo(T[] array, int arrayIndex) Parameters array T[] The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing. arrayIndex int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException arrayIndex is less than 0. ArgumentException The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array. GetEnumerator() public List<T>.Enumerator GetEnumerator() Returns List<T>.Enumerator IndexOf(T) Determines the index of a specific item in the IList<T>. public int IndexOf(T item) Parameters item T The object to locate in the IList<T>. Returns int The index of item if found in the list; otherwise, -1. Insert(int, T) Inserts an item to the IList<T> at the specified index. public void Insert(int index, T item) Parameters index int The zero-based index at which item should be inserted. item T The object to insert into the IList<T>. Exceptions ArgumentOutOfRangeException index is not a valid index in the IList<T>. NotSupportedException The IList<T> is read-only. Remove(T) Removes the first occurrence of a specific object from the ICollection<T>. public bool Remove(T item) Parameters item T The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. RemoveAt(int) Removes the IList<T> item at the specified index. public void RemoveAt(int index) Parameters index int The zero-based index of the item to remove. Exceptions ArgumentOutOfRangeException index is not a valid index in the IList<T>. NotSupportedException The IList<T> is read-only."
  },
  "api/Stride.Core.Collections.Deque-1.html": {
    "href": "api/Stride.Core.Collections.Deque-1.html",
    "title": "Class Deque<T> | Stride API",
    "summary": "Class Deque<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll A double-ended queue (deque), which provides O(1) indexed access, O(1) removals from the front and back, amortized O(1) insertions to the front and back, and O(N) insertions and removals anywhere else (with the operations getting slower as the index approaches the middle). public sealed class Deque<T> : IList<T>, ICollection<T>, IEnumerable<T>, IList, ICollection, IEnumerable Type Parameters T The type of elements contained in the deque. Inheritance object Deque<T> Implements IList<T> ICollection<T> IEnumerable<T> IList ICollection IEnumerable Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors Deque() Initializes a new instance of the Deque<T> class. public Deque() Deque(int) Initializes a new instance of the Deque<T> class with the specified capacity. public Deque(int capacity) Parameters capacity int The initial capacity. Must be a power of two greater than 0. Properties Capacity Gets or sets the capacity for this deque. This value must always be greater than zero, and this property cannot be set to a value less than Count. public int Capacity { get; set; } Property Value int Exceptions InvalidOperationException Capacity cannot be set to a value less than Count. Count Gets the number of elements contained in this deque. public int Count { get; } Property Value int The number of elements contained in this deque. this[int] Gets or sets the item at the specified index. public T this[int index] { get; set; } Parameters index int The index of the item to get or set. Property Value T Exceptions ArgumentOutOfRangeException index is not a valid index in this list. NotSupportedException This property is set and the list is read-only. Methods AddToBack(T) Inserts a single element at the back of this deque. public void AddToBack(T value) Parameters value T The element to insert. AddToFront(T) Inserts a single element at the front of this deque. public void AddToFront(T value) Parameters value T The element to insert. BinarySearch(T) Perform a binary search over this Deque<T> to find value using the default comparer. public int BinarySearch(T value) Parameters value T Returns int The zero-based index of value in this sorted Deque<T>, if value is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, the bitwise complement of Count. Remarks Result is undefined when the items in this Deque<T> are unordered. BinarySearch<TComparer>(T, TComparer) Perform a binary search over this Deque<T> to find value using comparer. public int BinarySearch<TComparer>(T value, TComparer comparer) where TComparer : IComparer<T>, allows ref struct Parameters value T comparer TComparer Returns int The zero-based index of value in this sorted Deque<T>, if value is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, the bitwise complement of Count. Type Parameters TComparer Remarks Result is undefined when the items in this Deque<T> are unordered. Exceptions ArgumentNullException comparer is null. Clear() Removes all items from this deque. public void Clear() GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<T> GetEnumerator() Returns IEnumerator<T> A IEnumerator<T> that can be used to iterate through the collection. IndexOf(T) Determines the index of a specific item in this list. public int IndexOf(T item) Parameters item T The object to locate in this list. Returns int The index of item if found in this list; otherwise, -1. Insert(int, T) Inserts an item to this list at the specified index. public void Insert(int index, T item) Parameters index int The zero-based index at which item should be inserted. item T The object to insert into this list. Exceptions ArgumentOutOfRangeException index is not a valid index in this list. NotSupportedException This list is read-only. InsertRange(int, IEnumerable<T>) Inserts a collection of elements into this deque. public void InsertRange(int index, IEnumerable<T> collection) Parameters index int The index at which the collection is inserted. collection IEnumerable<T> The collection of elements to insert. Exceptions ArgumentOutOfRangeException index is not a valid index to an insertion point for the source. Remove(T) Removes the first occurrence of a specific object from this list. public bool Remove(T item) Parameters item T The object to remove from this list. Returns bool true if item was successfully removed from this list; otherwise, false. This method also returns false if item is not found in this list. Exceptions NotSupportedException This list is read-only. RemoveAt(int) Removes the item at the specified index. public void RemoveAt(int index) Parameters index int The zero-based index of the item to remove. Exceptions ArgumentOutOfRangeException index is not a valid index in this list. NotSupportedException This list is read-only. RemoveFromBack() Removes and returns the last element of this deque. public T RemoveFromBack() Returns T The former last element. Exceptions InvalidOperationException The deque is empty. RemoveFromFront() Removes and returns the first element of this deque. public T RemoveFromFront() Returns T The former first element. Exceptions InvalidOperationException The deque is empty. RemoveRange(int, int) Removes a range of elements from this deque. public void RemoveRange(int offset, int count) Parameters offset int The index into the deque at which the range begins. count int The number of elements to remove. Exceptions ArgumentOutOfRangeException Either offset or count is less than 0. ArgumentException The range [offset, offset + count) is not within the range [0, Count)."
  },
  "api/Stride.Core.Collections.FastCollection-1.Enumerator.html": {
    "href": "api/Stride.Core.Collections.FastCollection-1.Enumerator.html",
    "title": "Struct FastCollection<T>.Enumerator | Stride API",
    "summary": "Struct FastCollection<T>.Enumerator Namespace Stride.Core.Collections Assembly Stride.Core.dll public struct FastCollection<T>.Enumerator : IEnumerator<T>, IEnumerator, IDisposable Implements IEnumerator<T> IEnumerator IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Current Gets the element in the collection at the current position of the enumerator. public readonly T Current { get; } Property Value T The element in the collection at the current position of the enumerator. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public readonly void Dispose() MoveNext() Advances the enumerator to the next element of the collection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created."
  },
  "api/Stride.Core.Collections.FastCollection-1.html": {
    "href": "api/Stride.Core.Collections.FastCollection-1.html",
    "title": "Class FastCollection<T> | Stride API",
    "summary": "Class FastCollection<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Faster and lighter implementation of Collection<T> with value types enumerators to avoid allocation in foreach loops, and various helper functions. [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] public class FastCollection<T> : IList<T>, ICollection<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable Type Parameters T Type of elements of this collection Inheritance object FastCollection<T> Implements IList<T> ICollection<T> IReadOnlyList<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable Derived FastTrackingCollection<T> TrackingCollection<T> EntityComponentCollection PhysicsComponent.ColliderShapeCollection TransformComponent.TransformChildrenCollection MaterialPassCollection Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors FastCollection() public FastCollection() FastCollection(IEnumerable<T>) public FastCollection(IEnumerable<T> collection) Parameters collection IEnumerable<T> FastCollection(int) public FastCollection(int capacity) Parameters capacity int Properties Capacity public int Capacity { get; set; } Property Value int Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. this[int] Gets or sets the element T at the specified index. public T this[int index] { get; set; } Parameters index int The index. Property Value T The element T. Exceptions ArgumentOutOfRangeException If index is out of range Methods Add(T) Adds an item to the ICollection<T>. public void Add(T item) Parameters item T The object to add to the ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. AddRange<TE>(TE) Adds the elements of the specified source to the end of FastCollection<T>. public void AddRange<TE>(TE itemsArgs) where TE : IEnumerable<T> Parameters itemsArgs TE The items to add to this collection. Type Parameters TE Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. ClearItems() protected virtual void ClearItems() Contains(T) Determines whether the ICollection<T> contains a specific value. public bool Contains(T item) Parameters item T The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. CopyTo(T[], int) Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. public void CopyTo(T[] array, int arrayIndex) Parameters array T[] The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing. arrayIndex int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException arrayIndex is less than 0. ArgumentException The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array. EnsureCapacity(int) public void EnsureCapacity(int min) Parameters min int GetEnumerator() Inline Enumerator used directly by foreach. public FastCollection<T>.Enumerator GetEnumerator() Returns FastCollection<T>.Enumerator An enumerator of this collection IndexOf(T) Determines the index of a specific item in the IList<T>. public int IndexOf(T item) Parameters item T The object to locate in the IList<T>. Returns int The index of item if found in the list; otherwise, -1. Insert(int, T) Inserts an item to the IList<T> at the specified index. public void Insert(int index, T item) Parameters index int The zero-based index at which item should be inserted. item T The object to insert into the IList<T>. Exceptions ArgumentOutOfRangeException index is not a valid index in the IList<T>. NotSupportedException The IList<T> is read-only. InsertItem(int, T) protected virtual void InsertItem(int index, T item) Parameters index int item T Remove(T) Removes the first occurrence of a specific object from the ICollection<T>. public bool Remove(T item) Parameters item T The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. RemoveAt(int) Removes the IList<T> item at the specified index. public void RemoveAt(int index) Parameters index int The zero-based index of the item to remove. Exceptions ArgumentOutOfRangeException index is not a valid index in the IList<T>. NotSupportedException The IList<T> is read-only. RemoveItem(int) protected virtual void RemoveItem(int index) Parameters index int SetItem(int, T) protected virtual void SetItem(int index, T item) Parameters index int item T Sort() public void Sort() Sort(IComparer<T>) public void Sort(IComparer<T> comparer) Parameters comparer IComparer<T> Sort(int, int, IComparer<T>?) public void Sort(int index, int count, IComparer<T>? comparer) Parameters index int count int comparer IComparer<T>"
  },
  "api/Stride.Core.Collections.FastList-1.Enumerator.html": {
    "href": "api/Stride.Core.Collections.FastList-1.Enumerator.html",
    "title": "Struct FastList<T>.Enumerator | Stride API",
    "summary": "Struct FastList<T>.Enumerator Namespace Stride.Core.Collections Assembly Stride.Core.dll public struct FastList<T>.Enumerator : IEnumerator<T>, IEnumerator, IDisposable Implements IEnumerator<T> IEnumerator IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Current Gets the element in the collection at the current position of the enumerator. public readonly T Current { get; } Property Value T The element in the collection at the current position of the enumerator. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public readonly void Dispose() MoveNext() Advances the enumerator to the next element of the collection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created."
  },
  "api/Stride.Core.Collections.FastList-1.html": {
    "href": "api/Stride.Core.Collections.FastList-1.html",
    "title": "Class FastList<T> | Stride API",
    "summary": "Class FastList<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Similar to List<T>, with direct access to underlying array. It is recommended to use Spans instead: https://github.com/stride3d/stride/discussions/2298#discussioncomment-9779439 [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] [Obsolete(\".NET Lists can be faster in the latest .NET versions.\")] public class FastList<T> : IList<T>, ICollection<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable Type Parameters T The type of elements in the list. Inheritance object FastList<T> Implements IList<T> ICollection<T> IReadOnlyList<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors FastList() public FastList() FastList(IEnumerable<T>) public FastList(IEnumerable<T> collection) Parameters collection IEnumerable<T> FastList(int) public FastList(int capacity) Parameters capacity int Properties Capacity public int Capacity { get; set; } Property Value int Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. this[int] Gets or sets the element at the specified index. public T this[int index] { get; set; } Parameters index int The zero-based index of the element to get or set. Property Value T The element at the specified index. Exceptions ArgumentOutOfRangeException index is not a valid index in the IList<T>. NotSupportedException The property is set and the IList<T> is read-only. Items Gets the items. [Obsolete(\"Its best to use a List<T> instead of FastList<T> and iterate through the list as a Span for peak performance.\")] public T[] Items { get; } Property Value T[] Methods Add(T) Adds an item to the ICollection<T>. public void Add(T item) Parameters item T The object to add to the ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. AddRange(IEnumerable<T>) public void AddRange(IEnumerable<T> collection) Parameters collection IEnumerable<T> AsReadOnly() public ReadOnlyCollection<T> AsReadOnly() Returns ReadOnlyCollection<T> BinarySearch(int, int, T, IComparer<T>?) public int BinarySearch(int index, int count, T item, IComparer<T>? comparer) Parameters index int count int item T comparer IComparer<T> Returns int BinarySearch(T) public int BinarySearch(T item) Parameters item T Returns int BinarySearch(T, IComparer<T>) public int BinarySearch(T item, IComparer<T> comparer) Parameters item T comparer IComparer<T> Returns int Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. Clear(bool) Clears this list with a fast-clear option. public void Clear(bool fastClear) Parameters fastClear bool if set to true this method only resets the count elements but doesn't clear items referenced already stored in the list. Contains(T) Determines whether the ICollection<T> contains a specific value. public bool Contains(T item) Parameters item T The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. CopyTo(int, T[], int, int) public void CopyTo(int index, T[] array, int arrayIndex, int count) Parameters index int array T[] arrayIndex int count int CopyTo(T[]) public void CopyTo(T[] array) Parameters array T[] CopyTo(T[], int) Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. public void CopyTo(T[] array, int arrayIndex) Parameters array T[] The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing. arrayIndex int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException arrayIndex is less than 0. ArgumentException The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array. EnsureCapacity(int) public void EnsureCapacity(int min) Parameters min int Exists(Predicate<T>) public bool Exists(Predicate<T> match) Parameters match Predicate<T> Returns bool Find(Predicate<T>) public T? Find(Predicate<T> match) Parameters match Predicate<T> Returns T FindAll(Predicate<T>) public FastList<T> FindAll(Predicate<T> match) Parameters match Predicate<T> Returns FastList<T> FindIndex(int, int, Predicate<T>) public int FindIndex(int startIndex, int count, Predicate<T> match) Parameters startIndex int count int match Predicate<T> Returns int FindIndex(int, Predicate<T>) public int FindIndex(int startIndex, Predicate<T> match) Parameters startIndex int match Predicate<T> Returns int FindIndex(Predicate<T>) public int FindIndex(Predicate<T> match) Parameters match Predicate<T> Returns int FindLast(Predicate<T>) public T? FindLast(Predicate<T> match) Parameters match Predicate<T> Returns T FindLastIndex(int, int, Predicate<T>) public int FindLastIndex(int startIndex, int count, Predicate<T> match) Parameters startIndex int count int match Predicate<T> Returns int FindLastIndex(int, Predicate<T>) public int FindLastIndex(int startIndex, Predicate<T> match) Parameters startIndex int match Predicate<T> Returns int FindLastIndex(Predicate<T>) public int FindLastIndex(Predicate<T> match) Parameters match Predicate<T> Returns int ForEach(Action<T>) public void ForEach(Action<T> action) Parameters action Action<T> GetEnumerator() public FastList<T>.Enumerator GetEnumerator() Returns FastList<T>.Enumerator GetRange(int, int) public FastList<T> GetRange(int index, int count) Parameters index int count int Returns FastList<T> IncreaseCapacity(int) public void IncreaseCapacity(int index) Parameters index int IndexOf(T) Determines the index of a specific item in the IList<T>. public int IndexOf(T item) Parameters item T The object to locate in the IList<T>. Returns int The index of item if found in the list; otherwise, -1. IndexOf(T, int) public int IndexOf(T item, int index) Parameters item T index int Returns int IndexOf(T, int, int) public int IndexOf(T item, int index, int count) Parameters item T index int count int Returns int Insert(int, T) Inserts an item to the IList<T> at the specified index. public void Insert(int index, T item) Parameters index int The zero-based index at which item should be inserted. item T The object to insert into the IList<T>. Exceptions ArgumentOutOfRangeException index is not a valid index in the IList<T>. NotSupportedException The IList<T> is read-only. InsertRange(int, IEnumerable<T>) public void InsertRange(int index, IEnumerable<T> collection) Parameters index int collection IEnumerable<T> LastIndexOf(T) public int LastIndexOf(T item) Parameters item T Returns int LastIndexOf(T, int) public int LastIndexOf(T item, int index) Parameters item T index int Returns int LastIndexOf(T, int, int) public int LastIndexOf(T item, int index, int count) Parameters item T index int count int Returns int Remove(T) Removes the first occurrence of a specific object from the ICollection<T>. public bool Remove(T item) Parameters item T The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. RemoveAll(Predicate<T>) public int RemoveAll(Predicate<T> match) Parameters match Predicate<T> Returns int RemoveAt(int) Removes the IList<T> item at the specified index. public void RemoveAt(int index) Parameters index int The zero-based index of the item to remove. Exceptions ArgumentOutOfRangeException index is not a valid index in the IList<T>. NotSupportedException The IList<T> is read-only. RemoveRange(int, int) public void RemoveRange(int index, int count) Parameters index int count int Resize(int, bool) public void Resize(int newSize, bool fastClear) Parameters newSize int fastClear bool Reverse() public void Reverse() Reverse(int, int) public void Reverse(int index, int count) Parameters index int count int Sort() public void Sort() Sort(IComparer<T>) public void Sort(IComparer<T> comparer) Parameters comparer IComparer<T> Sort(int, int, IComparer<T>?) public void Sort(int index, int count, IComparer<T>? comparer) Parameters index int count int comparer IComparer<T> ToArray() public T[] ToArray() Returns T[] TrimExcess() public void TrimExcess() TrueForAll(Predicate<T>) public bool TrueForAll(Predicate<T> match) Parameters match Predicate<T> Returns bool"
  },
  "api/Stride.Core.Collections.FastListStruct-1.Enumerator.html": {
    "href": "api/Stride.Core.Collections.FastListStruct-1.Enumerator.html",
    "title": "Struct FastListStruct<T>.Enumerator | Stride API",
    "summary": "Struct FastListStruct<T>.Enumerator Namespace Stride.Core.Collections Assembly Stride.Core.dll public struct FastListStruct<T>.Enumerator : IEnumerator<T>, IEnumerator, IDisposable Implements IEnumerator<T> IEnumerator IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Current Gets the element in the collection at the current position of the enumerator. public readonly T Current { get; } Property Value T The element in the collection at the current position of the enumerator. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public readonly void Dispose() MoveNext() Advances the enumerator to the next element of the collection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created."
  },
  "api/Stride.Core.Collections.FastListStruct-1.html": {
    "href": "api/Stride.Core.Collections.FastListStruct-1.html",
    "title": "Struct FastListStruct<T> | Stride API",
    "summary": "Struct FastListStruct<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll public struct FastListStruct<T> : IEnumerable<T>, IEnumerable Type Parameters T Implements IEnumerable<T> IEnumerable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors FastListStruct(FastList<T>) public FastListStruct(FastList<T> fastList) Parameters fastList FastList<T> FastListStruct(int) public FastListStruct(int capacity) Parameters capacity int FastListStruct(T[]) public FastListStruct(T[] array) Parameters array T[] Fields Count public int Count Field Value int Items Gets the items. public T[] Items Field Value T[] Properties this[int] public readonly T this[int index] { get; set; } Parameters index int Property Value T Methods Add(T) public void Add(T item) Parameters item T AddRange(FastListStruct<T>) public void AddRange(FastListStruct<T> items) Parameters items FastListStruct<T> Clear() public void Clear() Contains(T) public readonly bool Contains(T item) Parameters item T Returns bool EnsureCapacity(int) public void EnsureCapacity(int newCapacity) Parameters newCapacity int GetEnumerator() public readonly FastListStruct<T>.Enumerator GetEnumerator() Returns FastListStruct<T>.Enumerator IndexOf(T) public readonly int IndexOf(T item) Parameters item T Returns int Insert(int, T) public void Insert(int index, T item) Parameters index int item T Remove(T) public bool Remove(T item) Parameters item T Returns bool RemoveAt(int) public void RemoveAt(int index) Parameters index int SwapRemoveAt(int) Remove an item by swapping it with the last item and removing it from the last position. This function prevents to shift values from the list on removal but does not maintain order. public void SwapRemoveAt(int index) Parameters index int Index of the item to remove. ToArray() public readonly T[] ToArray() Returns T[] Operators implicit operator FastListStruct<T>(FastList<T>) public static implicit operator FastListStruct<T>(FastList<T> fastList) Parameters fastList FastList<T> Returns FastListStruct<T> implicit operator FastListStruct<T>(T[]) public static implicit operator FastListStruct<T>(T[] array) Parameters array T[] Returns FastListStruct<T>"
  },
  "api/Stride.Core.Collections.FastTrackingCollection-1.FastEventHandler-1.html": {
    "href": "api/Stride.Core.Collections.FastTrackingCollection-1.FastEventHandler-1.html",
    "title": "Delegate FastTrackingCollection<T>.FastEventHandler<TEventArgs> | Stride API",
    "summary": "Delegate FastTrackingCollection<T>.FastEventHandler<TEventArgs> Namespace Stride.Core.Collections Assembly Stride.Core.dll public delegate void FastTrackingCollection<T>.FastEventHandler<TEventArgs>(object sender, ref TEventArgs e) Parameters sender object e TEventArgs Type Parameters TEventArgs Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Collections.FastTrackingCollection-1.html": {
    "href": "api/Stride.Core.Collections.FastTrackingCollection-1.html",
    "title": "Class FastTrackingCollection<T> | Stride API",
    "summary": "Class FastTrackingCollection<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a collection that generates events when items get added or removed. [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] public class FastTrackingCollection<T> : FastCollection<T>, IList<T>, ICollection<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable Type Parameters T The type of elements in the collection. Inheritance object FastCollection<T> FastTrackingCollection<T> Implements IList<T> ICollection<T> IReadOnlyList<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable Derived SceneCameraSlotCollection Inherited Members FastCollection<T>.Capacity FastCollection<T>.Count FastCollection<T>.this[int] FastCollection<T>.Add(T) FastCollection<T>.Clear() FastCollection<T>.Contains(T) FastCollection<T>.CopyTo(T[], int) FastCollection<T>.IndexOf(T) FastCollection<T>.Insert(int, T) FastCollection<T>.Remove(T) FastCollection<T>.RemoveAt(int) FastCollection<T>.AddRange<TE>(TE) FastCollection<T>.GetEnumerator() FastCollection<T>.Sort() FastCollection<T>.Sort(IComparer<T>) FastCollection<T>.Sort(int, int, IComparer<T>) FastCollection<T>.IsReadOnly FastCollection<T>.EnsureCapacity(int) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods ClearItems() protected override void ClearItems() ClearItemsEvents() protected void ClearItemsEvents() InsertItem(int, T) protected override void InsertItem(int index, T item) Parameters index int item T RemoveItem(int) protected override void RemoveItem(int index) Parameters index int SetItem(int, T) protected override void SetItem(int index, T item) Parameters index int item T Events CollectionChanged public event FastTrackingCollection<T>.FastEventHandler<FastTrackingCollectionChangedEventArgs> CollectionChanged Event Type FastTrackingCollection<T>.FastEventHandler<FastTrackingCollectionChangedEventArgs>"
  },
  "api/Stride.Core.Collections.FastTrackingCollectionChangedEventArgs.html": {
    "href": "api/Stride.Core.Collections.FastTrackingCollectionChangedEventArgs.html",
    "title": "Struct FastTrackingCollectionChangedEventArgs | Stride API",
    "summary": "Struct FastTrackingCollectionChangedEventArgs Namespace Stride.Core.Collections Assembly Stride.Core.dll public readonly struct FastTrackingCollectionChangedEventArgs Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors FastTrackingCollectionChangedEventArgs(NotifyCollectionChangedAction, object?, object?, int, bool) public FastTrackingCollectionChangedEventArgs(NotifyCollectionChangedAction action, object? item, object? oldItem, int index = -1, bool collectionChanged = false) Parameters action NotifyCollectionChangedAction item object oldItem object index int collectionChanged bool FastTrackingCollectionChangedEventArgs(NotifyCollectionChangedAction, object, object, object?, bool) public FastTrackingCollectionChangedEventArgs(NotifyCollectionChangedAction action, object key, object item, object? oldItem, bool collectionChanged = false) Parameters action NotifyCollectionChangedAction key object item object oldItem object collectionChanged bool Properties Action Gets the type of action performed. Allowed values are Add and Remove. public NotifyCollectionChangedAction Action { get; } Property Value NotifyCollectionChangedAction CollectionChanged Gets a value indicating whether [collection changed (not a replacement but real insertion/removal)]. public bool CollectionChanged { get; } Property Value bool true if [collection changed]; otherwise, false. Index Gets the index in the collection (if applicable). public int Index { get; } Property Value int Item Gets the added or removed item (if dictionary, value only). public object? Item { get; } Property Value object Key Gets the added or removed key (if dictionary). public object? Key { get; } Property Value object OldItem Gets the previous value. Only valid if Action is Add and Remove public object? OldItem { get; } Property Value object"
  },
  "api/Stride.Core.Collections.IReadOnlySet-1.html": {
    "href": "api/Stride.Core.Collections.IReadOnlySet-1.html",
    "title": "Interface IReadOnlySet<T> | Stride API",
    "summary": "Interface IReadOnlySet<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a strongly-typed, read-only set of element. public interface IReadOnlySet<T> : IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable Type Parameters T The type of the elements. Inherited Members IReadOnlyCollection<T>.Count IEnumerable<T>.GetEnumerator() Extension Methods EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods Contains(T) Determines whether the set [contains] [the specified item]. bool Contains(T item) Parameters item T The item. Returns bool true if the set [contains] [the specified item]; otherwise, false."
  },
  "api/Stride.Core.Collections.ITrackingCollectionChanged.html": {
    "href": "api/Stride.Core.Collections.ITrackingCollectionChanged.html",
    "title": "Interface ITrackingCollectionChanged | Stride API",
    "summary": "Interface ITrackingCollectionChanged Namespace Stride.Core.Collections Assembly Stride.Core.dll public interface ITrackingCollectionChanged Extension Methods UnsafeUtilities.As<T>(object?) Events CollectionChanged Occurs when [collection changed]. event EventHandler<TrackingCollectionChangedEventArgs> CollectionChanged Event Type EventHandler<TrackingCollectionChangedEventArgs>"
  },
  "api/Stride.Core.Collections.IndexingDictionary-1.html": {
    "href": "api/Stride.Core.Collections.IndexingDictionary-1.html",
    "title": "Class IndexingDictionary<T> | Stride API",
    "summary": "Class IndexingDictionary<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll A dictionary that maps index values to items. It uses a sparse list internally for storage. [DataSerializer(typeof(IndexingDictionarySerializer<>), Mode = DataSerializerGenericMode.GenericArguments)] public class IndexingDictionary<T> : IDictionary<int, T>, ICollection<KeyValuePair<int, T>>, IEnumerable<KeyValuePair<int, T>>, IEnumerable where T : class Type Parameters T The type of item indexed in this collection. Inheritance object IndexingDictionary<T> Implements IDictionary<int, T> ICollection<KeyValuePair<int, T>> IEnumerable<KeyValuePair<int, T>> IEnumerable Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Properties Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. this[int] Gets or sets the element with the specified key. public T this[int index] { get; set; } Parameters index int Property Value T The element with the specified key. Exceptions ArgumentNullException key is null. KeyNotFoundException The property is retrieved and key is not found. NotSupportedException The property is set and the IDictionary<TKey, TValue> is read-only. Keys Gets an ICollection<T> containing the keys of the IDictionary<TKey, TValue>. public ICollection<int> Keys { get; } Property Value ICollection<int> An ICollection<T> containing the keys of the object that implements IDictionary<TKey, TValue>. Values Gets an ICollection<T> containing the values in the IDictionary<TKey, TValue>. public ICollection<T> Values { get; } Property Value ICollection<T> An ICollection<T> containing the values in the object that implements IDictionary<TKey, TValue>. Methods Add(KeyValuePair<int, T>) Adds an item to the ICollection<T>. public void Add(KeyValuePair<int, T> item) Parameters item KeyValuePair<int, T> The object to add to the ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. Add(int, T) Adds an element with the provided key and value to the IDictionary<TKey, TValue>. public void Add(int key, T value) Parameters key int The object to use as the key of the element to add. value T The object to use as the value of the element to add. Exceptions ArgumentNullException key is null. ArgumentException An element with the same key already exists in the IDictionary<TKey, TValue>. NotSupportedException The IDictionary<TKey, TValue> is read-only. Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. Contains(KeyValuePair<int, T>) Determines whether the ICollection<T> contains a specific value. public bool Contains(KeyValuePair<int, T> item) Parameters item KeyValuePair<int, T> The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. ContainsKey(int) Determines whether the IDictionary<TKey, TValue> contains an element with the specified key. public bool ContainsKey(int index) Parameters index int Returns bool true if the IDictionary<TKey, TValue> contains an element with the key; otherwise, false. Exceptions ArgumentNullException key is null. CopyTo(KeyValuePair<int, T>[], int) Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. public void CopyTo(KeyValuePair<int, T>[] array, int arrayIndex) Parameters array KeyValuePair<int, T>[] The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing. arrayIndex int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException arrayIndex is less than 0. ArgumentException The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array. GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<KeyValuePair<int, T>> GetEnumerator() Returns IEnumerator<KeyValuePair<int, T>> An enumerator that can be used to iterate through the collection. Remove(KeyValuePair<int, T>) Removes the first occurrence of a specific object from the ICollection<T>. public bool Remove(KeyValuePair<int, T> item) Parameters item KeyValuePair<int, T> The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. Remove(int) Removes the element with the specified key from the IDictionary<TKey, TValue>. public bool Remove(int index) Parameters index int Returns bool true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary<TKey, TValue>. Exceptions ArgumentNullException key is null. NotSupportedException The IDictionary<TKey, TValue> is read-only. SafeGet(int) public T? SafeGet(int index) Parameters index int Returns T TryGetValue(int, out T) Gets the value associated with the specified key. public bool TryGetValue(int key, out T value) Parameters key int The key whose value to get. value T When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized. Returns bool true if the object that implements IDictionary<TKey, TValue> contains an element with the specified key; otherwise, false. Exceptions ArgumentNullException key is null."
  },
  "api/Stride.Core.Collections.KeyedSortedList-2.Enumerator.html": {
    "href": "api/Stride.Core.Collections.KeyedSortedList-2.Enumerator.html",
    "title": "Struct KeyedSortedList<TKey, T>.Enumerator | Stride API",
    "summary": "Struct KeyedSortedList<TKey, T>.Enumerator Namespace Stride.Core.Collections Assembly Stride.Core.dll public struct KeyedSortedList<TKey, T>.Enumerator : IEnumerator<T>, IEnumerator, IDisposable Implements IEnumerator<T> IEnumerator IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Current Gets the element in the collection at the current position of the enumerator. public readonly T Current { get; } Property Value T The element in the collection at the current position of the enumerator. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public readonly void Dispose() MoveNext() Advances the enumerator to the next element of the collection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created."
  },
  "api/Stride.Core.Collections.KeyedSortedList-2.html": {
    "href": "api/Stride.Core.Collections.KeyedSortedList-2.html",
    "title": "Class KeyedSortedList<TKey, T> | Stride API",
    "summary": "Class KeyedSortedList<TKey, T> Namespace Stride.Core.Collections Assembly Stride.Core.dll List of items, stored sequentially and sorted by an implicit invariant key that are extracted from items by implementing GetKeyForItem(T). public abstract class KeyedSortedList<TKey, T> : ICollection<T>, IEnumerable<T>, ICollection, IEnumerable where TKey : notnull Type Parameters TKey The type of the key. T The type of the item in the collection. Inheritance object KeyedSortedList<TKey, T> Implements ICollection<T> IEnumerable<T> ICollection IEnumerable Derived RootAssetCollection Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors KeyedSortedList() protected KeyedSortedList() KeyedSortedList(IComparer<TKey>?) protected KeyedSortedList(IComparer<TKey>? comparer) Parameters comparer IComparer<TKey> Fields items protected FastListStruct<T> items Field Value FastListStruct<T> Properties Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. this[int] public T this[int index] { get; set; } Parameters index int Property Value T this[TKey] public T this[TKey key] { get; set; } Parameters key TKey Property Value T Methods Add(T) Adds an item to the ICollection<T>. public void Add(T item) Parameters item T The object to add to the ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. BinarySearch(TKey) public int BinarySearch(TKey searchKey) Parameters searchKey TKey Returns int Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. Contains(T) Determines whether the ICollection<T> contains a specific value. public bool Contains(T item) Parameters item T The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. ContainsKey(TKey) public bool ContainsKey(TKey key) Parameters key TKey Returns bool GetEnumerator() public KeyedSortedList<TKey, T>.Enumerator GetEnumerator() Returns KeyedSortedList<TKey, T>.Enumerator GetKeyForItem(T) Extracts the key for the specified element. protected abstract TKey GetKeyForItem(T item) Parameters item T The element from which to extract the key. Returns TKey The key for the specified item. IndexOf(T) public int IndexOf(T item) Parameters item T Returns int InsertItem(int, T) Called every time an item should be added at a given index. protected virtual void InsertItem(int index, T item) Parameters index int The index. item T The item. Remove(TKey) public bool Remove(TKey key) Parameters key TKey Returns bool Remove(T) public void Remove(T item) Parameters item T RemoveItem(int) Called every time an item should be removed at a given index. protected virtual void RemoveItem(int index) Parameters index int The index. Sort() Sorts again this list (in case keys were mutated). public void Sort() TryGetValue(TKey, out T) public bool TryGetValue(TKey key, out T value) Parameters key TKey value T Returns bool"
  },
  "api/Stride.Core.Collections.MultiValueSortedDictionary-2.Enumerator.html": {
    "href": "api/Stride.Core.Collections.MultiValueSortedDictionary-2.Enumerator.html",
    "title": "Struct MultiValueSortedDictionary<TKey, TValue>.Enumerator | Stride API",
    "summary": "Struct MultiValueSortedDictionary<TKey, TValue>.Enumerator Namespace Stride.Core.Collections Assembly Stride.Core.dll Enumerates the elements of a KoderHack.MultiValueSortedDictionary<TKey,TValue>. public struct MultiValueSortedDictionary<TKey, TValue>.Enumerator : IEnumerator<KeyValuePair<TKey, TValue>>, IDisposable, IDictionaryEnumerator, IEnumerator Implements IEnumerator<KeyValuePair<TKey, TValue>> IDisposable IDictionaryEnumerator IEnumerator Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Enumerator(MultiValueSortedDictionary<TKey, TValue>) public Enumerator(MultiValueSortedDictionary<TKey, TValue> dictionary) Parameters dictionary MultiValueSortedDictionary<TKey, TValue> Properties Current Gets the element at the current position of the enumerator. public KeyValuePair<TKey, TValue> Current { get; } Property Value KeyValuePair<TKey, TValue> The element in the SortedDictionary<TKey, TValue> at the current position of the enumerator. Methods Dispose() Releases all resources used by the KoderHack.MultiValueSortedDictionary<TKey,TValue>.Enumerator. public void Dispose() MoveNext() Advances the enumerator to the next element of the KoderHack.MultiValueSortedDictionary<TKey,TValue>. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created."
  },
  "api/Stride.Core.Collections.MultiValueSortedDictionary-2.ValueCollection.Enumerator.html": {
    "href": "api/Stride.Core.Collections.MultiValueSortedDictionary-2.ValueCollection.Enumerator.html",
    "title": "Struct MultiValueSortedDictionary<TKey, TValue>.ValueCollection.Enumerator | Stride API",
    "summary": "Struct MultiValueSortedDictionary<TKey, TValue>.ValueCollection.Enumerator Namespace Stride.Core.Collections Assembly Stride.Core.dll Enumerates the elements of a KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection. public struct MultiValueSortedDictionary<TKey, TValue>.ValueCollection.Enumerator : IEnumerator<TValue>, IDisposable, IEnumerator Implements IEnumerator<TValue> IDisposable IEnumerator Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Current Gets the element at the current position of the enumerator. public TValue Current { get; } Property Value TValue The element in the KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection at the current position of the enumerator. Methods Dispose() Releases all resources used by the KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection.Enumerator. public void Dispose() MoveNext() Advances the enumerator to the next element of the KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created."
  },
  "api/Stride.Core.Collections.MultiValueSortedDictionary-2.ValueCollection.html": {
    "href": "api/Stride.Core.Collections.MultiValueSortedDictionary-2.ValueCollection.html",
    "title": "Class MultiValueSortedDictionary<TKey, TValue>.ValueCollection | Stride API",
    "summary": "Class MultiValueSortedDictionary<TKey, TValue>.ValueCollection Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents the collection of values in a KoderHack.MultiValueSortedDictionary<TKey,TValue>. This class cannot be inherited public sealed class MultiValueSortedDictionary<TKey, TValue>.ValueCollection : ICollection<TValue>, IEnumerable<TValue>, ICollection, IEnumerable Inheritance object MultiValueSortedDictionary<TKey, TValue>.ValueCollection Implements ICollection<TValue> IEnumerable<TValue> ICollection IEnumerable Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors ValueCollection(MultiValueSortedDictionary<TKey, TValue>) Initializes a new instance of the KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection class that reflects the values in the specified KoderHack.MultiValueSortedDictionary<TKey,TValue>. public ValueCollection(MultiValueSortedDictionary<TKey, TValue> dictionary) Parameters dictionary MultiValueSortedDictionary<TKey, TValue> The KoderHack.MultiValueSortedDictionary<TKey,TValue> whose values are reflected in the new KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection. Exceptions ArgumentNullException dictionary is null. Properties Count Gets the number of elements contained in the KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection. public int Count { get; } Property Value int The number of elements contained in the KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection. Methods CopyTo(TValue[], int) Copies the KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection elements to an existing one-dimensional array, starting at the specified array index. public void CopyTo(TValue[] array, int index) Parameters array TValue[] The one-dimensional array that is the destination of the elements copied from the KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection. The array must have zero-based indexing. index int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException index is less than 0. ArgumentException index is equal to or greater than the length of array. -or- The number of elements in the source KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection is greater than the available space from index to the end of the destination array. GetEnumerator() Returns an enumerator that iterates through the KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection. public MultiValueSortedDictionary<TKey, TValue>.ValueCollection.Enumerator GetEnumerator() Returns MultiValueSortedDictionary<TKey, TValue>.ValueCollection.Enumerator A KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection.Enumerator structure for the KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection."
  },
  "api/Stride.Core.Collections.MultiValueSortedDictionary-2.html": {
    "href": "api/Stride.Core.Collections.MultiValueSortedDictionary-2.html",
    "title": "Class MultiValueSortedDictionary<TKey, TValue> | Stride API",
    "summary": "Class MultiValueSortedDictionary<TKey, TValue> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a priority queue, where keys are sorted and each key might have mlutiple values. public class MultiValueSortedDictionary<TKey, TValue> : IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IDictionary, ICollection, IEnumerable where TKey : notnull Type Parameters TKey The type of the key. TValue The type of the value. Inheritance object MultiValueSortedDictionary<TKey, TValue> Implements IDictionary<TKey, TValue> ICollection<KeyValuePair<TKey, TValue>> IEnumerable<KeyValuePair<TKey, TValue>> IDictionary ICollection IEnumerable Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Remarks Storage is based on a SortedDictionary<TKey, TValue>. Constructors MultiValueSortedDictionary() Initializes a new instance of the KoderHack.MultiValueSortedDictionary<TKey,TValue> class that is empty and uses the default System.Collections.Generic.IComparer<TKey> implementation to compare keys. public MultiValueSortedDictionary() MultiValueSortedDictionary(IComparer<TKey>) Initializes a new instance of the KoderHack.MultiValueSortedDictionary<TKey,TValue> class that is empty and uses the specified System.Collections.Generic.IComparer<TKey> implementation to compare keys. public MultiValueSortedDictionary(IComparer<TKey> comparer) Parameters comparer IComparer<TKey> The System.Collections.Generic.IComparer<TKey> implementation to use when comparing keys, or null to use the default System.Collections.Generic.Comparer<TKey> for the type of the key. MultiValueSortedDictionary(IDictionary<TKey, TValue>) Initializes a new instance of the KoderHack.MultiValueSortedDictionary<TKey,TValue> class that contains elements copied from the specified System.Collections.Generic.IDictionary<TKey,TValue> and uses the default System.Collections.Generic.IComparer<T> implementation for the key type. public MultiValueSortedDictionary(IDictionary<TKey, TValue> dictionary) Parameters dictionary IDictionary<TKey, TValue> The System.Collections.Generic.IDictionary<TKey,TValue> whose elements are copied to the new KoderHack.MultiValueSortedDictionary<TKey,TValue>. Exceptions ArgumentNullException dictionary is null MultiValueSortedDictionary(IDictionary<TKey, TValue>, IComparer<TKey>) Initializes a new instance of the KoderHack.MultiValueSortedDictionary<TKey,TValue> class that contains elements copied from the specified System.Collections.Generic.IDictionary<TKey,TValue> and uses the specified System.Collections.Generic.IComparer<TKey> implementation to compare keys. public MultiValueSortedDictionary(IDictionary<TKey, TValue> dictionary, IComparer<TKey> comparer) Parameters dictionary IDictionary<TKey, TValue> The System.Collections.Generic.IDictionary<TKey,TValue> whose elements are copied to the new KoderHack.MultiValueSortedDictionary<TKey,TValue>. comparer IComparer<TKey> The System.Collections.Generic.IComparer<T> implementation to use when comparing keys, or null to use the default System.Collections.Generic.Comparer<TKey> for the type of the key. Exceptions ArgumentNullException dictionary is null Properties Comparer Gets the System.Collections.Generic.IComparer<TKey> used to order the elements of the KoderHack.MultiValueSortedDictionary<TKey,TValue>. public IComparer<TKey> Comparer { get; } Property Value IComparer<TKey> The System.Collections.Generic.IComparer<TKey> used to order the elements of the KoderHack.MultiValueSortedDictionary<TKey,TValue> Count Gets the number of key/value pairs contained in the KoderHack.MultiValueSortedDictionary<TKey,TValue>. public int Count { get; } Property Value int The number of key/value pairs contained in the KoderHack.MultiValueSortedDictionary<TKey,TValue>. this[TKey] Gets or sets the value associated with the specified key. public TValue this[TKey key] { get; set; } Parameters key TKey The key of the value to get or set. Property Value TValue The value associated with the specified key. If the specified key is not found, a get operation throws a System.Collections.Generic.KeyNotFoundException, and a set operation creates a new element with the specified key. Exceptions ArgumentNullException key is null. KeyNotFoundException The property is retrieved and key does not exist in the collection. Keys Gets a collection containing the keys in the KoderHack.MultiValueSortedDictionary<TKey,TValue>. public SortedDictionary<TKey, List<TValue>>.KeyCollection Keys { get; } Property Value SortedDictionary<TKey, List<TValue>>.KeyCollection A KoderHack.MultiValueSortedDictionary<TKey,TValue>.KeyCollection containing the keys in the KoderHack.MultiValueSortedDictionary<TKey,TValue>. Values Gets a collection containing the values in the KoderHack.MultiValueSortedDictionary<TKey,TValue>. public MultiValueSortedDictionary<TKey, TValue>.ValueCollection Values { get; } Property Value MultiValueSortedDictionary<TKey, TValue>.ValueCollection A KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection containing the keys in the KoderHack.MultiValueSortedDictionary<TKey,TValue>. Methods Add(TKey, TValue) Adds an element with the specified key and value into the KoderHack.MultiValueSortedDictionary<TKey,TValue>. public void Add(TKey key, TValue value) Parameters key TKey The key of the element to add. value TValue The value of the element to add. The value can be null for reference types. Exceptions ArgumentNullException key is null. Clear() Removes all elements from the KoderHack.MultiValueSortedDictionary<TKey,TValue>. public void Clear() ContainsKey(TKey) Determines whether the KoderHack.MultiValueSortedDictionary<TKey,TValue> contains an element with the specified key. public bool ContainsKey(TKey key) Parameters key TKey The key to locate in the KoderHack.MultiValueSortedDictionary<TKey,TValue>. Returns bool true if the KoderHack.MultiValueSortedDictionary<TKey,TValue> contains an element with the specified key; otherwise, false. Exceptions ArgumentNullException key is null. ContainsValue(TValue) Determines whether the KoderHack.MultiValueSortedDictionary<TKey,TValue> contains an element with the specified value. public bool ContainsValue(TValue value) Parameters value TValue The value to locate in the KoderHack.MultiValueSortedDictionary<TKey,TValue>. The value can be null for reference types. Returns bool true if the KoderHack.MultiValueSortedDictionary<TKey,TValue> contains an element with the specified value; otherwise, false. CopyTo(KeyValuePair<TKey, TValue>[], int) Copies the elements of the KoderHack.MultiValueSortedDictionary<TKey,TValue> to the specified array of KeyValuePair<TKey, TValue> structures, starting at the specified index. public void CopyTo(KeyValuePair<TKey, TValue>[] array, int index) Parameters array KeyValuePair<TKey, TValue>[] The one-dimensional array of KeyValuePair<TKey, TValue> structures that is the destination of the elements copied from the current KoderHack.MultiValueSortedDictionary<TKey,TValue> The array must have zero-based indexing. index int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException index is equal to or greater than the length of array. -or- index is less than 0. ArgumentException The number of elements in the source KoderHack.MultiValueSortedDictionary<TKey,TValue> is greater than the available space from index to the end of the destination array. GetEnumerator() Returns an enumerator that iterates through the KoderHack.MultiValueSortedDictionary<TKey,TValue>. public MultiValueSortedDictionary<TKey, TValue>.Enumerator GetEnumerator() Returns MultiValueSortedDictionary<TKey, TValue>.Enumerator A KoderHack.MultiValueSortedDictionary<TKey,TValue>.Enumerator for the KoderHack.MultiValueSortedDictionary<TKey,TValue>. Remove(KeyValuePair<TKey, TValue>) Removes the element with the specified key from the KoderHack.MultiValueSortedDictionary<TKey,TValue>. public bool Remove(KeyValuePair<TKey, TValue> item) Parameters item KeyValuePair<TKey, TValue> The key of the element to remove. Returns bool true if the element is successfully removed; otherwise, false. This method also returns false if key is not found in the KoderHack.MultiValueSortedDictionary<TKey,TValue>. Exceptions ArgumentNullException key is null. Remove(TKey) Removes the elements with the specified key from the KoderHack.MultiValueSortedDictionary<TKey,TValue>. public bool Remove(TKey key) Parameters key TKey The key of the element to remove. Returns bool true if the element is successfully removed; otherwise, false. This method also returns false if key is not found in the KoderHack.MultiValueSortedDictionary<TKey,TValue>. Exceptions ArgumentNullException key is null. TryGetValue(TKey, out IEnumerable<TValue>) Gets the value associated with the specified key. public bool TryGetValue(TKey key, out IEnumerable<TValue> values) Parameters key TKey The key of the value to get. values IEnumerable<TValue> When this method returns, the values associated with the specified key, if the key is found; otherwise null. Returns bool true if the KoderHack.MultiValueSortedDictionary<TKey,TValue> contains an element with the specified key; otherwise, false. Exceptions ArgumentNullException key is null. TryGetValue(TKey, out TValue) Gets the value associated with the specified key. public bool TryGetValue(TKey key, out TValue value) Parameters key TKey The key of the value to get. value TValue When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. Returns bool true if the KoderHack.MultiValueSortedDictionary<TKey,TValue> contains an element with the specified key; otherwise, false. Exceptions ArgumentNullException key is null. TryToGetOnNotFound(TKey) protected virtual object TryToGetOnNotFound(TKey name) Parameters name TKey Returns object"
  },
  "api/Stride.Core.Collections.MultiValueSortedList-2.html": {
    "href": "api/Stride.Core.Collections.MultiValueSortedList-2.html",
    "title": "Class MultiValueSortedList<TKey, TValue> | Stride API",
    "summary": "Class MultiValueSortedList<TKey, TValue> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a priority queue, where keys are sorted and each key might have mlutiple values. public class MultiValueSortedList<TKey, TValue> : ILookup<TKey, TValue>, IEnumerable<IGrouping<TKey, TValue>>, ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, ICollection, IEnumerable where TKey : IComparable<TKey> Type Parameters TKey The type of the key. TValue The type of the value. Inheritance object MultiValueSortedList<TKey, TValue> Implements ILookup<TKey, TValue> IEnumerable<IGrouping<TKey, TValue>> ICollection<KeyValuePair<TKey, TValue>> IEnumerable<KeyValuePair<TKey, TValue>> ICollection IEnumerable Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Remarks Storage is based on a List<T> and a List<T>. Properties Count Gets the number of key/value collection pairs in the ILookup<TKey, TElement>. public int Count { get; } Property Value int The number of key/value collection pairs in the ILookup<TKey, TElement>. IsFixedSize public bool IsFixedSize { get; } Property Value bool IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. IsSynchronized Gets a value indicating whether access to the ICollection is synchronized (thread safe). public bool IsSynchronized { get; } Property Value bool true if access to the ICollection is synchronized (thread safe); otherwise, false. this[TKey] Gets the IEnumerable<T> sequence of values indexed by a specified key. public IEnumerable<TValue> this[TKey key] { get; } Parameters key TKey The key of the desired sequence of values. Property Value IEnumerable<TValue> The IEnumerable<T> sequence of values indexed by the specified key. Keys public IEnumerable<TKey> Keys { get; } Property Value IEnumerable<TKey> SyncRoot Gets an object that can be used to synchronize access to the ICollection. public object SyncRoot { get; } Property Value object An object that can be used to synchronize access to the ICollection. Values public IEnumerable<TValue> Values { get; } Property Value IEnumerable<TValue> Methods Add(KeyValuePair<TKey, TValue>) Adds an item to the ICollection<T>. public void Add(KeyValuePair<TKey, TValue> item) Parameters item KeyValuePair<TKey, TValue> The object to add to the ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. Add(object, object) public void Add(object key, object value) Parameters key object value object Add(TKey, TValue) public void Add(TKey key, TValue value) Parameters key TKey value TValue Contains(KeyValuePair<TKey, TValue>) Determines whether the ICollection<T> contains a specific value. public bool Contains(KeyValuePair<TKey, TValue> item) Parameters item KeyValuePair<TKey, TValue> The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. Contains(object) public bool Contains(object key) Parameters key object Returns bool Contains(TKey) Determines whether a specified key exists in the ILookup<TKey, TElement>. public bool Contains(TKey key) Parameters key TKey The key to search for in the ILookup<TKey, TElement>. Returns bool true if key is in the ILookup<TKey, TElement>; otherwise, false. ContainsKey(TKey) public bool ContainsKey(TKey key) Parameters key TKey Returns bool CopyTo(Array, int) Copies the elements of the ICollection to an Array, starting at a particular Array index. public void CopyTo(Array array, int index) Parameters array Array The one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing. index int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException index is less than zero. ArgumentException array is multidimensional. -or- The number of elements in the source ICollection is greater than the available space from index to the end of the destination array. -or- The type of the source ICollection cannot be cast automatically to the type of the destination array. CopyTo(KeyValuePair<TKey, TValue>[], int) Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. public void CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex) Parameters array KeyValuePair<TKey, TValue>[] The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing. arrayIndex int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException arrayIndex is less than 0. ArgumentException The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array. GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<IGrouping<TKey, TValue>> GetEnumerator() Returns IEnumerator<IGrouping<TKey, TValue>> An enumerator that can be used to iterate through the collection. Remove(KeyValuePair<TKey, TValue>) Removes the first occurrence of a specific object from the ICollection<T>. public bool Remove(KeyValuePair<TKey, TValue> item) Parameters item KeyValuePair<TKey, TValue> The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. Remove(TKey) public bool Remove(TKey key) Parameters key TKey Returns bool"
  },
  "api/Stride.Core.Collections.OrderedCollection-1.Enumerator.html": {
    "href": "api/Stride.Core.Collections.OrderedCollection-1.Enumerator.html",
    "title": "Struct OrderedCollection<T>.Enumerator | Stride API",
    "summary": "Struct OrderedCollection<T>.Enumerator Namespace Stride.Core.Collections Assembly Stride.Core.dll public struct OrderedCollection<T>.Enumerator : IEnumerator<T>, IEnumerator, IDisposable Implements IEnumerator<T> IEnumerator IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Current Gets the element in the collection at the current position of the enumerator. public readonly T Current { get; } Property Value T The element in the collection at the current position of the enumerator. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public readonly void Dispose() MoveNext() Advances the enumerator to the next element of the collection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created."
  },
  "api/Stride.Core.Collections.OrderedCollection-1.html": {
    "href": "api/Stride.Core.Collections.OrderedCollection-1.html",
    "title": "Class OrderedCollection<T> | Stride API",
    "summary": "Class OrderedCollection<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll A collection that maintains the order of the elements and lightter implementation of Collection<T> with value types enumerators to avoid allocation in foreach loops, and various helper functions. [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] public class OrderedCollection<T> : ICollection<T>, IEnumerable<T>, IEnumerable Type Parameters T Type of elements of this collection Inheritance object OrderedCollection<T> Implements ICollection<T> IEnumerable<T> IEnumerable Derived EntityProcessorCollection Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors OrderedCollection(IComparer<T>) Initializes a new instance of the OrderedCollection<T> class. public OrderedCollection(IComparer<T> comparer) Parameters comparer IComparer<T> The comparer providing information about order between elements. Exceptions ArgumentNullException If comparer is null OrderedCollection(IComparer<T>, int) Initializes a new instance of the OrderedCollection<T> class with a default capacity. public OrderedCollection(IComparer<T> comparer, int capacity) Parameters comparer IComparer<T> The comparer. capacity int The capacity. Properties Capacity public int Capacity { get; set; } Property Value int Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. this[int] Gets the element T at the specified index. public T this[int index] { get; } Parameters index int The index. Property Value T The element at the specified index Exceptions ArgumentOutOfRangeException If index is out of range Methods Add(T) Adds an item to the ICollection<T>. public void Add(T item) Parameters item T The object to add to the ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. AddItem(T) Adds an item to this collection. Can be overriden. protected virtual void AddItem(T item) Parameters item T The item. AddRange<TE>(TE) Adds the elements of the specified source to the end of FastCollection<T>. public void AddRange<TE>(TE itemsArgs) where TE : IEnumerable<T> Parameters itemsArgs TE The items to add to this collection. Type Parameters TE Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. ClearItems() Clears all the items in this collection. Can be overriden. protected virtual void ClearItems() Contains(T) Determines whether the ICollection<T> contains a specific value. public bool Contains(T item) Parameters item T The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. CopyTo(T[], int) Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. public void CopyTo(T[] array, int arrayIndex) Parameters array T[] The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing. arrayIndex int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException arrayIndex is less than 0. ArgumentException The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array. EnsureCapacity(int) public void EnsureCapacity(int min) Parameters min int GetEnumerator() Inline Enumerator used directly by foreach. public OrderedCollection<T>.Enumerator GetEnumerator() Returns OrderedCollection<T>.Enumerator An enumerator of this collection IndexOf(T) public int IndexOf(T item) Parameters item T Returns int RemoteItem(int) protected virtual void RemoteItem(int index) Parameters index int Remove(T) Removes the first occurrence of a specific object from the ICollection<T>. public bool Remove(T item) Parameters item T The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. RemoveAt(int) public void RemoveAt(int index) Parameters index int"
  },
  "api/Stride.Core.Collections.PoolListStruct-1.html": {
    "href": "api/Stride.Core.Collections.PoolListStruct-1.html",
    "title": "Struct PoolListStruct<T> | Stride API",
    "summary": "Struct PoolListStruct<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll A pool of objects allocated and can be cleared without losing previously allocated instance. public struct PoolListStruct<T> : IEnumerable<T>, IEnumerable where T : class Type Parameters T Type of the pooled object Implements IEnumerable<T> IEnumerable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors PoolListStruct(int, Func<T>) Initializes a new instance of the PoolListStruct<T> struct. public PoolListStruct(int capacity, Func<T> factory) Parameters capacity int The capacity. factory Func<T> The factory. Exceptions ArgumentNullException factory Fields Count The number of objects in use, readonly. public int Count Field Value int Properties this[int] Gets or sets the item at the specified index. public readonly T this[int index] { get; set; } Parameters index int The index. Property Value T An instance of T this[uint] Gets or sets the item at the specified index. public readonly T this[uint index] { get; set; } Parameters index uint The index. Property Value T An instance of T Methods Add() Adds a new object in use to this instance. public T Add() Returns T An instance of T Clear() Clears objects in use and keep allocated objects. public void Clear() GetEnumerator() public readonly FastListStruct<T>.Enumerator GetEnumerator() Returns FastListStruct<T>.Enumerator IndexOf(T) Gets the index of item public readonly int IndexOf(T item) Parameters item T The item to get the index of Returns int Index of the item, or -1 if the item is not in this list Remove(T) Removes the object from the list public void Remove(T item) Parameters item T The item to remove Remarks The item is added back in the pool to be reused for the next Add() RemoveAt(int) public void RemoveAt(int index) Parameters index int Reset() Resets this instance by releasing allocated objects. public void Reset()"
  },
  "api/Stride.Core.Collections.PriorityNodeQueue-1.html": {
    "href": "api/Stride.Core.Collections.PriorityNodeQueue-1.html",
    "title": "Class PriorityNodeQueue<T> | Stride API",
    "summary": "Class PriorityNodeQueue<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Implements a priority queue of type T. Elements may be added to the queue in any order, but when we pull elements out of the queue, they will be returned in 'ascending' order. Adding new elements into the queue may be done at any time, so this is useful to implement a dynamically growing and shrinking queue. Both adding an element and removing the first element are log(N) operations. The queue is implemented using a priority-heap data structure. For more details on this elegant and simple data structure see \"Programming Pearls\" in our library. The tree is implemented atop a list, where 2N and 2N+1 are the child nodes of node N. The tree is balanced and left-aligned so there are no 'holes' in this list. public class PriorityNodeQueue<T> Type Parameters T Type T. Inheritance object PriorityNodeQueue<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors PriorityNodeQueue() public PriorityNodeQueue() PriorityNodeQueue(IComparer<T>) public PriorityNodeQueue(IComparer<T> comparer) Parameters comparer IComparer<T> Properties Count Returns the number of elements in the queue. public int Count { get; } Property Value int Empty Returns true if the queue is empty. public bool Empty { get; } Property Value bool Methods Clear() Clear all the elements from the priority queue public void Clear() Dequeue() Removes and returns the first element from the queue (least element) public T Dequeue() Returns T The first element in the queue, in ascending order. Enqueue(PriorityQueueNode<T>) Add an element to the priority queue - O(log(n)) time operation. public void Enqueue(PriorityQueueNode<T> item) Parameters item PriorityQueueNode<T> The item to be added to the queue Enqueue(T) Add an element to the priority queue - O(log(n)) time operation. public PriorityQueueNode<T> Enqueue(T item) Parameters item T The item to be added to the queue Returns PriorityQueueNode<T> A node representing the item. Peek() Allows you to look at the first element waiting in the queue, without removing it. public T Peek() Returns T Remove(PriorityQueueNode<T>) Removes the specified item. public void Remove(PriorityQueueNode<T> item) Parameters item PriorityQueueNode<T> The item to remove."
  },
  "api/Stride.Core.Collections.PriorityQueue-1.html": {
    "href": "api/Stride.Core.Collections.PriorityQueue-1.html",
    "title": "Class PriorityQueue<T> | Stride API",
    "summary": "Class PriorityQueue<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a sorted queue, with logarithmic time insertion and deletion. public class PriorityQueue<T> Type Parameters T The type of the elements in the queue. Inheritance object PriorityQueue<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors PriorityQueue() public PriorityQueue() PriorityQueue(IComparer<T>) public PriorityQueue(IComparer<T> comparer) Parameters comparer IComparer<T> Properties Count public int Count { get; } Property Value int Empty public bool Empty { get; } Property Value bool Methods Clear() public void Clear() Dequeue() Removes and returns the object at the beginning of the PriorityQueue<T>. public T Dequeue() Returns T The object at the beginning of the PriorityQueue<T>. Enqueue(T) Adds an object to the PriorityQueue<T> and sorts underlying container. public void Enqueue(T item) Parameters item T The object to add to the queue. Peek() Returns the object at the beginning of the PriorityQueue<T>, without removing it. public T Peek() Returns T The object at the beginning of the PriorityQueue<T>. Remove(T) public void Remove(T item) Parameters item T"
  },
  "api/Stride.Core.Collections.PriorityQueueNode-1.html": {
    "href": "api/Stride.Core.Collections.PriorityQueueNode-1.html",
    "title": "Class PriorityQueueNode<T> | Stride API",
    "summary": "Class PriorityQueueNode<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a node in a priority queue, to allow O(n) removal. public class PriorityQueueNode<T> Type Parameters T Inheritance object PriorityQueueNode<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors PriorityQueueNode(T) public PriorityQueueNode(T value) Parameters value T Fields Value public T Value Field Value T Properties Index public int Index { get; } Property Value int"
  },
  "api/Stride.Core.Collections.ReadOnlySet-1.html": {
    "href": "api/Stride.Core.Collections.ReadOnlySet-1.html",
    "title": "Class ReadOnlySet<T> | Stride API",
    "summary": "Class ReadOnlySet<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a strongly-typed, read-only set of element. public class ReadOnlySet<T> : IReadOnlySet<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable Type Parameters T The type of the elements. Inheritance object ReadOnlySet<T> Implements IReadOnlySet<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable Extension Methods EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors ReadOnlySet(ISet<T>) public ReadOnlySet(ISet<T> innerSet) Parameters innerSet ISet<T> Properties Count Gets the number of elements in the collection. public int Count { get; } Property Value int The number of elements in the collection. Methods Contains(T) Determines whether the set [contains] [the specified item]. public bool Contains(T item) Parameters item T The item. Returns bool true if the set [contains] [the specified item]; otherwise, false. GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<T> GetEnumerator() Returns IEnumerator<T> An enumerator that can be used to iterate through the collection."
  },
  "api/Stride.Core.Collections.SafeList-1.html": {
    "href": "api/Stride.Core.Collections.SafeList-1.html",
    "title": "Class SafeList<T> | Stride API",
    "summary": "Class SafeList<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll A list to ensure that all items are not null. [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] public class SafeList<T> : ConstrainedList<T>, IList<T>, ICollection<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable where T : class Type Parameters T Type of the item Inheritance object ConstrainedList<T> SafeList<T> Implements IList<T> ICollection<T> IReadOnlyList<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable Derived ColorTransformCollection Inherited Members ConstrainedList<T>.ThrowException ConstrainedList<T>.Constraint ConstrainedList<T>.GetEnumerator() ConstrainedList<T>.Add(T) ConstrainedList<T>.Clear() ConstrainedList<T>.Contains(T) ConstrainedList<T>.CopyTo(T[], int) ConstrainedList<T>.Remove(T) ConstrainedList<T>.Count ConstrainedList<T>.IsReadOnly ConstrainedList<T>.IndexOf(T) ConstrainedList<T>.Insert(int, T) ConstrainedList<T>.RemoveAt(int) ConstrainedList<T>.this[int] Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors SafeList() Initializes a new instance of the SafeList<T> class. public SafeList()"
  },
  "api/Stride.Core.Collections.SortedList-2.Enumerator.html": {
    "href": "api/Stride.Core.Collections.SortedList-2.Enumerator.html",
    "title": "Class SortedList<TKey, TValue>.Enumerator | Stride API",
    "summary": "Class SortedList<TKey, TValue>.Enumerator Namespace Stride.Core.Collections Assembly Stride.Core.dll public sealed class SortedList<TKey, TValue>.Enumerator : IEnumerator<KeyValuePair<TKey, TValue>>, IEnumerator, IDisposable Inheritance object SortedList<TKey, TValue>.Enumerator Implements IEnumerator<KeyValuePair<TKey, TValue>> IEnumerator IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors Enumerator(SortedList<TKey, TValue>) public Enumerator(SortedList<TKey, TValue> host) Parameters host SortedList<TKey, TValue> Properties Current Gets the element in the collection at the current position of the enumerator. public KeyValuePair<TKey, TValue> Current { get; } Property Value KeyValuePair<TKey, TValue> The element in the collection at the current position of the enumerator. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() MoveNext() Advances the enumerator to the next element of the collection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created. Reset() Sets the enumerator to its initial position, which is before the first element in the collection. public void Reset() Exceptions InvalidOperationException The collection was modified after the enumerator was created. NotSupportedException The enumerator does not support being reset."
  },
  "api/Stride.Core.Collections.SortedList-2.html": {
    "href": "api/Stride.Core.Collections.SortedList-2.html",
    "title": "Class SortedList<TKey, TValue> | Stride API",
    "summary": "Class SortedList<TKey, TValue> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a collection of associated keys and values that are sorted by the keys and are accessible by key and by index. public class SortedList<TKey, TValue> : IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IDictionary, ICollection, IEnumerable Type Parameters TKey TValue Inheritance object SortedList<TKey, TValue> Implements IDictionary<TKey, TValue> ICollection<KeyValuePair<TKey, TValue>> IEnumerable<KeyValuePair<TKey, TValue>> IDictionary ICollection IEnumerable Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors SortedList() public SortedList() SortedList(IComparer<TKey>) public SortedList(IComparer<TKey> comparer) Parameters comparer IComparer<TKey> SortedList(IDictionary<TKey, TValue>) public SortedList(IDictionary<TKey, TValue> dictionary) Parameters dictionary IDictionary<TKey, TValue> SortedList(IDictionary<TKey, TValue>, IComparer<TKey>) public SortedList(IDictionary<TKey, TValue> dictionary, IComparer<TKey> comparer) Parameters dictionary IDictionary<TKey, TValue> comparer IComparer<TKey> SortedList(int) public SortedList(int capacity) Parameters capacity int SortedList(int, IComparer<TKey>) public SortedList(int capacity, IComparer<TKey> comparer) Parameters capacity int comparer IComparer<TKey> Properties Capacity public int Capacity { get; set; } Property Value int Comparer public IComparer<TKey> Comparer { get; } Property Value IComparer<TKey> Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. this[TKey] Gets or sets the element with the specified key. public TValue this[TKey key] { get; set; } Parameters key TKey The key of the element to get or set. Property Value TValue The element with the specified key. Exceptions ArgumentNullException key is null. KeyNotFoundException The property is retrieved and key is not found. NotSupportedException The property is set and the IDictionary<TKey, TValue> is read-only. Keys public IList<TKey> Keys { get; } Property Value IList<TKey> Values public IList<TValue> Values { get; } Property Value IList<TValue> Methods Add(TKey, TValue) Adds an element with the provided key and value to the IDictionary<TKey, TValue>. public void Add(TKey key, TValue value) Parameters key TKey The object to use as the key of the element to add. value TValue The object to use as the value of the element to add. Exceptions ArgumentNullException key is null. ArgumentException An element with the same key already exists in the IDictionary<TKey, TValue>. NotSupportedException The IDictionary<TKey, TValue> is read-only. Clear() Removes all elements from the IDictionary object. public void Clear() Exceptions NotSupportedException The IDictionary object is read-only. ContainsKey(TKey) Determines whether the IDictionary<TKey, TValue> contains an element with the specified key. public bool ContainsKey(TKey key) Parameters key TKey The key to locate in the IDictionary<TKey, TValue>. Returns bool true if the IDictionary<TKey, TValue> contains an element with the key; otherwise, false. Exceptions ArgumentNullException key is null. ContainsValue(TValue) public bool ContainsValue(TValue value) Parameters value TValue Returns bool GetEnumerator() public SortedList<TKey, TValue>.Enumerator GetEnumerator() Returns SortedList<TKey, TValue>.Enumerator IndexOfKey(TKey) public int IndexOfKey(TKey key) Parameters key TKey Returns int IndexOfValue(TValue) public int IndexOfValue(TValue value) Parameters value TValue Returns int Remove(TKey) Removes the element with the specified key from the IDictionary<TKey, TValue>. public bool Remove(TKey key) Parameters key TKey The key of the element to remove. Returns bool true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary<TKey, TValue>. Exceptions ArgumentNullException key is null. NotSupportedException The IDictionary<TKey, TValue> is read-only. RemoveAt(int) public void RemoveAt(int index) Parameters index int TrimExcess() public void TrimExcess() TryGetValue(TKey, out TValue) Gets the value associated with the specified key. public bool TryGetValue(TKey key, out TValue value) Parameters key TKey The key whose value to get. value TValue When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized. Returns bool true if the object that implements IDictionary<TKey, TValue> contains an element with the specified key; otherwise, false. Exceptions ArgumentNullException key is null."
  },
  "api/Stride.Core.Collections.TrackingCollection-1.html": {
    "href": "api/Stride.Core.Collections.TrackingCollection-1.html",
    "title": "Class TrackingCollection<T> | Stride API",
    "summary": "Class TrackingCollection<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a collection that generates events when items get added or removed. [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] public class TrackingCollection<T> : FastCollection<T>, IList<T>, ICollection<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable, ITrackingCollectionChanged Type Parameters T The type of elements in the collection. Inheritance object FastCollection<T> TrackingCollection<T> Implements IList<T> ICollection<T> IReadOnlyList<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable ITrackingCollectionChanged Derived Scene.EntityCollection Scene.SceneCollection GameSystemCollection VirtualButtonConfig StripDefinitionCollection UIElementCollection Inherited Members FastCollection<T>.Capacity FastCollection<T>.Count FastCollection<T>.this[int] FastCollection<T>.Add(T) FastCollection<T>.Clear() FastCollection<T>.Contains(T) FastCollection<T>.CopyTo(T[], int) FastCollection<T>.IndexOf(T) FastCollection<T>.Insert(int, T) FastCollection<T>.Remove(T) FastCollection<T>.RemoveAt(int) FastCollection<T>.AddRange<TE>(TE) FastCollection<T>.GetEnumerator() FastCollection<T>.Sort() FastCollection<T>.Sort(IComparer<T>) FastCollection<T>.Sort(int, int, IComparer<T>) FastCollection<T>.IsReadOnly FastCollection<T>.EnsureCapacity(int) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods ClearItems() protected override void ClearItems() ClearItemsEvents() protected void ClearItemsEvents() InsertItem(int, T) protected override void InsertItem(int index, T item) Parameters index int item T RemoveItem(int) protected override void RemoveItem(int index) Parameters index int SetItem(int, T) protected override void SetItem(int index, T item) Parameters index int item T Events CollectionChanged Occurs when [collection changed]. public event EventHandler<TrackingCollectionChangedEventArgs> CollectionChanged Event Type EventHandler<TrackingCollectionChangedEventArgs>"
  },
  "api/Stride.Core.Collections.TrackingCollectionChangedEventArgs.html": {
    "href": "api/Stride.Core.Collections.TrackingCollectionChangedEventArgs.html",
    "title": "Class TrackingCollectionChangedEventArgs | Stride API",
    "summary": "Class TrackingCollectionChangedEventArgs Namespace Stride.Core.Collections Assembly Stride.Core.dll public class TrackingCollectionChangedEventArgs : EventArgs Inheritance object EventArgs TrackingCollectionChangedEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors TrackingCollectionChangedEventArgs(NotifyCollectionChangedAction, object?, object?, int, bool) public TrackingCollectionChangedEventArgs(NotifyCollectionChangedAction action, object? item, object? oldItem, int index, bool collectionChanged) Parameters action NotifyCollectionChangedAction item object oldItem object index int collectionChanged bool TrackingCollectionChangedEventArgs(NotifyCollectionChangedAction, object, object?, object?, bool) public TrackingCollectionChangedEventArgs(NotifyCollectionChangedAction action, object key, object? item, object? oldItem, bool collectionChanged) Parameters action NotifyCollectionChangedAction key object item object oldItem object collectionChanged bool Properties Action Gets the type of action performed. Allowed values are Add and Remove. public NotifyCollectionChangedAction Action { get; } Property Value NotifyCollectionChangedAction CollectionChanged Gets a value indicating whether [collection changed (not a replacement but real insertion/removal)]. public bool CollectionChanged { get; } Property Value bool true if [collection changed]; otherwise, false. Index Gets the index in the collection (if applicable). public int Index { get; } Property Value int Item Gets the added or removed item (if dictionary, value only). public object? Item { get; } Property Value object Key Gets the added or removed key (if dictionary). public object? Key { get; } Property Value object OldItem Gets the previous value. Only valid if Action is Add and Remove public object? OldItem { get; } Property Value object"
  },
  "api/Stride.Core.Collections.TrackingDictionary-2.html": {
    "href": "api/Stride.Core.Collections.TrackingDictionary-2.html",
    "title": "Class TrackingDictionary<TKey, TValue> | Stride API",
    "summary": "Class TrackingDictionary<TKey, TValue> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a dictionary of key/value pairs that generates events when items get added or removed. [DataSerializer(typeof(DictionaryAllSerializer<,,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] public class TrackingDictionary<TKey, TValue> : IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IDictionary, ICollection, IEnumerable, ITrackingCollectionChanged where TKey : notnull Type Parameters TKey The type of the key. TValue The type of the value. Inheritance object TrackingDictionary<TKey, TValue> Implements IDictionary<TKey, TValue> ICollection<KeyValuePair<TKey, TValue>> IEnumerable<KeyValuePair<TKey, TValue>> IDictionary ICollection IEnumerable ITrackingCollectionChanged Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Remarks Underlying storage is done with a Dictionary<TKey, TValue>. Constructors TrackingDictionary() Initializes a new instance of the TrackingDictionary<TKey, TValue> class. public TrackingDictionary() Properties Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. this[TKey] Gets or sets the element with the specified key. public TValue this[TKey key] { get; set; } Parameters key TKey The key of the element to get or set. Property Value TValue The element with the specified key. Exceptions ArgumentNullException key is null. KeyNotFoundException The property is retrieved and key is not found. NotSupportedException The property is set and the IDictionary<TKey, TValue> is read-only. Keys Gets an ICollection<T> containing the keys of the IDictionary<TKey, TValue>. public ICollection<TKey> Keys { get; } Property Value ICollection<TKey> An ICollection<T> containing the keys of the object that implements IDictionary<TKey, TValue>. Values Gets an ICollection<T> containing the values in the IDictionary<TKey, TValue>. public ICollection<TValue> Values { get; } Property Value ICollection<TValue> An ICollection<T> containing the values in the object that implements IDictionary<TKey, TValue>. Methods Add(KeyValuePair<TKey, TValue>) Adds an item to the ICollection<T>. public void Add(KeyValuePair<TKey, TValue> item) Parameters item KeyValuePair<TKey, TValue> The object to add to the ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. Add(TKey, TValue) Adds an element with the provided key and value to the IDictionary<TKey, TValue>. public void Add(TKey key, TValue value) Parameters key TKey The object to use as the key of the element to add. value TValue The object to use as the value of the element to add. Exceptions ArgumentNullException key is null. ArgumentException An element with the same key already exists in the IDictionary<TKey, TValue>. NotSupportedException The IDictionary<TKey, TValue> is read-only. Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. Contains(KeyValuePair<TKey, TValue>) Determines whether the ICollection<T> contains a specific value. public bool Contains(KeyValuePair<TKey, TValue> item) Parameters item KeyValuePair<TKey, TValue> The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. ContainsKey(TKey) Determines whether the IDictionary<TKey, TValue> contains an element with the specified key. public bool ContainsKey(TKey key) Parameters key TKey The key to locate in the IDictionary<TKey, TValue>. Returns bool true if the IDictionary<TKey, TValue> contains an element with the key; otherwise, false. Exceptions ArgumentNullException key is null. CopyTo(KeyValuePair<TKey, TValue>[], int) Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. public void CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex) Parameters array KeyValuePair<TKey, TValue>[] The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing. arrayIndex int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException arrayIndex is less than 0. ArgumentException The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array. GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator() Returns IEnumerator<KeyValuePair<TKey, TValue>> An enumerator that can be used to iterate through the collection. Remove(KeyValuePair<TKey, TValue>) Removes the first occurrence of a specific object from the ICollection<T>. public bool Remove(KeyValuePair<TKey, TValue> item) Parameters item KeyValuePair<TKey, TValue> The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. Remove(TKey) Removes the element with the specified key from the IDictionary<TKey, TValue>. public bool Remove(TKey key) Parameters key TKey The key of the element to remove. Returns bool true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary<TKey, TValue>. Exceptions ArgumentNullException key is null. NotSupportedException The IDictionary<TKey, TValue> is read-only. TryGetValue(TKey, out TValue) Gets the value associated with the specified key. public bool TryGetValue(TKey key, out TValue value) Parameters key TKey The key whose value to get. value TValue When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized. Returns bool true if the object that implements IDictionary<TKey, TValue> contains an element with the specified key; otherwise, false. Exceptions ArgumentNullException key is null. Events CollectionChanged Occurs when [collection changed]. public event EventHandler<TrackingCollectionChangedEventArgs> CollectionChanged Event Type EventHandler<TrackingCollectionChangedEventArgs>"
  },
  "api/Stride.Core.Collections.TrackingHashSet-1.html": {
    "href": "api/Stride.Core.Collections.TrackingHashSet-1.html",
    "title": "Class TrackingHashSet<T> | Stride API",
    "summary": "Class TrackingHashSet<T> Namespace Stride.Core.Collections Assembly Stride.Core.dll Represents a hash set that generates events when items get added or removed. public class TrackingHashSet<T> : ISet<T>, ICollection<T>, IReadOnlySet<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable, ITrackingCollectionChanged Type Parameters T The type of elements in the hash set. Inheritance object TrackingHashSet<T> Implements ISet<T> ICollection<T> IReadOnlySet<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable ITrackingCollectionChanged Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Remarks Underlying storage is done with a HashSet<T>. Properties Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. Methods Add(T) Adds an element to the current set and returns a value to indicate if the element was successfully added. public bool Add(T item) Parameters item T The element to add to the set. Returns bool true if the element is added to the set; false if the element is already in the set. Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. Contains(T) Determines whether the ICollection<T> contains a specific value. public bool Contains(T item) Parameters item T The object to locate in the ICollection<T>. Returns bool true if item is found in the ICollection<T>; otherwise, false. CopyTo(T[], int) Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. public void CopyTo(T[] array, int arrayIndex) Parameters array T[] The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing. arrayIndex int The zero-based index in array at which copying begins. Exceptions ArgumentNullException array is null. ArgumentOutOfRangeException arrayIndex is less than 0. ArgumentException The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array. ExceptWith(IEnumerable<T>) Removes all elements in the specified collection from the current set. public void ExceptWith(IEnumerable<T> other) Parameters other IEnumerable<T> The collection of items to remove from the set. Exceptions ArgumentNullException other is null. GetEnumerator() public HashSet<T>.Enumerator GetEnumerator() Returns HashSet<T>.Enumerator IntersectWith(IEnumerable<T>) Modifies the current set so that it contains only elements that are also in a specified collection. public void IntersectWith(IEnumerable<T> other) Parameters other IEnumerable<T> The collection to compare to the current set. Exceptions ArgumentNullException other is null. IsProperSubsetOf(IEnumerable<T>) Determines whether the current set is a proper (strict) subset of a specified collection. public bool IsProperSubsetOf(IEnumerable<T> other) Parameters other IEnumerable<T> The collection to compare to the current set. Returns bool true if the current set is a proper subset of other; otherwise, false. Exceptions ArgumentNullException other is null. IsProperSupersetOf(IEnumerable<T>) Determines whether the current set is a proper (strict) superset of a specified collection. public bool IsProperSupersetOf(IEnumerable<T> other) Parameters other IEnumerable<T> The collection to compare to the current set. Returns bool true if the current set is a proper superset of other; otherwise, false. Exceptions ArgumentNullException other is null. IsSubsetOf(IEnumerable<T>) Determines whether a set is a subset of a specified collection. public bool IsSubsetOf(IEnumerable<T> other) Parameters other IEnumerable<T> The collection to compare to the current set. Returns bool true if the current set is a subset of other; otherwise, false. Exceptions ArgumentNullException other is null. IsSupersetOf(IEnumerable<T>) Determines whether the current set is a superset of a specified collection. public bool IsSupersetOf(IEnumerable<T> other) Parameters other IEnumerable<T> The collection to compare to the current set. Returns bool true if the current set is a superset of other; otherwise, false. Exceptions ArgumentNullException other is null. Overlaps(IEnumerable<T>) Determines whether the current set overlaps with the specified collection. public bool Overlaps(IEnumerable<T> other) Parameters other IEnumerable<T> The collection to compare to the current set. Returns bool true if the current set and other share at least one common element; otherwise, false. Exceptions ArgumentNullException other is null. Remove(T) Removes the first occurrence of a specific object from the ICollection<T>. public bool Remove(T item) Parameters item T The object to remove from the ICollection<T>. Returns bool true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>. Exceptions NotSupportedException The ICollection<T> is read-only. SetEquals(IEnumerable<T>) Determines whether the current set and the specified collection contain the same elements. public bool SetEquals(IEnumerable<T> other) Parameters other IEnumerable<T> The collection to compare to the current set. Returns bool true if the current set is equal to other; otherwise, false. Exceptions ArgumentNullException other is null. SymmetricExceptWith(IEnumerable<T>) Modifies the current set so that it contains only elements that are present either in the current set or in the specified collection, but not both. public void SymmetricExceptWith(IEnumerable<T> other) Parameters other IEnumerable<T> The collection to compare to the current set. Exceptions ArgumentNullException other is null. UnionWith(IEnumerable<T>) Modifies the current set so that it contains all elements that are present in the current set, in the specified collection, or in both. public void UnionWith(IEnumerable<T> other) Parameters other IEnumerable<T> The collection to compare to the current set. Exceptions ArgumentNullException other is null. Events CollectionChanged Occurs when [collection changed]. public event EventHandler<TrackingCollectionChangedEventArgs> CollectionChanged Event Type EventHandler<TrackingCollectionChangedEventArgs>"
  },
  "api/Stride.Core.Collections.html": {
    "href": "api/Stride.Core.Collections.html",
    "title": "Namespace Stride.Core.Collections | Stride API",
    "summary": "Namespace Stride.Core.Collections Classes ConstrainedList<T> Represent a collection associated with a constraint. When an item is added to this collection, it is tested against the constraint. If the test fails, the item can either be discarded, or an exception can be thrown. The desired behavior can be defined with ThrowException. Deque<T> A double-ended queue (deque), which provides O(1) indexed access, O(1) removals from the front and back, amortized O(1) insertions to the front and back, and O(N) insertions and removals anywhere else (with the operations getting slower as the index approaches the middle). FastCollection<T> Faster and lighter implementation of Collection<T> with value types enumerators to avoid allocation in foreach loops, and various helper functions. FastList<T> Similar to List<T>, with direct access to underlying array. It is recommended to use Spans instead: https://github.com/stride3d/stride/discussions/2298#discussioncomment-9779439 FastTrackingCollection<T> Represents a collection that generates events when items get added or removed. IndexingDictionary<T> A dictionary that maps index values to items. It uses a sparse list internally for storage. KeyedSortedList<TKey, T> List of items, stored sequentially and sorted by an implicit invariant key that are extracted from items by implementing GetKeyForItem(T). MultiValueSortedDictionary<TKey, TValue> Represents a priority queue, where keys are sorted and each key might have mlutiple values. MultiValueSortedDictionary<TKey, TValue>.ValueCollection Represents the collection of values in a KoderHack.MultiValueSortedDictionary<TKey,TValue>. This class cannot be inherited MultiValueSortedList<TKey, TValue> Represents a priority queue, where keys are sorted and each key might have mlutiple values. OrderedCollection<T> A collection that maintains the order of the elements and lightter implementation of Collection<T> with value types enumerators to avoid allocation in foreach loops, and various helper functions. PriorityNodeQueue<T> Implements a priority queue of type T. Elements may be added to the queue in any order, but when we pull elements out of the queue, they will be returned in 'ascending' order. Adding new elements into the queue may be done at any time, so this is useful to implement a dynamically growing and shrinking queue. Both adding an element and removing the first element are log(N) operations. The queue is implemented using a priority-heap data structure. For more details on this elegant and simple data structure see \"Programming Pearls\" in our library. The tree is implemented atop a list, where 2N and 2N+1 are the child nodes of node N. The tree is balanced and left-aligned so there are no 'holes' in this list. PriorityQueueNode<T> Represents a node in a priority queue, to allow O(n) removal. PriorityQueue<T> Represents a sorted queue, with logarithmic time insertion and deletion. ReadOnlySet<T> Represents a strongly-typed, read-only set of element. SafeList<T> A list to ensure that all items are not null. SortedList<TKey, TValue> Represents a collection of associated keys and values that are sorted by the keys and are accessible by key and by index. SortedList<TKey, TValue>.Enumerator TrackingCollectionChangedEventArgs TrackingCollection<T> Represents a collection that generates events when items get added or removed. TrackingDictionary<TKey, TValue> Represents a dictionary of key/value pairs that generates events when items get added or removed. TrackingHashSet<T> Represents a hash set that generates events when items get added or removed. Structs FastCollection<T>.Enumerator FastListStruct<T> FastListStruct<T>.Enumerator FastList<T>.Enumerator FastTrackingCollectionChangedEventArgs KeyedSortedList<TKey, T>.Enumerator MultiValueSortedDictionary<TKey, TValue>.Enumerator Enumerates the elements of a KoderHack.MultiValueSortedDictionary<TKey,TValue>. MultiValueSortedDictionary<TKey, TValue>.ValueCollection.Enumerator Enumerates the elements of a KoderHack.MultiValueSortedDictionary<TKey,TValue>.ValueCollection. OrderedCollection<T>.Enumerator PoolListStruct<T> A pool of objects allocated and can be cleared without losing previously allocated instance. Interfaces IReadOnlySet<T> Represents a strongly-typed, read-only set of element. ITrackingCollectionChanged Delegates FastTrackingCollection<T>.FastEventHandler<TEventArgs>"
  },
  "api/Stride.Core.ComponentBase.html": {
    "href": "api/Stride.Core.ComponentBase.html",
    "title": "Class ComponentBase | Stride API",
    "summary": "Class ComponentBase Namespace Stride.Core Assembly Stride.Core.dll Base class for a framework Component. [DataContract] public abstract class ComponentBase : DisposeBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase Implements IDisposable IComponent IReferencable ICollectorHolder Derived AudioEngine SoundBase SoundInstance Entity EntityManager Scene UILibrary UIPage GameBase GameSystemBase GameWindow GraphicsDeviceManager BatchBase<TDrawInfo> BatchBase<TDrawInfo>.DeviceResourceContext Effect FastTextRenderer GeometricMeshData<T> GeometricPrimitive<T> GraphicsAdapter GraphicsDevice GraphicsOutput GraphicsPresenter GraphicsResourceAllocator GraphicsResourceBase GraphicsResourceFactoryBase PrimitiveQuad ResourceGroupAllocator SpriteFont InputManager ShaderGeneratorContext RenderContext RenderDrawContext RenderFeature RenderSystem RendererCoreBase StreamableResource ElementRenderer Video Inherited Members DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.KeepReference<T>(T) ComponentBaseExtensions.PushTagAndRestore<T>(ComponentBase, PropertyKey<T?>, T) ComponentBaseExtensions.ReleaseBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveReleaseBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks A Component is an object that can have a Name and other meta-information (see Tags), and that can hold references to other sub-Components that depend on it. Components have reference-counting lifetime management, so calling Dispose() does not immediately releases its underlying resources, but instead decreases an internal reference count. When that reference count reaches zero, it then calls Destroy() automatically, where the underlying resources can then be released safely. When Destroy() is called, not only the resources associated with the Component itself should be released, but it cascades the releasing of resources to its contained sub-Components. Constructors ComponentBase() Initializes a new instance of the ComponentBase class. protected ComponentBase() ComponentBase(string?) Initializes a new instance of the ComponentBase class. protected ComponentBase(string? name) Parameters name string The name attached to the Component, or null to use the type's name. Fields Tags The properties attached to the Component. public PropertyContainer Tags Field Value PropertyContainer Properties Name Gets or sets the name of the Component. public virtual string Name { get; set; } Property Value string The name that identifies the Component. It can be null to denote it has no specific name. Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. OnNameChanged() Called when the Name property has changed. protected virtual void OnNameChanged() ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. See Also IComponent IReferencable ICollectorHolder"
  },
  "api/Stride.Core.ComponentBaseExtensions.PropertyTagRestore-1.html": {
    "href": "api/Stride.Core.ComponentBaseExtensions.PropertyTagRestore-1.html",
    "title": "Struct ComponentBaseExtensions.PropertyTagRestore<T> | Stride API",
    "summary": "Struct ComponentBaseExtensions.PropertyTagRestore<T> Namespace Stride.Core Assembly Stride.Core.dll A structure returned by PushTagAndRestore<T>(ComponentBase, PropertyKey<T?>, T) that saves the value of a tag property of an object and, once finished, can restore its value to the previous one. public readonly struct ComponentBaseExtensions.PropertyTagRestore<T> : IDisposable Type Parameters T The type of the tag. Implements IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors PropertyTagRestore(ComponentBase, PropertyKey<T?>) Initializes a new instance of the ComponentBaseExtensions.PropertyTagRestore<T> structure. public PropertyTagRestore(ComponentBase container, PropertyKey<T?> key) Parameters container ComponentBase The Component that contains the tag to set and restore. key PropertyKey<T> The key that identifies the tag to set and restore. Exceptions ArgumentNullException container is null. ArgumentNullException key is null. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose()"
  },
  "api/Stride.Core.ComponentBaseExtensions.html": {
    "href": "api/Stride.Core.ComponentBaseExtensions.html",
    "title": "Class ComponentBaseExtensions | Stride API",
    "summary": "Class ComponentBaseExtensions Namespace Stride.Core Assembly Stride.Core.dll Extensions for IComponent. public static class ComponentBaseExtensions Inheritance object ComponentBaseExtensions Methods DisposeBy<T>(T, ICollectorHolder) Keeps a disposable object alive by adding it to a container. public static T? DisposeBy<T>(this T component, ICollectorHolder container) where T : IDisposable Parameters component T The Component to keep alive. container ICollectorHolder The container that will keep a reference to the Component. Returns T The same Component instance. Type Parameters T The type of the Component. KeepReference<T>(T) Pins this component as a new reference. public static T? KeepReference<T>(this T component) where T : IReferencable Parameters component T The Component to add a reference to. Returns T The same Component instance. Type Parameters T The type of the Component. Remarks This method is equivalent to calling AddReference() and returning the same component instance. PushTagAndRestore<T>(ComponentBase, PropertyKey<T?>, T) Sets a tag in a Component and removes it after using it. public static ComponentBaseExtensions.PropertyTagRestore<T> PushTagAndRestore<T>(this ComponentBase component, PropertyKey<T?> key, T value) Parameters component ComponentBase The Component to set a tag for. key PropertyKey<T> The key to identify the tag to set. value T The value of the tag. Returns ComponentBaseExtensions.PropertyTagRestore<T> A ComponentBaseExtensions.PropertyTagRestore<T> structure that can be used with a using clause (or manually disposed) to set a tag, perform some action, and remove the tag once finished. Type Parameters T The type of the tag. Remarks This method is used to set a property value in Tags, perform some actions, and restore the previous value after finishing. The returned object must be disposed once the original value must be restored. It can be done manually (by calling Dispose()) or automatically with a using clause. ReleaseBy<T>(T, ICollectorHolder) Keeps a referenceable object alive by adding it to a container. public static T? ReleaseBy<T>(this T component, ICollectorHolder container) where T : IReferencable Parameters component T The Component to keep alive. container ICollectorHolder The container that will keep a reference to the Component. Returns T The same Component instance. Type Parameters T The type of the Component. RemoveDisposeBy<T>(T, ICollectorHolder) Removes a disposable object from a container that keeping it alive. public static void RemoveDisposeBy<T>(this T component, ICollectorHolder container) where T : IDisposable Parameters component T The Component to remove. container ICollectorHolder The container that kept a reference to the Component. Type Parameters T The type of the Component. RemoveReleaseBy<T>(T, ICollectorHolder) Removes a referenceable object from a container that keeping it alive. public static void RemoveReleaseBy<T>(this T component, ICollectorHolder container) where T : IReferencable Parameters component T The Component to remove. container ICollectorHolder The container that kept a reference to the Component. Type Parameters T The type of the Component."
  },
  "api/Stride.Core.DataAliasAttribute.html": {
    "href": "api/Stride.Core.DataAliasAttribute.html",
    "title": "Class DataAliasAttribute | Stride API",
    "summary": "Class DataAliasAttribute Namespace Stride.Core Assembly Stride.Core.dll Allows to re-map a previous class/field/property/enum name to the specified property/field/enum/class/struct. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = true)] public sealed class DataAliasAttribute : Attribute Inheritance object Attribute DataAliasAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DataAliasAttribute(string) Initializes a new instance of the DataAliasAttribute class. public DataAliasAttribute(string name) Parameters name string The previous name. Properties Name Gets the previous name. public string Name { get; } Property Value string The previous name."
  },
  "api/Stride.Core.DataContractAttribute.html": {
    "href": "api/Stride.Core.DataContractAttribute.html",
    "title": "Class DataContractAttribute | Stride API",
    "summary": "Class DataContractAttribute Namespace Stride.Core Assembly Stride.Core.dll Indicates that a class can be serialized. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Delegate, AllowMultiple = false, Inherited = false)] public class DataContractAttribute : Attribute Inheritance object Attribute DataContractAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DataContractAttribute() Initializes a new instance of the DataContractAttribute class. public DataContractAttribute() DataContractAttribute(string) Initializes a new instance of the DataContractAttribute class. public DataContractAttribute(string aliasName) Parameters aliasName string The type alias name when serializing to a textual format. Properties Alias Gets or sets the alias name when serializing to a textual format. public string? Alias { get; } Property Value string The alias name. DefaultMemberMode The default member mode. public DataMemberMode DefaultMemberMode { get; set; } Property Value DataMemberMode Inherited Gets or sets a value indicating whether this DataContractAttribute is implicitly inherited by all its descendant classes. public bool Inherited { get; set; } Property Value bool true if inherited; otherwise, false."
  },
  "api/Stride.Core.DataContractIgnoreAttribute.html": {
    "href": "api/Stride.Core.DataContractIgnoreAttribute.html",
    "title": "Class DataContractIgnoreAttribute | Stride API",
    "summary": "Class DataContractIgnoreAttribute Namespace Stride.Core Assembly Stride.Core.dll [AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Delegate, Inherited = false)] public class DataContractIgnoreAttribute : Attribute Inheritance object Attribute DataContractIgnoreAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.DataContractMetadataTypeAttribute.html": {
    "href": "api/Stride.Core.DataContractMetadataTypeAttribute.html",
    "title": "Class DataContractMetadataTypeAttribute | Stride API",
    "summary": "Class DataContractMetadataTypeAttribute Namespace Stride.Core Assembly Stride.Core.dll Specifies the metadata class to associate with a serializable class. The main usage of this class is to allow a sub-class to override property attributes such as DefaultValueAttribute. [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)] public class DataContractMetadataTypeAttribute : Attribute Inheritance object Attribute DataContractMetadataTypeAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DataContractMetadataTypeAttribute(Type) Initializes a new instance of the DataContractMetadataTypeAttribute class. public DataContractMetadataTypeAttribute(Type metadataClassType) Parameters metadataClassType Type The type alias name when serializing to a textual format. Exceptions ArgumentException metadataClassType is null Properties MetadataClassType Gets the metadata class that is associated with a serializable class. public Type MetadataClassType { get; } Property Value Type"
  },
  "api/Stride.Core.DataMemberAttribute.html": {
    "href": "api/Stride.Core.DataMemberAttribute.html",
    "title": "Class DataMemberAttribute | Stride API",
    "summary": "Class DataMemberAttribute Namespace Stride.Core Assembly Stride.Core.dll Specify the way to store a property or field of some class or structure. [AttributeUsage(AttributeTargets.Property|AttributeTargets.Field)] public class DataMemberAttribute : Attribute Inheritance object Attribute DataMemberAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DataMemberAttribute() Initializes a new instance of the DataMemberAttribute class. public DataMemberAttribute() DataMemberAttribute(DataMemberMode) Specify the way to store a property or field of some class or structure. public DataMemberAttribute(DataMemberMode mode) Parameters mode DataMemberMode The serialize method. DataMemberAttribute(int) Initializes a new instance of the DataMemberAttribute class. public DataMemberAttribute(int order) Parameters order int The order. DataMemberAttribute(int, DataMemberMode) Initializes a new instance of the DataMemberAttribute class. public DataMemberAttribute(int order, DataMemberMode mode) Parameters order int The order. mode DataMemberMode The mode. DataMemberAttribute(int, string) Initializes a new instance of the DataMemberAttribute class. public DataMemberAttribute(int order, string name) Parameters order int The order. name string The name. DataMemberAttribute(int, string, DataMemberMode) Initializes a new instance of the DataMemberAttribute class. public DataMemberAttribute(int order, string name, DataMemberMode mode) Parameters order int The order. name string The name. mode DataMemberMode The mode. DataMemberAttribute(string) Initializes a new instance of the DataMemberAttribute class. public DataMemberAttribute(string name) Parameters name string The name. DataMemberAttribute(string, DataMemberMode) Specify the way to store a property or field of some class or structure. public DataMemberAttribute(string name, DataMemberMode mode) Parameters name string The name. mode DataMemberMode The serialize method. Fields DefaultMask public const uint DefaultMask = 1 Field Value uint IgnoreMask public const uint IgnoreMask = 4026531840 Field Value uint Properties Mask Gets or sets the mask to filter out members. public uint Mask { get; set; } Property Value uint The mask. Mode Gets the serialize method1. public DataMemberMode Mode { get; } Property Value DataMemberMode The serialize method1. Name Gets the name. public string? Name { get; } Property Value string The name. Order Gets or sets the order. Default is -1 (default to alphabetical) public int? Order { get; set; } Property Value int? The order."
  },
  "api/Stride.Core.DataMemberCustomSerializerAttribute.html": {
    "href": "api/Stride.Core.DataMemberCustomSerializerAttribute.html",
    "title": "Class DataMemberCustomSerializerAttribute | Stride API",
    "summary": "Class DataMemberCustomSerializerAttribute Namespace Stride.Core Assembly Stride.Core.dll When specified on a property or field, a serializer won't be needed for this type (useful if serializer is dynamically or manually registered). [AttributeUsage(AttributeTargets.Property|AttributeTargets.Field)] public class DataMemberCustomSerializerAttribute : Attribute Inheritance object Attribute DataMemberCustomSerializerAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.DataMemberIgnoreAttribute.html": {
    "href": "api/Stride.Core.DataMemberIgnoreAttribute.html",
    "title": "Class DataMemberIgnoreAttribute | Stride API",
    "summary": "Class DataMemberIgnoreAttribute Namespace Stride.Core Assembly Stride.Core.dll When specified on a property or field, it will not be used when serializing/deserializing. [AttributeUsage(AttributeTargets.Property|AttributeTargets.Field, Inherited = false)] public class DataMemberIgnoreAttribute : Attribute Inheritance object Attribute DataMemberIgnoreAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.DataMemberMode.html": {
    "href": "api/Stride.Core.DataMemberMode.html",
    "title": "Enum DataMemberMode | Stride API",
    "summary": "Enum DataMemberMode Namespace Stride.Core Assembly Stride.Core.dll Specify the way to store a property or field of some class or structure. public enum DataMemberMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Assign = 1 When restored, new object is created by using the parameters in the YAML data and assigned to the property / field. When the property / field is writeable, this is the default. Content = 2 Only valid for a property / field that return a class, no strings, primitives or value types. When restored, instead of recreating the whole class, the members are independently restored. When the property / field is not writeable this is the default. Default = 0 Use the default mode depending on the type of the field/property. Never = 4 The property / field will not be stored."
  },
  "api/Stride.Core.DataStyle.html": {
    "href": "api/Stride.Core.DataStyle.html",
    "title": "Enum DataStyle | Stride API",
    "summary": "Enum DataStyle Namespace Stride.Core Assembly Stride.Core.dll Specifies the style used for textual serialization when an array/list or a dictionary/map must be serialized. public enum DataStyle Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Any = 0 Let the emitter choose the style. Compact = 2 The compact style (style embraced by [] or {}) Normal = 1 The normal style (One line per item, structured by space)."
  },
  "api/Stride.Core.DataStyleAttribute.html": {
    "href": "api/Stride.Core.DataStyleAttribute.html",
    "title": "Class DataStyleAttribute | Stride API",
    "summary": "Class DataStyleAttribute Namespace Stride.Core Assembly Stride.Core.dll An attribute to modify the output style of a sequence or mapping. This attribute can be apply directly on a type or on a property/field. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Property|AttributeTargets.Field)] public class DataStyleAttribute : Attribute Inheritance object Attribute DataStyleAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DataStyleAttribute(DataStyle) Initializes a new instance of the DataStyleAttribute class. public DataStyleAttribute(DataStyle style) Parameters style DataStyle The style. DataStyleAttribute(ScalarStyle) Initializes a new instance of the DataStyleAttribute class. public DataStyleAttribute(ScalarStyle style) Parameters style ScalarStyle The style. Properties ScalarStyle Gets the style. public ScalarStyle ScalarStyle { get; } Property Value ScalarStyle The style. Style Gets the style. public DataStyle Style { get; } Property Value DataStyle The style."
  },
  "api/Stride.Core.DefaultValueMetadata-1.html": {
    "href": "api/Stride.Core.DefaultValueMetadata-1.html",
    "title": "Class DefaultValueMetadata<T> | Stride API",
    "summary": "Class DefaultValueMetadata<T> Namespace Stride.Core Assembly Stride.Core.dll public abstract class DefaultValueMetadata<T> : DefaultValueMetadata Type Parameters T Inheritance object PropertyKeyMetadata DefaultValueMetadata DefaultValueMetadata<T> Derived DelegateDefaultValueMetadata<T> StaticDefaultValueMetadata<T> Inherited Members DefaultValueMetadata.KeepValue DefaultValueMetadata.PropertyUpdateCallback DefaultValueMetadata.Static<T>(T, bool) DefaultValueMetadata.Delegate<T>(DelegateDefaultValueMetadata<T>.DefaultValueCallback) Extension Methods UnsafeUtilities.As<T>(object?) Methods GetDefaultValue(ref PropertyContainer) Gets the default value of an external property, and specify if this default value should be kept. It could be usefull with properties with default values depending of its container, especially if they are long to generate. An example would be collision data, which should be generated only once. public override object GetDefaultValue(ref PropertyContainer obj) Parameters obj PropertyContainer The property container. Returns object The default value. GetDefaultValueT(ref PropertyContainer) Gets the default value of an external property, and specify if this default value should be kept. It could be usefull with properties with default values depending of its container, especially if they are long to generate. An example would be collision data, which should be generated only once. public abstract T GetDefaultValueT(ref PropertyContainer obj) Parameters obj PropertyContainer The property container. Returns T The default value."
  },
  "api/Stride.Core.DefaultValueMetadata.html": {
    "href": "api/Stride.Core.DefaultValueMetadata.html",
    "title": "Class DefaultValueMetadata | Stride API",
    "summary": "Class DefaultValueMetadata Namespace Stride.Core Assembly Stride.Core.dll Abstract class that could be overloaded in order to define how to get default value of an PropertyKey. public abstract class DefaultValueMetadata : PropertyKeyMetadata Inheritance object PropertyKeyMetadata DefaultValueMetadata Derived DefaultValueMetadata<T> Extension Methods UnsafeUtilities.As<T>(object?) Properties KeepValue Gets a value indicating whether this value is kept. public virtual bool KeepValue { get; } Property Value bool true if this value is kept; otherwise, false. PropertyUpdateCallback Gets or sets the property update callback. public PropertyContainer.PropertyUpdatedDelegate? PropertyUpdateCallback { get; set; } Property Value PropertyContainer.PropertyUpdatedDelegate The property update callback. Methods Delegate<T>(DefaultValueCallback) public static DelegateDefaultValueMetadata<T> Delegate<T>(DelegateDefaultValueMetadata<T>.DefaultValueCallback callback) Parameters callback DelegateDefaultValueMetadata<T>.DefaultValueCallback Returns DelegateDefaultValueMetadata<T> Type Parameters T GetDefaultValue(ref PropertyContainer) Gets the default value of an external property, and specify if this default value should be kept. It could be usefull with properties with default values depending of its container, especially if they are long to generate. An example would be collision data, which should be generated only once. public abstract object GetDefaultValue(ref PropertyContainer obj) Parameters obj PropertyContainer The property container. Returns object The default value. Static<T>(T, bool) public static StaticDefaultValueMetadata<T> Static<T>(T defaultValue, bool keepDefaultValue = false) Parameters defaultValue T keepDefaultValue bool Returns StaticDefaultValueMetadata<T> Type Parameters T"
  },
  "api/Stride.Core.DelegateDefaultValueMetadata-1.DefaultValueCallback.html": {
    "href": "api/Stride.Core.DelegateDefaultValueMetadata-1.DefaultValueCallback.html",
    "title": "Delegate DelegateDefaultValueMetadata<T>.DefaultValueCallback | Stride API",
    "summary": "Delegate DelegateDefaultValueMetadata<T>.DefaultValueCallback Namespace Stride.Core Assembly Stride.Core.dll Callback used to initialiwe the tag value. public delegate T DelegateDefaultValueMetadata<T>.DefaultValueCallback(ref PropertyContainer container) Parameters container PropertyContainer The tag property container. Returns T Value of the tag. Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.DelegateDefaultValueMetadata-1.html": {
    "href": "api/Stride.Core.DelegateDefaultValueMetadata-1.html",
    "title": "Class DelegateDefaultValueMetadata<T> | Stride API",
    "summary": "Class DelegateDefaultValueMetadata<T> Namespace Stride.Core Assembly Stride.Core.dll Specifies a delegate to fetch the default value of an PropertyKey. public class DelegateDefaultValueMetadata<T> : DefaultValueMetadata<T> Type Parameters T Inheritance object PropertyKeyMetadata DefaultValueMetadata DefaultValueMetadata<T> DelegateDefaultValueMetadata<T> Inherited Members DefaultValueMetadata<T>.GetDefaultValue(ref PropertyContainer) DefaultValueMetadata.PropertyUpdateCallback DefaultValueMetadata.Static<T>(T, bool) DefaultValueMetadata.Delegate<T>(DelegateDefaultValueMetadata<T>.DefaultValueCallback) Extension Methods UnsafeUtilities.As<T>(object?) Constructors DelegateDefaultValueMetadata(DefaultValueCallback) Initializes a new instance of the DelegateDefaultValueMetadata<T> class. public DelegateDefaultValueMetadata(DelegateDefaultValueMetadata<T>.DefaultValueCallback callback) Parameters callback DelegateDefaultValueMetadata<T>.DefaultValueCallback The callback. Properties KeepValue Gets a value indicating whether this value is kept. public override bool KeepValue { get; } Property Value bool true if this value is kept; otherwise, false. Methods GetDefaultValueT(ref PropertyContainer) Gets the default value of an external property, and specify if this default value should be kept. It could be usefull with properties with default values depending of its container, especially if they are long to generate. An example would be collision data, which should be generated only once. public override T GetDefaultValueT(ref PropertyContainer obj) Parameters obj PropertyContainer The property container. Returns T The default value."
  },
  "api/Stride.Core.Diagnostics.CallerInfo.html": {
    "href": "api/Stride.Core.Diagnostics.CallerInfo.html",
    "title": "Class CallerInfo | Stride API",
    "summary": "Class CallerInfo Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A class to store Caller Information attributes. public sealed class CallerInfo Inheritance object CallerInfo Extension Methods UnsafeUtilities.As<T>(object?) Fields FilePath Full path of the source file that contains the caller. This is the file path at compile time. public readonly string FilePath Field Value string LineNumber Line number in the source file at which the method is called. public readonly int LineNumber Field Value int MemberName Method or property name of the caller. See Member Names later in this topic. public readonly string MemberName Field Value string Methods Get(string, string, int) Gets the caller information. public static CallerInfo Get(string sourceFilePath = \"\", string memberName = \"\", int sourceLineNumber = 0) Parameters sourceFilePath string The source file path. memberName string Name of the member. sourceLineNumber int The source line number. Returns CallerInfo A caller information. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Diagnostics.ChromeTracingProfileWriter.html": {
    "href": "api/Stride.Core.Diagnostics.ChromeTracingProfileWriter.html",
    "title": "Class ChromeTracingProfileWriter | Stride API",
    "summary": "Class ChromeTracingProfileWriter Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll public class ChromeTracingProfileWriter Inheritance object ChromeTracingProfileWriter Extension Methods UnsafeUtilities.As<T>(object?) Methods Start(string, bool) public void Start(string outputPath, bool indentOutput = false) Parameters outputPath string indentOutput bool Stop() public void Stop()"
  },
  "api/Stride.Core.Diagnostics.CollectionDebugView-1.html": {
    "href": "api/Stride.Core.Diagnostics.CollectionDebugView-1.html",
    "title": "Class CollectionDebugView<T> | Stride API",
    "summary": "Class CollectionDebugView<T> Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Use this class to provide a debug output in Visual Studio debugger. public class CollectionDebugView<T> Type Parameters T Inheritance object CollectionDebugView<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors CollectionDebugView(ICollection<T>) public CollectionDebugView(ICollection<T> collection) Parameters collection ICollection<T> Properties Items public T[] Items { get; } Property Value T[]"
  },
  "api/Stride.Core.Diagnostics.CollectionDebugView.html": {
    "href": "api/Stride.Core.Diagnostics.CollectionDebugView.html",
    "title": "Class CollectionDebugView | Stride API",
    "summary": "Class CollectionDebugView Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Use this class to provide a debug output in Visual Studio debugger. public class CollectionDebugView Inheritance object CollectionDebugView Extension Methods UnsafeUtilities.As<T>(object?) Constructors CollectionDebugView(IEnumerable) public CollectionDebugView(IEnumerable collection) Parameters collection IEnumerable Properties Items public object[] Items { get; } Property Value object[]"
  },
  "api/Stride.Core.Diagnostics.ComponentEventInfo.html": {
    "href": "api/Stride.Core.Diagnostics.ComponentEventInfo.html",
    "title": "Class ComponentEventInfo | Stride API",
    "summary": "Class ComponentEventInfo Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Contains information about a AddReference/Release event. public class ComponentEventInfo Inheritance object ComponentEventInfo Extension Methods UnsafeUtilities.As<T>(object?) Constructors ComponentEventInfo(ComponentEventType) public ComponentEventInfo(ComponentEventType type) Parameters type ComponentEventType Properties StackTrace Gets the stack trace at the time of the event. public string? StackTrace { get; } Property Value string Time Gets the time (from Environment.TickCount) at which the event happened. public int Time { get; } Property Value int Type Gets the event type. public ComponentEventType Type { get; } Property Value ComponentEventType Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Diagnostics.ComponentEventType.html": {
    "href": "api/Stride.Core.Diagnostics.ComponentEventType.html",
    "title": "Enum ComponentEventType | Stride API",
    "summary": "Enum ComponentEventType Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll TODO: Update summary. public enum ComponentEventType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AddReference = 2 IReferencable.AddReference() event. Destroy = 1 ComponentBase.Destroy() event. Instantiate = 0 ComponentBase constructor event. Release = 3 IReferenceable.Release() event."
  },
  "api/Stride.Core.Diagnostics.ConsoleLogListener.html": {
    "href": "api/Stride.Core.Diagnostics.ConsoleLogListener.html",
    "title": "Class ConsoleLogListener | Stride API",
    "summary": "Class ConsoleLogListener Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A LogListener implementation redirecting its output to the default OS console. If console is not supported message are output to Debug public class ConsoleLogListener : LogListener, IDisposable Inheritance object LogListener ConsoleLogListener Implements IDisposable Inherited Members LogListener.LogMessageCount LogListener.UseFlushAsync LogListener.TextFormatter LogListener.LogCountFlushLimit LogListener.ShouldFlush(ILogMessage) LogListener.Flush() LogListener.Dispose() LogListener.GetDefaultText(ILogMessage) LogListener.GetExceptionText(ILogMessage) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties LogLevel Gets or sets the minimum log level handled by this listener. public LogMessageType LogLevel { get; set; } Property Value LogMessageType The minimum log level. LogMode Gets or sets the log mode. public ConsoleLogMode LogMode { get; set; } Property Value ConsoleLogMode The log mode. Methods HideConsole() public static void HideConsole() OnLog(ILogMessage) Called when a log occurred. protected override void OnLog(ILogMessage logMessage) Parameters logMessage ILogMessage The log message. ShowConsole() public static void ShowConsole()"
  },
  "api/Stride.Core.Diagnostics.ConsoleLogMode.html": {
    "href": "api/Stride.Core.Diagnostics.ConsoleLogMode.html",
    "title": "Enum ConsoleLogMode | Stride API",
    "summary": "Enum ConsoleLogMode Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Defines how the console is opened. public enum ConsoleLogMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Always = 2 The console should be always visible Auto = 0 The console should be visible only in debug and if there is a message, otherwise it is not visible. Default = 0 Same as Auto None = 1 The console should not be visible."
  },
  "api/Stride.Core.Diagnostics.DebugLogListener.html": {
    "href": "api/Stride.Core.Diagnostics.DebugLogListener.html",
    "title": "Class DebugLogListener | Stride API",
    "summary": "Class DebugLogListener Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A LogListener implementation redirecting its output to a Debug. public class DebugLogListener : LogListener, IDisposable Inheritance object LogListener DebugLogListener Implements IDisposable Inherited Members LogListener.LogMessageCount LogListener.UseFlushAsync LogListener.TextFormatter LogListener.LogCountFlushLimit LogListener.ShouldFlush(ILogMessage) LogListener.Flush() LogListener.Dispose() LogListener.GetDefaultText(ILogMessage) LogListener.GetExceptionText(ILogMessage) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Methods OnLog(ILogMessage) Called when a log occurred. protected override void OnLog(ILogMessage logMessage) Parameters logMessage ILogMessage The log message."
  },
  "api/Stride.Core.Diagnostics.ExceptionInfo.html": {
    "href": "api/Stride.Core.Diagnostics.ExceptionInfo.html",
    "title": "Class ExceptionInfo | Stride API",
    "summary": "Class ExceptionInfo Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll This class is used to store some properties of an exception. It is serializable. [DataContract] [Serializable] public sealed class ExceptionInfo Inheritance object ExceptionInfo Extension Methods UnsafeUtilities.As<T>(object?) Constructors ExceptionInfo() Initializes a new instance of the ExceptionInfo class with default values for its properties public ExceptionInfo() ExceptionInfo(Exception) Initializes a new instance of the ExceptionInfo class from an Exception. public ExceptionInfo(Exception exception) Parameters exception Exception The exception used to initialize the properties of this instance. Properties InnerExceptions Gets or sets the ExceptionInfo of the inner exception. public ExceptionInfo[] InnerExceptions { get; set; } Property Value ExceptionInfo[] Message Gets or sets the message of the exception. public string Message { get; set; } Property Value string StackTrace Gets or sets the stack trace of the exception. public string? StackTrace { get; set; } Property Value string TypeFullName Gets or sets the full name of the exception type. Should correspond to the FullName property of the exception type. public string? TypeFullName { get; set; } Property Value string TypeName Gets or sets the name of the exception type. Should correspond to the Name property of the exception type. public string TypeName { get; set; } Property Value string Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Diagnostics.ForwardingLoggerResult.html": {
    "href": "api/Stride.Core.Diagnostics.ForwardingLoggerResult.html",
    "title": "Class ForwardingLoggerResult | Stride API",
    "summary": "Class ForwardingLoggerResult Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A LoggerResult that also forwards messages to another ILogger. public class ForwardingLoggerResult : LoggerResult, ILogger, IProgressStatus Inheritance object Logger LoggerResult ForwardingLoggerResult Implements ILogger IProgressStatus Inherited Members LoggerResult.ProgressChanged LoggerResult.Module LoggerResult.Clear() LoggerResult.IsLoggingProgressAsInfo LoggerResult.Progress(string) LoggerResult.Progress(string, int, int) LoggerResult.Messages LoggerResult.CopyTo(ILogger) LoggerResult.ToText() Logger.EnableTypes Logger.MessageLogged Logger.MinimumLevelEnabled Logger.IsDebugEnabled Logger.IsVerboseEnabled Logger.HasErrors Logger.ActivateLog(LogMessageType, LogMessageType, bool) Logger.ActivateLog(LogMessageType, bool) Logger.Activated(LogMessageType) Logger.Log(ILogMessage) Logger.Verbose(string, Exception, CallerInfo) Logger.Verbose(string, CallerInfo) Logger.Debug(string, Exception, CallerInfo) Logger.Debug(string, CallerInfo) Logger.Info(string, Exception, CallerInfo) Logger.Info(string, CallerInfo) Logger.Warning(string, Exception, CallerInfo) Logger.Warning(string, CallerInfo) Logger.Error(string, Exception, CallerInfo) Logger.Error(string, CallerInfo) Logger.Fatal(string, Exception, CallerInfo) Logger.Fatal(string, CallerInfo) Extension Methods LoggerExtensions.Debug(ILogger, string, CallerInfo?) LoggerExtensions.Debug(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Error(ILogger, string, CallerInfo?) LoggerExtensions.Error(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Info(ILogger, string, CallerInfo?) LoggerExtensions.Info(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Warning(ILogger, string, CallerInfo?) LoggerExtensions.Warning(ILogger, string, Exception?, CallerInfo?) UnsafeUtilities.As<T>(object?) Constructors ForwardingLoggerResult(ILogger) public ForwardingLoggerResult(ILogger loggerToForward) Parameters loggerToForward ILogger Methods LogRaw(ILogMessage) Internal method used to log a message. All Info, Debug, Error...etc. methods are calling this method. protected override void LogRaw(ILogMessage logMessage) Parameters logMessage ILogMessage The log message."
  },
  "api/Stride.Core.Diagnostics.GlobalLogger.MessageFilterDelegate.html": {
    "href": "api/Stride.Core.Diagnostics.GlobalLogger.MessageFilterDelegate.html",
    "title": "Delegate GlobalLogger.MessageFilterDelegate | Stride API",
    "summary": "Delegate GlobalLogger.MessageFilterDelegate Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll public delegate void GlobalLogger.MessageFilterDelegate(ref ILogMessage logMessage) Parameters logMessage ILogMessage Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Diagnostics.GlobalLogger.html": {
    "href": "api/Stride.Core.Diagnostics.GlobalLogger.html",
    "title": "Class GlobalLogger | Stride API",
    "summary": "Class GlobalLogger Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A logger that redirect messages to a global handler and handle instantiated MapModuleNameToLogger. public sealed class GlobalLogger : Logger, ILogger Inheritance object Logger GlobalLogger Implements ILogger Inherited Members Logger.MessageLogged Logger.MinimumLevelEnabled Logger.IsDebugEnabled Logger.IsVerboseEnabled Logger.HasErrors Logger.Module Logger.ActivateLog(LogMessageType, LogMessageType, bool) Logger.ActivateLog(LogMessageType, bool) Logger.Activated(LogMessageType) Logger.Log(ILogMessage) Logger.Verbose(string, Exception, CallerInfo) Logger.Verbose(string, CallerInfo) Logger.Debug(string, Exception, CallerInfo) Logger.Debug(string, CallerInfo) Logger.Info(string, Exception, CallerInfo) Logger.Info(string, CallerInfo) Logger.Warning(string, Exception, CallerInfo) Logger.Warning(string, CallerInfo) Logger.Error(string, Exception, CallerInfo) Logger.Error(string, CallerInfo) Logger.Fatal(string, Exception, CallerInfo) Logger.Fatal(string, CallerInfo) Extension Methods LoggerExtensions.Debug(ILogger, string, CallerInfo?) LoggerExtensions.Debug(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Error(ILogger, string, CallerInfo?) LoggerExtensions.Error(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Info(ILogger, string, CallerInfo?) LoggerExtensions.Info(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Warning(ILogger, string, CallerInfo?) LoggerExtensions.Warning(ILogger, string, Exception?, CallerInfo?) UnsafeUtilities.As<T>(object?) Properties RegisteredLoggers Gets all registered loggers. public static Logger[] RegisteredLoggers { get; } Property Value Logger[] The registered loggers. Methods ActivateLog(Action<Logger>) Activates the log for all loggers using the specified action.. public static void ActivateLog(Action<Logger> activator) Parameters activator Action<Logger> The activator. Exceptions ArgumentNullException If activator is null ActivateLog(string, LogMessageType, LogMessageType, bool) Activates the log for loggers that match a regex pattern on the module name. public static void ActivateLog(string regexPatternModule, LogMessageType minimumLevel, LogMessageType maximumLevel = LogMessageType.Fatal, bool enabledFlag = true) Parameters regexPatternModule string The regex pattern to match a module name. minimumLevel LogMessageType The minimum level. maximumLevel LogMessageType The maximum level. enabledFlag bool if set to true enaable the log, else disable. Exceptions ArgumentNullException If regexPatternModule is null ActivateLog(Regex, LogMessageType, LogMessageType, bool) Activates the log for loggers that match a regex pattern on the module name. public static void ActivateLog(Regex regexPatternModule, LogMessageType minimumLevel, LogMessageType maximumLevel = LogMessageType.Fatal, bool enabledFlag = true) Parameters regexPatternModule Regex The regex pattern to match a module name. minimumLevel LogMessageType The minimum level. maximumLevel LogMessageType The maximum level. enabledFlag bool if set to true enaable the log, else disable. Exceptions ArgumentNullException If regexPatternModule is null GetLogger(string) Gets the GlobalLogger associated to the specified module. public static Logger GetLogger(string module) Parameters module string The module name. Returns Logger An instance of a Logger Exceptions ArgumentNullException If module name is null GetLogger(string, LogMessageType) Gets the GlobalLogger associated to the specified module. public static Logger GetLogger(string module, LogMessageType minimumLevel) Parameters module string The module name. minimumLevel LogMessageType Minimum log level (only applied if new logger instance is created) Returns Logger An instance of a Logger Exceptions ArgumentNullException If module name is null LogRaw(ILogMessage) Internal method used to log a message. All Info, Debug, Error...etc. methods are calling this method. protected override void LogRaw(ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Events GlobalMessageFilter Occurs before a message is logged. public static event GlobalLogger.MessageFilterDelegate? GlobalMessageFilter Event Type GlobalLogger.MessageFilterDelegate GlobalMessageLogged Occurs when a message is logged. public static event Action<ILogMessage>? GlobalMessageLogged Event Type Action<ILogMessage>"
  },
  "api/Stride.Core.Diagnostics.ILogMessage.html": {
    "href": "api/Stride.Core.Diagnostics.ILogMessage.html",
    "title": "Interface ILogMessage | Stride API",
    "summary": "Interface ILogMessage Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll The base interface for log messages used by the logging infrastructure. public interface ILogMessage Extension Methods LogMessageExtensions.IsAtLeast(ILogMessage, LogMessageType) LogMessageExtensions.IsAtMost(ILogMessage, LogMessageType) LogMessageExtensions.IsDebug(ILogMessage) LogMessageExtensions.IsError(ILogMessage) LogMessageExtensions.IsFatal(ILogMessage) LogMessageExtensions.IsInfo(ILogMessage) LogMessageExtensions.IsVerbose(ILogMessage) LogMessageExtensions.IsWarning(ILogMessage) UnsafeUtilities.As<T>(object?) Properties ExceptionInfo Gets or sets the exception info. ExceptionInfo? ExceptionInfo { get; } Property Value ExceptionInfo Module Gets or sets the module. string? Module { get; set; } Property Value string The module. Remarks The module is an identifier for a logical part of the system. It can be a class name, a namespace or a regular string not linked to a code hierarchy. Text Gets or sets the text. string Text { get; set; } Property Value string The text. Type Gets or sets the type of this message. LogMessageType Type { get; set; } Property Value LogMessageType The type."
  },
  "api/Stride.Core.Diagnostics.ILogger.html": {
    "href": "api/Stride.Core.Diagnostics.ILogger.html",
    "title": "Interface ILogger | Stride API",
    "summary": "Interface ILogger Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Interface for logging. public interface ILogger Extension Methods LoggerExtensions.Debug(ILogger, string, CallerInfo?) LoggerExtensions.Debug(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Error(ILogger, string, CallerInfo?) LoggerExtensions.Error(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Info(ILogger, string, CallerInfo?) LoggerExtensions.Info(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Warning(ILogger, string, CallerInfo?) LoggerExtensions.Warning(ILogger, string, Exception?, CallerInfo?) UnsafeUtilities.As<T>(object?) Properties Module Gets the module this logger refers to. string? Module { get; } Property Value string The module. Methods Log(ILogMessage) Logs the specified log message. void Log(ILogMessage logMessage) Parameters logMessage ILogMessage The log message."
  },
  "api/Stride.Core.Diagnostics.IProgressStatus.html": {
    "href": "api/Stride.Core.Diagnostics.IProgressStatus.html",
    "title": "Interface IProgressStatus | Stride API",
    "summary": "Interface IProgressStatus Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Provides progress of an operation. public interface IProgressStatus Extension Methods UnsafeUtilities.As<T>(object?) Methods OnProgressChanged(ProgressStatusEventArgs) Handles the ProgressChanged event. void OnProgressChanged(ProgressStatusEventArgs e) Parameters e ProgressStatusEventArgs The ProgressStatusEventArgs instance containing the event data. Events ProgressChanged An event handler to notify the progress of an operation. event EventHandler<ProgressStatusEventArgs> ProgressChanged Event Type EventHandler<ProgressStatusEventArgs>"
  },
  "api/Stride.Core.Diagnostics.LogListener.html": {
    "href": "api/Stride.Core.Diagnostics.LogListener.html",
    "title": "Class LogListener | Stride API",
    "summary": "Class LogListener Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A base class to implement a log listener public abstract class LogListener : IDisposable Inheritance object LogListener Implements IDisposable Derived ConsoleLogListener DebugLogListener TextWriterLogListener Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors LogListener() Initializes a new instance of the LogListener class. protected LogListener() Properties LogCountFlushLimit Gets or sets the log count flush limit. Default is on every message. public int LogCountFlushLimit { get; set; } Property Value int The log count flush limit. LogMessageCount Gets the log message count. public int LogMessageCount { get; } Property Value int The log message count. TextFormatter Gets or sets the function that convert a ILogMessage instance into a string. public Func<ILogMessage, string?> TextFormatter { get; set; } Property Value Func<ILogMessage, string> UseFlushAsync Gets or sets a value indicating whether [use flush async]. public bool UseFlushAsync { get; set; } Property Value bool true if [use flush async]; otherwise, false. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public virtual void Dispose() Flush() Flush the log, method to be implemented in a subclass. protected virtual void Flush() GetDefaultText(ILogMessage) Gets the default text for a particular log message. protected virtual string? GetDefaultText(ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Returns string A textual representation of a message. GetExceptionText(ILogMessage) Gets the text that describes the exception associated to a particular log message. protected virtual string GetExceptionText(ILogMessage message) Parameters message ILogMessage The log message. Returns string A textual representation of the exception, or Empty if no exception is associated to this log message. OnLog(ILogMessage) Called when a log occurred. protected abstract void OnLog(ILogMessage logMessage) Parameters logMessage ILogMessage The log message. ShouldFlush(ILogMessage) Returns a boolean indicating whether the log should be flushed. By default, flushing is occurring if the message has a higher level than Info protected virtual bool ShouldFlush(ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Returns bool true if the log should be flushed, false otherwise Operators implicit operator Action<ILogMessage>(LogListener) Performs an implicit conversion from LogListener to Action<T>. public static implicit operator Action<ILogMessage>(LogListener logListener) Parameters logListener LogListener The log listener. Returns Action<ILogMessage> The result of the conversion."
  },
  "api/Stride.Core.Diagnostics.LogMessage.html": {
    "href": "api/Stride.Core.Diagnostics.LogMessage.html",
    "title": "Class LogMessage | Stride API",
    "summary": "Class LogMessage Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A base log message used by the logging infrastructure. public class LogMessage : ILogMessage Inheritance object LogMessage Implements ILogMessage Derived AssetLogMessage ProfilingMessage Extension Methods LogMessageExtensions.IsAtLeast(ILogMessage, LogMessageType) LogMessageExtensions.IsAtMost(ILogMessage, LogMessageType) LogMessageExtensions.IsDebug(ILogMessage) LogMessageExtensions.IsError(ILogMessage) LogMessageExtensions.IsFatal(ILogMessage) LogMessageExtensions.IsInfo(ILogMessage) LogMessageExtensions.IsVerbose(ILogMessage) LogMessageExtensions.IsWarning(ILogMessage) UnsafeUtilities.As<T>(object?) Remarks This class can be derived in order to provide additional custom log information. Constructors LogMessage() Initializes a new instance of the LogMessage class. public LogMessage() LogMessage(string?, LogMessageType, string) Initializes a new instance of the LogMessage class. public LogMessage(string? module, LogMessageType type, string text) Parameters module string The module. type LogMessageType The type. text string The text. LogMessage(string?, LogMessageType, string, Exception?, CallerInfo?) Initializes a new instance of the LogMessage class. public LogMessage(string? module, LogMessageType type, string text, Exception? exception, CallerInfo? callerInfo) Parameters module string The module. type LogMessageType The type. text string The text. exception Exception The exception. callerInfo CallerInfo The caller info. Properties CallerInfo Gets or sets the caller information. public CallerInfo? CallerInfo { get; set; } Property Value CallerInfo The caller information. Exception Gets or sets the exception. public Exception? Exception { get; set; } Property Value Exception The exception. ExceptionInfo Gets or sets the exception info. public ExceptionInfo? ExceptionInfo { get; } Property Value ExceptionInfo Module Gets or sets the module. public string? Module { get; set; } Property Value string The module. Remarks The module is an identifier for a logical part of the system. It can be a class name, a namespace or a regular string not linked to a code hierarchy. Text Gets or sets the text. public virtual string Text { get; set; } Property Value string The text. Type Gets or sets the type of this message. public LogMessageType Type { get; set; } Property Value LogMessageType The type. Methods ToString() Returns a string that represents this instance. public override string ToString() Returns string A string that represents this instance."
  },
  "api/Stride.Core.Diagnostics.LogMessageExtensions.html": {
    "href": "api/Stride.Core.Diagnostics.LogMessageExtensions.html",
    "title": "Class LogMessageExtensions | Stride API",
    "summary": "Class LogMessageExtensions Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A set of extensions method to use with the LogMessage class. public static class LogMessageExtensions Inheritance object LogMessageExtensions Methods IsAtLeast(ILogMessage, LogMessageType) Gets whether the given log message is at least as severe as the given severity level. public static bool IsAtLeast(this ILogMessage logMessage, LogMessageType minSeverity) Parameters logMessage ILogMessage The log message. minSeverity LogMessageType The minimal severity level. Returns bool true if the given log message is at least as severe as the given severity level, false otherwise. IsAtMost(ILogMessage, LogMessageType) Gets whether the given log message is at most as severe as the given severity level. public static bool IsAtMost(this ILogMessage logMessage, LogMessageType maxSeverity) Parameters logMessage ILogMessage The log message. maxSeverity LogMessageType The maximal severity level. Returns bool true if the given log message is at most as severe as the given severity level, false otherwise. IsDebug(ILogMessage) Gets whether the given log message is a Debug message type public static bool IsDebug(this ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Returns bool true if the given log message is a Debug message, false otherwise. IsError(ILogMessage) Gets whether the given log message is a Error message type public static bool IsError(this ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Returns bool true if the given log message is a Error message, false otherwise. IsFatal(ILogMessage) Gets whether the given log message is a Fatal message type public static bool IsFatal(this ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Returns bool true if the given log message is a Fatal message, false otherwise. IsInfo(ILogMessage) Gets whether the given log message is a Info message type public static bool IsInfo(this ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Returns bool true if the given log message is a Info message, false otherwise. IsVerbose(ILogMessage) Gets whether the given log message is a Verbose message type public static bool IsVerbose(this ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Returns bool true if the given log message is a Verbose message, false otherwise. IsWarning(ILogMessage) Gets whether the given log message is a Warning message type public static bool IsWarning(this ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Returns bool true if the given log message is a Warning message, false otherwise."
  },
  "api/Stride.Core.Diagnostics.LogMessageType.html": {
    "href": "api/Stride.Core.Diagnostics.LogMessageType.html",
    "title": "Enum LogMessageType | Stride API",
    "summary": "Enum LogMessageType Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Type of a LogMessage. [DataContract] public enum LogMessageType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Debug = 0 A debug message (level 0). Error = 4 An error message (level 4). Fatal = 5 A Fatal error message (level 5). Info = 2 An regular info message (level 2). Verbose = 1 A verbose message (level 1). Warning = 3 A warning message (level 3)."
  },
  "api/Stride.Core.Diagnostics.Logger.html": {
    "href": "api/Stride.Core.Diagnostics.Logger.html",
    "title": "Class Logger | Stride API",
    "summary": "Class Logger Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Base implementation for ILogger. public abstract class Logger : ILogger Inheritance object Logger Implements ILogger Derived GlobalLogger LoggerResult TimestampLocalLogger Extension Methods LoggerExtensions.Debug(ILogger, string, CallerInfo?) LoggerExtensions.Debug(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Error(ILogger, string, CallerInfo?) LoggerExtensions.Error(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Info(ILogger, string, CallerInfo?) LoggerExtensions.Info(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Warning(ILogger, string, CallerInfo?) LoggerExtensions.Warning(ILogger, string, Exception?, CallerInfo?) UnsafeUtilities.As<T>(object?) Constructors Logger() Initializes a new instance of the Logger class. protected Logger() Fields EnableTypes protected readonly bool[] EnableTypes Field Value bool[] IsDebugEnabled True if the debug level is enabled at a global level public static readonly bool IsDebugEnabled Field Value bool IsVerboseEnabled True if the verbose level is enabled at a global level public static readonly bool IsVerboseEnabled Field Value bool Properties HasErrors Gets or sets a value indicating whether this instance has errors. public bool HasErrors { get; set; } Property Value bool true if this instance has errors; otherwise, false. MinimumLevelEnabled Gets the minimum level enabled from the config file. Can be overridden by the user. public static LogMessageType MinimumLevelEnabled { get; set; } Property Value LogMessageType Module Gets the module name. read-only. public string? Module { get; protected set; } Property Value string The module name. Methods ActivateLog(LogMessageType, LogMessageType, bool) Activates the log for this logger for a range of LogMessageType. public void ActivateLog(LogMessageType fromLevel, LogMessageType toLevel = LogMessageType.Fatal, bool enabledFlag = true) Parameters fromLevel LogMessageType The lowest inclusive level to log for. toLevel LogMessageType The highest inclusive level to log for. enabledFlag bool if set to true this will enable the log, false otherwise. Default is true. Remarks Outside the specified range the log message type are disabled (!enabledFlag). ActivateLog(LogMessageType, bool) Activates the log for this logger for a specific LogMessageType. public void ActivateLog(LogMessageType type, bool enabledFlag) Parameters type LogMessageType The type. enabledFlag bool if set to true [enabled flag]. Remarks All other activated type are leaved intact. Activated(LogMessageType) Returns a boolean indicating if a particular LogMessageType is activated. public bool Activated(LogMessageType type) Parameters type LogMessageType The type. Returns bool True if the log is activated, otherwise false. Debug(string, CallerInfo?) Logs the specified debug message. public void Debug(string message, CallerInfo? callerInfo = null) Parameters message string The debug message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Debug(string, Exception?, CallerInfo?) Logs the specified debug message with an exception. public void Debug(string message, Exception? exception, CallerInfo? callerInfo = null) Parameters message string The debug message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Error(string, CallerInfo?) Logs the specified error message. public void Error(string message, CallerInfo? callerInfo = null) Parameters message string The error message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Error(string, Exception?, CallerInfo?) Logs the specified error message with an exception. public void Error(string message, Exception? exception, CallerInfo? callerInfo = null) Parameters message string The error message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Fatal(string, CallerInfo?) Logs the specified fatal message. public void Fatal(string message, CallerInfo? callerInfo = null) Parameters message string The fatal message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Fatal(string, Exception?, CallerInfo?) Logs the specified fatal message with an exception. public void Fatal(string message, Exception? exception, CallerInfo? callerInfo = null) Parameters message string The fatal message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Info(string, CallerInfo?) Logs the specified info message. public void Info(string message, CallerInfo? callerInfo = null) Parameters message string The info message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Info(string, Exception?, CallerInfo?) Logs the specified info message with an exception. public void Info(string message, Exception? exception, CallerInfo? callerInfo = null) Parameters message string The info message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Log(ILogMessage) Logs the specified log message. public void Log(ILogMessage logMessage) Parameters logMessage ILogMessage The log message. LogRaw(ILogMessage) Internal method used to log a message. All Info, Debug, Error...etc. methods are calling this method. protected abstract void LogRaw(ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Verbose(string, CallerInfo?) Logs the specified verbose message. public void Verbose(string message, CallerInfo? callerInfo = null) Parameters message string The verbose message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Verbose(string, Exception?, CallerInfo?) Logs the specified verbose message with an exception. public void Verbose(string message, Exception? exception, CallerInfo? callerInfo = null) Parameters message string The verbose message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Warning(string, CallerInfo?) Logs the specified warning message. public void Warning(string message, CallerInfo? callerInfo = null) Parameters message string The warning message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Warning(string, Exception?, CallerInfo?) Logs the specified warning message with an exception. public void Warning(string message, Exception? exception, CallerInfo? callerInfo = null) Parameters message string The warning message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Events MessageLogged Occurs when a message is logged. public event EventHandler<MessageLoggedEventArgs>? MessageLogged Event Type EventHandler<MessageLoggedEventArgs>"
  },
  "api/Stride.Core.Diagnostics.LoggerConfig.html": {
    "href": "api/Stride.Core.Diagnostics.LoggerConfig.html",
    "title": "Class LoggerConfig | Stride API",
    "summary": "Class LoggerConfig Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Configuration for GlobalLogger. [DataContract(\"GlobalLoggerConfig\")] public class LoggerConfig Inheritance object LoggerConfig Extension Methods UnsafeUtilities.As<T>(object?) Properties Level Gets or sets the minimum level to allow logging. public LogMessageType Level { get; set; } Property Value LogMessageType The level."
  },
  "api/Stride.Core.Diagnostics.LoggerExtensions.html": {
    "href": "api/Stride.Core.Diagnostics.LoggerExtensions.html",
    "title": "Class LoggerExtensions | Stride API",
    "summary": "Class LoggerExtensions Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Extensions for ILogger. public static class LoggerExtensions Inheritance object LoggerExtensions Methods Debug(ILogger, string, CallerInfo?) Logs the specified debug message. public static void Debug(this ILogger logger, string message, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The debug message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Debug(ILogger, string, Exception?, CallerInfo?) Logs the specified debug message with an exception. public static void Debug(this ILogger logger, string message, Exception? exception, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The debug message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Error(ILogger, string, CallerInfo?) Logs the specified error message. public static void Error(this ILogger logger, string message, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The error message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Error(ILogger, string, Exception?, CallerInfo?) Logs the specified error message with an exception. public static void Error(this ILogger logger, string message, Exception? exception, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The error message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Fatal(ILogger, string, CallerInfo?) Logs the specified fatal message. public static void Fatal(this ILogger logger, string message, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The fatal message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Fatal(ILogger, string, Exception?, CallerInfo?) Logs the specified fatal message with an exception. public static void Fatal(this ILogger logger, string message, Exception? exception, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The fatal message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Info(ILogger, string, CallerInfo?) Logs the specified info message. public static void Info(this ILogger logger, string message, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The info message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Info(ILogger, string, Exception?, CallerInfo?) Logs the specified info message with an exception. public static void Info(this ILogger logger, string message, Exception? exception, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The info message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Verbose(ILogger, string, CallerInfo?) Logs the specified verbose message. public static void Verbose(this ILogger logger, string message, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The verbose message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Verbose(ILogger, string, Exception?, CallerInfo?) Logs the specified verbose message with an exception. public static void Verbose(this ILogger logger, string message, Exception? exception, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The verbose message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Warning(ILogger, string, CallerInfo?) Logs the specified warning message. public static void Warning(this ILogger logger, string message, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The warning message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int). Warning(ILogger, string, Exception?, CallerInfo?) Logs the specified warning message with an exception. public static void Warning(this ILogger logger, string message, Exception? exception, CallerInfo? callerInfo = null) Parameters logger ILogger The logger. message string The warning message. exception Exception An exception to log with the message. callerInfo CallerInfo Information about the caller. Default is null, otherwise use Get(string, string, int)."
  },
  "api/Stride.Core.Diagnostics.LoggerResult.html": {
    "href": "api/Stride.Core.Diagnostics.LoggerResult.html",
    "title": "Class LoggerResult | Stride API",
    "summary": "Class LoggerResult Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A logger that stores messages locally useful for internal log scenarios. public class LoggerResult : Logger, ILogger, IProgressStatus Inheritance object Logger LoggerResult Implements ILogger IProgressStatus Derived AssetCompilerResult PackageSessionResult ForwardingLoggerResult LoggerValueResult<T> MaterialShaderResult CompilerResults Inherited Members Logger.EnableTypes Logger.MessageLogged Logger.MinimumLevelEnabled Logger.IsDebugEnabled Logger.IsVerboseEnabled Logger.HasErrors Logger.ActivateLog(LogMessageType, LogMessageType, bool) Logger.ActivateLog(LogMessageType, bool) Logger.Activated(LogMessageType) Logger.Log(ILogMessage) Logger.Verbose(string, Exception, CallerInfo) Logger.Verbose(string, CallerInfo) Logger.Debug(string, Exception, CallerInfo) Logger.Debug(string, CallerInfo) Logger.Info(string, Exception, CallerInfo) Logger.Info(string, CallerInfo) Logger.Warning(string, Exception, CallerInfo) Logger.Warning(string, CallerInfo) Logger.Error(string, Exception, CallerInfo) Logger.Error(string, CallerInfo) Logger.Fatal(string, Exception, CallerInfo) Logger.Fatal(string, CallerInfo) Extension Methods LoggerExtensions.Debug(ILogger, string, CallerInfo?) LoggerExtensions.Debug(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Error(ILogger, string, CallerInfo?) LoggerExtensions.Error(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Info(ILogger, string, CallerInfo?) LoggerExtensions.Info(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Warning(ILogger, string, CallerInfo?) LoggerExtensions.Warning(ILogger, string, Exception?, CallerInfo?) UnsafeUtilities.As<T>(object?) Constructors LoggerResult(string?) Initializes a new instance of the LoggerResult class. public LoggerResult(string? moduleName = null) Parameters moduleName string Properties IsLoggingProgressAsInfo Gets or sets a value indicating whether this instance is logging progress as information. Default is true. public bool IsLoggingProgressAsInfo { get; set; } Property Value bool true if this instance is logging progress as information; otherwise, false. Messages Gets the messages logged to this instance. public TrackingCollection<ILogMessage> Messages { get; } Property Value TrackingCollection<ILogMessage> The messages. Module Gets the module name. read-write. public string? Module { get; set; } Property Value string The module name. Methods Clear() Clears all messages. public virtual void Clear() CopyTo(ILogger) Copies all messages to another instance. public void CopyTo(ILogger results) Parameters results ILogger The results. LogRaw(ILogMessage) Internal method used to log a message. All Info, Debug, Error...etc. methods are calling this method. protected override void LogRaw(ILogMessage logMessage) Parameters logMessage ILogMessage The log message. Progress(string) Notifies progress on this instance. public void Progress(string message) Parameters message string The message. Progress(string, int, int) Notifies progress on this instance. public void Progress(string message, int currentStep, int stepCount) Parameters message string The message. currentStep int The current step. stepCount int The step count. ToText() Returns a string representation of this public string ToText() Returns string System.String. Events ProgressChanged Occurs when the progress changed for this logger. public event EventHandler<ProgressStatusEventArgs>? ProgressChanged Event Type EventHandler<ProgressStatusEventArgs>"
  },
  "api/Stride.Core.Diagnostics.LoggerValueResult-1.html": {
    "href": "api/Stride.Core.Diagnostics.LoggerValueResult-1.html",
    "title": "Class LoggerValueResult<T> | Stride API",
    "summary": "Class LoggerValueResult<T> Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A LoggerResult with an associated value; public class LoggerValueResult<T> : LoggerResult, ILogger, IProgressStatus Type Parameters T Inheritance object Logger LoggerResult LoggerValueResult<T> Implements ILogger IProgressStatus Inherited Members LoggerResult.ProgressChanged LoggerResult.Module LoggerResult.Clear() LoggerResult.IsLoggingProgressAsInfo LoggerResult.Progress(string) LoggerResult.Progress(string, int, int) LoggerResult.Messages LoggerResult.LogRaw(ILogMessage) LoggerResult.CopyTo(ILogger) LoggerResult.ToText() Logger.EnableTypes Logger.MessageLogged Logger.MinimumLevelEnabled Logger.IsDebugEnabled Logger.IsVerboseEnabled Logger.HasErrors Logger.ActivateLog(LogMessageType, LogMessageType, bool) Logger.ActivateLog(LogMessageType, bool) Logger.Activated(LogMessageType) Logger.Log(ILogMessage) Logger.Verbose(string, Exception, CallerInfo) Logger.Verbose(string, CallerInfo) Logger.Debug(string, Exception, CallerInfo) Logger.Debug(string, CallerInfo) Logger.Info(string, Exception, CallerInfo) Logger.Info(string, CallerInfo) Logger.Warning(string, Exception, CallerInfo) Logger.Warning(string, CallerInfo) Logger.Error(string, Exception, CallerInfo) Logger.Error(string, CallerInfo) Logger.Fatal(string, Exception, CallerInfo) Logger.Fatal(string, CallerInfo) Extension Methods LoggerExtensions.Debug(ILogger, string, CallerInfo?) LoggerExtensions.Debug(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Error(ILogger, string, CallerInfo?) LoggerExtensions.Error(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Info(ILogger, string, CallerInfo?) LoggerExtensions.Info(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Warning(ILogger, string, CallerInfo?) LoggerExtensions.Warning(ILogger, string, Exception?, CallerInfo?) UnsafeUtilities.As<T>(object?) Constructors LoggerValueResult(string?) public LoggerValueResult(string? moduleName = null) Parameters moduleName string Properties Value Gets or sets the value associated with this log. public T? Value { get; set; } Property Value T The value."
  },
  "api/Stride.Core.Diagnostics.MessageLoggedEventArgs.html": {
    "href": "api/Stride.Core.Diagnostics.MessageLoggedEventArgs.html",
    "title": "Class MessageLoggedEventArgs | Stride API",
    "summary": "Class MessageLoggedEventArgs Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Arguments of the MessageLogged event. public class MessageLoggedEventArgs : EventArgs Inheritance object EventArgs MessageLoggedEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors MessageLoggedEventArgs(ILogMessage) Initializes a new instance of the MessageLoggedEventArgs class with a log message. public MessageLoggedEventArgs(ILogMessage message) Parameters message ILogMessage The message that has been logged. Properties Message Gets the message that has been logged. public ILogMessage Message { get; } Property Value ILogMessage"
  },
  "api/Stride.Core.Diagnostics.PerformanceCheckBlock.html": {
    "href": "api/Stride.Core.Diagnostics.PerformanceCheckBlock.html",
    "title": "Class PerformanceCheckBlock | Stride API",
    "summary": "Class PerformanceCheckBlock Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll public class PerformanceCheckBlock : IDisposable Inheritance object PerformanceCheckBlock Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors PerformanceCheckBlock(string, PerformanceReport) public PerformanceCheckBlock(string text, PerformanceReport report) Parameters text string report PerformanceReport Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool"
  },
  "api/Stride.Core.Diagnostics.PerformanceReport.PerformanceReportInfo.html": {
    "href": "api/Stride.Core.Diagnostics.PerformanceReport.PerformanceReportInfo.html",
    "title": "Struct PerformanceReport.PerformanceReportInfo | Stride API",
    "summary": "Struct PerformanceReport.PerformanceReportInfo Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll public struct PerformanceReport.PerformanceReportInfo Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Milliseconds public long Milliseconds { readonly get; set; } Property Value long Text public string Text { readonly get; set; } Property Value string Ticks public long Ticks { readonly get; set; } Property Value long"
  },
  "api/Stride.Core.Diagnostics.PerformanceReport.html": {
    "href": "api/Stride.Core.Diagnostics.PerformanceReport.html",
    "title": "Class PerformanceReport | Stride API",
    "summary": "Class PerformanceReport Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll public class PerformanceReport Inheritance object PerformanceReport Extension Methods UnsafeUtilities.As<T>(object?) Constructors PerformanceReport() public PerformanceReport() Properties Measures public IEnumerable<PerformanceReport.PerformanceReportInfo> Measures { get; } Property Value IEnumerable<PerformanceReport.PerformanceReportInfo> Methods BeginMeasure(string) [Conditional(\"DEBUG\")] public void BeginMeasure(string text) Parameters text string EndMeasure() [Conditional(\"DEBUG\")] public void EndMeasure() Reset() public void Reset() ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Diagnostics.Profiler.html": {
    "href": "api/Stride.Core.Diagnostics.Profiler.html",
    "title": "Class Profiler | Stride API",
    "summary": "Class Profiler Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll High level CPU Profiler. For usage see remarks. public static class Profiler Inheritance object Profiler Remarks This class is a lightweight profiler that can log detailed KPI (Key Performance Indicators) of an application. To use it, simply enclose in a using code the section of code you want to profile: public static readonly ProfilingKey GameInitialization = new ProfilingKey(\"Game\", \"Initialization\"); // This will log a 'Begin' profiling event. using (var profile = Profiler.Begin(GameInitialization)) { // Long running code here... // You can log 'Mark' profiling event profile.Mark(\"CriticalPart\"); // Adds an attribute that will be logged in End event profile.Attributes.Add(\"ModelCount\", modelCount); } // here a 'End' profiling event will be issued. By default, the profiler is not enabled, so there is a minimum performance impact leaving it in the code. It doesn't measure anything and doesn't produce any KPI. To enable a particular profiler (before using Begin(ProfilingKey) method): Profiler.Enable(GameInitialization); To enable all profilers, use Profiler.EnableAll() method. When the profiler is enabled, it is logged using the logging system through the standard Logger infrastructure, if ProfilingKeyFlags.Log is set for the ProfilingKey. The logger module name used is \"Profile.\" concatenates with the name of the profile. Note also that when profiling, it is possible to attach some property values (counters, indicators...etc.) to a profiler state. This property values will be displayed along the standard profiler state. You can use Attributes to attach a property value to a ProfilingState. To register your own system to receive ProfilingEvents use the Subscribe() and Unsubscribe(ChannelReader<ProfilingEvent>) methods. Properties MinimumProfileDuration The minimum duration of events that will be captured. Defaults to 1 µs. public static TimeSpan MinimumProfileDuration { get; set; } Property Value TimeSpan Methods AppendTime(StringBuilder, long, long) Append the provided time properly formated at the end of the string. tickFrequency is used to convert the ticks into time. If tickFrequency is 0 then Frequency is used to perform the calculation. public static void AppendTime(StringBuilder builder, long accumulatedTicks, long tickFrequency = 0) Parameters builder StringBuilder accumulatedTicks long tickFrequency long AppendTime(StringBuilder, TimeSpan) public static void AppendTime(StringBuilder builder, TimeSpan accumulatedTimeSpan) Parameters builder StringBuilder accumulatedTimeSpan TimeSpan Begin(ProfilingKey) Creates a profiler with the specified key. The returned object must be disposed at the end of the section being profiled. See remarks. public static ProfilingState Begin(ProfilingKey profilingKey) Parameters profilingKey ProfilingKey The profile key. Returns ProfilingState A profiler state. Remarks It is recommended to call this method with using (Profiler.Begin(...)) {...} or using var _ = Profiler.Begin(...); in order to make sure that the Dispose() method will be called on the ProfilingState returned object. Begin(ProfilingKey, string, ProfilingCustomValue?, ProfilingCustomValue?, ProfilingCustomValue?, ProfilingCustomValue?) Creates a profiler with the specified key. The returned object must be disposed at the end of the section being profiled. See remarks. public static ProfilingState Begin(ProfilingKey profilingKey, string textFormat, ProfilingCustomValue? value0 = null, ProfilingCustomValue? value1 = null, ProfilingCustomValue? value2 = null, ProfilingCustomValue? value3 = null) Parameters profilingKey ProfilingKey The profile key. textFormat string The text to format. value0 ProfilingCustomValue? First value (can be int, float, long or double). value1 ProfilingCustomValue? Second value (can be int, float, long or double). value2 ProfilingCustomValue? Third value (can be int, float, long or double). value3 ProfilingCustomValue? Fourth value (can be int, float, long or double). Returns ProfilingState A profiler state. Remarks It is recommended to call this method with using (Profiler.Begin(...)) {...} or using var _ = Profiler.Begin(...); in order to make sure that the Dispose() method will be called on the ProfilingState returned object. Disable(ProfilingKey) Disables the specified profiler. public static void Disable(ProfilingKey profilingKey) Parameters profilingKey ProfilingKey The profile key. DisableAll() Disable all profilers. public static void DisableAll() Enable(ProfilingKey) Enables the specified profiler. public static void Enable(ProfilingKey profilingKey) Parameters profilingKey ProfilingKey The profile key. EnableAll() Enables all profilers. public static void EnableAll() IsEnabled(ProfilingKey) Enables the specified profiler. public static bool IsEnabled(ProfilingKey profilingKey) Parameters profilingKey ProfilingKey The profile key. Returns bool New(ProfilingKey) Creates a profiler with the specified name. The returned object must be disposed at the end of the section being profiled. See remarks. public static ProfilingState New(ProfilingKey profilingKey) Parameters profilingKey ProfilingKey The profile key. Returns ProfilingState A profiler state. Remarks It is recommended to call this method with using (Profiler.Begin(...)) {...} or using var _ = Profiler.Begin(...); in order to make sure that the Dispose() method will be called on the ProfilingState returned object. ProcessEvent(ref ProfilingEvent, ProfilingEventType) public static void ProcessEvent(ref ProfilingEvent profilingEvent, ProfilingEventType eventType) Parameters profilingEvent ProfilingEvent eventType ProfilingEventType Reset() Resets the id counter to zero and disable all registered profiles. public static void Reset() Subscribe() Subscribes to the generated ProfilingEvents. public static ChannelReader<ProfilingEvent> Subscribe() Returns ChannelReader<ProfilingEvent> The ChannelReader<T> which will receive the events. Unsubscribe(ChannelReader<ProfilingEvent>) Unsubscribes from receiving ProfilingEvents. public static void Unsubscribe(ChannelReader<ProfilingEvent> eventReader) Parameters eventReader ChannelReader<ProfilingEvent> The reader previously returned by Subscribe()"
  },
  "api/Stride.Core.Diagnostics.ProfilerDisposeEventDelegate.html": {
    "href": "api/Stride.Core.Diagnostics.ProfilerDisposeEventDelegate.html",
    "title": "Delegate ProfilerDisposeEventDelegate | Stride API",
    "summary": "Delegate ProfilerDisposeEventDelegate Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Delegate called when a ProfilingState is disposed (end of profiling). public delegate void ProfilerDisposeEventDelegate(ref ProfilingState profilingState) Parameters profilingState ProfilingState State of the profile. Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Diagnostics.ProfilingCustomValue.html": {
    "href": "api/Stride.Core.Diagnostics.ProfilingCustomValue.html",
    "title": "Struct ProfilingCustomValue | Stride API",
    "summary": "Struct ProfilingCustomValue Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll public struct ProfilingCustomValue Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields DoubleValue public double DoubleValue Field Value double FloatValue public float FloatValue Field Value float IntValue public int IntValue Field Value int LongValue public long LongValue Field Value long ValueType public Type ValueType Field Value Type Methods ToObject() public readonly object ToObject() Returns object Operators implicit operator ProfilingCustomValue(double) public static implicit operator ProfilingCustomValue(double value) Parameters value double Returns ProfilingCustomValue implicit operator ProfilingCustomValue(int) public static implicit operator ProfilingCustomValue(int value) Parameters value int Returns ProfilingCustomValue implicit operator ProfilingCustomValue(long) public static implicit operator ProfilingCustomValue(long value) Parameters value long Returns ProfilingCustomValue implicit operator ProfilingCustomValue(float) public static implicit operator ProfilingCustomValue(float value) Parameters value float Returns ProfilingCustomValue"
  },
  "api/Stride.Core.Diagnostics.ProfilingEvent.html": {
    "href": "api/Stride.Core.Diagnostics.ProfilingEvent.html",
    "title": "Struct ProfilingEvent | Stride API",
    "summary": "Struct ProfilingEvent Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A profiling event generated by Profiler. public readonly struct ProfilingEvent Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ProfilingEvent(int, ProfilingKey, ProfilingMessageType, TimeSpan, TimeSpan, int, ProfilingEventMessage?, TagList) Initializes a new instance of the ProfilingEvent struct. public ProfilingEvent(int profileId, ProfilingKey profilingKey, ProfilingMessageType profilingType, TimeSpan timeStamp, TimeSpan elapsedTime, int threadId, ProfilingEventMessage? message, TagList attributes) Parameters profileId int The profile identifier. profilingKey ProfilingKey The profiling key. profilingType ProfilingMessageType Type of the profiling. timeStamp TimeSpan elapsedTime TimeSpan The elapsed time. threadId int message ProfilingEventMessage? The message. attributes TagList The attributes. Fields Attributes The attributes public readonly TagList Attributes Field Value TagList ElapsedTime The elapsed time since Begin event. public readonly TimeSpan ElapsedTime Field Value TimeSpan Id The unique identifier. public readonly int Id Field Value int Key The profile key. public readonly ProfilingKey Key Field Value ProfilingKey Message The message. public readonly ProfilingEventMessage? Message Field Value ProfilingEventMessage? ThreadId The thread id. public readonly int ThreadId Field Value int TimeStamp The timestamp. public readonly TimeSpan TimeStamp Field Value TimeSpan Type The type of the profile. public readonly ProfilingMessageType Type Field Value ProfilingMessageType Methods IsGPUEvent() public bool IsGPUEvent() Returns bool"
  },
  "api/Stride.Core.Diagnostics.ProfilingEventMessage.html": {
    "href": "api/Stride.Core.Diagnostics.ProfilingEventMessage.html",
    "title": "Struct ProfilingEventMessage | Stride API",
    "summary": "Struct ProfilingEventMessage Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A message attached to a ProfilingEvent. public readonly struct ProfilingEventMessage Inherited Members ValueType.Equals(object) ValueType.GetHashCode() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ProfilingEventMessage(string, ProfilingCustomValue?, ProfilingCustomValue?, ProfilingCustomValue?, ProfilingCustomValue?) Initializes a new instance of the ProfilingEventMessage struct. public ProfilingEventMessage(string text, ProfilingCustomValue? value0 = null, ProfilingCustomValue? value1 = null, ProfilingCustomValue? value2 = null, ProfilingCustomValue? value3 = null) Parameters text string The text supporting formatting of up to 4 numerical parameters. value0 ProfilingCustomValue? value1 ProfilingCustomValue? value2 ProfilingCustomValue? value3 ProfilingCustomValue? Fields Custom0 public readonly ProfilingCustomValue? Custom0 Field Value ProfilingCustomValue? Custom1 public readonly ProfilingCustomValue? Custom1 Field Value ProfilingCustomValue? Custom2 public readonly ProfilingCustomValue? Custom2 Field Value ProfilingCustomValue? Custom3 public readonly ProfilingCustomValue? Custom3 Field Value ProfilingCustomValue? Text The text supporting formatting of up to 4 numerical parameters. public readonly string Text Field Value string Methods ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. ToString(StringBuilder) public void ToString(StringBuilder builder) Parameters builder StringBuilder"
  },
  "api/Stride.Core.Diagnostics.ProfilingEventType.html": {
    "href": "api/Stride.Core.Diagnostics.ProfilingEventType.html",
    "title": "Enum ProfilingEventType | Stride API",
    "summary": "Enum ProfilingEventType Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll List the different types of profiling events public enum ProfilingEventType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields CpuProfilingEvent = 0 GpuProfilingEvent = 1"
  },
  "api/Stride.Core.Diagnostics.ProfilingKey.html": {
    "href": "api/Stride.Core.Diagnostics.ProfilingKey.html",
    "title": "Class ProfilingKey | Stride API",
    "summary": "Class ProfilingKey Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A key to identify a specific profile. public class ProfilingKey Inheritance object ProfilingKey Extension Methods UnsafeUtilities.As<T>(object?) Constructors ProfilingKey(ProfilingKey, string, ProfilingKeyFlags) Initializes a new instance of the ProfilingKey class. public ProfilingKey(ProfilingKey parent, string name, ProfilingKeyFlags flags = ProfilingKeyFlags.None) Parameters parent ProfilingKey The parent. name string The name. flags ProfilingKeyFlags Exceptions ArgumentNullException parent ProfilingKey(string, ProfilingKeyFlags) Initializes a new instance of the ProfilingKey class. public ProfilingKey(string name, ProfilingKeyFlags flags = ProfilingKeyFlags.None) Parameters name string The name. flags ProfilingKeyFlags Properties Children Gets the children. public List<ProfilingKey> Children { get; } Property Value List<ProfilingKey> The children. Name Gets the name. public string Name { get; } Property Value string The name. Parent Gets the group. public ProfilingKey? Parent { get; } Property Value ProfilingKey The group. Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Diagnostics.ProfilingKeyFlags.html": {
    "href": "api/Stride.Core.Diagnostics.ProfilingKeyFlags.html",
    "title": "Enum ProfilingKeyFlags | Stride API",
    "summary": "Enum ProfilingKeyFlags Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll [Flags] public enum ProfilingKeyFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Log = 1 Output message to log right away. None = 0 Empty flag."
  },
  "api/Stride.Core.Diagnostics.ProfilingMessage.html": {
    "href": "api/Stride.Core.Diagnostics.ProfilingMessage.html",
    "title": "Class ProfilingMessage | Stride API",
    "summary": "Class ProfilingMessage Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A log message generate by Profiler. public class ProfilingMessage : LogMessage, ILogMessage Inheritance object LogMessage ProfilingMessage Implements ILogMessage Inherited Members LogMessage.Module LogMessage.Type LogMessage.Exception LogMessage.CallerInfo LogMessage.ExceptionInfo Extension Methods LogMessageExtensions.IsAtLeast(ILogMessage, LogMessageType) LogMessageExtensions.IsAtMost(ILogMessage, LogMessageType) LogMessageExtensions.IsDebug(ILogMessage) LogMessageExtensions.IsError(ILogMessage) LogMessageExtensions.IsFatal(ILogMessage) LogMessageExtensions.IsInfo(ILogMessage) LogMessageExtensions.IsVerbose(ILogMessage) LogMessageExtensions.IsWarning(ILogMessage) UnsafeUtilities.As<T>(object?) Constructors ProfilingMessage(int, ProfilingKey, ProfilingMessageType) Initializes a new instance of the ProfilingMessage class. public ProfilingMessage(int profileId, ProfilingKey profilingKey, ProfilingMessageType profilingType) Parameters profileId int The profile unique identifier. profilingKey ProfilingKey The profile key. profilingType ProfilingMessageType Type of the profile. ProfilingMessage(int, ProfilingKey, ProfilingMessageType, ProfilingEventMessage?) Initializes a new instance of the ProfilingMessage class. public ProfilingMessage(int profileId, ProfilingKey profilingKey, ProfilingMessageType profilingType, ProfilingEventMessage? message) Parameters profileId int The profile unique identifier. profilingKey ProfilingKey The profile key. profilingType ProfilingMessageType Type of the profile. message ProfilingEventMessage? Properties Attributes Gets attributes attached to this message. May be null. public TagList Attributes { get; set; } Property Value TagList The properties. ElapsedTime Gets or sets the time elapsed for this particular profile. public TimeSpan ElapsedTime { get; set; } Property Value TimeSpan The elapsed. Id Gets or sets the unique identifier associated with this profile message. public int Id { get; } Property Value int The unique identifier. Key Gets or sets the profile key. public ProfilingKey Key { get; } Property Value ProfilingKey The profile key. Message Event message. public ProfilingEventMessage? Message { get; } Property Value ProfilingEventMessage? ProfilingType Gets the type of the profile. public ProfilingMessageType ProfilingType { get; } Property Value ProfilingMessageType The type of the profile. Text Text of the log. public override string Text { get; set; } Property Value string Methods ToString() Returns a string that represents this instance. public override string ToString() Returns string A string that represents this instance."
  },
  "api/Stride.Core.Diagnostics.ProfilingMessageType.html": {
    "href": "api/Stride.Core.Diagnostics.ProfilingMessageType.html",
    "title": "Enum ProfilingMessageType | Stride API",
    "summary": "Enum ProfilingMessageType Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll Type of a profiling message. public enum ProfilingMessageType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Begin = 0 A begin message. End = 1 A end message. Mark = 2 A mark message."
  },
  "api/Stride.Core.Diagnostics.ProfilingState.html": {
    "href": "api/Stride.Core.Diagnostics.ProfilingState.html",
    "title": "Struct ProfilingState | Stride API",
    "summary": "Struct ProfilingState Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A profiler state contains information of a portion of code being profiled. See remarks. public struct ProfilingState : IDisposable Implements IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks This struct is not intended to be used directly but only through Begin(ProfilingKey). You can still attach some attributes to it while profiling a portion of code. Properties Attributes A list of attributes (dimensions) associated with this profiling state. public readonly TagList Attributes { get; } Property Value TagList IsInitialized Gets a value indicating whether this instance is initialized. public readonly bool IsInitialized { get; } Property Value bool true if this instance is initialized; otherwise, false. ProfilingId Gets the profiling unique identifier. public readonly int ProfilingId { get; } Property Value int The profiling unique identifier. ProfilingKey Gets the profiling key. public readonly ProfilingKey ProfilingKey { get; } Property Value ProfilingKey The profiling key. TickFrequency Gets or sets the TickFrequency used to convert long timestamp to TimeSpan. By default for CPU events it's Frequency and for GPU events it's set by the rendering code.\"/> public long TickFrequency { get; set; } Property Value long Methods Begin() public void Begin() Begin(string, ProfilingCustomValue?, ProfilingCustomValue?, ProfilingCustomValue?, ProfilingCustomValue?) Emits a Begin event with the specified formatted text. public void Begin(string text, ProfilingCustomValue? value0 = null, ProfilingCustomValue? value1 = null, ProfilingCustomValue? value2 = null, ProfilingCustomValue? value3 = null) Parameters text string The event text. value0 ProfilingCustomValue? First value (can be int, float, long or double). value1 ProfilingCustomValue? Second value (can be int, float, long or double). value2 ProfilingCustomValue? Third value (can be int, float, long or double). value3 ProfilingCustomValue? Fourth value (can be int, float, long or double). CheckIfEnabled() Checks if the profiling key is enabled and update this instance. See remarks. public void CheckIfEnabled() Remarks This can be used for long running profiling that are using markers and want to log markers if the profiling was activated at runtime. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() End() Emits a End profiling event. public void End() End(string, ProfilingCustomValue?, ProfilingCustomValue?, ProfilingCustomValue?, ProfilingCustomValue?) Emits a End profiling event with the specified custom value. public void End(string text, ProfilingCustomValue? value0 = null, ProfilingCustomValue? value1 = null, ProfilingCustomValue? value2 = null, ProfilingCustomValue? value3 = null) Parameters text string The event text. value0 ProfilingCustomValue? First value (can be int, float, long or double). value1 ProfilingCustomValue? Second value (can be int, float, long or double). value2 ProfilingCustomValue? Third value (can be int, float, long or double). value3 ProfilingCustomValue? Fourth value (can be int, float, long or double). Mark() Emits a Mark event. public void Mark() Mark(string, ProfilingCustomValue?, ProfilingCustomValue?, ProfilingCustomValue?, ProfilingCustomValue?) Emits a Mark profiling event with the specified text. public void Mark(string text, ProfilingCustomValue? value0 = null, ProfilingCustomValue? value1 = null, ProfilingCustomValue? value2 = null, ProfilingCustomValue? value3 = null) Parameters text string The event text. value0 ProfilingCustomValue? First value (can be int, float, long or double). value1 ProfilingCustomValue? Second value (can be int, float, long or double). value2 ProfilingCustomValue? Third value (can be int, float, long or double). value3 ProfilingCustomValue? Fourth value (can be int, float, long or double)."
  },
  "api/Stride.Core.Diagnostics.ProgressStatusEventArgs.html": {
    "href": "api/Stride.Core.Diagnostics.ProgressStatusEventArgs.html",
    "title": "Class ProgressStatusEventArgs | Stride API",
    "summary": "Class ProgressStatusEventArgs Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll An event indicating the progress of an operation. public class ProgressStatusEventArgs : EventArgs Inheritance object EventArgs ProgressStatusEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors ProgressStatusEventArgs(string) Initializes a new instance of the ProgressStatusEventArgs class. public ProgressStatusEventArgs(string message) Parameters message string The message. ProgressStatusEventArgs(string, int, int) Initializes a new instance of the ProgressStatusEventArgs class. public ProgressStatusEventArgs(string message, int currentStep, int stepCount) Parameters message string The message. currentStep int The current step. stepCount int The step count. Properties CurrentStep Gets or sets the current index of the indicative step. See StepCount remarks. public int CurrentStep { get; } Property Value int The index of the step. HasKnownSteps Gets or sets a value indicating whether this instance has known steps (CurrentStep and StepCount are valid). public bool HasKnownSteps { get; } Property Value bool true if this instance has known steps; otherwise, false. Message Gets or sets the message associated with the progress. public string Message { get; } Property Value string The message. StepCount Gets or sets the step count used to indicate the number expected steps returned by this logger result. See remarks. public int StepCount { get; } Property Value int The step count, greater than 1. Default is 1 Remarks This property providea an estimation of the duration of an operation in terms of \"step counts\". The CurrentStep property returns the current step and gives indication about how much is still being processed. Exceptions ArgumentOutOfRangeException Expecting value >= 1;value"
  },
  "api/Stride.Core.Diagnostics.SafeAction.html": {
    "href": "api/Stride.Core.Diagnostics.SafeAction.html",
    "title": "Class SafeAction | Stride API",
    "summary": "Class SafeAction Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll public static class SafeAction Inheritance object SafeAction Methods Wrap(ParameterizedThreadStart, string, string, int) public static ParameterizedThreadStart Wrap(ParameterizedThreadStart action, string sourceFilePath = \"\", string memberName = \"\", int sourceLineNumber = 0) Parameters action ParameterizedThreadStart sourceFilePath string memberName string sourceLineNumber int Returns ParameterizedThreadStart Wrap(ThreadStart, string, string, int) public static ThreadStart Wrap(ThreadStart action, string sourceFilePath = \"\", string memberName = \"\", int sourceLineNumber = 0) Parameters action ThreadStart sourceFilePath string memberName string sourceLineNumber int Returns ThreadStart"
  },
  "api/Stride.Core.Diagnostics.SerializableLogMessage.html": {
    "href": "api/Stride.Core.Diagnostics.SerializableLogMessage.html",
    "title": "Class SerializableLogMessage | Stride API",
    "summary": "Class SerializableLogMessage Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A class that represents a copy of a LogMessage that can be serialized. [DataContract] [Serializable] public class SerializableLogMessage : ILogMessage Inheritance object SerializableLogMessage Implements ILogMessage Derived AssetSerializableLogMessage Extension Methods LogMessageExtensions.IsAtLeast(ILogMessage, LogMessageType) LogMessageExtensions.IsAtMost(ILogMessage, LogMessageType) LogMessageExtensions.IsDebug(ILogMessage) LogMessageExtensions.IsError(ILogMessage) LogMessageExtensions.IsFatal(ILogMessage) LogMessageExtensions.IsInfo(ILogMessage) LogMessageExtensions.IsVerbose(ILogMessage) LogMessageExtensions.IsWarning(ILogMessage) UnsafeUtilities.As<T>(object?) Constructors SerializableLogMessage() Initializes a new instance of the SerializableLogMessage class with default values for its properties. public SerializableLogMessage() SerializableLogMessage(LogMessage) Initializes a new instance of the SerializableLogMessage class from a LogMessage instance. public SerializableLogMessage(LogMessage message) Parameters message LogMessage The LogMessage instance to use to initialize properties. SerializableLogMessage(string, LogMessageType, string, ExceptionInfo?) Initializes a new instance of the SerializableLogMessage class using the given parameters to set its properties. public SerializableLogMessage(string module, LogMessageType type, string text, ExceptionInfo? exceptionInfo = null) Parameters module string The module name. type LogMessageType The type. text string The text. exceptionInfo ExceptionInfo The exception information. This parameter can be null. Properties ExceptionInfo Gets or sets the ExceptionInfo of this message. public ExceptionInfo? ExceptionInfo { get; set; } Property Value ExceptionInfo Module Gets or sets the module. public string? Module { get; set; } Property Value string Remarks The module is an identifier for a logical part of the system. It can be a class name, a namespace or a regular string not linked to a code hierarchy. Text Gets or sets the text. public string Text { get; set; } Property Value string Type Gets or sets the type of this message. public LogMessageType Type { get; set; } Property Value LogMessageType Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Diagnostics.TextWriterLogListener.html": {
    "href": "api/Stride.Core.Diagnostics.TextWriterLogListener.html",
    "title": "Class TextWriterLogListener | Stride API",
    "summary": "Class TextWriterLogListener Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A LogListener implementation redirecting its output to a TextWriter. public class TextWriterLogListener : LogListener, IDisposable Inheritance object LogListener TextWriterLogListener Implements IDisposable Inherited Members LogListener.LogMessageCount LogListener.UseFlushAsync LogListener.TextFormatter LogListener.LogCountFlushLimit LogListener.ShouldFlush(ILogMessage) LogListener.Dispose() LogListener.GetDefaultText(ILogMessage) LogListener.GetExceptionText(ILogMessage) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors TextWriterLogListener(Stream) Initializes a new instance of the TextWriterLogListener class. public TextWriterLogListener(Stream logStream) Parameters logStream Stream The log stream. TextWriterLogListener(TextWriter) Initializes a new instance of the TextWriterLogListener class. public TextWriterLogListener(TextWriter logWriter) Parameters logWriter TextWriter The log writer. Properties LogWriter Gets the log writer. public TextWriter LogWriter { get; } Property Value TextWriter The log writer. Methods Flush() Flush the log, method to be implemented in a subclass. protected override void Flush() OnLog(ILogMessage) Called when a log occurred. protected override void OnLog(ILogMessage logMessage) Parameters logMessage ILogMessage The log message."
  },
  "api/Stride.Core.Diagnostics.TimestampLocalLogger.Message.html": {
    "href": "api/Stride.Core.Diagnostics.TimestampLocalLogger.Message.html",
    "title": "Struct TimestampLocalLogger.Message | Stride API",
    "summary": "Struct TimestampLocalLogger.Message Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A structure describing a log message associated with a timestamp. public struct TimestampLocalLogger.Message Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Message(long, ILogMessage) Initializes a new instance of the TimestampLocalLogger.Message struct. public Message(long timestamp, ILogMessage logMessage) Parameters timestamp long The timestamp associated to the log message. logMessage ILogMessage The log message. Fields LogMessage The log message. public ILogMessage LogMessage Field Value ILogMessage Timestamp The timestamp associated to the log message. public long Timestamp Field Value long"
  },
  "api/Stride.Core.Diagnostics.TimestampLocalLogger.html": {
    "href": "api/Stride.Core.Diagnostics.TimestampLocalLogger.html",
    "title": "Class TimestampLocalLogger | Stride API",
    "summary": "Class TimestampLocalLogger Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll A logger that stores messages locally with their timestamp, useful for internal log scenarios. public class TimestampLocalLogger : Logger, ILogger Inheritance object Logger TimestampLocalLogger Implements ILogger Inherited Members Logger.EnableTypes Logger.MessageLogged Logger.MinimumLevelEnabled Logger.IsDebugEnabled Logger.IsVerboseEnabled Logger.HasErrors Logger.Module Logger.ActivateLog(LogMessageType, LogMessageType, bool) Logger.ActivateLog(LogMessageType, bool) Logger.Activated(LogMessageType) Logger.Log(ILogMessage) Logger.Verbose(string, Exception, CallerInfo) Logger.Verbose(string, CallerInfo) Logger.Debug(string, Exception, CallerInfo) Logger.Debug(string, CallerInfo) Logger.Info(string, Exception, CallerInfo) Logger.Info(string, CallerInfo) Logger.Warning(string, Exception, CallerInfo) Logger.Warning(string, CallerInfo) Logger.Error(string, Exception, CallerInfo) Logger.Error(string, CallerInfo) Logger.Fatal(string, Exception, CallerInfo) Logger.Fatal(string, CallerInfo) Extension Methods LoggerExtensions.Debug(ILogger, string, CallerInfo?) LoggerExtensions.Debug(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Error(ILogger, string, CallerInfo?) LoggerExtensions.Error(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, CallerInfo?) LoggerExtensions.Fatal(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Info(ILogger, string, CallerInfo?) LoggerExtensions.Info(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, CallerInfo?) LoggerExtensions.Verbose(ILogger, string, Exception?, CallerInfo?) LoggerExtensions.Warning(ILogger, string, CallerInfo?) LoggerExtensions.Warning(ILogger, string, Exception?, CallerInfo?) UnsafeUtilities.As<T>(object?) Constructors TimestampLocalLogger(DateTime, string?) Initializes a new instance of the TimestampLocalLogger class. public TimestampLocalLogger(DateTime startTime, string? moduleName = null) Parameters startTime DateTime moduleName string Properties Messages Gets the messages logged to this instance. public List<TimestampLocalLogger.Message> Messages { get; } Property Value List<TimestampLocalLogger.Message> The messages. Methods LogRaw(ILogMessage) Internal method used to log a message. All Info, Debug, Error...etc. methods are calling this method. protected override void LogRaw(ILogMessage logMessage) Parameters logMessage ILogMessage The log message."
  },
  "api/Stride.Core.Diagnostics.VTuneProfiler.Domain.html": {
    "href": "api/Stride.Core.Diagnostics.VTuneProfiler.Domain.html",
    "title": "Struct VTuneProfiler.Domain | Stride API",
    "summary": "Struct VTuneProfiler.Domain Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll public readonly struct VTuneProfiler.Domain Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Methods BeginFrame() public void BeginFrame() BeginTask(string) public void BeginTask(string taskName) Parameters taskName string EndFrame() public void EndFrame() EndTask() public void EndTask()"
  },
  "api/Stride.Core.Diagnostics.VTuneProfiler.Event.html": {
    "href": "api/Stride.Core.Diagnostics.VTuneProfiler.Event.html",
    "title": "Struct VTuneProfiler.Event | Stride API",
    "summary": "Struct VTuneProfiler.Event Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll public readonly struct VTuneProfiler.Event Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Methods End() public void End() Start() public void Start()"
  },
  "api/Stride.Core.Diagnostics.VTuneProfiler.html": {
    "href": "api/Stride.Core.Diagnostics.VTuneProfiler.html",
    "title": "Class VTuneProfiler | Stride API",
    "summary": "Class VTuneProfiler Namespace Stride.Core.Diagnostics Assembly Stride.Core.dll This static class gives access to the Pause/Resume API of VTune Amplifier. It is available on Windows Desktop platform only. public static class VTuneProfiler Inheritance object VTuneProfiler Fields IsAvailable public static readonly bool IsAvailable Field Value bool Methods CreateDomain(string) public static VTuneProfiler.Domain CreateDomain(string domaiName) Parameters domaiName string Returns VTuneProfiler.Domain CreateEvent(string) public static VTuneProfiler.Event CreateEvent(string eventName) Parameters eventName string Returns VTuneProfiler.Event Pause() Suspends the profiler. public static void Pause() Resume() Resumes the profiler. public static void Resume()"
  },
  "api/Stride.Core.Diagnostics.html": {
    "href": "api/Stride.Core.Diagnostics.html",
    "title": "Namespace Stride.Core.Diagnostics | Stride API",
    "summary": "Namespace Stride.Core.Diagnostics Classes CallerInfo A class to store Caller Information attributes. ChromeTracingProfileWriter CollectionDebugView Use this class to provide a debug output in Visual Studio debugger. CollectionDebugView<T> Use this class to provide a debug output in Visual Studio debugger. ComponentEventInfo Contains information about a AddReference/Release event. ConsoleLogListener A LogListener implementation redirecting its output to the default OS console. If console is not supported message are output to Debug DebugLogListener A LogListener implementation redirecting its output to a Debug. ExceptionInfo This class is used to store some properties of an exception. It is serializable. ForwardingLoggerResult A LoggerResult that also forwards messages to another ILogger. GlobalLogger A logger that redirect messages to a global handler and handle instantiated MapModuleNameToLogger. LogListener A base class to implement a log listener LogMessage A base log message used by the logging infrastructure. LogMessageExtensions A set of extensions method to use with the LogMessage class. Logger Base implementation for ILogger. LoggerConfig Configuration for GlobalLogger. LoggerExtensions Extensions for ILogger. LoggerResult A logger that stores messages locally useful for internal log scenarios. LoggerValueResult<T> A LoggerResult with an associated value; MessageLoggedEventArgs Arguments of the MessageLogged event. PerformanceCheckBlock PerformanceReport Profiler High level CPU Profiler. For usage see remarks. ProfilingKey A key to identify a specific profile. ProfilingMessage A log message generate by Profiler. ProgressStatusEventArgs An event indicating the progress of an operation. SafeAction SerializableLogMessage A class that represents a copy of a LogMessage that can be serialized. TextWriterLogListener A LogListener implementation redirecting its output to a TextWriter. TimestampLocalLogger A logger that stores messages locally with their timestamp, useful for internal log scenarios. VTuneProfiler This static class gives access to the Pause/Resume API of VTune Amplifier. It is available on Windows Desktop platform only. Structs PerformanceReport.PerformanceReportInfo ProfilingCustomValue ProfilingEvent A profiling event generated by Profiler. ProfilingEventMessage A message attached to a ProfilingEvent. ProfilingState A profiler state contains information of a portion of code being profiled. See remarks. TimestampLocalLogger.Message A structure describing a log message associated with a timestamp. VTuneProfiler.Domain VTuneProfiler.Event Interfaces ILogMessage The base interface for log messages used by the logging infrastructure. ILogger Interface for logging. IProgressStatus Provides progress of an operation. Enums ComponentEventType TODO: Update summary. ConsoleLogMode Defines how the console is opened. LogMessageType Type of a LogMessage. ProfilingEventType List the different types of profiling events ProfilingKeyFlags ProfilingMessageType Type of a profiling message. Delegates GlobalLogger.MessageFilterDelegate ProfilerDisposeEventDelegate Delegate called when a ProfilingState is disposed (end of profiling)."
  },
  "api/Stride.Core.DisplayAttribute.html": {
    "href": "api/Stride.Core.DisplayAttribute.html",
    "title": "Class DisplayAttribute | Stride API",
    "summary": "Class DisplayAttribute Namespace Stride.Core Assembly Stride.Core.dll Portable DisplayAttribute equivalent to DisplayAttribute. public class DisplayAttribute : Attribute Inheritance object Attribute DisplayAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DisplayAttribute(int, string?, string?) Initializes a new instance of the DisplayAttribute class. public DisplayAttribute(int order, string? name = null, string? category = null) Parameters order int The order weight of the column. name string A value that is used for display in the UI.. category string A value that is used to group fields in the UI.. DisplayAttribute(string?, string?) Initializes a new instance of the DisplayAttribute class. public DisplayAttribute(string? name = null, string? category = null) Parameters name string A value that is used for display in the UI.. category string A value that is used to group fields in the UI.. Properties Browsable Gets or sets whether the related member is browsable when its class is exposed in the UI. public bool Browsable { get; set; } Property Value bool Category Gets a string that is used to group fields in the UI. public string? Category { get; } Property Value string The category. CustomHue Gets the hue of a color that is used in the UI. public float? CustomHue { get; set; } Property Value float? Remarks If not null, this value must be in the range [0, 360]. Expand Gets or sets whether to expand the control representing the associated object in the UI. public ExpandRule Expand { get; set; } Property Value ExpandRule Name Gets a string that is used for display in the UI. public string? Name { get; } Property Value string The name. Order Gets the order weight of the column. public int? Order { get; } Property Value int? The order. Methods GetDisplay(MemberInfo) Gets the display attribute attached to the specified member info. [Obsolete(\"Display attribute should be retrieved via an AttributeRegistry.\")] public static DisplayAttribute GetDisplay(MemberInfo memberInfo) Parameters memberInfo MemberInfo Member type (Property, Field or Type). Returns DisplayAttribute DisplayAttribute. Exceptions ArgumentNullException memberInfo GetDisplayName(Type) Gets the display name of the given type. The display name is the name of the type, or, if the DisplayAttribute is applied on the type, value of the Name property. [Obsolete(\"Display attribute should be retrieved via an AttributeRegistry.\")] public static string? GetDisplayName(Type type) Parameters type Type The type for which to get the display name. Returns string A string representing the display name of the type. GetOrder(MemberInfo) [Obsolete(\"Display attribute should be retrieved via an AttributeRegistry.\")] public static int? GetOrder(MemberInfo memberInfo) Parameters memberInfo MemberInfo Returns int?"
  },
  "api/Stride.Core.DisposeBase.html": {
    "href": "api/Stride.Core.DisposeBase.html",
    "title": "Class DisposeBase | Stride API",
    "summary": "Class DisposeBase Namespace Stride.Core Assembly Stride.Core.dll Base class for a IDisposable interface implementation with reference-counting semantics. [DataContract] public abstract class DisposeBase : IDisposable, IReferencable Inheritance object DisposeBase Implements IDisposable IReferencable Derived ComponentBase ContentStorage EffectInstance EffectCompilerBase Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.KeepReference<T>(T) ComponentBaseExtensions.ReleaseBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveReleaseBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks A class inheriting from DisposeBase is an implementation of IDisposable where calls to Dispose() decrements an internal reference count (following also IReferencable). Only when that reference count reaches zero, the object should be disposed and the Destroy() method is invoked. That method can be overriden by derived classes to release dependent resources. Properties IsDisposed Gets a value indicating whether the object has been disposed. public bool IsDisposed { get; } Property Value bool Methods Destroy() Disposes the object's resources. protected virtual void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. Dispose() Decrements the reference count of this object, disposing, releasing, and freeing associated resources when the count reaches zero. public void Dispose() See Also Destroy() OnAddReference() Called when a new reference of this object has been counted (via a call to AddReference()). protected virtual void OnAddReference() OnReleaseReference() Called when a call to Release() has decremented the reference count of this object. protected virtual void OnReleaseReference()"
  },
  "api/Stride.Core.ExpandRule.html": {
    "href": "api/Stride.Core.ExpandRule.html",
    "title": "Enum ExpandRule | Stride API",
    "summary": "Enum ExpandRule Namespace Stride.Core Assembly Stride.Core.dll public enum ExpandRule Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Always = 3 The control representing the associated object will be expanded. Auto = 0 The control representing the associated object will use the default rule. Never = 2 The control representing the associated object will be collapsed. Once = 1 The control representing the associated object will be expanded only the first time it is displayed."
  },
  "api/Stride.Core.Extensions.ArrayExtensions.html": {
    "href": "api/Stride.Core.Extensions.ArrayExtensions.html",
    "title": "Class ArrayExtensions | Stride API",
    "summary": "Class ArrayExtensions Namespace Stride.Core.Extensions Assembly Stride.Core.dll Extensions for list and arrays. public static class ArrayExtensions Inheritance object ArrayExtensions Methods ArraysEqual<T>(IList<T>, IList<T>, IEqualityComparer<T>?) Deeply compares of two IList<T>. public static bool ArraysEqual<T>(IList<T> a1, IList<T> a2, IEqualityComparer<T>? comparer = null) Parameters a1 IList<T> The list1 to compare a2 IList<T> The list2 to compare comparer IEqualityComparer<T> The comparer to use (or default to the default EqualityComparer for T) Returns bool true if the list are equal Type Parameters T Type of the object to compare ArraysReferenceEqual<T>(FastListStruct<T>, FastListStruct<T>) Compares of two FastListStruct<T> using operator !=. public static bool ArraysReferenceEqual<T>(FastListStruct<T> a1, FastListStruct<T> a2) where T : class Parameters a1 FastListStruct<T> The list1 to compare a2 FastListStruct<T> The list2 to compare Returns bool true if the list are equal Type Parameters T Type of the object to compare ArraysReferenceEqual<T>(ref FastListStruct<T>, ref FastListStruct<T>) Compares of two FastListStruct<T> using operator !=. public static bool ArraysReferenceEqual<T>(ref FastListStruct<T> a1, ref FastListStruct<T> a2) where T : class Parameters a1 FastListStruct<T> The list1 to compare a2 FastListStruct<T> The list2 to compare Returns bool true if the list are equal Type Parameters T Type of the object to compare ArraysReferenceEqual<T>(IList<T>, IList<T>) Compares of two IList<T> using operator !=. public static bool ArraysReferenceEqual<T>(IList<T> a1, IList<T> a2) where T : class Parameters a1 IList<T> The list1 to compare a2 IList<T> The list2 to compare Returns bool true if the list are equal Type Parameters T Type of the object to compare ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) Computes the hash of a collection using hash of each elements. public static int ComputeHash<T>(this ICollection<T> data, IEqualityComparer<T>? comparer = null) Parameters data ICollection<T> The list to generates the hash comparer IEqualityComparer<T> The comparer to use (or use the default comparer otherwise) Returns int The hashcode of the collection. Type Parameters T Type of the object to calculate the hash ComputeHash<T>(T[], IEqualityComparer<T>?) Computes the hash of the array. public static int ComputeHash<T>(this T[] data, IEqualityComparer<T>? comparer = null) Parameters data T[] The array to generates the hash comparer IEqualityComparer<T> The comparer to use (or use the default comparer otherwise) Returns int The hashcode of the array. Type Parameters T Type of the object to calculate the hash Concat<T>(T[], T[]) Concats two arrays. public static T[] Concat<T>(this T[] array1, T[] array2) Parameters array1 T[] The array1 to concat array2 T[] The array2 to concat Returns T[] The concat of the array. Type Parameters T Type of the array element SubArray<T>(T[], int, int) Extracts a sub-array from an array. public static T[] SubArray<T>(this T[] data, int index, int length) Parameters data T[] The array to slice index int The start of the index to get the data from. length int The length of elements to slice Returns T[] A slice of the array. Type Parameters T Type of the array element"
  },
  "api/Stride.Core.Extensions.CollectionExtensions.html": {
    "href": "api/Stride.Core.Extensions.CollectionExtensions.html",
    "title": "Class CollectionExtensions | Stride API",
    "summary": "Class CollectionExtensions Namespace Stride.Core.Extensions Assembly Stride.Core.dll An extension class for various types of collection. public static class CollectionExtensions Inheritance object CollectionExtensions Methods GetItemOrNull<T>(IList<T>, int) Gets the item from a list at a specified index. If index is out of the list, returns null. public static T? GetItemOrNull<T>(this IList<T> list, int index) where T : class Parameters list IList<T> The list. index int The index. Returns T The item from a list at a specified index. If index is out of the list, returns null.. Type Parameters T Type of the item in the list IndexOf<T>(IReadOnlyList<T>, T) Determines the index of a specific item in the IReadOnlyList<T>. public static int IndexOf<T>(this IReadOnlyList<T> list, T item) Parameters list IReadOnlyList<T> The list. item T The object to locate in the IReadOnlyList<T>. Returns int The index of item if found in the list; otherwise, -1. Type Parameters T SwapRemoveAt<T>(IList<T>, int) Remove an item by swapping it with the last item and removing it from the last position. This function prevents to shift values from the list on removal but does not maintain order. public static void SwapRemoveAt<T>(this IList<T> list, int index) Parameters list IList<T> The list. index int Index of the item to remove. Type Parameters T SwapRemove<T>(IList<T>, T) Remove an item by swapping it with the last item and removing it from the last position. This function prevents to shift values from the list on removal but does not maintain order. public static void SwapRemove<T>(this IList<T> list, T item) Parameters list IList<T> The list. item T The item to remove. Type Parameters T"
  },
  "api/Stride.Core.Extensions.EnumerableExtensions.html": {
    "href": "api/Stride.Core.Extensions.EnumerableExtensions.html",
    "title": "Class EnumerableExtensions | Stride API",
    "summary": "Class EnumerableExtensions Namespace Stride.Core.Extensions Assembly Stride.Core.dll public static class EnumerableExtensions Inheritance object EnumerableExtensions Methods ForEach<T>(IEnumerable<T>, Action<T>) Executes an action for each item of the given enumerable. public static void ForEach<T>(this IEnumerable<T> source, Action<T> action) Parameters source IEnumerable<T> Input enumerable to work on. action Action<T> Action performed for each item in the enumerable. Type Parameters T Type of the item value in the enumerable. Remarks This extension method do not yield. It acts just like a foreach statement. ForEach<T>(IEnumerable, Action<T>) Executes an action for each (casted) item of the given enumerable. public static void ForEach<T>(this IEnumerable source, Action<T> action) Parameters source IEnumerable Input enumerable to work on. action Action<T> Action performed for each item in the enumerable. Type Parameters T Type of the item value in the enumerable. Remarks This extension method do not yield. It acts just like a foreach statement, and performs a cast to a typed enumerable in the middle. IndexOf<T>(IEnumerable<T>, Func<T, bool>) An IEnumerable<T> extension method that searches for the first match and returns its index. [Pure] public static int IndexOf<T>(this IEnumerable<T> source, Func<T, bool> predicate) Parameters source IEnumerable<T> Input enumerable to work on. predicate Func<T, bool> The predicate. Returns int The index of the first element matching. Type Parameters T Generic type parameter. IsNullOrEmpty(IEnumerable) Tells whether a sequence is null or empty. [Pure] public static bool IsNullOrEmpty(this IEnumerable source) Parameters source IEnumerable The source sequence. Returns bool Returns true if the sequence is null or empty, false if it is not null and contains at least one element. LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) An IEnumerable<T> extension method that searches for the last match and returns its index. [Pure] public static int LastIndexOf<T>(this IEnumerable<T> source, Func<T, bool> predicate) Parameters source IEnumerable<T> Input enumerable to work on. predicate Func<T, bool> The predicate. Returns int The index of the last element matching. Type Parameters T Generic type parameter. NotNull<T>(IEnumerable<T?>) Filters out null items from the enumerable. [Pure] public static IEnumerable<T> NotNull<T>(this IEnumerable<T?> source) where T : struct Parameters source IEnumerable<T?> Input enumerable to work on. Returns IEnumerable<T> An enumeration of all items in source that are not null. Type Parameters T Generic type parameter. NotNull<T>(IEnumerable<T?>) Filters out null items from the enumerable. [Pure] public static IEnumerable<T> NotNull<T>(this IEnumerable<T?> source) where T : class Parameters source IEnumerable<T> Input enumerable to work on. Returns IEnumerable<T> An enumeration of all items in source that are not null. Type Parameters T Generic type parameter. ToHashCode<T>(IEnumerable<T>) Calculates a combined hash code for items of the enumerbale. [Pure] public static int ToHashCode<T>(this IEnumerable<T> source) where T : class Parameters source IEnumerable<T> Input enumerable to work on. Returns int A combined hash code or 0 if the source is empty. Type Parameters T Generic type parameter."
  },
  "api/Stride.Core.Extensions.TimeSpanExtensions.html": {
    "href": "api/Stride.Core.Extensions.TimeSpanExtensions.html",
    "title": "Class TimeSpanExtensions | Stride API",
    "summary": "Class TimeSpanExtensions Namespace Stride.Core.Extensions Assembly Stride.Core.dll public static class TimeSpanExtensions Inheritance object TimeSpanExtensions Methods Clamp(TimeSpan, TimeSpan, TimeSpan) public static TimeSpan Clamp(TimeSpan value, TimeSpan min, TimeSpan max) Parameters value TimeSpan min TimeSpan max TimeSpan Returns TimeSpan FromMicroSeconds(long) public static TimeSpan FromMicroSeconds(long microSeconds) Parameters microSeconds long Returns TimeSpan FromTimeStamp(long) public static TimeSpan FromTimeStamp(long timestamp) Parameters timestamp long Returns TimeSpan FromTimeStamp(long, long) public static TimeSpan FromTimeStamp(long timestamp, long frequency) Parameters timestamp long frequency long Returns TimeSpan Max(TimeSpan, TimeSpan) public static TimeSpan Max(TimeSpan left, TimeSpan right) Parameters left TimeSpan right TimeSpan Returns TimeSpan Min(TimeSpan, TimeSpan) public static TimeSpan Min(TimeSpan left, TimeSpan right) Parameters left TimeSpan right TimeSpan Returns TimeSpan TotalMicroSeconds(TimeSpan) public static long TotalMicroSeconds(this TimeSpan timeSpan) Parameters timeSpan TimeSpan Returns long"
  },
  "api/Stride.Core.Extensions.html": {
    "href": "api/Stride.Core.Extensions.html",
    "title": "Namespace Stride.Core.Extensions | Stride API",
    "summary": "Namespace Stride.Core.Extensions Classes ArrayExtensions Extensions for list and arrays. CollectionExtensions An extension class for various types of collection. EnumerableExtensions TimeSpanExtensions"
  },
  "api/Stride.Core.ICollectorHolder.html": {
    "href": "api/Stride.Core.ICollectorHolder.html",
    "title": "Interface ICollectorHolder | Stride API",
    "summary": "Interface ICollectorHolder Namespace Stride.Core Assembly Stride.Core.dll Interface for objects that can collect other object instances that can be released / disposed in bulk. public interface ICollectorHolder Extension Methods UnsafeUtilities.As<T>(object?) Properties Collector Gets the collector of associated objects that can be released / disposed. ObjectCollector Collector { get; } Property Value ObjectCollector"
  },
  "api/Stride.Core.IComponent.html": {
    "href": "api/Stride.Core.IComponent.html",
    "title": "Interface IComponent | Stride API",
    "summary": "Interface IComponent Namespace Stride.Core Assembly Stride.Core.dll Base interface for all framework Components. public interface IComponent : IReferencable Inherited Members IReferencable.ReferenceCount IReferencable.AddReference() IReferencable.Release() Extension Methods ComponentBaseExtensions.KeepReference<T>(T) ComponentBaseExtensions.ReleaseBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveReleaseBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks A Component is an object that can have an optional Name, and that has reference-counting lifetime management. Properties Name Gets the name of the Component. string Name { get; } Property Value string See Also IReferencable"
  },
  "api/Stride.Core.IContentUrl.html": {
    "href": "api/Stride.Core.IContentUrl.html",
    "title": "Interface IContentUrl | Stride API",
    "summary": "Interface IContentUrl Namespace Stride.Core Assembly Stride.Core.dll Interface for serializable object having an url (so referenceable by other assets and saved into a single blob file) public interface IContentUrl Extension Methods UnsafeUtilities.As<T>(object?) Properties Url The URL of this asset. string Url { get; set; } Property Value string"
  },
  "api/Stride.Core.IIdentifiable.html": {
    "href": "api/Stride.Core.IIdentifiable.html",
    "title": "Interface IIdentifiable | Stride API",
    "summary": "Interface IIdentifiable Namespace Stride.Core Assembly Stride.Core.dll Base interface for all identifiable instances. public interface IIdentifiable Extension Methods UnsafeUtilities.As<T>(object?) Properties Id Gets the id of this instance Guid Id { get; set; } Property Value Guid"
  },
  "api/Stride.Core.IO.DatabaseFileProvider.html": {
    "href": "api/Stride.Core.IO.DatabaseFileProvider.html",
    "title": "Class DatabaseFileProvider | Stride API",
    "summary": "Class DatabaseFileProvider Namespace Stride.Core.IO Assembly Stride.Core.Serialization.dll public sealed class DatabaseFileProvider : VirtualFileProviderBase, IVirtualFileProvider, IDisposable Inheritance object VirtualFileProviderBase DatabaseFileProvider Implements IVirtualFileProvider IDisposable Inherited Members VirtualFileProviderBase.RootPath VirtualFileProviderBase.TryGetFileLocation(string, out string, out long, out long) VirtualFileProviderBase.DirectoryExists(string) VirtualFileProviderBase.FileDelete(string) VirtualFileProviderBase.FileMove(string, string) VirtualFileProviderBase.FileMove(string, IVirtualFileProvider, string) VirtualFileProviderBase.GetLastWriteTime(string) VirtualFileProviderBase.CreateDirectory(string) VirtualFileProviderBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DatabaseFileProvider(IContentIndexMap, ObjectDatabase, string?) public DatabaseFileProvider(IContentIndexMap contentIndexMap, ObjectDatabase objectDatabase, string? mountPoint = null) Parameters contentIndexMap IContentIndexMap objectDatabase ObjectDatabase mountPoint string DatabaseFileProvider(ObjectDatabase, string?) public DatabaseFileProvider(ObjectDatabase objectDatabase, string? mountPoint = null) Parameters objectDatabase ObjectDatabase mountPoint string Fields ObjectIdUrl URL prefix for ObjectId references. public static readonly string ObjectIdUrl Field Value string Properties ContentIndexMap public IContentIndexMap ContentIndexMap { get; } Property Value IContentIndexMap ObjectDatabase public ObjectDatabase ObjectDatabase { get; } Property Value ObjectDatabase Methods CreateRegexForFileSearch(string, string, VirtualSearchOption) public static Regex CreateRegexForFileSearch(string url, string searchPattern, VirtualSearchOption searchOption) Parameters url string searchPattern string searchOption VirtualSearchOption Returns Regex FileExists(string) Determines whether the specified path points to an existing file. public override bool FileExists(string url) Parameters url string The path. Returns bool FileSize(string) Returns the size of the specified file in bytes public override long FileSize(string url) Parameters url string The file or directory for which to obtain size Returns long A long value representing the file size in bytes GetAbsolutePath(string) Gets the absolute path for the specified local path from this provider. public override string GetAbsolutePath(string url) Parameters url string Returns string An absolute path. ListFiles(string, string, VirtualSearchOption) Returns the list of files from the specified path. public override string[] ListFiles(string url, string searchPattern, VirtualSearchOption searchOption) Parameters url string The url (without preceding slash). searchPattern string The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions. searchOption VirtualSearchOption One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory. Returns string[] A list of files from the specified path Remarks Example: to get all files within a directory ListFiles(\"path/to/folder\", \"*\", VirtualSearchOption.TopDirectoryOnly) OpenStream(string, VirtualFileMode, VirtualFileAccess, VirtualFileShare, StreamFlags) Opens a Stream from the specified path. public override Stream OpenStream(string url, VirtualFileMode mode, VirtualFileAccess access, VirtualFileShare share = VirtualFileShare.Read, StreamFlags streamFlags = StreamFlags.None) Parameters url string mode VirtualFileMode The mode. access VirtualFileAccess The access. share VirtualFileShare The process sharing mode. streamFlags StreamFlags The type of stream needed Returns Stream The opened stream. ResolveObjectId(string, out ObjectId) Resolves the given VFS URL into a ObjectId and its DatabaseFileProvider. public static DatabaseFileProvider? ResolveObjectId(string url, out ObjectId objectId) Parameters url string The URL to resolve. objectId ObjectId The object id. Returns DatabaseFileProvider The DatabaseFileProvider containing this object if it could be found; [null] otherwise."
  },
  "api/Stride.Core.IO.DatabaseFileProviderService.html": {
    "href": "api/Stride.Core.IO.DatabaseFileProviderService.html",
    "title": "Class DatabaseFileProviderService | Stride API",
    "summary": "Class DatabaseFileProviderService Namespace Stride.Core.IO Assembly Stride.Core.Serialization.dll public class DatabaseFileProviderService : IDatabaseFileProviderService Inheritance object DatabaseFileProviderService Implements IDatabaseFileProviderService Extension Methods UnsafeUtilities.As<T>(object?) Constructors DatabaseFileProviderService(DatabaseFileProvider) public DatabaseFileProviderService(DatabaseFileProvider fileProvider) Parameters fileProvider DatabaseFileProvider Properties FileProvider public DatabaseFileProvider FileProvider { get; set; } Property Value DatabaseFileProvider"
  },
  "api/Stride.Core.IO.DictionaryStore-2.UnsavedIdMapEntry.html": {
    "href": "api/Stride.Core.IO.DictionaryStore-2.UnsavedIdMapEntry.html",
    "title": "Struct DictionaryStore<TKey, TValue>.UnsavedIdMapEntry | Stride API",
    "summary": "Struct DictionaryStore<TKey, TValue>.UnsavedIdMapEntry Namespace Stride.Core.IO Assembly Stride.Core.Serialization.dll protected struct DictionaryStore<TKey, TValue>.UnsavedIdMapEntry Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Transaction public int Transaction Field Value int Value public TValue Value Field Value TValue"
  },
  "api/Stride.Core.IO.DictionaryStore-2.html": {
    "href": "api/Stride.Core.IO.DictionaryStore-2.html",
    "title": "Class DictionaryStore<TKey, TValue> | Stride API",
    "summary": "Class DictionaryStore<TKey, TValue> Namespace Stride.Core.IO Assembly Stride.Core.Serialization.dll A Key->Value store that will be incrementally saved on the HDD. Thread-safe and process-safe. public class DictionaryStore<TKey, TValue> : Store<KeyValuePair<TKey, TValue>>, IDisposable where TKey : notnull Type Parameters TKey The type of the key. TValue The type of the value. Inheritance object Store<KeyValuePair<TKey, TValue>> DictionaryStore<TKey, TValue> Implements IDisposable Derived ContentIndexMap Inherited Members Store<KeyValuePair<TKey, TValue>>.stream Store<KeyValuePair<TKey, TValue>>.transaction Store<KeyValuePair<TKey, TValue>>.lockObject Store<KeyValuePair<TKey, TValue>>.UseTransaction Store<KeyValuePair<TKey, TValue>>.AutoLoadNewValues Store<KeyValuePair<TKey, TValue>>.Dispose() Store<KeyValuePair<TKey, TValue>>.Dispose(bool) Store<KeyValuePair<TKey, TValue>>.AddValues(IEnumerable<KeyValuePair<TKey, TValue>>) Store<KeyValuePair<TKey, TValue>>.AddValue(KeyValuePair<TKey, TValue>) Store<KeyValuePair<TKey, TValue>>.Save() Store<KeyValuePair<TKey, TValue>>.Reset() Store<KeyValuePair<TKey, TValue>>.ResetInternal() Store<KeyValuePair<TKey, TValue>>.LoadNewValues() Store<KeyValuePair<TKey, TValue>>.AddUnsaved(KeyValuePair<TKey, TValue>, int) Store<KeyValuePair<TKey, TValue>>.RemoveUnsaved(KeyValuePair<TKey, TValue>, int) Store<KeyValuePair<TKey, TValue>>.RemoveUnsaved(IEnumerable<KeyValuePair<TKey, TValue>>, int) Store<KeyValuePair<TKey, TValue>>.AddLoaded(KeyValuePair<TKey, TValue>) Store<KeyValuePair<TKey, TValue>>.GetPendingItems(int) Store<KeyValuePair<TKey, TValue>>.BuildContext(Stream) Store<KeyValuePair<TKey, TValue>>.ReadEntries(Stream) Store<KeyValuePair<TKey, TValue>>.WriteEntry(Stream, KeyValuePair<TKey, TValue>) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DictionaryStore(Stream) public DictionaryStore(Stream stream) Parameters stream Stream Fields loadedIdMap protected readonly Dictionary<TKey, TValue> loadedIdMap Field Value Dictionary<TKey, TValue> unsavedIdMap protected readonly Dictionary<TKey, DictionaryStore<TKey, TValue>.UnsavedIdMapEntry> unsavedIdMap Field Value Dictionary<TKey, DictionaryStore<TKey, TValue>.UnsavedIdMapEntry> Properties this[TKey] Gets or sets the item with the specified key. public TValue this[TKey key] { get; set; } Parameters key TKey The key of the item to get or set. Property Value TValue The item to get or set. Exceptions KeyNotFoundException Methods AddLoaded(KeyValuePair<TKey, TValue>) Adds a value that has already been saved in the store (saved state). protected override void AddLoaded(KeyValuePair<TKey, TValue> item) Parameters item KeyValuePair<TKey, TValue> The item. AddUnsaved(KeyValuePair<TKey, TValue>, int) Adds a value that has not yet been saved in the store (pending state). protected override void AddUnsaved(KeyValuePair<TKey, TValue> item, int currentTransaction) Parameters item KeyValuePair<TKey, TValue> The item. currentTransaction int Contains(TKey) Gets or sets the item with the specified key. public bool Contains(TKey key) Parameters key TKey The key of the item to get or set. Returns bool The item to get or set. Exceptions KeyNotFoundException GetPendingItems(int) Gets the list of pending items for a given transaction index. protected override IEnumerable<KeyValuePair<TKey, TValue>> GetPendingItems(int currentTransaction) Parameters currentTransaction int Returns IEnumerable<KeyValuePair<TKey, TValue>> GetValues() Gets the values stored including unsaved. public KeyValuePair<TKey, TValue>[] GetValues() Returns KeyValuePair<TKey, TValue>[] Values stored including unsaved. RemoveUnsaved(KeyValuePair<TKey, TValue>, int) Removes a value that has not yet been saved (pending state). protected override void RemoveUnsaved(KeyValuePair<TKey, TValue> item, int currentTransaction) Parameters item KeyValuePair<TKey, TValue> The item. currentTransaction int ResetInternal() Resets the store to an empty state, to be implemented by subclasses if necessary. protected override void ResetInternal() SearchValues(Func<KeyValuePair<TKey, TValue>, bool>) public IEnumerable<KeyValuePair<TKey, TValue>> SearchValues(Func<KeyValuePair<TKey, TValue>, bool> predicate) Parameters predicate Func<KeyValuePair<TKey, TValue>, bool> Returns IEnumerable<KeyValuePair<TKey, TValue>> TryGetValue(TKey, out TValue) Tries to get the value from its key. public bool TryGetValue(TKey key, out TValue value) Parameters key TKey The key. value TValue The value. Returns bool"
  },
  "api/Stride.Core.IO.DirectoryWatcher.html": {
    "href": "api/Stride.Core.IO.DirectoryWatcher.html",
    "title": "Class DirectoryWatcher | Stride API",
    "summary": "Class DirectoryWatcher Namespace Stride.Core.IO Assembly Stride.Core.IO.dll Track file system events from several directories. public class DirectoryWatcher : IDisposable Inheritance object DirectoryWatcher Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DirectoryWatcher(string?) Initializes a new instance of the DirectoryWatcher class. public DirectoryWatcher(string? fileFilter = null) Parameters fileFilter string The file filter By default null default to . Properties FileFilter Gets the file filter used by this instance. public string FileFilter { get; } Property Value string The file filter. Methods CreateFileSystemWatcher(string) protected FileSystemWatcher CreateFileSystemWatcher(string directory) Parameters directory string Returns FileSystemWatcher Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool GetTrackedDirectories() Gets a list of current directories being tracked. public List<string> GetTrackedDirectories() Returns List<string> A list of current directories being tracked OnModified(object, FileEvent) Called when a file event occurred. protected virtual void OnModified(object sender, FileEvent e) Parameters sender object The sender. e FileEvent The file event. Track(string) Tracks the specified path. public void Track(string path) Parameters path string The path. Remarks If path is a file, this will used the parent directory. If the path is invalid, it will not fail but just skip it. UnTrack(string) UnTracks the specified path. public void UnTrack(string path) Parameters path string Remarks If path is a file, this will used the parent directory. If the path is invalid, it will not fail but just skip it. Events Modified Occurs when a file/directory change occurred. public event EventHandler<FileEvent>? Modified Event Type EventHandler<FileEvent>"
  },
  "api/Stride.Core.IO.DriveFileProvider.html": {
    "href": "api/Stride.Core.IO.DriveFileProvider.html",
    "title": "Class DriveFileProvider | Stride API",
    "summary": "Class DriveFileProvider Namespace Stride.Core.IO Assembly Stride.Core.IO.dll Exposes the whole file system through folder similar to Cygwin. As an example, \"/c/Program Files/Test/Data.dat\" would work. public class DriveFileProvider : FileSystemProvider, IVirtualFileProvider, IDisposable Inheritance object VirtualFileProviderBase FileSystemProvider DriveFileProvider Implements IVirtualFileProvider IDisposable Inherited Members FileSystemProvider.VolumeSeparatorChar FileSystemProvider.DirectorySeparatorChar FileSystemProvider.AltDirectorySeparatorChar FileSystemProvider.ChangeBasePath(string) FileSystemProvider.DirectoryExists(string) FileSystemProvider.CreateDirectory(string) FileSystemProvider.FileExists(string) FileSystemProvider.FileSize(string) FileSystemProvider.FileDelete(string) FileSystemProvider.FileMove(string, string) FileSystemProvider.FileMove(string, IVirtualFileProvider, string) FileSystemProvider.GetAbsolutePath(string) FileSystemProvider.TryGetFileLocation(string, out string, out long, out long) FileSystemProvider.ListFiles(string, string, VirtualSearchOption) FileSystemProvider.OpenStream(string, VirtualFileMode, VirtualFileAccess, VirtualFileShare, StreamFlags) FileSystemProvider.GetLastWriteTime(string) VirtualFileProviderBase.RootPath VirtualFileProviderBase.ResolvePath(string) VirtualFileProviderBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DriveFileProvider(string) public DriveFileProvider(string rootPath) Parameters rootPath string Fields DefaultRootPath public static string DefaultRootPath Field Value string Methods ConvertFullPathToUrl(string) protected override string ConvertFullPathToUrl(string path) Parameters path string Returns string ConvertUrlToFullPath(string) protected override string ConvertUrlToFullPath(string url) Parameters url string Returns string GetLocalPath(string) Resolves the VFS URL from a given file path. public string GetLocalPath(string filePath) Parameters filePath string The file path. Returns string Exceptions InvalidOperationException"
  },
  "api/Stride.Core.IO.FileEvent.html": {
    "href": "api/Stride.Core.IO.FileEvent.html",
    "title": "Class FileEvent | Stride API",
    "summary": "Class FileEvent Namespace Stride.Core.IO Assembly Stride.Core.IO.dll � file event used notified by DirectoryWatcher public class FileEvent : EventArgs Inheritance object EventArgs FileEvent Derived FileRenameEvent Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors FileEvent(FileEventChangeType, string, string) Initializes a new instance of the FileEvent class. public FileEvent(FileEventChangeType changeType, string name, string fullPath) Parameters changeType FileEventChangeType Type of the change. name string The name. fullPath string The full path. Properties ChangeType Gets the type of the change. public FileEventChangeType ChangeType { get; } Property Value FileEventChangeType The type of the change. FullPath Gets the full path. public string FullPath { get; } Property Value string The full path. Name Gets the name. public string Name { get; } Property Value string The name."
  },
  "api/Stride.Core.IO.FileEventChangeType.html": {
    "href": "api/Stride.Core.IO.FileEventChangeType.html",
    "title": "Enum FileEventChangeType | Stride API",
    "summary": "Enum FileEventChangeType Namespace Stride.Core.IO Assembly Stride.Core.IO.dll Change type of file used by FileEvent and DirectoryWatcher. [Flags] public enum FileEventChangeType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields All = Created | Deleted | Changed | Renamed Changed = 4 Created = 1 Deleted = 2 Renamed = 8"
  },
  "api/Stride.Core.IO.FileRenameEvent.html": {
    "href": "api/Stride.Core.IO.FileRenameEvent.html",
    "title": "Class FileRenameEvent | Stride API",
    "summary": "Class FileRenameEvent Namespace Stride.Core.IO Assembly Stride.Core.IO.dll � file rename event used notified by DirectoryWatcher public class FileRenameEvent : FileEvent Inheritance object EventArgs FileEvent FileRenameEvent Inherited Members FileEvent.ChangeType FileEvent.Name FileEvent.FullPath EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors FileRenameEvent(string, string, string) Initializes a new instance of the FileRenameEvent class. public FileRenameEvent(string name, string fullPath, string oldFullPath) Parameters name string The name. fullPath string The full path. oldFullPath string The old full path. (before rename) Properties OldFullPath Gets the full path. (in case of rename) public string OldFullPath { get; } Property Value string The full path. (in case of rename) Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.IO.FileSystemProvider.html": {
    "href": "api/Stride.Core.IO.FileSystemProvider.html",
    "title": "Class FileSystemProvider | Stride API",
    "summary": "Class FileSystemProvider Namespace Stride.Core.IO Assembly Stride.Core.IO.dll A file system implementation for IVirtualFileProvider. public class FileSystemProvider : VirtualFileProviderBase, IVirtualFileProvider, IDisposable Inheritance object VirtualFileProviderBase FileSystemProvider Implements IVirtualFileProvider IDisposable Derived DriveFileProvider Inherited Members VirtualFileProviderBase.RootPath VirtualFileProviderBase.ResolvePath(string) VirtualFileProviderBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors FileSystemProvider(string, string?) Initializes a new instance of the FileSystemProvider class with the given base path. public FileSystemProvider(string rootPath, string? localBasePath) Parameters rootPath string The root path of this provider. localBasePath string The path to a local directory where this instance will load the files from. Fields AltDirectorySeparatorChar public static readonly char AltDirectorySeparatorChar Field Value char DirectorySeparatorChar public static readonly char DirectorySeparatorChar Field Value char VolumeSeparatorChar public static readonly char VolumeSeparatorChar Field Value char Methods ChangeBasePath(string?) public void ChangeBasePath(string? basePath) Parameters basePath string ConvertFullPathToUrl(string) protected virtual string ConvertFullPathToUrl(string path) Parameters path string Returns string ConvertUrlToFullPath(string) protected virtual string ConvertUrlToFullPath(string url) Parameters url string Returns string CreateDirectory(string) Creates all directories so that url exists. public override void CreateDirectory(string url) Parameters url string The URL. DirectoryExists(string) Determines whether the specified path points to an existing directory. public override bool DirectoryExists(string url) Parameters url string The path. Returns bool FileDelete(string) Deletes the specified file. public override void FileDelete(string url) Parameters url string The URL. FileExists(string) Determines whether the specified path points to an existing file. public override bool FileExists(string url) Parameters url string The path. Returns bool FileMove(string, IVirtualFileProvider, string) Move the specified file specified from its sourceUrl to the location pointed by destinationUrl in the destination provider. Do not overwrite, throw IOException if the file can't be moved. public override void FileMove(string sourceUrl, IVirtualFileProvider destinationProvider, string destinationUrl) Parameters sourceUrl string The source URL. destinationProvider IVirtualFileProvider The destination provider. destinationUrl string The destination URL, relative to the destination provider. FileMove(string, string) Move the specified file specified from its sourceUrl to the location pointed by destinationUrl. Do not overwrite, throw IOException if the file can't be moved. public override void FileMove(string sourceUrl, string destinationUrl) Parameters sourceUrl string The source URL of the file destinationUrl string The destination URL of the file FileSize(string) Returns the size of the specified file in bytes public override long FileSize(string url) Parameters url string The file or directory for which to obtain size Returns long A long value representing the file size in bytes GetAbsolutePath(string) Gets the absolute path for the specified local path from this provider. public override string GetAbsolutePath(string path) Parameters path string The path local to this instance. Returns string An absolute path. GetLastWriteTime(string) Returns the date and time the specified file or directory was last written to. public override DateTime GetLastWriteTime(string url) Parameters url string The file or directory for which to obtain write date and time information. Returns DateTime A DateTime structure set to the date and time that the specified file or directory was last written to. ListFiles(string, string, VirtualSearchOption) Returns the list of files from the specified path. public override string[] ListFiles(string url, string searchPattern, VirtualSearchOption searchOption) Parameters url string searchPattern string The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions. searchOption VirtualSearchOption One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory. Returns string[] A list of files from the specified path OpenStream(string, VirtualFileMode, VirtualFileAccess, VirtualFileShare, StreamFlags) Opens a Stream from the specified path. public override Stream OpenStream(string url, VirtualFileMode mode, VirtualFileAccess access, VirtualFileShare share = VirtualFileShare.Read, StreamFlags streamType = StreamFlags.None) Parameters url string mode VirtualFileMode The mode. access VirtualFileAccess The access. share VirtualFileShare The process sharing mode. streamType StreamFlags Returns Stream The opened stream. TryGetFileLocation(string, out string, out long, out long) Gets the absolute path and location if the specified path physically exist on the disk in an uncompressed form (could be inside another file). public override bool TryGetFileLocation(string path, out string filePath, out long start, out long end) Parameters path string The path. filePath string The file containing the data. start long The start offset in the file. end long The end offset in the file (can be -1 if full file). Returns bool True if success, false if not supported and entry is found (note: even when true, the file might not actually exists)."
  },
  "api/Stride.Core.IO.IDatabaseFileProviderService.html": {
    "href": "api/Stride.Core.IO.IDatabaseFileProviderService.html",
    "title": "Interface IDatabaseFileProviderService | Stride API",
    "summary": "Interface IDatabaseFileProviderService Namespace Stride.Core.IO Assembly Stride.Core.Serialization.dll public interface IDatabaseFileProviderService Extension Methods UnsafeUtilities.As<T>(object?) Properties FileProvider DatabaseFileProvider FileProvider { get; } Property Value DatabaseFileProvider"
  },
  "api/Stride.Core.IO.IDatabaseStream.html": {
    "href": "api/Stride.Core.IO.IDatabaseStream.html",
    "title": "Interface IDatabaseStream | Stride API",
    "summary": "Interface IDatabaseStream Namespace Stride.Core.IO Assembly Stride.Core.Serialization.dll public interface IDatabaseStream Extension Methods UnsafeUtilities.As<T>(object?) Properties ObjectId ObjectId ObjectId { get; } Property Value ObjectId"
  },
  "api/Stride.Core.IO.IVirtualFileProvider.html": {
    "href": "api/Stride.Core.IO.IVirtualFileProvider.html",
    "title": "Interface IVirtualFileProvider | Stride API",
    "summary": "Interface IVirtualFileProvider Namespace Stride.Core.IO Assembly Stride.Core.IO.dll A virtual file provider, that can returns a Stream for a given path. public interface IVirtualFileProvider : IDisposable Inherited Members IDisposable.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties RootPath Gets or sets the root path of this provider. See remarks. string? RootPath { get; } Property Value string The root path. Remarks All path are relative to the root path. Methods CreateDirectory(string) Creates all directories so that url exists. void CreateDirectory(string url) Parameters url string The URL. DirectoryExists(string) Determines whether the specified path points to an existing directory. bool DirectoryExists(string url) Parameters url string The path. Returns bool FileDelete(string) Deletes the specified file. void FileDelete(string url) Parameters url string The URL. FileExists(string) Determines whether the specified path points to an existing file. bool FileExists(string url) Parameters url string The path. Returns bool FileMove(string, IVirtualFileProvider, string) Move the specified file specified from its sourceUrl to the location pointed by destinationUrl in the destination provider. Do not overwrite, throw IOException if the file can't be moved. void FileMove(string sourceUrl, IVirtualFileProvider destinationProvider, string destinationUrl) Parameters sourceUrl string The source URL. destinationProvider IVirtualFileProvider The destination provider. destinationUrl string The destination URL, relative to the destination provider. FileMove(string, string) Move the specified file specified from its sourceUrl to the location pointed by destinationUrl. Do not overwrite, throw IOException if the file can't be moved. void FileMove(string sourceUrl, string destinationUrl) Parameters sourceUrl string The source URL of the file destinationUrl string The destination URL of the file FileSize(string) Returns the size of the specified file in bytes long FileSize(string url) Parameters url string The file or directory for which to obtain size Returns long A long value representing the file size in bytes GetAbsolutePath(string) Gets the absolute path for the specified local path from this provider. string GetAbsolutePath(string path) Parameters path string The path local to this instance. Returns string An absolute path. GetLastWriteTime(string) Returns the date and time the specified file or directory was last written to. DateTime GetLastWriteTime(string url) Parameters url string The file or directory for which to obtain write date and time information. Returns DateTime A DateTime structure set to the date and time that the specified file or directory was last written to. ListFiles(string, string, VirtualSearchOption) Returns the list of files from the specified path. string[] ListFiles(string path, string searchPattern, VirtualSearchOption searchOption) Parameters path string The path. searchPattern string The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions. searchOption VirtualSearchOption One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory. Returns string[] A list of files from the specified path OpenStream(string, VirtualFileMode, VirtualFileAccess, VirtualFileShare, StreamFlags) Opens a Stream from the specified path. Stream OpenStream(string path, VirtualFileMode mode, VirtualFileAccess access, VirtualFileShare share = VirtualFileShare.Read, StreamFlags streamFlags = StreamFlags.None) Parameters path string The path. mode VirtualFileMode The mode. access VirtualFileAccess The access. share VirtualFileShare The process sharing mode. streamFlags StreamFlags The type of stream needed Returns Stream The opened stream. TryGetFileLocation(string, out string, out long, out long) Gets the absolute path and location if the specified path physically exist on the disk in an uncompressed form (could be inside another file). bool TryGetFileLocation(string path, out string filePath, out long start, out long end) Parameters path string The path. filePath string The file containing the data. start long The start offset in the file. end long The end offset in the file (can be -1 if full file). Returns bool True if success, false if not supported and entry is found (note: even when true, the file might not actually exists)."
  },
  "api/Stride.Core.IO.ListStore-1.UnsavedEntry.html": {
    "href": "api/Stride.Core.IO.ListStore-1.UnsavedEntry.html",
    "title": "Class ListStore<T>.UnsavedEntry | Stride API",
    "summary": "Class ListStore<T>.UnsavedEntry Namespace Stride.Core.IO Assembly Stride.Core.Serialization.dll protected class ListStore<T>.UnsavedEntry Inheritance object ListStore<T>.UnsavedEntry Extension Methods UnsafeUtilities.As<T>(object?) Properties Transaction public int Transaction { get; set; } Property Value int Value public T Value { get; set; } Property Value T"
  },
  "api/Stride.Core.IO.ListStore-1.html": {
    "href": "api/Stride.Core.IO.ListStore-1.html",
    "title": "Class ListStore<T> | Stride API",
    "summary": "Class ListStore<T> Namespace Stride.Core.IO Assembly Stride.Core.Serialization.dll A value store that will be incrementally saved on HDD. Thread-safe and process-safe. public class ListStore<T> : Store<T>, IDisposable where T : new() Type Parameters T The type of elements in the store. Inheritance object Store<T> ListStore<T> Implements IDisposable Inherited Members Store<T>.stream Store<T>.transaction Store<T>.lockObject Store<T>.UseTransaction Store<T>.AutoLoadNewValues Store<T>.Dispose() Store<T>.Dispose(bool) Store<T>.AddValues(IEnumerable<T>) Store<T>.AddValue(T) Store<T>.Save() Store<T>.Reset() Store<T>.ResetInternal() Store<T>.LoadNewValues() Store<T>.BuildContext(Stream) Store<T>.ReadEntries(Stream) Store<T>.WriteEntry(Stream, T) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ListStore(Stream) public ListStore(Stream stream) Parameters stream Stream Fields loadedIdMap protected readonly List<T> loadedIdMap Field Value List<T> unsavedIdMap protected readonly LinkedList<ListStore<T>.UnsavedEntry> unsavedIdMap Field Value LinkedList<ListStore<T>.UnsavedEntry> Methods AddLoaded(T) Adds a value that has already been saved in the store (saved state). protected override void AddLoaded(T item) Parameters item T The item. AddUnsaved(T, int) Adds a value that has not yet been saved in the store (pending state). protected override void AddUnsaved(T item, int currentTransaction) Parameters item T The item. currentTransaction int GetPendingItems(int) Gets the list of pending items for a given transaction index. protected override IEnumerable<T> GetPendingItems(int currentTransaction) Parameters currentTransaction int Returns IEnumerable<T> GetValues() public T[] GetValues() Returns T[] RemoveUnsaved(IEnumerable<T>, int) Removes values that have not yet been saved (pending state). protected override void RemoveUnsaved(IEnumerable<T> items, int currentTransaction) Parameters items IEnumerable<T> The items. currentTransaction int RemoveUnsaved(T, int) Removes a value that has not yet been saved (pending state). protected override void RemoveUnsaved(T item, int currentTransaction) Parameters item T The item. currentTransaction int"
  },
  "api/Stride.Core.IO.NativeLockFile.html": {
    "href": "api/Stride.Core.IO.NativeLockFile.html",
    "title": "Class NativeLockFile | Stride API",
    "summary": "Class NativeLockFile Namespace Stride.Core.IO Assembly Stride.Core.IO.dll public static class NativeLockFile Inheritance object NativeLockFile Methods TryLockFile(FileStream, long, long, bool, bool) public static bool TryLockFile(FileStream fileStream, long offset, long count, bool exclusive, bool failImmediately = false) Parameters fileStream FileStream offset long count long exclusive bool failImmediately bool Returns bool TryUnlockFile(FileStream, long, long) public static void TryUnlockFile(FileStream fileStream, long offset, long count) Parameters fileStream FileStream offset long count long"
  },
  "api/Stride.Core.IO.Store-1.html": {
    "href": "api/Stride.Core.IO.Store-1.html",
    "title": "Class Store<T> | Stride API",
    "summary": "Class Store<T> Namespace Stride.Core.IO Assembly Stride.Core.Serialization.dll A store that will be incrementally saved on the HDD. Thread-safe and process-safe. public abstract class Store<T> : IDisposable where T : new() Type Parameters T The type of elements in the store. Inheritance object Store<T> Implements IDisposable Derived DictionaryStore<TKey, TValue> ListStore<T> Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors Store(Stream) protected Store(Stream stream) Parameters stream Stream Fields lockObject protected readonly object lockObject Field Value object stream protected Stream stream Field Value Stream transaction protected int transaction Field Value int Properties AutoLoadNewValues Gets or sets a flag specifying if a Save should also load new values that happened in between. public bool AutoLoadNewValues { get; set; } Property Value bool UseTransaction Gets or sets a flag specifying if the index map changes should be kept aside instead of being committed immediately. public bool UseTransaction { get; set; } Property Value bool Methods AddLoaded(T) Adds a value that has already been saved in the store (saved state). protected abstract void AddLoaded(T item) Parameters item T The item. AddUnsaved(T, int) Adds a value that has not yet been saved in the store (pending state). protected abstract void AddUnsaved(T item, int transaction) Parameters item T The item. transaction int The transaction index. AddValue(T) Adds a value to the store. public void AddValue(T item) Parameters item T The item. AddValues(IEnumerable<T>) Adds multiple values to the store public void AddValues(IEnumerable<T> values) Parameters values IEnumerable<T> The values. BuildContext(Stream) protected virtual object BuildContext(Stream stream) Parameters stream Stream Returns object Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Waits for pending operation to finish, if any. Note that it does not write pending transaction if Save() has not been called before. public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool GetPendingItems(int) Gets the list of pending items for a given transaction index. protected abstract IEnumerable<T> GetPendingItems(int transaction) Parameters transaction int The transaction index. Returns IEnumerable<T> LoadNewValues() Refreshes URL to ObjectId mapping from the latest results in the index file. public bool LoadNewValues() Returns bool True on success. ReadEntries(Stream) protected virtual List<T> ReadEntries(Stream localStream) Parameters localStream Stream Returns List<T> RemoveUnsaved(IEnumerable<T>, int) Removes values that have not yet been saved (pending state). protected virtual void RemoveUnsaved(IEnumerable<T> items, int transaction) Parameters items IEnumerable<T> The items. transaction int The transaction index. RemoveUnsaved(T, int) Removes a value that has not yet been saved (pending state). protected abstract void RemoveUnsaved(T item, int transaction) Parameters item T The item. transaction int The transaction index. Reset() Resets the store to an empty state. public void Reset() ResetInternal() Resets the store to an empty state, to be implemented by subclasses if necessary. protected virtual void ResetInternal() Save() Saves the newly added mapping (only necessary when UseTransaction is set to true). public void Save() WriteEntry(Stream, T) protected virtual void WriteEntry(Stream localStream, T value) Parameters localStream Stream value T"
  },
  "api/Stride.Core.IO.StreamFlags.html": {
    "href": "api/Stride.Core.IO.StreamFlags.html",
    "title": "Enum StreamFlags | Stride API",
    "summary": "Enum StreamFlags Namespace Stride.Core.IO Assembly Stride.Core.IO.dll Describes the different type of streams. [Flags] public enum StreamFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields None = 0 Returns the default underlying stream without any alterations. Can be a seek-able stream or not depending on the file. Seekable = 1 A stream in which we can seek"
  },
  "api/Stride.Core.IO.TemporaryDirectory.html": {
    "href": "api/Stride.Core.IO.TemporaryDirectory.html",
    "title": "Class TemporaryDirectory | Stride API",
    "summary": "Class TemporaryDirectory Namespace Stride.Core.IO Assembly Stride.Core.IO.dll public class TemporaryDirectory : IDisposable Inheritance object TemporaryDirectory Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors TemporaryDirectory() public TemporaryDirectory() TemporaryDirectory(string) public TemporaryDirectory(string path) Parameters path string Properties DirectoryPath public string DirectoryPath { get; } Property Value string Methods DeleteDirectory(string) public static void DeleteDirectory(string directoryPath) Parameters directoryPath string Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose()"
  },
  "api/Stride.Core.IO.TemporaryFile.html": {
    "href": "api/Stride.Core.IO.TemporaryFile.html",
    "title": "Class TemporaryFile | Stride API",
    "summary": "Class TemporaryFile Namespace Stride.Core.IO Assembly Stride.Core.IO.dll public class TemporaryFile : IDisposable Inheritance object TemporaryFile Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors TemporaryFile() public TemporaryFile() Properties Path public string Path { get; } Property Value string Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool ~TemporaryFile() protected ~TemporaryFile()"
  },
  "api/Stride.Core.IO.VirtualFileAccess.html": {
    "href": "api/Stride.Core.IO.VirtualFileAccess.html",
    "title": "Enum VirtualFileAccess | Stride API",
    "summary": "Enum VirtualFileAccess Namespace Stride.Core.IO Assembly Stride.Core.IO.dll File access equivalent of FileAccess. [Flags] public enum VirtualFileAccess : uint Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Read = 1 Read access. ReadWrite = Read | Write Read/Write Access, Write = 2 Write access."
  },
  "api/Stride.Core.IO.VirtualFileMode.html": {
    "href": "api/Stride.Core.IO.VirtualFileMode.html",
    "title": "Enum VirtualFileMode | Stride API",
    "summary": "Enum VirtualFileMode Namespace Stride.Core.IO Assembly Stride.Core.IO.dll File mode equivalent of FileMode. public enum VirtualFileMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Append = 6 Opens a file if it exists and go at the end, otherwise creates a new file. Create = 2 Creates a new file, always. If a file exists, the function overwrites the file, clears the existing attributes, combines the specified file attributes, and flags with FILE_ATTRIBUTE_ARCHIVE, but does not set the security descriptor that the SECURITY_ATTRIBUTES structure specifies. CreateNew = 1 Creates a new file. The function fails if a specified file exists. Open = 3 Opens a file. The function fails if the file does not exist. OpenOrCreate = 4 Opens a file, always. If a file does not exist, the function creates a file as if dwCreationDisposition is CREATE_NEW. Truncate = 5 Opens a file and truncates it so that its size is 0 (zero) bytes. The function fails if the file does not exist. The calling process must open the file with the GENERIC_WRITE access right."
  },
  "api/Stride.Core.IO.VirtualFileProviderBase.html": {
    "href": "api/Stride.Core.IO.VirtualFileProviderBase.html",
    "title": "Class VirtualFileProviderBase | Stride API",
    "summary": "Class VirtualFileProviderBase Namespace Stride.Core.IO Assembly Stride.Core.IO.dll Abstract base class for IVirtualFileProvider. public abstract class VirtualFileProviderBase : IVirtualFileProvider, IDisposable Inheritance object VirtualFileProviderBase Implements IVirtualFileProvider IDisposable Derived DatabaseFileProvider FileSystemProvider NetworkVirtualFileProvider Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors VirtualFileProviderBase(string?) protected VirtualFileProviderBase(string? rootPath) Parameters rootPath string Properties RootPath Gets or sets the root path of this provider. See remarks. public string? RootPath { get; } Property Value string The root path. Remarks All path are relative to the root path. Methods CreateDirectory(string) Creates all directories so that url exists. public virtual void CreateDirectory(string url) Parameters url string The URL. DirectoryExists(string) Determines whether the specified path points to an existing directory. public virtual bool DirectoryExists(string url) Parameters url string The path. Returns bool Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() FileDelete(string) Deletes the specified file. public virtual void FileDelete(string url) Parameters url string The URL. FileExists(string) Determines whether the specified path points to an existing file. public virtual bool FileExists(string url) Parameters url string The path. Returns bool FileMove(string, IVirtualFileProvider, string) Move the specified file specified from its sourceUrl to the location pointed by destinationUrl in the destination provider. Do not overwrite, throw IOException if the file can't be moved. public virtual void FileMove(string sourceUrl, IVirtualFileProvider destinationProvider, string destinationUrl) Parameters sourceUrl string The source URL. destinationProvider IVirtualFileProvider The destination provider. destinationUrl string The destination URL, relative to the destination provider. FileMove(string, string) Move the specified file specified from its sourceUrl to the location pointed by destinationUrl. Do not overwrite, throw IOException if the file can't be moved. public virtual void FileMove(string sourceUrl, string destinationUrl) Parameters sourceUrl string The source URL of the file destinationUrl string The destination URL of the file FileSize(string) Returns the size of the specified file in bytes public virtual long FileSize(string url) Parameters url string The file or directory for which to obtain size Returns long A long value representing the file size in bytes GetAbsolutePath(string) Gets the absolute path for the specified local path from this provider. public virtual string GetAbsolutePath(string path) Parameters path string The path local to this instance. Returns string An absolute path. GetLastWriteTime(string) Returns the date and time the specified file or directory was last written to. public virtual DateTime GetLastWriteTime(string url) Parameters url string The file or directory for which to obtain write date and time information. Returns DateTime A DateTime structure set to the date and time that the specified file or directory was last written to. ListFiles(string, string, VirtualSearchOption) Returns the list of files from the specified path. public virtual string[] ListFiles(string url, string searchPattern, VirtualSearchOption searchOption) Parameters url string searchPattern string The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions. searchOption VirtualSearchOption One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory. Returns string[] A list of files from the specified path OpenStream(string, VirtualFileMode, VirtualFileAccess, VirtualFileShare, StreamFlags) Opens a Stream from the specified path. public abstract Stream OpenStream(string url, VirtualFileMode mode, VirtualFileAccess access, VirtualFileShare share = VirtualFileShare.Read, StreamFlags streamFlags = StreamFlags.None) Parameters url string mode VirtualFileMode The mode. access VirtualFileAccess The access. share VirtualFileShare The process sharing mode. streamFlags StreamFlags The type of stream needed Returns Stream The opened stream. ResolvePath(string) Resolves the path (can map virtual to absolute path). protected virtual string ResolvePath(string path) Parameters path string The path. Returns string The resolved path. TryGetFileLocation(string, out string, out long, out long) Gets the absolute path and location if the specified path physically exist on the disk in an uncompressed form (could be inside another file). public virtual bool TryGetFileLocation(string path, out string filePath, out long start, out long end) Parameters path string The path. filePath string The file containing the data. start long The start offset in the file. end long The end offset in the file (can be -1 if full file). Returns bool True if success, false if not supported and entry is found (note: even when true, the file might not actually exists)."
  },
  "api/Stride.Core.IO.VirtualFileShare.html": {
    "href": "api/Stride.Core.IO.VirtualFileShare.html",
    "title": "Enum VirtualFileShare | Stride API",
    "summary": "Enum VirtualFileShare Namespace Stride.Core.IO Assembly Stride.Core.IO.dll File share capabilities, equivalent of FileShare. [Flags] public enum VirtualFileShare : uint Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Delete = 4 None = 0 Read = 1 ReadWrite = Read | Write Write = 2"
  },
  "api/Stride.Core.IO.VirtualFileSystem.ResolveProviderResult.html": {
    "href": "api/Stride.Core.IO.VirtualFileSystem.ResolveProviderResult.html",
    "title": "Struct VirtualFileSystem.ResolveProviderResult | Stride API",
    "summary": "Struct VirtualFileSystem.ResolveProviderResult Namespace Stride.Core.IO Assembly Stride.Core.IO.dll public struct VirtualFileSystem.ResolveProviderResult Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Path public string Path Field Value string Provider public IVirtualFileProvider Provider Field Value IVirtualFileProvider"
  },
  "api/Stride.Core.IO.VirtualFileSystem.html": {
    "href": "api/Stride.Core.IO.VirtualFileSystem.html",
    "title": "Class VirtualFileSystem | Stride API",
    "summary": "Class VirtualFileSystem Namespace Stride.Core.IO Assembly Stride.Core.IO.dll Virtual abstraction over a file system. It handles access to files, http, packages, path rewrite, etc... public static class VirtualFileSystem Inheritance object VirtualFileSystem Fields AllDirectorySeparatorChars public static readonly char[] AllDirectorySeparatorChars Field Value char[] AltDirectorySeparatorChar public static readonly char AltDirectorySeparatorChar Field Value char ApplicationBinary The application binary folder. public static readonly IVirtualFileProvider ApplicationBinary Field Value IVirtualFileProvider ApplicationCache The application cache folder. public static readonly IVirtualFileProvider ApplicationCache Field Value IVirtualFileProvider ApplicationData The application data file provider. public static readonly IVirtualFileProvider ApplicationData Field Value IVirtualFileProvider ApplicationDatabase The application database file provider (Index level). public static readonly IVirtualFileProvider ApplicationDatabase Field Value IVirtualFileProvider ApplicationDatabaseIndexName public static readonly string ApplicationDatabaseIndexName Field Value string ApplicationDatabaseIndexPath public static readonly string ApplicationDatabaseIndexPath Field Value string ApplicationDatabasePath public static readonly string ApplicationDatabasePath Field Value string ApplicationLocal The application user local folder. Included in backup. public static readonly IVirtualFileProvider ApplicationLocal Field Value IVirtualFileProvider ApplicationObjectDatabase The application database file provider (ObjectId level). public static IVirtualFileProvider ApplicationObjectDatabase Field Value IVirtualFileProvider ApplicationRoaming The application user roaming folder. Included in backup. public static readonly IVirtualFileProvider ApplicationRoaming Field Value IVirtualFileProvider ApplicationTemporary The application temporary data provider. public static readonly IVirtualFileProvider ApplicationTemporary Field Value IVirtualFileProvider DirectorySeparatorChar public static readonly char DirectorySeparatorChar Field Value char Drive The whole host file system. This should be used only in tools. public static readonly DriveFileProvider Drive Field Value DriveFileProvider LocalDatabasePath public static readonly string LocalDatabasePath Field Value string Properties Providers Gets the registered providers. public static IEnumerable<IVirtualFileProvider> Providers { get; } Property Value IEnumerable<IVirtualFileProvider> The providers. Methods BuildPath(string, string) public static string BuildPath(string path, string relativePath) Parameters path string relativePath string Returns string Combine(string, string) Combines the specified paths. Similiar to Combine(string, string). public static string Combine(string path1, string path2) Parameters path1 string The path1. path2 string The path2. Returns string The combined path. CreateDirectory(string) Creates all directories so that path exists. public static void CreateDirectory(string path) Parameters path string The path. CreateRelativePath(string, string) Creates the relative path that can access to target from sourcePath. public static string CreateRelativePath(string target, string sourcePath) Parameters target string The target. sourcePath string The source path. Returns string The relative path. DirectoryExists(string) Checks the existence of a directory. public static bool DirectoryExists(string path) Parameters path string The path of the directory to check. Returns bool True if the directory exists, false otherwise. FileDelete(string) public static void FileDelete(string path) Parameters path string FileExists(string) Checks the existence of a file. public static bool FileExists(string path) Parameters path string The path of the file to check. Returns bool True if the file exists, false otherwise. FileExistsAsync(string) public static Task<bool> FileExistsAsync(string path) Parameters path string Returns Task<bool> FileMove(string, string) public static void FileMove(string sourcePath, string destinationPath) Parameters sourcePath string destinationPath string FileSize(string) public static long FileSize(string path) Parameters path string Returns long GetAbsolutePath(string) Gets the absolute path (system dependent) for the specified path in the context of the virtual file system. public static string GetAbsolutePath(string path) Parameters path string The path local to the virtual file system. Returns string An absolute path (system dependent .i.e C:\\Path\\To\\Your\\File.x). GetFileName(string) Gets the file's name with its extension (\"/path/to/file/fileName.ext\"->\"fileName.ext\") public static string GetFileName(string path) Parameters path string path containing file's path and name Returns string The name of the file with its extension GetLastWriteTime(string) public static DateTime GetLastWriteTime(string path) Parameters path string Returns DateTime GetParentFolder(string) Gets the parent folder. public static string GetParentFolder(string path) Parameters path string The path. Returns string The parent folder. Exceptions ArgumentNullException path ArgumentException path doesn't contain a /;path GetTempFileName() Creates a temporary zero-byte file and returns its full path. public static string GetTempFileName() Returns string The full path of the created temporary file. ListFiles(string, string, VirtualSearchOption) Lists the files matching a pattern in a specified directory. public static Task<string[]> ListFiles(string path, string searchPattern, VirtualSearchOption searchOption) Parameters path string The path. searchPattern string The search pattern. searchOption VirtualSearchOption The search option. Returns Task<string[]> The list of files matching the pattern. MountFileSystem(string, string) Mounts the specified path in the specified virtual file mount point. public static IVirtualFileProvider MountFileSystem(string mountPoint, string path) Parameters mountPoint string The mount point in the VFS. path string The directory path. Returns IVirtualFileProvider OpenStream(string, VirtualFileMode, VirtualFileAccess, VirtualFileShare) Opens the stream from a given path. public static Stream OpenStream(string path, VirtualFileMode mode, VirtualFileAccess access, VirtualFileShare share = VirtualFileShare.Read) Parameters path string The path. mode VirtualFileMode The stream opening mode (append, open, create, etc...). access VirtualFileAccess The stream access. share VirtualFileShare The stream share mode. Returns Stream The stream. OpenStream(string, VirtualFileMode, VirtualFileAccess, VirtualFileShare, out IVirtualFileProvider) Opens the stream from a given path. public static Stream OpenStream(string path, VirtualFileMode mode, VirtualFileAccess access, VirtualFileShare share, out IVirtualFileProvider provider) Parameters path string The path. mode VirtualFileMode The stream opening mode (append, open, create, etc...). access VirtualFileAccess The stream access. share VirtualFileShare The stream share mode. provider IVirtualFileProvider The provider used to load the stream. Returns Stream The stream. OpenStreamAsync(string, VirtualFileMode, VirtualFileAccess, VirtualFileShare) public static Task<Stream> OpenStreamAsync(string path, VirtualFileMode mode, VirtualFileAccess access, VirtualFileShare share = VirtualFileShare.Read) Parameters path string mode VirtualFileMode access VirtualFileAccess share VirtualFileShare Returns Task<Stream> RegisterProvider(IVirtualFileProvider) Registers the specified virtual file provider at the specified mount location. public static void RegisterProvider(IVirtualFileProvider provider) Parameters provider IVirtualFileProvider The provider. RemountFileSystem(string, string) Mounts or remounts the specified path in the specified virtual file mount point. public static IVirtualFileProvider RemountFileSystem(string mountPoint, string path) Parameters mountPoint string The mount point in the VFS. path string The directory path. Returns IVirtualFileProvider ResolveAbsolutePath(string) Returns the path with its .. or . parts simplified. public static string ResolveAbsolutePath(string path) Parameters path string The path. Returns string The resolved absolute path. ResolvePath(string) Resolves the path. public static string ResolvePath(string path) Parameters path string The path. Returns string The resolved path. ResolveProvider(string, bool) Resolves the virtual file provider for a given path. public static VirtualFileSystem.ResolveProviderResult ResolveProvider(string path, bool resolveTop) Parameters path string The path. resolveTop bool if set to true [resolve top]. Returns VirtualFileSystem.ResolveProviderResult The virtual file system provider and local path in it. Exceptions InvalidOperationException path cannot be resolved to a provider. ResolveProviderUnsafe(string, bool) public static VirtualFileSystem.ResolveProviderResult ResolveProviderUnsafe(string path, bool resolveTop) Parameters path string resolveTop bool Returns VirtualFileSystem.ResolveProviderResult UnregisterProvider(IVirtualFileProvider, bool) Unregisters the specified virtual file provider. public static void UnregisterProvider(IVirtualFileProvider provider, bool dispose = true) Parameters provider IVirtualFileProvider The provider. dispose bool Indicate that the provider should be disposed, if it inherits from IDisposable interface."
  },
  "api/Stride.Core.IO.VirtualSearchOption.html": {
    "href": "api/Stride.Core.IO.VirtualSearchOption.html",
    "title": "Enum VirtualSearchOption | Stride API",
    "summary": "Enum VirtualSearchOption Namespace Stride.Core.IO Assembly Stride.Core.IO.dll public enum VirtualSearchOption Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AllDirectories = 1 TopDirectoryOnly = 0"
  },
  "api/Stride.Core.IO.VirtualWatcherChangeTypes.html": {
    "href": "api/Stride.Core.IO.VirtualWatcherChangeTypes.html",
    "title": "Enum VirtualWatcherChangeTypes | Stride API",
    "summary": "Enum VirtualWatcherChangeTypes Namespace Stride.Core.IO Assembly Stride.Core.IO.dll [Flags] public enum VirtualWatcherChangeTypes Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields All = Created | Deleted | Changed | Renamed Changed = 4 Created = 1 Deleted = 2 Renamed = 8"
  },
  "api/Stride.Core.IO.html": {
    "href": "api/Stride.Core.IO.html",
    "title": "Namespace Stride.Core.IO | Stride API",
    "summary": "Namespace Stride.Core.IO Classes DatabaseFileProvider DatabaseFileProviderService DictionaryStore<TKey, TValue> A Key->Value store that will be incrementally saved on the HDD. Thread-safe and process-safe. DirectoryWatcher Track file system events from several directories. DriveFileProvider Exposes the whole file system through folder similar to Cygwin. As an example, \"/c/Program Files/Test/Data.dat\" would work. FileEvent � file event used notified by DirectoryWatcher FileRenameEvent � file rename event used notified by DirectoryWatcher FileSystemProvider A file system implementation for IVirtualFileProvider. ListStore<T> A value store that will be incrementally saved on HDD. Thread-safe and process-safe. ListStore<T>.UnsavedEntry NativeLockFile Store<T> A store that will be incrementally saved on the HDD. Thread-safe and process-safe. TemporaryDirectory TemporaryFile VirtualFileProviderBase Abstract base class for IVirtualFileProvider. VirtualFileSystem Virtual abstraction over a file system. It handles access to files, http, packages, path rewrite, etc... Structs DictionaryStore<TKey, TValue>.UnsavedIdMapEntry VirtualFileSystem.ResolveProviderResult Interfaces IDatabaseFileProviderService IDatabaseStream IVirtualFileProvider A virtual file provider, that can returns a Stream for a given path. Enums FileEventChangeType Change type of file used by FileEvent and DirectoryWatcher. StreamFlags Describes the different type of streams. VirtualFileAccess File access equivalent of FileAccess. VirtualFileMode File mode equivalent of FileMode. VirtualFileShare File share capabilities, equivalent of FileShare. VirtualSearchOption VirtualWatcherChangeTypes"
  },
  "api/Stride.Core.IReferencable.html": {
    "href": "api/Stride.Core.IReferencable.html",
    "title": "Interface IReferencable | Stride API",
    "summary": "Interface IReferencable Namespace Stride.Core Assembly Stride.Core.dll Base interface for all objects that use reference-counting lifetime management. public interface IReferencable Extension Methods ComponentBaseExtensions.KeepReference<T>(T) ComponentBaseExtensions.ReleaseBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveReleaseBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties ReferenceCount Gets the reference count of this instance. int ReferenceCount { get; } Property Value int The reference count. Methods AddReference() Increments the reference count of this instance. int AddReference() Returns int The new reference count. Release() Decrements the reference count of this instance. int Release() Returns int The new reference count. Remarks When the reference count reaches 0, the component should release / dispose dependent objects."
  },
  "api/Stride.Core.IService.html": {
    "href": "api/Stride.Core.IService.html",
    "title": "Interface IService | Stride API",
    "summary": "Interface IService Namespace Stride.Core Assembly Stride.Core.dll public interface IService Extension Methods UnsafeUtilities.As<T>(object?) Methods NewInstance(IServiceRegistry) public static abstract IService NewInstance(IServiceRegistry services) Parameters services IServiceRegistry Returns IService"
  },
  "api/Stride.Core.IServiceRegistry.html": {
    "href": "api/Stride.Core.IServiceRegistry.html",
    "title": "Interface IServiceRegistry | Stride API",
    "summary": "Interface IServiceRegistry Namespace Stride.Core Assembly Stride.Core.dll A service registry is a IServiceProvider that provides methods to register and unregister services. public interface IServiceRegistry Extension Methods ServiceRegistryExtensions.GetSafeServiceAs<T>(IServiceRegistry) ServiceRegistryExtensions.GetServiceLate<T>(IServiceRegistry, Action<T>) UnsafeUtilities.As<T>(object?) Methods AddService<T>(T) Adds a service to this ServiceRegistry. void AddService<T>(T service) where T : class Parameters service T The service to add. Type Parameters T The type of service to add. Exceptions ArgumentNullException Thrown when the provided service is null. ArgumentException Thrown when a service of the same type is already registered. GetOrCreate<T>() Gets the service object of the specified type, create one if it didn't exist before. T GetOrCreate<T>() where T : class, IService Returns T Type Parameters T The type of the service to retrieve. GetService<T>() Gets the service object of the specified type. T? GetService<T>() where T : class Returns T A service of the requested type, or [null] if not found. Type Parameters T The type of the service to retrieve. Remarks The generic type provided must match the generic type of your initial call to AddService<T>(T) RemoveService<T>() Removes the object providing a specified service. void RemoveService<T>() where T : class Type Parameters T The type of the service to remove. Remarks The generic type provided must match the generic type of your initial call to AddService<T>(T) RemoveService<T>(T) Removes the following object from services if it was registered as one. bool RemoveService<T>(T serviceObject) where T : class Parameters serviceObject T Returns bool True if the argument was a service, false otherwise Type Parameters T The type of the service to remove. Remarks The generic type provided must match the generic type of your initial call to AddService<T>(T) Events ServiceAdded Occurs when a new service is added to the registry. event EventHandler<ServiceEventArgs> ServiceAdded Event Type EventHandler<ServiceEventArgs> ServiceRemoved Occurs when a service is removed from the registry. event EventHandler<ServiceEventArgs> ServiceRemoved Event Type EventHandler<ServiceEventArgs>"
  },
  "api/Stride.Core.IThreadThrottler.html": {
    "href": "api/Stride.Core.IThreadThrottler.html",
    "title": "Interface IThreadThrottler | Stride API",
    "summary": "Interface IThreadThrottler Namespace Stride.Core Assembly Stride.Core.dll public interface IThreadThrottler Extension Methods UnsafeUtilities.As<T>(object?) Properties MinimumElapsedTime TimeSpan MinimumElapsedTime { get; set; } Property Value TimeSpan Type ThreadThrottler.ThrottlerType Type { get; } Property Value ThreadThrottler.ThrottlerType Methods SetMaxFrequency(int) void SetMaxFrequency(int frequencyMax) Parameters frequencyMax int SetToPreciseAuto() void SetToPreciseAuto() SetToPreciseManual(long) void SetToPreciseManual(long spinwaitWindowParam) Parameters spinwaitWindowParam long SetToStandard() void SetToStandard() Throttle(out double) bool Throttle(out double elapsedInSeconds) Parameters elapsedInSeconds double Returns bool Throttle(out long) bool Throttle(out long elapsedInSwFreq) Parameters elapsedInSwFreq long Returns bool Throttle(out TimeSpan) bool Throttle(out TimeSpan elapsedTimeSpan) Parameters elapsedTimeSpan TimeSpan Returns bool"
  },
  "api/Stride.Core.LZ4.LZ4Stream.ChunkFlags.html": {
    "href": "api/Stride.Core.LZ4.LZ4Stream.ChunkFlags.html",
    "title": "Enum LZ4Stream.ChunkFlags | Stride API",
    "summary": "Enum LZ4Stream.ChunkFlags Namespace Stride.Core.LZ4 Assembly Stride.Core.Serialization.dll Flags of a chunk. Please note, this [Flags] public enum LZ4Stream.ChunkFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Compressed = 1 Set if chunk is compressed. HighCompression = 2 Set if high compression has been selected (does not affect decoder, but might be useful when rewriting) None = 0 None. Passes = 28 3 bits for number of passes. Currently only 1 pass (value 0) is supported."
  },
  "api/Stride.Core.LZ4.LZ4Stream.html": {
    "href": "api/Stride.Core.LZ4.LZ4Stream.html",
    "title": "Class LZ4Stream | Stride API",
    "summary": "Class LZ4Stream Namespace Stride.Core.LZ4 Assembly Stride.Core.Serialization.dll Block compression stream. Allows to use LZ4 for stream compression. public class LZ4Stream : Stream, IAsyncDisposable, IDisposable Inheritance object MarshalByRefObject Stream LZ4Stream Implements IAsyncDisposable IDisposable Inherited Members Stream.Null Stream.BeginRead(byte[], int, int, AsyncCallback, object) Stream.BeginWrite(byte[], int, int, AsyncCallback, object) Stream.Close() Stream.CopyTo(Stream) Stream.CopyTo(Stream, int) Stream.CopyToAsync(Stream) Stream.CopyToAsync(Stream, int) Stream.CopyToAsync(Stream, int, CancellationToken) Stream.CopyToAsync(Stream, CancellationToken) Stream.CreateWaitHandle() Stream.Dispose() Stream.DisposeAsync() Stream.EndRead(IAsyncResult) Stream.EndWrite(IAsyncResult) Stream.FlushAsync() Stream.FlushAsync(CancellationToken) Stream.ObjectInvariant() Stream.ReadAsync(byte[], int, int) Stream.ReadAsync(byte[], int, int, CancellationToken) Stream.ReadAsync(Memory<byte>, CancellationToken) Stream.ReadAtLeast(Span<byte>, int, bool) Stream.ReadAtLeastAsync(Memory<byte>, int, bool, CancellationToken) Stream.ReadExactly(byte[], int, int) Stream.ReadExactly(Span<byte>) Stream.ReadExactlyAsync(byte[], int, int, CancellationToken) Stream.ReadExactlyAsync(Memory<byte>, CancellationToken) Stream.Synchronized(Stream) Stream.ValidateBufferArguments(byte[], int, int) Stream.ValidateCopyToArguments(Stream, int) Stream.WriteAsync(byte[], int, int) Stream.WriteAsync(byte[], int, int, CancellationToken) Stream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken) Stream.CanTimeout Stream.ReadTimeout Stream.WriteTimeout MarshalByRefObject.GetLifetimeService() MarshalByRefObject.InitializeLifetimeService() MarshalByRefObject.MemberwiseClone(bool) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) SocketExtensions.Read7BitEncodedInt(Stream) SocketExtensions.ReadAllAsync(Stream, byte[], int, int) SocketExtensions.ReadGuidAsync(Stream) SocketExtensions.ReadInt16Async(Stream) SocketExtensions.ReadInt32Async(Stream) SocketExtensions.ReadStringAsync(Stream) SocketExtensions.Write7BitEncodedInt(Stream, int) SocketExtensions.WriteGuidAsync(Stream, Guid) SocketExtensions.WriteInt16Async(Stream, short) SocketExtensions.WriteInt32Async(Stream, int) SocketExtensions.WriteStringAsync(Stream, string) UnsafeUtilities.As<T>(object?) Constructors LZ4Stream(Stream, CompressionMode, bool, long, long, bool, int) Initializes a new instance of the LZ4Stream class. public LZ4Stream(Stream innerStream, CompressionMode compressionMode, bool highCompression = false, long uncompressedSize = -1, long compressedSize = -1, bool disposeInnerStream = false, int blockSize = 1048576) Parameters innerStream Stream The inner stream. compressionMode CompressionMode The compression mode. highCompression bool if set to true [high compression]. uncompressedSize long The size of the stream uncompressed compressedSize long disposeInnerStream bool if set to true innerStream is disposed during called to Dispose(bool) blockSize int Size of the block. Properties CanRead When overridden in a derived class, gets a value indicating whether the current stream supports reading. public override bool CanRead { get; } Property Value bool true if the stream supports reading; otherwise, false. CanSeek When overridden in a derived class, gets a value indicating whether the current stream supports seeking. public override bool CanSeek { get; } Property Value bool true if the stream supports seeking; otherwise, false. CanWrite When overridden in a derived class, gets a value indicating whether the current stream supports writing. public override bool CanWrite { get; } Property Value bool true if the stream supports writing; otherwise, false. Length When overridden in a derived class, gets the length in bytes of the stream. public override long Length { get; } Property Value long A long value representing the length of the stream in bytes. Exceptions NotSupportedException A class derived from Stream does not support seeking and the length is unknown. ObjectDisposedException Methods were called after the stream was closed. Position When overridden in a derived class, gets or sets the position within the current stream. public override long Position { get; set; } Property Value long The current position within the stream. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support seeking. ObjectDisposedException Methods were called after the stream was closed. Methods Dispose(bool) Releases the unmanaged resources used by the Stream and optionally releases the managed resources. protected override void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. Flush() When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. public override void Flush() Exceptions IOException An I/O error occurs. Read(byte[], int, int) When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. public override int Read(byte[] buffer, int offset, int count) Parameters buffer byte[] An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. offset int The zero-based byte offset in buffer at which to begin storing the data read from the current stream. count int The maximum number of bytes to be read from the current stream. Returns int The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if count is 0 or the end of the stream has been reached. Exceptions ArgumentException The sum of offset and count is larger than the buffer length. ArgumentNullException buffer is null. ArgumentOutOfRangeException offset or count is negative. IOException An I/O error occurs. NotSupportedException The stream does not support reading. ObjectDisposedException Methods were called after the stream was closed. Read(Span<byte>) When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. public override int Read(Span<byte> buffer) Parameters buffer Span<byte> A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source. Returns int The total number of bytes read into the buffer. This can be less than the size of the buffer if that many bytes are not currently available, or zero (0) if the buffer's length is zero or the end of the stream has been reached. ReadByte() Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. public override int ReadByte() Returns int The unsigned byte cast to an int, or -1 if at the end of the stream. Exceptions NotSupportedException The stream does not support reading. ObjectDisposedException Methods were called after the stream was closed. Reset() Reset the stream to its initial position and state public void Reset() Seek(long, SeekOrigin) When overridden in a derived class, sets the position within the current stream. public override long Seek(long offset, SeekOrigin origin) Parameters offset long A byte offset relative to the origin parameter. origin SeekOrigin A value of type SeekOrigin indicating the reference point used to obtain the new position. Returns long The new position within the current stream. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support seeking, such as if the stream is constructed from a pipe or console output. ObjectDisposedException Methods were called after the stream was closed. SetLength(long) When overridden in a derived class, sets the length of the current stream. public override void SetLength(long value) Parameters value long The desired length of the current stream in bytes. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. ObjectDisposedException Methods were called after the stream was closed. Write(byte[], int, int) When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. public override void Write(byte[] buffer, int offset, int count) Parameters buffer byte[] An array of bytes. This method copies count bytes from buffer to the current stream. offset int The zero-based byte offset in buffer at which to begin copying bytes to the current stream. count int The number of bytes to be written to the current stream. Exceptions ArgumentException The sum of offset and count is greater than the buffer length. ArgumentNullException buffer is null. ArgumentOutOfRangeException offset or count is negative. IOException An I/O error occurred, such as the specified file cannot be found. NotSupportedException The stream does not support writing. ObjectDisposedException Write(byte[], int, int) was called after the stream was closed. Write(ReadOnlySpan<byte>) When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. public override void Write(ReadOnlySpan<byte> buffer) Parameters buffer ReadOnlySpan<byte> A region of memory. This method copies the contents of this region to the current stream. WriteByte(byte) Writes a byte to the current position in the stream and advances the position within the stream by one byte. public override void WriteByte(byte value) Parameters value byte The byte to write to the stream. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support writing, or the stream is already closed. ObjectDisposedException Methods were called after the stream was closed."
  },
  "api/Stride.Core.LZ4.html": {
    "href": "api/Stride.Core.LZ4.html",
    "title": "Namespace Stride.Core.LZ4 | Stride API",
    "summary": "Namespace Stride.Core.LZ4 Classes LZ4Stream Block compression stream. Allows to use LZ4 for stream compression. Enums LZ4Stream.ChunkFlags Flags of a chunk. Please note, this"
  },
  "api/Stride.Core.Mathematics.AngleSingle.html": {
    "href": "api/Stride.Core.Mathematics.AngleSingle.html",
    "title": "Struct AngleSingle | Stride API",
    "summary": "Struct AngleSingle Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a unit independant angle using a single-precision floating-point internal representation. [DataStyle(DataStyle.Compact)] [DataContract] public struct AngleSingle : IComparable, IComparable<AngleSingle>, IEquatable<AngleSingle>, ISpanFormattable, IFormattable Implements IComparable IComparable<AngleSingle> IEquatable<AngleSingle> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors AngleSingle(float, AngleType) Initializes a new instance of the AngleSingle struct with the given unit dependant angle and unit type. public AngleSingle(float angle, AngleType type) Parameters angle float A unit dependant measure of the angle. type AngleType The type of unit the angle argument is. AngleSingle(float, float) Initializes a new instance of the AngleSingle struct using the arc length formula (θ = s/r). public AngleSingle(float arcLength, float radius) Parameters arcLength float The measure of the arc. radius float The radius of the circle. Fields Degree A value that specifies the size of a single degree. public const float Degree = 0.0027777778 Field Value float Gradian A value that specifies the size of a single gradian. public const float Gradian = 0.0025 Field Value float Milliradian A value that specifies the size of a single milliradian. public const float Milliradian = 0.00015915494 Field Value float Minute A value that specifies the size of a single minute. public const float Minute = 4.6296296E-05 Field Value float Radian A value that specifies the size of a single radian. public const float Radian = 0.15915494 Field Value float Second A value that specifies the size of a single second. public const float Second = 7.7160496E-07 Field Value float Properties Complement Gets a Stride.Core.Mathematics.AngleSingle instance that complements this angle (i.e. the two angles add to 90°). public readonly AngleSingle Complement { get; } Property Value AngleSingle Degrees Gets or sets the total number of degrees this Stride.Core.Mathematics.AngleSingle represents. public float Degrees { readonly get; set; } Property Value float FullRotationAngle Gets a new Stride.Core.Mathematics.AngleSingle instance that represents the full rotation angle (i.e. 360° or 2π). public static AngleSingle FullRotationAngle { get; } Property Value AngleSingle Gradians Gets or sets the total number of gradians this Stride.Core.Mathematics.AngleSingle represents. public float Gradians { readonly get; set; } Property Value float IsAcute Gets a System.Boolean that determines whether this Stride.Core.Mathematics.Angle is an acute angle (i.e. less than 90° but greater than 0°). public readonly bool IsAcute { get; } Property Value bool IsFullRotation Gets a System.Boolean that determines whether this Stride.Core.Mathematics.Angle is a full rotation angle (i.e. 360° or 2π). public readonly bool IsFullRotation { get; } Property Value bool IsOblique Gets a System.Boolean that determines whether this Stride.Core.Mathematics.Angle is an oblique angle (i.e. is not 90° or a multiple of 90°). public readonly bool IsOblique { get; } Property Value bool IsObtuse Gets a System.Boolean that determines whether this Stride.Core.Mathematics.Angle is an obtuse angle (i.e. greater than 90° but less than 180°). public readonly bool IsObtuse { get; } Property Value bool IsReflex Gets a System.Boolean that determines whether this Stride.Core.Mathematics.Angle is a reflex angle (i.e. greater than 180° but less than 360°). public readonly bool IsReflex { get; } Property Value bool IsRight Gets a System.Boolean that determines whether this Stride.Core.Mathematics.Angle is a right angle (i.e. 90° or π/2). public readonly bool IsRight { get; } Property Value bool IsStraight Gets a System.Boolean that determines whether this Stride.Core.Mathematics.Angle is a straight angle (i.e. 180° or π). public readonly bool IsStraight { get; } Property Value bool Milliradians Gets or sets the total number of milliradians this Stride.Core.Mathematics.AngleSingle represents. One milliradian is equal to 1/(2000π). public float Milliradians { readonly get; set; } Property Value float Minutes Gets or sets the minutes component of the degrees this Stride.Core.Mathematics.AngleSingle represents. When setting the minutes, if the value is in the range (-60, 60) the whole degrees are not changed; otherwise, the whole degrees may be changed. Fractional values may set the seconds component. public float Minutes { readonly get; set; } Property Value float Radians Gets or sets the total number of radians this Stride.Core.Mathematics.AngleSingle represents. public float Radians { readonly get; set; } Property Value float Revolutions Gets or sets the total number of revolutions this Stride.Core.Mathematics.AngleSingle represents. public float Revolutions { readonly get; set; } Property Value float RightAngle Gets a new Stride.Core.Mathematics.AngleSingle instance that represents the right angle (i.e. 90° or π/2). public static AngleSingle RightAngle { get; } Property Value AngleSingle Seconds Gets or sets the seconds of the degrees this Stride.Core.Mathematics.AngleSingle represents. When setting te seconds, if the value is in the range (-60, 60) the whole minutes or whole degrees are not changed; otherwise, the whole minutes or whole degrees may be changed. public float Seconds { readonly get; set; } Property Value float StraightAngle Gets a new Stride.Core.Mathematics.AngleSingle instance that represents the straight angle (i.e. 180° or π). public static AngleSingle StraightAngle { get; } Property Value AngleSingle Supplement Gets a Stride.Core.Mathematics.AngleSingle instance that supplements this angle (i.e. the two angles add to 180°). public readonly AngleSingle Supplement { get; } Property Value AngleSingle ZeroAngle Gets a new Stride.Core.Mathematics.AngleSingle instance that represents the zero angle (i.e. 0°). public static AngleSingle ZeroAngle { get; } Property Value AngleSingle Methods Add(AngleSingle, AngleSingle) Adds two Stride.Core.Mathematics.AngleSingle objects and returns the result. public static AngleSingle Add(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to add. right AngleSingle The second object to add. Returns AngleSingle The value of the two objects added together. CompareTo(AngleSingle) Compares this instance to a second Stride.Core.Mathematics.AngleSingle and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object. public readonly int CompareTo(AngleSingle other) Parameters other AngleSingle The object to compare. Returns int A signed integer that indicates the relationship of the current instance to the obj parameter. If the value is less than zero, the current instance is less than the other. If the value is zero, the current instance is equal to the other. If the value is greater than zero, the current instance is greater than the other. CompareTo(object?) Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object. public readonly int CompareTo(object? other) Parameters other object The object to compare. Returns int A signed integer that indicates the relationship of the current instance to the obj parameter. If the value is less than zero, the current instance is less than the other. If the value is zero, the current instance is equal to the other. If the value is greater than zero, the current instance is greater than the other. Divide(AngleSingle, AngleSingle) Divides two Stride.Core.Mathematics.AngleSingle objects and returns the result. public static AngleSingle Divide(AngleSingle left, AngleSingle right) Parameters left AngleSingle The numerator object. right AngleSingle The denominator object. Returns AngleSingle The value of the two objects divided. Equals(AngleSingle) Returns a value that indicates whether the current instance and a specified Stride.Core.Mathematics.AngleSingle object have the same value. public readonly bool Equals(AngleSingle other) Parameters other AngleSingle The object to compare. Returns bool Returns true if this Stride.Core.Mathematics.AngleSingle object and another have the same value; otherwise, false. Equals(object?) Returns a value that indicates whether the current instance and a specified object have the same value. public override readonly bool Equals(object? obj) Parameters obj object The object to compare. Returns bool Returns true if the obj parameter is a Stride.Core.Mathematics.AngleSingle object or a type capable of implicit conversion to a Stride.Core.Mathematics.AngleSingle value, and its value is equal to the value of the current Stride.Core.Mathematics.Angle object; otherwise, false. GetHashCode() Returns a hash code for this Stride.Core.Mathematics.AngleSingle instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer hash code. Max(AngleSingle, AngleSingle) Compares two Stride.Core.Mathematics.AngleSingle instances and returns the greater angle. public static AngleSingle Max(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first Stride.Core.Mathematics.AngleSingle instance to compare. right AngleSingle The second Stride.Core.Mathematics.AngleSingle instance to compare. Returns AngleSingle The greater of the two given Stride.Core.Mathematics.AngleSingle instances. Min(AngleSingle, AngleSingle) Compares two Stride.Core.Mathematics.AngleSingle instances and returns the smaller angle. public static AngleSingle Min(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first Stride.Core.Mathematics.AngleSingle instance to compare. right AngleSingle The second Stride.Core.Mathematics.AngleSingle instance to compare. Returns AngleSingle The smaller of the two given Stride.Core.Mathematics.AngleSingle instances. Multiply(AngleSingle, AngleSingle) Multiplies two Stride.Core.Mathematics.AngleSingle objects and returns the result. public static AngleSingle Multiply(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to multiply. right AngleSingle The second object to multiply. Returns AngleSingle The value of the two objects multiplied together. Subtract(AngleSingle, AngleSingle) Subtracts two Stride.Core.Mathematics.AngleSingle objects and returns the result. public static AngleSingle Subtract(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to subtract. right AngleSingle The second object to subtract. Returns AngleSingle The value of the two objects subtracted. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Wrap() Wraps this Stride.Core.Mathematics.AngleSingle to be in the range [π, -π]. public void Wrap() Wrap(AngleSingle) Wraps the Stride.Core.Mathematics.AngleSingle given in the value argument to be in the range [π, -π]. public static AngleSingle Wrap(AngleSingle value) Parameters value AngleSingle A Stride.Core.Mathematics.AngleSingle to wrap. Returns AngleSingle The Stride.Core.Mathematics.AngleSingle that is wrapped. WrapPositive() Wraps this Stride.Core.Mathematics.AngleSingle to be in the range [0, 2π). public void WrapPositive() WrapPositive(AngleSingle) Wraps the Stride.Core.Mathematics.AngleSingle given in the value argument to be in the range [0, 2π). public static AngleSingle WrapPositive(AngleSingle value) Parameters value AngleSingle A Stride.Core.Mathematics.AngleSingle to wrap. Returns AngleSingle The Stride.Core.Mathematics.AngleSingle that is wrapped. Operators operator +(AngleSingle, AngleSingle) Adds two Stride.Core.Mathematics.AngleSingle objects and returns the result. public static AngleSingle operator +(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to add. right AngleSingle The second object to add. Returns AngleSingle The value of the two objects added together. operator /(AngleSingle, AngleSingle) Divides two Stride.Core.Mathematics.AngleSingle objects and returns the result. public static AngleSingle operator /(AngleSingle left, AngleSingle right) Parameters left AngleSingle The numerator object. right AngleSingle The denominator object. Returns AngleSingle The value of the two objects divided. operator ==(AngleSingle, AngleSingle) Returns a System.Boolean that indicates whether the values of two Stride.Core.Mathematics.Angle objects are equal. public static bool operator ==(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to compare. right AngleSingle The second object to compare. Returns bool True if the left and right parameters have the same value; otherwise, false. operator >(AngleSingle, AngleSingle) Returns a System.Boolean that indicates whether a Stride.Core.Mathematics.Angle object is greater than another Stride.Core.Mathematics.AngleSingle object. public static bool operator >(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to compare. right AngleSingle The second object to compare. Returns bool True if left is greater than right; otherwise, false. operator >=(AngleSingle, AngleSingle) Returns a System.Boolean that indicates whether a Stride.Core.Mathematics.Angle object is greater than or equal to another Stride.Core.Mathematics.AngleSingle object. public static bool operator >=(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to compare. right AngleSingle The second object to compare. Returns bool True if left is greater than or equal to right; otherwise, false. operator !=(AngleSingle, AngleSingle) Returns a System.Boolean that indicates whether the values of two Stride.Core.Mathematics.Angle objects are not equal. public static bool operator !=(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to compare. right AngleSingle The second object to compare. Returns bool True if the left and right parameters do not have the same value; otherwise, false. operator <(AngleSingle, AngleSingle) Returns a System.Boolean that indicates whether a Stride.Core.Mathematics.Angle object is less than another Stride.Core.Mathematics.AngleSingle object. public static bool operator <(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to compare. right AngleSingle The second object to compare. Returns bool True if left is less than right; otherwise, false. operator <=(AngleSingle, AngleSingle) Returns a System.Boolean that indicates whether a Stride.Core.Mathematics.Angle object is less than or equal to another Stride.Core.Mathematics.AngleSingle object. public static bool operator <=(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to compare. right AngleSingle The second object to compare. Returns bool True if left is less than or equal to right; otherwise, false. operator *(AngleSingle, AngleSingle) Multiplies two Stride.Core.Mathematics.AngleSingle objects and returns the result. public static AngleSingle operator *(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to multiply. right AngleSingle The second object to multiply. Returns AngleSingle The value of the two objects multiplied together. operator -(AngleSingle, AngleSingle) Subtracts two Stride.Core.Mathematics.AngleSingle objects and returns the result. public static AngleSingle operator -(AngleSingle left, AngleSingle right) Parameters left AngleSingle The first object to subtract right AngleSingle The second object to subtract. Returns AngleSingle The value of the two objects subtracted. operator -(AngleSingle) Returns the negated value of the Stride.Core.Mathematics.AngleSingle operand. public static AngleSingle operator -(AngleSingle value) Parameters value AngleSingle A Stride.Core.Mathematics.AngleSingle object. Returns AngleSingle The negated value of the value parameter. operator +(AngleSingle) Returns the value of the Stride.Core.Mathematics.AngleSingle operand. (The sign of the operand is unchanged.) public static AngleSingle operator +(AngleSingle value) Parameters value AngleSingle A Stride.Core.Mathematics.AngleSingle object. Returns AngleSingle The value of the value parameter."
  },
  "api/Stride.Core.Mathematics.AngleType.html": {
    "href": "api/Stride.Core.Mathematics.AngleType.html",
    "title": "Enum AngleType | Stride API",
    "summary": "Enum AngleType Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Describes the type of angle. public enum AngleType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Degree = 1 Specifies an angle measurement in degrees. Gradian = 3 Specifies an angle measurement in gradians. Radian = 2 Specifies an angle measurement in radians. Revolution = 0 Specifies an angle measurement in revolutions."
  },
  "api/Stride.Core.Mathematics.BoundingBox.html": {
    "href": "api/Stride.Core.Mathematics.BoundingBox.html",
    "title": "Struct BoundingBox | Stride API",
    "summary": "Struct BoundingBox Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents an axis-aligned bounding box in three dimensional space. [DataContract] public struct BoundingBox : IEquatable<BoundingBox>, ISpanFormattable, IFormattable, IIntersectableWithRay, IIntersectableWithPlane Implements IEquatable<BoundingBox> ISpanFormattable IFormattable IIntersectableWithRay IIntersectableWithPlane Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors BoundingBox(Vector3, Vector3) Initializes a new instance of the BoundingBox struct. public BoundingBox(Vector3 minimum, Vector3 maximum) Parameters minimum Vector3 The minimum vertex of the bounding box. maximum Vector3 The maximum vertex of the bounding box. Fields Empty A BoundingBox which represents an empty space. public static readonly BoundingBox Empty Field Value BoundingBox Maximum The maximum point of the box. public Vector3 Maximum Field Value Vector3 Minimum The minimum point of the box. public Vector3 Minimum Field Value Vector3 Properties Center Gets the center of this bouding box. public readonly Vector3 Center { get; } Property Value Vector3 Extent Gets the extent of this bouding box. public readonly Vector3 Extent { get; } Property Value Vector3 Methods Contains(ref readonly BoundingBox) Determines whether the current objects contains a BoundingBox. public ContainmentType Contains(ref readonly BoundingBox box) Parameters box BoundingBox The box to test. Returns ContainmentType The type of containment the two objects have. Contains(ref readonly BoundingSphere) Determines whether the current objects contains a BoundingSphere. public ContainmentType Contains(ref readonly BoundingSphere sphere) Parameters sphere BoundingSphere The sphere to test. Returns ContainmentType The type of containment the two objects have. Contains(ref readonly Vector3) Determines whether the current objects contains a point. public ContainmentType Contains(ref readonly Vector3 point) Parameters point Vector3 The point to test. Returns ContainmentType The type of containment the two objects have. Equals(BoundingBox) Determines whether the specified Vector4 is equal to this instance. public readonly bool Equals(BoundingBox value) Parameters value BoundingBox The Vector4 to compare with this instance. Returns bool true if the specified Vector4 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. FromPoints(Vector3[]) Constructs a BoundingBox that fully contains the given points. public static BoundingBox FromPoints(Vector3[] points) Parameters points Vector3[] The points that will be contained by the box. Returns BoundingBox The newly constructed bounding box. Exceptions ArgumentNullException Thrown when points is null. FromPoints(Vector3[], out BoundingBox) Constructs a BoundingBox that fully contains the given points. public static void FromPoints(Vector3[] points, out BoundingBox result) Parameters points Vector3[] The points that will be contained by the box. result BoundingBox When the method completes, contains the newly constructed bounding box. Exceptions ArgumentNullException Thrown when points is null. FromSphere(BoundingSphere) Constructs a BoundingBox from a given sphere. public static BoundingBox FromSphere(BoundingSphere sphere) Parameters sphere BoundingSphere The sphere that will designate the extents of the box. Returns BoundingBox The newly constructed bounding box. FromSphere(ref readonly BoundingSphere, out BoundingBox) Constructs a BoundingBox from a given sphere. public static void FromSphere(ref readonly BoundingSphere sphere, out BoundingBox result) Parameters sphere BoundingSphere The sphere that will designate the extents of the box. result BoundingBox When the method completes, contains the newly constructed bounding box. GetCorners() Retrieves the eight corners of the bounding box. public readonly Vector3[] GetCorners() Returns Vector3[] An array of points representing the eight corners of the bounding box. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Intersects(ref readonly BoundingBox) Determines if there is an intersection between the current object and a BoundingBox. public bool Intersects(ref readonly BoundingBox box) Parameters box BoundingBox The box to test. Returns bool Whether the two objects intersected. Intersects(ref readonly BoundingSphere) Determines if there is an intersection between the current object and a BoundingSphere. public bool Intersects(ref readonly BoundingSphere sphere) Parameters sphere BoundingSphere The sphere to test. Returns bool Whether the two objects intersected. Intersects(ref readonly Plane) Determines if there is an intersection between the current object and a Plane. public PlaneIntersectionType Intersects(ref readonly Plane plane) Parameters plane Plane The plane to test. Returns PlaneIntersectionType Whether the two objects intersected. Intersects(ref readonly Ray) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray) Parameters ray Ray The ray to test. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray, out Vector3) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray, out Vector3 point) Parameters ray Ray The ray to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray, out float) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray, out float distance) Parameters ray Ray The ray to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected. Merge(BoundingBox, BoundingBox) Constructs a BoundingBox that is as large as the total combined area of the two specified boxes. public static BoundingBox Merge(BoundingBox value1, BoundingBox value2) Parameters value1 BoundingBox The first box to merge. value2 BoundingBox The second box to merge. Returns BoundingBox The newly constructed bounding box. Merge(ref readonly BoundingBox, ref readonly BoundingBox, out BoundingBox) Constructs a BoundingBox that is as large as the total combined area of the two specified boxes. public static void Merge(ref readonly BoundingBox value1, ref readonly BoundingBox value2, out BoundingBox result) Parameters value1 BoundingBox The first box to merge. value2 BoundingBox The second box to merge. result BoundingBox When the method completes, contains the newly constructed bounding box. Merge(ref readonly BoundingBox, ref readonly Vector3, out BoundingBox) Constructs a BoundingBox that is as large enough to contains the bounding box and the given point. public static void Merge(ref readonly BoundingBox value1, ref readonly Vector3 value2, out BoundingBox result) Parameters value1 BoundingBox The box to merge. value2 Vector3 The point to merge. result BoundingBox When the method completes, contains the newly constructed bounding box. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transform(ref readonly BoundingBox, ref readonly Matrix, out BoundingBox) Transform a bounding box. public static void Transform(ref readonly BoundingBox value, ref readonly Matrix transform, out BoundingBox result) Parameters value BoundingBox The original bounding box. transform Matrix The transform to apply to the bounding box. result BoundingBox The transformed bounding box. Operators operator ==(BoundingBox, BoundingBox) Tests for equality between two objects. public static bool operator ==(BoundingBox left, BoundingBox right) Parameters left BoundingBox The first value to compare. right BoundingBox The second value to compare. Returns bool true if left has the same value as right; otherwise, false. operator !=(BoundingBox, BoundingBox) Tests for inequality between two objects. public static bool operator !=(BoundingBox left, BoundingBox right) Parameters left BoundingBox The first value to compare. right BoundingBox The second value to compare. Returns bool true if left has a different value than right; otherwise, false."
  },
  "api/Stride.Core.Mathematics.BoundingBoxExt.html": {
    "href": "api/Stride.Core.Mathematics.BoundingBoxExt.html",
    "title": "Struct BoundingBoxExt | Stride API",
    "summary": "Struct BoundingBoxExt Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents an axis-aligned bounding box in three dimensional space that store only the Center and Extent. [DataContract] public struct BoundingBoxExt : IEquatable<BoundingBoxExt>, ISpanFormattable, IFormattable Implements IEquatable<BoundingBoxExt> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors BoundingBoxExt(BoundingBox) Initializes a new instance of the BoundingBoxExt struct. public BoundingBoxExt(BoundingBox box) Parameters box BoundingBox The box. BoundingBoxExt(Vector3, Vector3) Initializes a new instance of the BoundingBoxExt struct. public BoundingBoxExt(Vector3 minimum, Vector3 maximum) Parameters minimum Vector3 The minimum vertex of the bounding box. maximum Vector3 The maximum vertex of the bounding box. Fields Center The center of this bounding box. public Vector3 Center Field Value Vector3 Empty A BoundingBoxExt which represents an empty space. public static readonly BoundingBoxExt Empty Field Value BoundingBoxExt Extent The extent of this bounding box. public Vector3 Extent Field Value Vector3 Properties Maximum Gets the maximum. public readonly Vector3 Maximum { get; } Property Value Vector3 The maximum. Minimum Gets the minimum. public readonly Vector3 Minimum { get; } Property Value Vector3 The minimum. Methods Equals(BoundingBoxExt) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(BoundingBoxExt other) Parameters other BoundingBoxExt An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Merge(ref readonly BoundingBoxExt, ref readonly BoundingBoxExt, out BoundingBoxExt) Constructs a BoundingBoxExt that is as large as the total combined area of the two specified boxes. public static void Merge(ref readonly BoundingBoxExt value1, ref readonly BoundingBoxExt value2, out BoundingBoxExt result) Parameters value1 BoundingBoxExt The first box to merge. value2 BoundingBoxExt The second box to merge. result BoundingBoxExt When the method completes, contains the newly constructed bounding box. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transform(Matrix) Transform this Bounding box public void Transform(Matrix world) Parameters world Matrix The transform to apply to the bounding box. Operators operator ==(BoundingBoxExt, BoundingBoxExt) Implements the ==. public static bool operator ==(BoundingBoxExt left, BoundingBoxExt right) Parameters left BoundingBoxExt The left. right BoundingBoxExt The right. Returns bool The result of the operator. explicit operator BoundingBoxExt(BoundingBox) Performs an explicit conversion from BoundingBox to BoundingBoxExt. public static explicit operator BoundingBoxExt(BoundingBox boundingBox) Parameters boundingBox BoundingBox The bounding box. Returns BoundingBoxExt The result of the conversion. explicit operator BoundingBox(BoundingBoxExt) Performs an explicit conversion from BoundingBoxExt to BoundingBox. public static explicit operator BoundingBox(BoundingBoxExt bbExt) Parameters bbExt BoundingBoxExt The bb ext. Returns BoundingBox The result of the conversion. operator !=(BoundingBoxExt, BoundingBoxExt) Implements the !=. public static bool operator !=(BoundingBoxExt left, BoundingBoxExt right) Parameters left BoundingBoxExt The left. right BoundingBoxExt The right. Returns bool The result of the operator."
  },
  "api/Stride.Core.Mathematics.BoundingFrustum.html": {
    "href": "api/Stride.Core.Mathematics.BoundingFrustum.html",
    "title": "Struct BoundingFrustum | Stride API",
    "summary": "Struct BoundingFrustum Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll A bounding frustum. public struct BoundingFrustum Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors BoundingFrustum(ref readonly Matrix) Initializes a new instance of the BoundingFrustum struct from a matrix view-projection. public BoundingFrustum(ref readonly Matrix matrix) Parameters matrix Matrix The matrix view projection. Fields BottomPlane The bottom plane of this frustum. public Plane BottomPlane Field Value Plane FarPlane The far plane of this frustum. public Plane FarPlane Field Value Plane LeftPlane The left plane of this frustum. public Plane LeftPlane Field Value Plane NearPlane The near plane of this frustum. public Plane NearPlane Field Value Plane RightPlane The right plane of this frustum. public Plane RightPlane Field Value Plane TopPlane The top plane of this frustum. public Plane TopPlane Field Value Plane Methods Contains(ref readonly BoundingBoxExt) Check whether this frustum contains the specified BoundingBoxExt. public bool Contains(ref readonly BoundingBoxExt boundingBoxExt) Parameters boundingBoxExt BoundingBoxExt The bounding box. Returns bool true if this frustum contains the specified bounding box."
  },
  "api/Stride.Core.Mathematics.BoundingSphere.html": {
    "href": "api/Stride.Core.Mathematics.BoundingSphere.html",
    "title": "Struct BoundingSphere | Stride API",
    "summary": "Struct BoundingSphere Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a bounding sphere in three dimensional space. [DataContract] public struct BoundingSphere : IEquatable<BoundingSphere>, ISpanFormattable, IFormattable, IIntersectableWithRay, IIntersectableWithPlane Implements IEquatable<BoundingSphere> ISpanFormattable IFormattable IIntersectableWithRay IIntersectableWithPlane Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors BoundingSphere(Vector3, float) Initializes a new instance of the BoundingSphere struct. public BoundingSphere(Vector3 center, float radius) Parameters center Vector3 The center of the sphere in three dimensional space. radius float The radius of the sphere. Fields Center The center of the sphere in three dimensional space. public Vector3 Center Field Value Vector3 Empty An empty bounding sphere (Center = 0 and Radius = 0). public static readonly BoundingSphere Empty Field Value BoundingSphere Radius The radius of the sphere. public float Radius Field Value float Methods Contains(ref readonly BoundingBox) Determines whether the current objects contains a BoundingBox. public ContainmentType Contains(ref readonly BoundingBox box) Parameters box BoundingBox The box to test. Returns ContainmentType The type of containment the two objects have. Contains(ref readonly BoundingSphere) Determines whether the current objects contains a BoundingSphere. public ContainmentType Contains(ref readonly BoundingSphere sphere) Parameters sphere BoundingSphere The sphere to test. Returns ContainmentType The type of containment the two objects have. Contains(ref readonly Vector3) Determines whether the current objects contains a point. public ContainmentType Contains(ref readonly Vector3 point) Parameters point Vector3 The point to test. Returns ContainmentType The type of containment the two objects have. Contains(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3) Determines whether the current objects contains a triangle. public ContainmentType Contains(ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3) Parameters vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triagnle to test. vertex3 Vector3 The third vertex of the triangle to test. Returns ContainmentType The type of containment the two objects have. Equals(BoundingSphere) Determines whether the specified Vector4 is equal to this instance. public readonly bool Equals(BoundingSphere value) Parameters value BoundingSphere The Vector4 to compare with this instance. Returns bool true if the specified Vector4 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. FromBox(BoundingBox) Constructs a BoundingSphere from a given box. public static BoundingSphere FromBox(BoundingBox box) Parameters box BoundingBox The box that will designate the extents of the sphere. Returns BoundingSphere The newly constructed bounding sphere. FromBox(ref readonly BoundingBox, out BoundingSphere) Constructs a BoundingSphere from a given box. public static void FromBox(ref readonly BoundingBox box, out BoundingSphere result) Parameters box BoundingBox The box that will designate the extents of the sphere. result BoundingSphere When the method completes, the newly constructed bounding sphere. FromPoints(Vector3[]) Constructs a BoundingSphere that fully contains the given points. public static BoundingSphere FromPoints(Vector3[] points) Parameters points Vector3[] The points that will be contained by the sphere. Returns BoundingSphere The newly constructed bounding sphere. FromPoints(Vector3[], out BoundingSphere) Constructs a BoundingSphere that fully contains the given points. public static void FromPoints(Vector3[] points, out BoundingSphere result) Parameters points Vector3[] The points that will be contained by the sphere. result BoundingSphere When the method completes, contains the newly constructed bounding sphere. FromPoints(nint, int, int, int, out BoundingSphere) Constructs a BoundingSphere that fully contains the given unmanaged points. public static void FromPoints(nint vertexBufferPtr, int vertexPositionOffsetInBytes, int vertexCount, int vertexStride, out BoundingSphere result) Parameters vertexBufferPtr nint A pointer to of vertices containing points. vertexPositionOffsetInBytes int The point offset in bytes starting from the vertex structure. vertexCount int The verterx vertexCount. vertexStride int The vertex stride (size of vertex). result BoundingSphere When the method completes, contains the newly constructed bounding sphere. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Intersects(ref readonly BoundingBox) Determines if there is an intersection between the current object and a BoundingBox. public bool Intersects(ref readonly BoundingBox box) Parameters box BoundingBox The box to test. Returns bool Whether the two objects intersected. Intersects(ref readonly BoundingSphere) Determines if there is an intersection between the current object and a BoundingSphere. public bool Intersects(ref readonly BoundingSphere sphere) Parameters sphere BoundingSphere The sphere to test. Returns bool Whether the two objects intersected. Intersects(ref readonly Plane) Determines if there is an intersection between the current object and a Plane. public PlaneIntersectionType Intersects(ref readonly Plane plane) Parameters plane Plane The plane to test. Returns PlaneIntersectionType Whether the two objects intersected. Intersects(ref readonly Ray) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray) Parameters ray Ray The ray to test. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray, out Vector3) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray, out Vector3 point) Parameters ray Ray The ray to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray, out float) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray, out float distance) Parameters ray Ray The ray to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3) Determines if there is an intersection between the current object and a triangle. public bool Intersects(ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3) Parameters vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triagnle to test. vertex3 Vector3 The third vertex of the triangle to test. Returns bool Whether the two objects intersected. Merge(BoundingSphere, BoundingSphere) Constructs a BoundingSphere that is the as large as the total combined area of the two specified spheres. public static BoundingSphere Merge(BoundingSphere value1, BoundingSphere value2) Parameters value1 BoundingSphere The first sphere to merge. value2 BoundingSphere The second sphere to merge. Returns BoundingSphere The newly constructed bounding sphere. Merge(ref readonly BoundingSphere, ref readonly BoundingSphere, out BoundingSphere) Constructs a BoundingSphere that is the as large as the total combined area of the two specified spheres. public static void Merge(ref readonly BoundingSphere value1, ref readonly BoundingSphere value2, out BoundingSphere result) Parameters value1 BoundingSphere The first sphere to merge. value2 BoundingSphere The second sphere to merge. result BoundingSphere When the method completes, contains the newly constructed bounding sphere. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transform(ref readonly BoundingSphere, ref readonly Matrix, out BoundingSphere) Transforms a bounding sphere, yielding the bounding sphere of all points contained by the original one, transformed by the specified transform. public static void Transform(ref readonly BoundingSphere value, ref readonly Matrix transform, out BoundingSphere result) Parameters value BoundingSphere The original bounding sphere. transform Matrix The transform to apply to the bounding sphere. result BoundingSphere The transformed bounding sphere. Operators operator ==(BoundingSphere, BoundingSphere) Tests for equality between two objects. public static bool operator ==(BoundingSphere left, BoundingSphere right) Parameters left BoundingSphere The first value to compare. right BoundingSphere The second value to compare. Returns bool true if left has the same value as right; otherwise, false. operator !=(BoundingSphere, BoundingSphere) Tests for inequality between two objects. public static bool operator !=(BoundingSphere left, BoundingSphere right) Parameters left BoundingSphere The first value to compare. right BoundingSphere The second value to compare. Returns bool true if left has a different value than right; otherwise, false."
  },
  "api/Stride.Core.Mathematics.CollisionHelper.html": {
    "href": "api/Stride.Core.Mathematics.CollisionHelper.html",
    "title": "Class CollisionHelper | Stride API",
    "summary": "Class CollisionHelper Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Contains static methods to help in determining intersections, containment, etc. public static class CollisionHelper Inheritance object CollisionHelper Methods BoxContainsBox(ref readonly BoundingBox, ref readonly BoundingBox) Determines whether a BoundingBox contains a BoundingBox. public static ContainmentType BoxContainsBox(ref readonly BoundingBox box1, ref readonly BoundingBox box2) Parameters box1 BoundingBox The first box to test. box2 BoundingBox The second box to test. Returns ContainmentType The type of containment the two objects have. BoxContainsPoint(ref readonly BoundingBox, ref readonly Vector3) Determines whether a BoundingBox contains a point. public static ContainmentType BoxContainsPoint(ref readonly BoundingBox box, ref readonly Vector3 point) Parameters box BoundingBox The box to test. point Vector3 The point to test. Returns ContainmentType The type of containment the two objects have. BoxContainsSphere(ref readonly BoundingBox, ref readonly BoundingSphere) Determines whether a BoundingBox contains a BoundingSphere. public static ContainmentType BoxContainsSphere(ref readonly BoundingBox box, ref readonly BoundingSphere sphere) Parameters box BoundingBox The box to test. sphere BoundingSphere The sphere to test. Returns ContainmentType The type of containment the two objects have. BoxIntersectsBox(ref readonly BoundingBox, ref readonly BoundingBox) Determines whether there is an intersection between a BoundingBox and a BoundingBox. public static bool BoxIntersectsBox(ref readonly BoundingBox box1, ref readonly BoundingBox box2) Parameters box1 BoundingBox The first box to test. box2 BoundingBox The second box to test. Returns bool Whether the two objects intersected. BoxIntersectsSphere(ref readonly BoundingBox, ref readonly BoundingSphere) Determines whether there is an intersection between a BoundingBox and a BoundingSphere. public static bool BoxIntersectsSphere(ref readonly BoundingBox box, ref readonly BoundingSphere sphere) Parameters box BoundingBox The box to test. sphere BoundingSphere The sphere to test. Returns bool Whether the two objects intersected. ClosestPointBoxPoint(ref readonly BoundingBox, ref readonly Vector3, out Vector3) Determines the closest point between a BoundingBox and a point. public static void ClosestPointBoxPoint(ref readonly BoundingBox box, ref readonly Vector3 point, out Vector3 result) Parameters box BoundingBox The box to test. point Vector3 The point to test. result Vector3 When the method completes, contains the closest point between the two objects. ClosestPointPlanePoint(ref readonly Plane, ref readonly Vector3, out Vector3) Determines the closest point between a Plane and a point. public static void ClosestPointPlanePoint(ref readonly Plane plane, ref readonly Vector3 point, out Vector3 result) Parameters plane Plane The plane to test. point Vector3 The point to test. result Vector3 When the method completes, contains the closest point between the two objects. ClosestPointPointTriangle(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, out Vector3) Determines the closest point between a point and a triangle. public static void ClosestPointPointTriangle(ref readonly Vector3 point, ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3, out Vector3 result) Parameters point Vector3 The point to test. vertex1 Vector3 The first vertex to test. vertex2 Vector3 The second vertex to test. vertex3 Vector3 The third vertex to test. result Vector3 When the method completes, contains the closest point between the two objects. ClosestPointSpherePoint(ref readonly BoundingSphere, ref readonly Vector3, out Vector3) Determines the closest point between a BoundingSphere and a point. public static void ClosestPointSpherePoint(ref readonly BoundingSphere sphere, ref readonly Vector3 point, out Vector3 result) Parameters sphere BoundingSphere The bounding sphere. point Vector3 The point to test. result Vector3 When the method completes, contains the closest point between the two objects; or, if the point is directly in the center of the sphere, contains Zero. ClosestPointSphereSphere(ref readonly BoundingSphere, ref readonly BoundingSphere, out Vector3) Determines the closest point between a BoundingSphere and a BoundingSphere. public static void ClosestPointSphereSphere(ref readonly BoundingSphere sphere1, ref readonly BoundingSphere sphere2, out Vector3 result) Parameters sphere1 BoundingSphere The first sphere to test. sphere2 BoundingSphere The second sphere to test. result Vector3 When the method completes, contains the closest point between the two objects; or, if the point is directly in the center of the sphere, contains Zero. Remarks If the two spheres are overlapping, but not directly ontop of each other, the closest point is the 'closest' point of intersection. This can also be considered is the deepest point of intersection. DistanceBoxBox(ref readonly BoundingBox, ref readonly BoundingBox) Determines the distance between a BoundingBox and a BoundingBox. public static float DistanceBoxBox(ref readonly BoundingBox box1, ref readonly BoundingBox box2) Parameters box1 BoundingBox The first box to test. box2 BoundingBox The second box to test. Returns float The distance between the two objects. DistanceBoxPoint(ref readonly BoundingBox, ref readonly Vector3) Determines the distance between a BoundingBox and a point. public static float DistanceBoxPoint(ref readonly BoundingBox box, ref readonly Vector3 point) Parameters box BoundingBox The box to test. point Vector3 The point to test. Returns float The distance between the two objects. DistancePlanePoint(ref readonly Plane, ref readonly Vector3) Determines the distance between a Plane and a point. public static float DistancePlanePoint(ref readonly Plane plane, ref readonly Vector3 point) Parameters plane Plane The plane to test. point Vector3 The point to test. Returns float The distance between the two objects. DistanceSpherePoint(ref readonly BoundingSphere, ref readonly Vector3) Determines the distance between a BoundingSphere and a point. public static float DistanceSpherePoint(ref readonly BoundingSphere sphere, ref readonly Vector3 point) Parameters sphere BoundingSphere The sphere to test. point Vector3 The point to test. Returns float The distance between the two objects. DistanceSphereSphere(ref readonly BoundingSphere, ref readonly BoundingSphere) Determines the distance between a BoundingSphere and a BoundingSphere. public static float DistanceSphereSphere(ref readonly BoundingSphere sphere1, ref readonly BoundingSphere sphere2) Parameters sphere1 BoundingSphere The first sphere to test. sphere2 BoundingSphere The second sphere to test. Returns float The distance between the two objects. FrustumContainsBox(ref readonly BoundingFrustum, ref readonly BoundingBoxExt) Determines whether a BoundingFrustum intersects or contains an AABB determined by its center and extent. Faster variant specific for frustum culling. public static bool FrustumContainsBox(ref readonly BoundingFrustum frustum, ref readonly BoundingBoxExt boundingBoxExt) Parameters frustum BoundingFrustum The frustum. boundingBoxExt BoundingBoxExt The bounding box ext. Returns bool true if XXXX, false otherwise. GetNearestHit<T>(IEnumerable<T>, ref readonly Ray, out T, out float, out Vector3) Retrieves the nearest hit object starting from the position of the ray in the direction of the ray. public static bool GetNearestHit<T>(IEnumerable<T> objects, ref readonly Ray ray, out T hitObject, out float distance, out Vector3 point) where T : struct, IIntersectableWithRay Parameters objects IEnumerable<T> The objects that get tested for a collision with the ray. ray Ray The ray. hitObject T The hit object. distance float The distance from the start of the ray. point Vector3 The position of the collision. Returns bool Whether there was a hit. Type Parameters T LinePlaneIntersection(Plane, Vector3, Vector3, out Vector3) Determines whether there is an intersection between a Line and a Plane. public static bool LinePlaneIntersection(Plane plane, Vector3 point1, Vector3 point2, out Vector3 intersection) Parameters plane Plane The plane to test. point1 Vector3 The first point of the line to test. point2 Vector3 The second point of the line to test. intersection Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. PlaneIntersectsBox(ref readonly Plane, ref readonly BoundingBox) Determines whether there is an intersection between a Plane and a BoundingBox. public static PlaneIntersectionType PlaneIntersectsBox(ref readonly Plane plane, ref readonly BoundingBox box) Parameters plane Plane The plane to test. box BoundingBox The box to test. Returns PlaneIntersectionType Whether the two objects intersected. PlaneIntersectsPlane(ref readonly Plane, ref readonly Plane) Determines whether there is an intersection between a Plane and a Plane. public static bool PlaneIntersectsPlane(ref readonly Plane plane1, ref readonly Plane plane2) Parameters plane1 Plane The first plane to test. plane2 Plane The second plane to test. Returns bool Whether the two objects intersected. PlaneIntersectsPlane(ref readonly Plane, ref readonly Plane, out Ray) Determines whether there is an intersection between a Plane and a Plane. public static bool PlaneIntersectsPlane(ref readonly Plane plane1, ref readonly Plane plane2, out Ray line) Parameters plane1 Plane The first plane to test. plane2 Plane The second plane to test. line Ray When the method completes, contains the line of intersection as a Ray, or a zero ray if there was no intersection. Returns bool Whether the two objects intersected. Remarks Although a ray is set to have an origin, the ray returned by this method is really a line in three dimensions which has no real origin. The ray is considered valid when both the positive direction is used and when the negative direction is used. PlaneIntersectsPoint(ref readonly Plane, ref readonly Vector3) Determines whether there is an intersection between a Plane and a point. public static PlaneIntersectionType PlaneIntersectsPoint(ref readonly Plane plane, ref readonly Vector3 point) Parameters plane Plane The plane to test. point Vector3 The point to test. Returns PlaneIntersectionType Whether the two objects intersected. PlaneIntersectsSphere(ref readonly Plane, ref readonly BoundingSphere) Determines whether there is an intersection between a Plane and a BoundingSphere. public static PlaneIntersectionType PlaneIntersectsSphere(ref readonly Plane plane, ref readonly BoundingSphere sphere) Parameters plane Plane The plane to test. sphere BoundingSphere The sphere to test. Returns PlaneIntersectionType Whether the two objects intersected. PlaneIntersectsTriangle(ref readonly Plane, ref readonly Vector3, ref readonly Vector3, ref readonly Vector3) Determines whether there is an intersection between a Plane and a triangle. public static PlaneIntersectionType PlaneIntersectsTriangle(ref readonly Plane plane, ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3) Parameters plane Plane The plane to test. vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triagnle to test. vertex3 Vector3 The third vertex of the triangle to test. Returns PlaneIntersectionType Whether the two objects intersected. RayIntersectsBox(ref readonly Ray, ref readonly BoundingBox, out Vector3) Determines whether there is an intersection between a Ray and a BoundingBox. public static bool RayIntersectsBox(ref readonly Ray ray, ref readonly BoundingBox box, out Vector3 point) Parameters ray Ray The ray to test. box BoundingBox The box to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. RayIntersectsBox(ref readonly Ray, ref readonly BoundingBox, out float) Determines whether there is an intersection between a Ray and a BoundingBox. public static bool RayIntersectsBox(ref readonly Ray ray, ref readonly BoundingBox box, out float distance) Parameters ray Ray The ray to test. box BoundingBox The box to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected. RayIntersectsPlane(ref readonly Ray, ref readonly Plane, out Vector3) Determines whether there is an intersection between a Ray and a Plane. public static bool RayIntersectsPlane(ref readonly Ray ray, ref readonly Plane plane, out Vector3 point) Parameters ray Ray The ray to test. plane Plane The plane to test point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. RayIntersectsPlane(ref readonly Ray, ref readonly Plane, out float) Determines whether there is an intersection between a Ray and a Plane. public static bool RayIntersectsPlane(ref readonly Ray ray, ref readonly Plane plane, out float distance) Parameters ray Ray The ray to test. plane Plane The plane to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersect. RayIntersectsPoint(ref readonly Ray, ref readonly Vector3) Determines whether there is an intersection between a Ray and a point. public static bool RayIntersectsPoint(ref readonly Ray ray, ref readonly Vector3 point) Parameters ray Ray The ray to test. point Vector3 The point to test. Returns bool Whether the two objects intersect. RayIntersectsRay(ref readonly Ray, ref readonly Ray, out Vector3) Determines whether there is an intersection between a Ray and a Ray. public static bool RayIntersectsRay(ref readonly Ray ray1, ref readonly Ray ray2, out Vector3 point) Parameters ray1 Ray The first ray to test. ray2 Ray The second ray to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersect. Remarks This method performs a ray vs ray intersection test based on the following formula from Goldman. s = det([o_2 - o_1, d_2, d_1 x d_2]) / ||d_1 x d_2||^2 t = det([o_2 - o_1, d_1, d_1 x d_2]) / ||d_1 x d_2||^2 Where o_1 is the position of the first ray, o_2 is the position of the second ray, d_1 is the normalized direction of the first ray, d_2 is the normalized direction of the second ray, det denotes the determinant of a matrix, x denotes the cross product, [ ] denotes a matrix, and || || denotes the length or magnitude of a vector. RayIntersectsRectangle(ref readonly Ray, ref readonly Matrix, ref readonly Vector3, int, out Vector3) Determines whether there is an intersection between a Ray and a rectangle (2D). public static bool RayIntersectsRectangle(ref readonly Ray ray, ref readonly Matrix rectangleWorldMatrix, ref readonly Vector3 rectangleSize, int normalAxis, out Vector3 intersectionPoint) Parameters ray Ray The ray to test rectangleWorldMatrix Matrix The world matrix applied on the rectangle rectangleSize Vector3 The size of the rectangle in 3D normalAxis int The index of axis defining the normal of the rectangle in the world. This value should be 0, 1 or 2 intersectionPoint Vector3 The position of the intersection point in the world Returns bool true if the ray and rectangle intersects. RayIntersectsSphere(ref readonly Ray, ref readonly BoundingSphere, out Vector3) Determines whether there is an intersection between a Ray and a BoundingSphere. public static bool RayIntersectsSphere(ref readonly Ray ray, ref readonly BoundingSphere sphere, out Vector3 point) Parameters ray Ray The ray to test. sphere BoundingSphere The sphere to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. RayIntersectsSphere(ref readonly Ray, ref readonly BoundingSphere, out float) Determines whether there is an intersection between a Ray and a BoundingSphere. public static bool RayIntersectsSphere(ref readonly Ray ray, ref readonly BoundingSphere sphere, out float distance) Parameters ray Ray The ray to test. sphere BoundingSphere The sphere to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected. RayIntersectsTriangle(ref readonly Ray, ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, out Vector3) Determines whether there is an intersection between a Ray and a triangle. public static bool RayIntersectsTriangle(ref readonly Ray ray, ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3, out Vector3 point) Parameters ray Ray The ray to test. vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triangle to test. vertex3 Vector3 The third vertex of the triangle to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. RayIntersectsTriangle(ref readonly Ray, ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, out float) Determines whether there is an intersection between a Ray and a triangle. public static bool RayIntersectsTriangle(ref readonly Ray ray, ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3, out float distance) Parameters ray Ray The ray to test. vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triagnle to test. vertex3 Vector3 The third vertex of the triangle to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected. Remarks This method tests if the ray intersects either the front or back of the triangle. If the ray is parallel to the triangle's plane, no intersection is assumed to have happened. If the intersection of the ray and the triangle is behind the origin of the ray, no intersection is assumed to have happened. In both cases of assumptions, this method returns false. SphereContainsBox(ref readonly BoundingSphere, ref readonly BoundingBox) Determines whether a BoundingSphere contains a BoundingBox. public static ContainmentType SphereContainsBox(ref readonly BoundingSphere sphere, ref readonly BoundingBox box) Parameters sphere BoundingSphere The sphere to test. box BoundingBox The box to test. Returns ContainmentType The type of containment the two objects have. SphereContainsPoint(ref readonly BoundingSphere, ref readonly Vector3) Determines whether a BoundingSphere contains a point. public static ContainmentType SphereContainsPoint(ref readonly BoundingSphere sphere, ref readonly Vector3 point) Parameters sphere BoundingSphere The sphere to test. point Vector3 The point to test. Returns ContainmentType The type of containment the two objects have. SphereContainsSphere(ref readonly BoundingSphere, ref readonly BoundingSphere) Determines whether a BoundingSphere contains a BoundingSphere. public static ContainmentType SphereContainsSphere(ref readonly BoundingSphere sphere1, ref readonly BoundingSphere sphere2) Parameters sphere1 BoundingSphere The first sphere to test. sphere2 BoundingSphere The second sphere to test. Returns ContainmentType The type of containment the two objects have. SphereContainsTriangle(ref readonly BoundingSphere, ref readonly Vector3, ref readonly Vector3, ref readonly Vector3) Determines whether a BoundingSphere contains a triangle. public static ContainmentType SphereContainsTriangle(ref readonly BoundingSphere sphere, ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3) Parameters sphere BoundingSphere The sphere to test. vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triagnle to test. vertex3 Vector3 The third vertex of the triangle to test. Returns ContainmentType The type of containment the two objects have. SphereIntersectsSphere(ref readonly BoundingSphere, ref readonly BoundingSphere) Determines whether there is an intersection between a BoundingSphere and a BoundingSphere. public static bool SphereIntersectsSphere(ref readonly BoundingSphere sphere1, ref readonly BoundingSphere sphere2) Parameters sphere1 BoundingSphere First sphere to test. sphere2 BoundingSphere Second sphere to test. Returns bool Whether the two objects intersected. SphereIntersectsTriangle(ref readonly BoundingSphere, ref readonly Vector3, ref readonly Vector3, ref readonly Vector3) Determines whether there is an intersection between a BoundingSphere and a triangle. public static bool SphereIntersectsTriangle(ref readonly BoundingSphere sphere, ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3) Parameters sphere BoundingSphere The sphere to test. vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triagnle to test. vertex3 Vector3 The third vertex of the triangle to test. Returns bool Whether the two objects intersected."
  },
  "api/Stride.Core.Mathematics.Color.html": {
    "href": "api/Stride.Core.Mathematics.Color.html",
    "title": "Struct Color | Stride API",
    "summary": "Struct Color Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a 32-bit color (4 bytes) in the form of RGBA (in byte order: R, G, B, A). [DataContract(\"Color\")] [DataStyle(DataStyle.Compact)] public struct Color : IEquatable<Color> Implements IEquatable<Color> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Color(Vector3) Initializes a new instance of the Color struct. Alpha is set to 255. public Color(Vector3 value) Parameters value Vector3 The red, green, and blue components of the color. Color(Vector3, float) Initializes a new instance of the Color struct. public Color(Vector3 value, float alpha) Parameters value Vector3 The red, green, and blue components of the color. alpha float The alpha component of the color. Color(Vector4) Initializes a new instance of the Color struct. public Color(Vector4 value) Parameters value Vector4 The red, green, blue, and alpha components of the color. Color(byte) Initializes a new instance of the Color struct. public Color(byte value) Parameters value byte The value that will be assigned to all components. Color(byte, byte, byte) Initializes a new instance of the Color struct. Alpha is set to 255. public Color(byte red, byte green, byte blue) Parameters red byte The red component of the color. green byte The green component of the color. blue byte The blue component of the color. Color(byte, byte, byte, byte) Initializes a new instance of the Color struct. public Color(byte red, byte green, byte blue, byte alpha) Parameters red byte The red component of the color. green byte The green component of the color. blue byte The blue component of the color. alpha byte The alpha component of the color. Color(byte[]) Initializes a new instance of the Color struct. public Color(byte[] values) Parameters values byte[] The values to assign to the red, green, blue, or alpha components of the color. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Color(int) Initializes a new instance of the Color struct. public Color(int rgba) Parameters rgba int A packed integer containing all four color components in RGBA order. Color(float) Initializes a new instance of the Color struct. public Color(float value) Parameters value float The value that will be assigned to all components. Color(float, float, float) Initializes a new instance of the Color struct. Alpha is set to 255. public Color(float red, float green, float blue) Parameters red float The red component of the color. green float The green component of the color. blue float The blue component of the color. Color(float, float, float, float) Initializes a new instance of the Color struct. public Color(float red, float green, float blue, float alpha) Parameters red float The red component of the color. green float The green component of the color. blue float The blue component of the color. alpha float The alpha component of the color. Color(float[]) Initializes a new instance of the Color struct. public Color(float[] values) Parameters values float[] The values to assign to the red, green, and blue, alpha components of the color. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Color(uint) Initializes a new instance of the Color struct. public Color(uint rgba) Parameters rgba uint A packed integer containing all four color components in RGBA order. Fields A The alpha component of the color. [DataMember(3)] public byte A Field Value byte AliceBlue AliceBlue color. public static readonly Color AliceBlue Field Value Color AntiqueWhite AntiqueWhite color. public static readonly Color AntiqueWhite Field Value Color Aqua Aqua color. public static readonly Color Aqua Field Value Color Aquamarine Aquamarine color. public static readonly Color Aquamarine Field Value Color Azure Azure color. public static readonly Color Azure Field Value Color B The blue component of the color. [DataMember(2)] public byte B Field Value byte Beige Beige color. public static readonly Color Beige Field Value Color Bisque Bisque color. public static readonly Color Bisque Field Value Color Black Black color. public static readonly Color Black Field Value Color BlanchedAlmond BlanchedAlmond color. public static readonly Color BlanchedAlmond Field Value Color Blue Blue color. public static readonly Color Blue Field Value Color BlueViolet BlueViolet color. public static readonly Color BlueViolet Field Value Color Brown Brown color. public static readonly Color Brown Field Value Color BurlyWood BurlyWood color. public static readonly Color BurlyWood Field Value Color CadetBlue CadetBlue color. public static readonly Color CadetBlue Field Value Color Chartreuse Chartreuse color. public static readonly Color Chartreuse Field Value Color Chocolate Chocolate color. public static readonly Color Chocolate Field Value Color Coral Coral color. public static readonly Color Coral Field Value Color CornflowerBlue CornflowerBlue color. public static readonly Color CornflowerBlue Field Value Color Cornsilk Cornsilk color. public static readonly Color Cornsilk Field Value Color Crimson Crimson color. public static readonly Color Crimson Field Value Color Cyan Cyan color. public static readonly Color Cyan Field Value Color DarkBlue DarkBlue color. public static readonly Color DarkBlue Field Value Color DarkCyan DarkCyan color. public static readonly Color DarkCyan Field Value Color DarkGoldenrod DarkGoldenrod color. public static readonly Color DarkGoldenrod Field Value Color DarkGray DarkGray color. public static readonly Color DarkGray Field Value Color DarkGreen DarkGreen color. public static readonly Color DarkGreen Field Value Color DarkKhaki DarkKhaki color. public static readonly Color DarkKhaki Field Value Color DarkMagenta DarkMagenta color. public static readonly Color DarkMagenta Field Value Color DarkOliveGreen DarkOliveGreen color. public static readonly Color DarkOliveGreen Field Value Color DarkOrange DarkOrange color. public static readonly Color DarkOrange Field Value Color DarkOrchid DarkOrchid color. public static readonly Color DarkOrchid Field Value Color DarkRed DarkRed color. public static readonly Color DarkRed Field Value Color DarkSalmon DarkSalmon color. public static readonly Color DarkSalmon Field Value Color DarkSeaGreen DarkSeaGreen color. public static readonly Color DarkSeaGreen Field Value Color DarkSlateBlue DarkSlateBlue color. public static readonly Color DarkSlateBlue Field Value Color DarkSlateGray DarkSlateGray color. public static readonly Color DarkSlateGray Field Value Color DarkTurquoise DarkTurquoise color. public static readonly Color DarkTurquoise Field Value Color DarkViolet DarkViolet color. public static readonly Color DarkViolet Field Value Color DeepPink DeepPink color. public static readonly Color DeepPink Field Value Color DeepSkyBlue DeepSkyBlue color. public static readonly Color DeepSkyBlue Field Value Color DimGray DimGray color. public static readonly Color DimGray Field Value Color DodgerBlue DodgerBlue color. public static readonly Color DodgerBlue Field Value Color Firebrick Firebrick color. public static readonly Color Firebrick Field Value Color FloralWhite FloralWhite color. public static readonly Color FloralWhite Field Value Color ForestGreen ForestGreen color. public static readonly Color ForestGreen Field Value Color Fuchsia Fuchsia color. public static readonly Color Fuchsia Field Value Color G The green component of the color. [DataMember(1)] public byte G Field Value byte Gainsboro Gainsboro color. public static readonly Color Gainsboro Field Value Color GhostWhite GhostWhite color. public static readonly Color GhostWhite Field Value Color Gold Gold color. public static readonly Color Gold Field Value Color Goldenrod Goldenrod color. public static readonly Color Goldenrod Field Value Color Gray Gray color. public static readonly Color Gray Field Value Color Green Green color. public static readonly Color Green Field Value Color GreenYellow GreenYellow color. public static readonly Color GreenYellow Field Value Color Honeydew Honeydew color. public static readonly Color Honeydew Field Value Color HotPink HotPink color. public static readonly Color HotPink Field Value Color IndianRed IndianRed color. public static readonly Color IndianRed Field Value Color Indigo Indigo color. public static readonly Color Indigo Field Value Color Ivory Ivory color. public static readonly Color Ivory Field Value Color Khaki Khaki color. public static readonly Color Khaki Field Value Color Lavender Lavender color. public static readonly Color Lavender Field Value Color LavenderBlush LavenderBlush color. public static readonly Color LavenderBlush Field Value Color LawnGreen LawnGreen color. public static readonly Color LawnGreen Field Value Color LemonChiffon LemonChiffon color. public static readonly Color LemonChiffon Field Value Color LightBlue LightBlue color. public static readonly Color LightBlue Field Value Color LightCoral LightCoral color. public static readonly Color LightCoral Field Value Color LightCyan LightCyan color. public static readonly Color LightCyan Field Value Color LightGoldenrodYellow LightGoldenrodYellow color. public static readonly Color LightGoldenrodYellow Field Value Color LightGray LightGray color. public static readonly Color LightGray Field Value Color LightGreen LightGreen color. public static readonly Color LightGreen Field Value Color LightPink LightPink color. public static readonly Color LightPink Field Value Color LightSalmon LightSalmon color. public static readonly Color LightSalmon Field Value Color LightSeaGreen LightSeaGreen color. public static readonly Color LightSeaGreen Field Value Color LightSkyBlue LightSkyBlue color. public static readonly Color LightSkyBlue Field Value Color LightSlateGray LightSlateGray color. public static readonly Color LightSlateGray Field Value Color LightSteelBlue LightSteelBlue color. public static readonly Color LightSteelBlue Field Value Color LightYellow LightYellow color. public static readonly Color LightYellow Field Value Color Lime Lime color. public static readonly Color Lime Field Value Color LimeGreen LimeGreen color. public static readonly Color LimeGreen Field Value Color Linen Linen color. public static readonly Color Linen Field Value Color Magenta Magenta color. public static readonly Color Magenta Field Value Color Maroon Maroon color. public static readonly Color Maroon Field Value Color MediumAquamarine MediumAquamarine color. public static readonly Color MediumAquamarine Field Value Color MediumBlue MediumBlue color. public static readonly Color MediumBlue Field Value Color MediumOrchid MediumOrchid color. public static readonly Color MediumOrchid Field Value Color MediumPurple MediumPurple color. public static readonly Color MediumPurple Field Value Color MediumSeaGreen MediumSeaGreen color. public static readonly Color MediumSeaGreen Field Value Color MediumSlateBlue MediumSlateBlue color. public static readonly Color MediumSlateBlue Field Value Color MediumSpringGreen MediumSpringGreen color. public static readonly Color MediumSpringGreen Field Value Color MediumTurquoise MediumTurquoise color. public static readonly Color MediumTurquoise Field Value Color MediumVioletRed MediumVioletRed color. public static readonly Color MediumVioletRed Field Value Color MidnightBlue MidnightBlue color. public static readonly Color MidnightBlue Field Value Color MintCream MintCream color. public static readonly Color MintCream Field Value Color MistyRose MistyRose color. public static readonly Color MistyRose Field Value Color Moccasin Moccasin color. public static readonly Color Moccasin Field Value Color NavajoWhite NavajoWhite color. public static readonly Color NavajoWhite Field Value Color Navy Navy color. public static readonly Color Navy Field Value Color OldLace OldLace color. public static readonly Color OldLace Field Value Color Olive Olive color. public static readonly Color Olive Field Value Color OliveDrab OliveDrab color. public static readonly Color OliveDrab Field Value Color Orange Orange color. public static readonly Color Orange Field Value Color OrangeRed OrangeRed color. public static readonly Color OrangeRed Field Value Color Orchid Orchid color. public static readonly Color Orchid Field Value Color PaleGoldenrod PaleGoldenrod color. public static readonly Color PaleGoldenrod Field Value Color PaleGreen PaleGreen color. public static readonly Color PaleGreen Field Value Color PaleTurquoise PaleTurquoise color. public static readonly Color PaleTurquoise Field Value Color PaleVioletRed PaleVioletRed color. public static readonly Color PaleVioletRed Field Value Color PapayaWhip PapayaWhip color. public static readonly Color PapayaWhip Field Value Color PeachPuff PeachPuff color. public static readonly Color PeachPuff Field Value Color Peru Peru color. public static readonly Color Peru Field Value Color Pink Pink color. public static readonly Color Pink Field Value Color Plum Plum color. public static readonly Color Plum Field Value Color PowderBlue PowderBlue color. public static readonly Color PowderBlue Field Value Color Purple Purple color. public static readonly Color Purple Field Value Color R The red component of the color. [DataMember(0)] public byte R Field Value byte Red Red color. public static readonly Color Red Field Value Color RosyBrown RosyBrown color. public static readonly Color RosyBrown Field Value Color RoyalBlue RoyalBlue color. public static readonly Color RoyalBlue Field Value Color SaddleBrown SaddleBrown color. public static readonly Color SaddleBrown Field Value Color Salmon Salmon color. public static readonly Color Salmon Field Value Color SandyBrown SandyBrown color. public static readonly Color SandyBrown Field Value Color SeaGreen SeaGreen color. public static readonly Color SeaGreen Field Value Color SeaShell SeaShell color. public static readonly Color SeaShell Field Value Color Sienna Sienna color. public static readonly Color Sienna Field Value Color Silver Silver color. public static readonly Color Silver Field Value Color SkyBlue SkyBlue color. public static readonly Color SkyBlue Field Value Color SlateBlue SlateBlue color. public static readonly Color SlateBlue Field Value Color SlateGray SlateGray color. public static readonly Color SlateGray Field Value Color Snow Snow color. public static readonly Color Snow Field Value Color SpringGreen SpringGreen color. public static readonly Color SpringGreen Field Value Color SteelBlue SteelBlue color. public static readonly Color SteelBlue Field Value Color Tan Tan color. public static readonly Color Tan Field Value Color Teal Teal color. public static readonly Color Teal Field Value Color Thistle Thistle color. public static readonly Color Thistle Field Value Color Tomato Tomato color. public static readonly Color Tomato Field Value Color Transparent Transparent color. public static readonly Color Transparent Field Value Color Turquoise Turquoise color. public static readonly Color Turquoise Field Value Color VeryDimGray VeryDimGray color. public static readonly Color VeryDimGray Field Value Color Violet Violet color. public static readonly Color Violet Field Value Color Wheat Wheat color. public static readonly Color Wheat Field Value Color White White color. public static readonly Color White Field Value Color WhiteSmoke WhiteSmoke color. public static readonly Color WhiteSmoke Field Value Color Yellow Yellow color. public static readonly Color Yellow Field Value Color YellowGreen YellowGreen color. public static readonly Color YellowGreen Field Value Color Zero Zero color. public static readonly Color Zero Field Value Color Properties this[int] Gets or sets the component at the specified index. public byte this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the red(R) component, 1 for the green(G) component, 2 for the blue(B) component, and 3 for the alpha(A) component. Property Value byte The value of the red, green, blue, or alpha component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 3]. Methods Add(Color, Color) Adds two colors. public static Color Add(Color left, Color right) Parameters left Color The first color to add. right Color The second color to add. Returns Color The sum of the two colors. Add(ref readonly Color, ref readonly Color, out Color) Adds two colors. public static void Add(ref readonly Color left, ref readonly Color right, out Color result) Parameters left Color The first color to add. right Color The second color to add. result Color When the method completes, completes the sum of the two colors. AdjustContrast(Color, float) Adjusts the contrast of a color. public static Color AdjustContrast(Color value, float contrast) Parameters value Color The color whose contrast is to be adjusted. contrast float The amount by which to adjust the contrast. Returns Color The adjusted color. AdjustContrast(ref readonly Color, float, out Color) Adjusts the contrast of a color. public static void AdjustContrast(ref readonly Color value, float contrast, out Color result) Parameters value Color The color whose contrast is to be adjusted. contrast float The amount by which to adjust the contrast. result Color When the method completes, contains the adjusted color. AdjustSaturation(Color, float) Adjusts the saturation of a color. public static Color AdjustSaturation(Color value, float saturation) Parameters value Color The color whose saturation is to be adjusted. saturation float The amount by which to adjust the saturation. Returns Color The adjusted color. AdjustSaturation(ref readonly Color, float, out Color) Adjusts the saturation of a color. public static void AdjustSaturation(ref readonly Color value, float saturation, out Color result) Parameters value Color The color whose saturation is to be adjusted. saturation float The amount by which to adjust the saturation. result Color When the method completes, contains the adjusted color. Clamp(Color, Color, Color) Restricts a value to be within a specified range. public static Color Clamp(Color value, Color min, Color max) Parameters value Color The value to clamp. min Color The minimum value. max Color The maximum value. Returns Color The clamped value. Clamp(ref readonly Color, ref readonly Color, ref readonly Color, out Color) Restricts a value to be within a specified range. public static void Clamp(ref readonly Color value, ref readonly Color min, ref readonly Color max, out Color result) Parameters value Color The value to clamp. min Color The minimum value. max Color The maximum value. result Color When the method completes, contains the clamped value. Equals(Color) Determines whether the specified Color is equal to this instance. public readonly bool Equals(Color other) Parameters other Color The Color to compare with this instance. Returns bool true if the specified Color is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. FromAbgr(int) Converts the color from a packed ABGR integer. public static Color FromAbgr(int color) Parameters color int A packed integer containing all four color components in ABGR order Returns Color A color. FromAbgr(uint) Converts the color from a packed ABGR integer. public static Color FromAbgr(uint color) Parameters color uint A packed integer containing all four color components in ABGR order Returns Color A color. FromBgra(int) Converts the color from a packed BGRA integer. public static Color FromBgra(int color) Parameters color int A packed integer containing all four color components in BGRA order Returns Color A color. FromBgra(uint) Converts the color from a packed BGRA integer. public static Color FromBgra(uint color) Parameters color uint A packed integer containing all four color components in BGRA order Returns Color A color. FromRgba(int) Converts the color from a packed RGBA integer. public static Color FromRgba(int color) Parameters color int A packed integer containing all four color components in RGBA order Returns Color A color. FromRgba(uint) Converts the color from a packed RGBA integer. public static Color FromRgba(uint color) Parameters color uint A packed integer containing all four color components in RGBA order Returns Color A color. GetBrightness() Gets the brightness. public readonly float GetBrightness() Returns float The Hue-Saturation-Brightness (HSB) saturation for this Color GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. GetHue() Gets the hue. public readonly float GetHue() Returns float The Hue-Saturation-Brightness (HSB) saturation for this Color GetSaturation() Gets the saturation. public readonly float GetSaturation() Returns float The Hue-Saturation-Brightness (HSB) saturation for this Color Lerp(Color, Color, float) Performs a linear interpolation between two colors. public static Color Lerp(Color start, Color end, float amount) Parameters start Color Start color. end Color End color. amount float Value between 0 and 1 indicating the weight of end. Returns Color The linear interpolation of the two colors. Remarks Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Color, ref readonly Color, float, out Color) Performs a linear interpolation between two colors. public static void Lerp(ref readonly Color start, ref readonly Color end, float amount, out Color result) Parameters start Color Start color. end Color End color. amount float Value between 0 and 1 indicating the weight of end. result Color When the method completes, contains the linear interpolation of the two colors. Remarks Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Color, Color) Returns a color containing the largest components of the specified colorss. public static Color Max(Color left, Color right) Parameters left Color The first source color. right Color The second source color. Returns Color A color containing the largest components of the source colors. Max(ref readonly Color, ref readonly Color, out Color) Returns a color containing the smallest components of the specified colors. public static void Max(ref readonly Color left, ref readonly Color right, out Color result) Parameters left Color The first source color. right Color The second source color. result Color When the method completes, contains an new color composed of the largest components of the source colors. Min(Color, Color) Returns a color containing the smallest components of the specified colors. public static Color Min(Color left, Color right) Parameters left Color The first source color. right Color The second source color. Returns Color A color containing the smallest components of the source colors. Min(ref readonly Color, ref readonly Color, out Color) Returns a color containing the smallest components of the specified colors. public static void Min(ref readonly Color left, ref readonly Color right, out Color result) Parameters left Color The first source color. right Color The second source color. result Color When the method completes, contains an new color composed of the smallest components of the source colors. Modulate(Color, Color) Modulates two colors. public static Color Modulate(Color left, Color right) Parameters left Color The first color to modulate. right Color The second color to modulate. Returns Color The modulated color. Modulate(ref readonly Color, ref readonly Color, out Color) Modulates two colors. public static void Modulate(ref readonly Color left, ref readonly Color right, out Color result) Parameters left Color The first color to modulate. right Color The second color to modulate. result Color When the method completes, contains the modulated color. Negate(Color) Negates a color. public static Color Negate(Color value) Parameters value Color The color to negate. Returns Color The negated color. Negate(ref readonly Color, out Color) Negates a color. public static void Negate(ref readonly Color value, out Color result) Parameters value Color The color to negate. result Color When the method completes, contains the negated color. Scale(Color, float) Scales a color. public static Color Scale(Color value, float scale) Parameters value Color The color to scale. scale float The amount by which to scale. Returns Color The scaled color. Scale(ref readonly Color, float, out Color) Scales a color. public static void Scale(ref readonly Color value, float scale, out Color result) Parameters value Color The color to scale. scale float The amount by which to scale. result Color When the method completes, contains the scaled color. SmoothStep(Color, Color, float) Performs a cubic interpolation between two colors. public static Color SmoothStep(Color start, Color end, float amount) Parameters start Color Start color. end Color End color. amount float Value between 0 and 1 indicating the weight of end. Returns Color The cubic interpolation of the two colors. SmoothStep(ref readonly Color, ref readonly Color, float, out Color) Performs a cubic interpolation between two colors. public static void SmoothStep(ref readonly Color start, ref readonly Color end, float amount, out Color result) Parameters start Color Start color. end Color End color. amount float Value between 0 and 1 indicating the weight of end. result Color When the method completes, contains the cubic interpolation of the two colors. Subtract(Color, Color) Subtracts two colors. public static Color Subtract(Color left, Color right) Parameters left Color The first color to subtract. right Color The second color to subtract Returns Color The difference of the two colors. Subtract(ref readonly Color, ref readonly Color, out Color) Subtracts two colors. public static void Subtract(ref readonly Color left, ref readonly Color right, out Color result) Parameters left Color The first color to subtract. right Color The second color to subtract. result Color WHen the method completes, contains the difference of the two colors. ToAbgr() Converts the color into a packed integer. public readonly int ToAbgr() Returns int A packed integer containing all four color components. ToArgb() Converts the color into a packed integer. public readonly int ToArgb() Returns int A packed integer containing all four color components. ToArray() Creates an array containing the elements of the color. public readonly byte[] ToArray() Returns byte[] A four-element array containing the components of the color in RGBA order. ToBgra() Converts the color into a packed integer. public readonly int ToBgra() Returns int A packed integer containing all four color components. ToColor3() Converts the color into a three component color. public readonly Color3 ToColor3() Returns Color3 A three component color containing the red, green, and blue components of the color. ToColor4() Convert this instance to a Color4 public readonly Color4 ToColor4() Returns Color4 The result of the conversion. ToRgba() Converts the color into a packed integer. public readonly int ToRgba() Returns int A packed integer containing all four color components. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToVector3() Converts the color into a three component vector. public readonly Vector3 ToVector3() Returns Vector3 A three component vector containing the red, green, and blue components of the color. ToVector4() Converts the color into a four component vector. public readonly Vector4 ToVector4() Returns Vector4 A four component vector containing all four color components. Operators operator +(Color, Color) Adds two colors. public static Color operator +(Color left, Color right) Parameters left Color The first color to add. right Color The second color to add. Returns Color The sum of the two colors. operator ==(Color, Color) Tests for equality between two objects. public static bool operator ==(Color left, Color right) Parameters left Color The first value to compare. right Color The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Color3(Color) Performs an explicit conversion from Color to Color3. public static explicit operator Color3(Color value) Parameters value Color The value. Returns Color3 The result of the conversion. explicit operator Vector3(Color) Performs an explicit conversion from Color to Vector3. public static explicit operator Vector3(Color value) Parameters value Color The value. Returns Vector3 The result of the conversion. explicit operator Vector4(Color) Performs an explicit conversion from Color to Vector4. public static explicit operator Vector4(Color value) Parameters value Color The value. Returns Vector4 The result of the conversion. explicit operator int(Color) Performs an explicit conversion from int to Color. public static explicit operator int(Color value) Parameters value Color The value. Returns int The result of the conversion. explicit operator Color(Color3) Performs an explicit conversion from Color3 to Color. public static explicit operator Color(Color3 value) Parameters value Color3 The value. Returns Color The result of the conversion. explicit operator Color(Color4) Performs an explicit conversion from Color4 to Color. public static explicit operator Color(Color4 value) Parameters value Color4 The value. Returns Color The result of the conversion. explicit operator Color(Vector3) Performs an explicit conversion from Vector3 to Color. public static explicit operator Color(Vector3 value) Parameters value Vector3 The value. Returns Color The result of the conversion. explicit operator Color(Vector4) Performs an explicit conversion from Vector4 to Color. public static explicit operator Color(Vector4 value) Parameters value Vector4 The value. Returns Color The result of the conversion. explicit operator Color(int) Performs an explicit conversion from int to Color. public static explicit operator Color(int value) Parameters value int The value. Returns Color The result of the conversion. implicit operator Color4(Color) Performs an implicit conversion from Color to Color4. public static implicit operator Color4(Color value) Parameters value Color The value. Returns Color4 The result of the conversion. operator !=(Color, Color) Tests for inequality between two objects. public static bool operator !=(Color left, Color right) Parameters left Color The first value to compare. right Color The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Color, Color) Modulates two colors. public static Color operator *(Color left, Color right) Parameters left Color The first color to modulate. right Color The second color to modulate. Returns Color The modulated color. operator *(Color, float) Scales a color. public static Color operator *(Color value, float scale) Parameters value Color The factor by which to scale the color. scale float The color to scale. Returns Color The scaled color. operator *(float, Color) Scales a color. public static Color operator *(float scale, Color value) Parameters scale float The factor by which to scale the color. value Color The color to scale. Returns Color The scaled color. operator -(Color, Color) Subtracts two colors. public static Color operator -(Color left, Color right) Parameters left Color The first color to subtract. right Color The second color to subtract. Returns Color The difference of the two colors. operator -(Color) Negates a color. public static Color operator -(Color value) Parameters value Color The color to negate. Returns Color A negated color. operator +(Color) Assert a color (return it unchanged). public static Color operator +(Color value) Parameters value Color The color to assert (unchanged). Returns Color The asserted (unchanged) color."
  },
  "api/Stride.Core.Mathematics.Color3.html": {
    "href": "api/Stride.Core.Mathematics.Color3.html",
    "title": "Struct Color3 | Stride API",
    "summary": "Struct Color3 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a color in the form of rgb. [DataContract(\"Color3\")] [DataStyle(DataStyle.Compact)] public struct Color3 : IEquatable<Color3>, ISpanFormattable, IFormattable Implements IEquatable<Color3> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Color3(Vector3) Initializes a new instance of the Color3 struct. public Color3(Vector3 value) Parameters value Vector3 The red, green, and blue components of the color. Color3(int) Initializes a new instance of the Color3 struct. public Color3(int rgb) Parameters rgb int A packed integer containing all three color components. The alpha component is ignored. Color3(float) Initializes a new instance of the Color3 struct. public Color3(float value) Parameters value float The value that will be assigned to all components. Color3(float, float, float) Initializes a new instance of the Color3 struct. public Color3(float red, float green, float blue) Parameters red float The red component of the color. green float The green component of the color. blue float The blue component of the color. Color3(float[]) Initializes a new instance of the Color3 struct. public Color3(float[] values) Parameters values float[] The values to assign to the red, green, and blue components of the color. This must be an array with three elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Color3(uint) Initializes a new instance of the Color3 struct. public Color3(uint rgb) Parameters rgb uint A packed unsigned integer containing all three color components. The alpha component is ignored. Fields B The blue component of the color. [DataMember(2)] public float B Field Value float G The green component of the color. [DataMember(1)] public float G Field Value float R The red component of the color. [DataMember(0)] public float R Field Value float Properties this[int] Gets or sets the component at the specified index. public float this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the red component, 1 for the green component, and 2 for the blue component. Property Value float The value of the red, green, or blue component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 2]. Methods Add(Color3, Color3) Adds two colors. public static Color3 Add(Color3 left, Color3 right) Parameters left Color3 The first color to add. right Color3 The second color to add. Returns Color3 The sum of the two colors. Add(ref readonly Color3, ref readonly Color3, out Color3) Adds two colors. public static void Add(ref readonly Color3 left, ref readonly Color3 right, out Color3 result) Parameters left Color3 The first color to add. right Color3 The second color to add. result Color3 When the method completes, completes the sum of the two colors. AdjustContrast(Color3, float) Adjusts the contrast of a color. public static Color3 AdjustContrast(Color3 value, float contrast) Parameters value Color3 The color whose contrast is to be adjusted. contrast float The amount by which to adjust the contrast. Returns Color3 The adjusted color. AdjustContrast(ref readonly Color3, float, out Color3) Adjusts the contrast of a color. public static void AdjustContrast(ref readonly Color3 value, float contrast, out Color3 result) Parameters value Color3 The color whose contrast is to be adjusted. contrast float The amount by which to adjust the contrast. result Color3 When the method completes, contains the adjusted color. AdjustSaturation(Color3, float) Adjusts the saturation of a color. public static Color3 AdjustSaturation(Color3 value, float saturation) Parameters value Color3 The color whose saturation is to be adjusted. saturation float The amount by which to adjust the saturation. Returns Color3 The adjusted color. AdjustSaturation(ref readonly Color3, float, out Color3) Adjusts the saturation of a color. public static void AdjustSaturation(ref readonly Color3 value, float saturation, out Color3 result) Parameters value Color3 The color whose saturation is to be adjusted. saturation float The amount by which to adjust the saturation. result Color3 When the method completes, contains the adjusted color. Clamp(Color3, Color3, Color3) Restricts a value to be within a specified range. public static Color3 Clamp(Color3 value, Color3 min, Color3 max) Parameters value Color3 The value to clamp. min Color3 The minimum value. max Color3 The maximum value. Returns Color3 The clamped value. Clamp(ref readonly Color3, ref readonly Color3, ref readonly Color3, out Color3) Restricts a value to be within a specified range. public static void Clamp(ref readonly Color3 value, ref readonly Color3 min, ref readonly Color3 max, out Color3 result) Parameters value Color3 The value to clamp. min Color3 The minimum value. max Color3 The maximum value. result Color3 When the method completes, contains the clamped value. Deconstruct(out float, out float, out float) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out float r, out float g, out float b) Parameters r float The R component g float The G component b float The B component Equals(Color3) Determines whether the specified Color3 is equal to this instance. public readonly bool Equals(Color3 other) Parameters other Color3 The Color3 to compare with this instance. Returns bool true if the specified Color3 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Lerp(Color3, Color3, float) Performs a linear interpolation between two colors. public static Color3 Lerp(Color3 start, Color3 end, float amount) Parameters start Color3 Start color. end Color3 End color. amount float Value between 0 and 1 indicating the weight of end. Returns Color3 The linear interpolation of the two colors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Color3, ref readonly Color3, float, out Color3) Performs a linear interpolation between two colors. public static void Lerp(ref readonly Color3 start, ref readonly Color3 end, float amount, out Color3 result) Parameters start Color3 Start color. end Color3 End color. amount float Value between 0 and 1 indicating the weight of end. result Color3 When the method completes, contains the linear interpolation of the two colors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Color3, Color3) Returns a color containing the largest components of the specified colorss. public static Color3 Max(Color3 left, Color3 right) Parameters left Color3 The first source color. right Color3 The second source color. Returns Color3 A color containing the largest components of the source colors. Max(ref readonly Color3, ref readonly Color3, out Color3) Returns a color containing the smallest components of the specified colorss. public static void Max(ref readonly Color3 left, ref readonly Color3 right, out Color3 result) Parameters left Color3 The first source color. right Color3 The second source color. result Color3 When the method completes, contains an new color composed of the largest components of the source colorss. Min(Color3, Color3) Returns a color containing the smallest components of the specified colors. public static Color3 Min(Color3 left, Color3 right) Parameters left Color3 The first source color. right Color3 The second source color. Returns Color3 A color containing the smallest components of the source colors. Min(ref readonly Color3, ref readonly Color3, out Color3) Returns a color containing the smallest components of the specified colors. public static void Min(ref readonly Color3 left, ref readonly Color3 right, out Color3 result) Parameters left Color3 The first source color. right Color3 The second source color. result Color3 When the method completes, contains an new color composed of the smallest components of the source colors. Modulate(Color3, Color3) Modulates two colors. public static Color3 Modulate(Color3 left, Color3 right) Parameters left Color3 The first color to modulate. right Color3 The second color to modulate. Returns Color3 The modulated color. Modulate(ref readonly Color3, ref readonly Color3, out Color3) Modulates two colors. public static void Modulate(ref readonly Color3 left, ref readonly Color3 right, out Color3 result) Parameters left Color3 The first color to modulate. right Color3 The second color to modulate. result Color3 When the method completes, contains the modulated color. Negate(Color3) Negates a color. public static Color3 Negate(Color3 value) Parameters value Color3 The color to negate. Returns Color3 The negated color. Negate(ref readonly Color3, out Color3) Negates a color. public static void Negate(ref readonly Color3 value, out Color3 result) Parameters value Color3 The color to negate. result Color3 When the method completes, contains the negated color. Pow(float) Raises the exponent for each components. public void Pow(float exponent) Parameters exponent float The exponent. Scale(Color3, float) Scales a color. public static Color3 Scale(Color3 value, float scale) Parameters value Color3 The color to scale. scale float The amount by which to scale. Returns Color3 The scaled color. Scale(ref readonly Color3, float, out Color3) Scales a color. public static void Scale(ref readonly Color3 value, float scale, out Color3 result) Parameters value Color3 The color to scale. scale float The amount by which to scale. result Color3 When the method completes, contains the scaled color. SmoothStep(Color3, Color3, float) Performs a cubic interpolation between two colors. public static Color3 SmoothStep(Color3 start, Color3 end, float amount) Parameters start Color3 Start color. end Color3 End color. amount float Value between 0 and 1 indicating the weight of end. Returns Color3 The cubic interpolation of the two colors. SmoothStep(ref readonly Color3, ref readonly Color3, float, out Color3) Performs a cubic interpolation between two colors. public static void SmoothStep(ref readonly Color3 start, ref readonly Color3 end, float amount, out Color3 result) Parameters start Color3 Start color. end Color3 End color. amount float Value between 0 and 1 indicating the weight of end. result Color3 When the method completes, contains the cubic interpolation of the two colors. Subtract(Color3, Color3) Subtracts two colors. public static Color3 Subtract(Color3 left, Color3 right) Parameters left Color3 The first color to subtract. right Color3 The second color to subtract Returns Color3 The difference of the two colors. Subtract(ref readonly Color3, ref readonly Color3, out Color3) Subtracts two colors. public static void Subtract(ref readonly Color3 left, ref readonly Color3 right, out Color3 result) Parameters left Color3 The first color to subtract. right Color3 The second color to subtract. result Color3 WHen the method completes, contains the difference of the two colors. ToArray() Creates an array containing the elements of the color. public readonly float[] ToArray() Returns float[] A three-element array containing the components of the color. ToColor4() Convert this color to an equivalent Color4 with an opaque alpha. public readonly Color4 ToColor4() Returns Color4 An equivalent Color4 with an opaque alpha. ToLinear() Converts this color from sRGB space to linear space. public readonly Color3 ToLinear() Returns Color3 Color3. ToRgb() Converts the color into a packed integer. public readonly int ToRgb() Returns int A packed integer containing all three color components. The alpha channel is set to 255. ToSRgb() Converts this color from linear space to sRGB space. public readonly Color3 ToSRgb() Returns Color3 A color3 in sRGB space. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. ToVector3() Converts the color into a three component vector. public readonly Vector3 ToVector3() Returns Vector3 A three component vector containing the red, green, and blue components of the color. Operators operator +(Color3, Color3) Adds two colors. public static Color3 operator +(Color3 left, Color3 right) Parameters left Color3 The first color to add. right Color3 The second color to add. Returns Color3 The sum of the two colors. operator ==(Color3, Color3) Tests for equality between two objects. public static bool operator ==(Color3 left, Color3 right) Parameters left Color3 The first value to compare. right Color3 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Color4(Color3) Performs an explicit conversion from Color3 to Color4. public static explicit operator Color4(Color3 value) Parameters value Color3 The value. Returns Color4 The result of the conversion. explicit operator Vector3(Color3) Performs an explicit conversion from Color3 to Vector3. public static explicit operator Vector3(Color3 value) Parameters value Color3 The value. Returns Vector3 The result of the conversion. explicit operator Color3(Vector3) Performs an explicit conversion from Vector3 to Color3. public static explicit operator Color3(Vector3 value) Parameters value Vector3 The value. Returns Color3 The result of the conversion. explicit operator Color3(int) Performs an explicit conversion from int to Color3. public static explicit operator Color3(int value) Parameters value int The value. Returns Color3 The result of the conversion. operator !=(Color3, Color3) Tests for inequality between two objects. public static bool operator !=(Color3 left, Color3 right) Parameters left Color3 The first value to compare. right Color3 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Color3, Color3) Modulates two colors. public static Color3 operator *(Color3 left, Color3 right) Parameters left Color3 The first color to modulate. right Color3 The second color to modulate. Returns Color3 The modulated color. operator *(Color3, float) Scales a color. public static Color3 operator *(Color3 value, float scale) Parameters value Color3 The factor by which to scale the color. scale float The color to scale. Returns Color3 The scaled color. operator *(float, Color3) Scales a color. public static Color3 operator *(float scale, Color3 value) Parameters scale float The factor by which to scale the color. value Color3 The color to scale. Returns Color3 The scaled color. operator -(Color3, Color3) Subtracts two colors. public static Color3 operator -(Color3 left, Color3 right) Parameters left Color3 The first color to subtract. right Color3 The second color to subtract. Returns Color3 The difference of the two colors. operator -(Color3) Negates a color. public static Color3 operator -(Color3 value) Parameters value Color3 The color to negate. Returns Color3 A negated color. operator +(Color3) Assert a color (return it unchanged). public static Color3 operator +(Color3 value) Parameters value Color3 The color to assert (unchange). Returns Color3 The asserted (unchanged) color."
  },
  "api/Stride.Core.Mathematics.Color4.html": {
    "href": "api/Stride.Core.Mathematics.Color4.html",
    "title": "Struct Color4 | Stride API",
    "summary": "Struct Color4 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll A RGBA color value with 32-bit floating-point precision per channel. [DataContract(\"Color4\")] [DataStyle(DataStyle.Compact)] public struct Color4 : IEquatable<Color4>, ISpanFormattable, IFormattable Implements IEquatable<Color4> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Color4(Color) Initializes a new instance of the Color4 struct. public Color4(Color color) Parameters color Color Color used to initialize the color. Color4(Color3) Initializes a new instance of the Color4 struct. public Color4(Color3 color) Parameters color Color3 Color3 used to initialize the color. Color4(Color3, float) Initializes a new instance of the Color4 struct. public Color4(Color3 color, float alpha = 1) Parameters color Color3 Color3 used to initialize the color. alpha float The alpha component of the color. Color4(ColorBGRA) Initializes a new instance of the Color4 struct. public Color4(ColorBGRA color) Parameters color ColorBGRA Color used to initialize the color. Color4(Vector3, float) Initializes a new instance of the Color4 struct. public Color4(Vector3 value, float alpha = 1) Parameters value Vector3 The red, green, and blue components of the color. alpha float The alpha component of the color. Color4(Vector4) Initializes a new instance of the Color4 struct. public Color4(Vector4 value) Parameters value Vector4 The red, green, blue, and alpha components of the color. Color4(int) Initializes a new instance of the Color4 struct. public Color4(int rgba) Parameters rgba int A packed integer containing all four color components in RGBA order. Color4(float) Initializes a new instance of the Color4 struct. public Color4(float value) Parameters value float The value that will be assigned to all components. Color4(float, float, float, float) Initializes a new instance of the Color4 struct. public Color4(float red, float green, float blue, float alpha = 1) Parameters red float The red component of the color. green float The green component of the color. blue float The blue component of the color. alpha float The alpha component of the color. Color4(float[]) Initializes a new instance of the Color4 struct. public Color4(float[] values) Parameters values float[] The values to assign to the red, green, blue, and alpha components of the color. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Color4(uint) Initializes a new instance of the Color4 struct. public Color4(uint rgba) Parameters rgba uint A packed integer containing all four color components in RGBA order. Fields A The alpha component of the color. [DataMember(3)] public float A Field Value float B The blue component of the color. [DataMember(2)] public float B Field Value float Black The Black color (0, 0, 0, 1). public static readonly Color4 Black Field Value Color4 G The green component of the color. [DataMember(1)] public float G Field Value float R The red component of the color. [DataMember(0)] public float R Field Value float TransparentBlack The transparent black color (0, 0, 0, 0). public static readonly Color4 TransparentBlack Field Value Color4 White The White color (1, 1, 1, 1). public static readonly Color4 White Field Value Color4 Properties this[int] Gets or sets the component at the specified index. public float this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the alpha component, 1 for the red component, 2 for the green component, and 3 for the blue component. Property Value float The value of the red, green, blue, and alpha components, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 3]. Methods Add(Color4, Color4) Adds two colors. public static Color4 Add(Color4 left, Color4 right) Parameters left Color4 The first color to add. right Color4 The second color to add. Returns Color4 The sum of the two colors. Add(ref readonly Color4, ref readonly Color4, out Color4) Adds two colors. public static void Add(ref readonly Color4 left, ref readonly Color4 right, out Color4 result) Parameters left Color4 The first color to add. right Color4 The second color to add. result Color4 When the method completes, completes the sum of the two colors. AdjustContrast(Color4, float) Adjusts the contrast of a color. public static Color4 AdjustContrast(Color4 value, float contrast) Parameters value Color4 The color whose contrast is to be adjusted. contrast float The amount by which to adjust the contrast. Returns Color4 The adjusted color. AdjustContrast(ref readonly Color4, float, out Color4) Adjusts the contrast of a color. public static void AdjustContrast(ref readonly Color4 value, float contrast, out Color4 result) Parameters value Color4 The color whose contrast is to be adjusted. contrast float The amount by which to adjust the contrast. result Color4 When the method completes, contains the adjusted color. AdjustSaturation(Color4, float) Adjusts the saturation of a color. public static Color4 AdjustSaturation(Color4 value, float saturation) Parameters value Color4 The color whose saturation is to be adjusted. saturation float The amount by which to adjust the saturation. Returns Color4 The adjusted color. AdjustSaturation(ref readonly Color4, float, out Color4) Adjusts the saturation of a color. public static void AdjustSaturation(ref readonly Color4 value, float saturation, out Color4 result) Parameters value Color4 The color whose saturation is to be adjusted. saturation float The amount by which to adjust the saturation. result Color4 When the method completes, contains the adjusted color. Clamp(Color4, Color4, Color4) Restricts a value to be within a specified range. public static Color4 Clamp(Color4 value, Color4 min, Color4 max) Parameters value Color4 The value to clamp. min Color4 The minimum value. max Color4 The maximum value. Returns Color4 The clamped value. Clamp(ref readonly Color4, ref readonly Color4, ref readonly Color4, out Color4) Restricts a value to be within a specified range. public static void Clamp(ref readonly Color4 value, ref readonly Color4 min, ref readonly Color4 max, out Color4 result) Parameters value Color4 The value to clamp. min Color4 The minimum value. max Color4 The maximum value. result Color4 When the method completes, contains the clamped value. Deconstruct(out float, out float, out float, out float) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out float r, out float g, out float b, out float a) Parameters r float The R component g float The G component b float The B component a float The A component Equals(Color4) Determines whether the specified Color4 is equal to this instance. public readonly bool Equals(Color4 other) Parameters other Color4 The Color4 to compare with this instance. Returns bool true if the specified Color4 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Lerp(Color4, Color4, float) Performs a linear interpolation between two colors. public static Color4 Lerp(Color4 start, Color4 end, float amount) Parameters start Color4 Start color. end Color4 End color. amount float Value between 0 and 1 indicating the weight of end. Returns Color4 The linear interpolation of the two colors. Remarks Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Color4, ref readonly Color4, float, out Color4) Performs a linear interpolation between two colors. public static void Lerp(ref readonly Color4 start, ref readonly Color4 end, float amount, out Color4 result) Parameters start Color4 Start color. end Color4 End color. amount float Value between 0 and 1 indicating the weight of end. result Color4 When the method completes, contains the linear interpolation of the two colors. Remarks Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Color4, Color4) Returns a color containing the largest components of the specified colors. public static Color4 Max(Color4 left, Color4 right) Parameters left Color4 The first source color. right Color4 The second source color. Returns Color4 A color containing the largest components of the source colors. Max(ref readonly Color4, ref readonly Color4, out Color4) Returns a color containing the smallest components of the specified colors. public static void Max(ref readonly Color4 left, ref readonly Color4 right, out Color4 result) Parameters left Color4 The first source color. right Color4 The second source color. result Color4 When the method completes, contains an new color composed of the largest components of the source colors. Min(Color4, Color4) Returns a color containing the smallest components of the specified colors. public static Color4 Min(Color4 left, Color4 right) Parameters left Color4 The first source color. right Color4 The second source color. Returns Color4 A color containing the smallest components of the source colors. Min(ref readonly Color4, ref readonly Color4, out Color4) Returns a color containing the smallest components of the specified colors. public static void Min(ref readonly Color4 left, ref readonly Color4 right, out Color4 result) Parameters left Color4 The first source color. right Color4 The second source color. result Color4 When the method completes, contains an new color composed of the smallest components of the source colors. Modulate(Color4, Color4) Modulates two colors. public static Color4 Modulate(Color4 left, Color4 right) Parameters left Color4 The first color to modulate. right Color4 The second color to modulate. Returns Color4 The modulated color. Modulate(ref readonly Color4, ref readonly Color4, out Color4) Modulates two colors. public static void Modulate(ref readonly Color4 left, ref readonly Color4 right, out Color4 result) Parameters left Color4 The first color to modulate. right Color4 The second color to modulate. result Color4 When the method completes, contains the modulated color. Negate(Color4) Negates a color. public static Color4 Negate(Color4 value) Parameters value Color4 The color to negate. Returns Color4 The negated color. Negate(ref readonly Color4, out Color4) Negates a color. public static void Negate(ref readonly Color4 value, out Color4 result) Parameters value Color4 The color to negate. result Color4 When the method completes, contains the negated color. PremultiplyAlpha(Color4) Premultiplies the color components by the alpha value. public static Color4 PremultiplyAlpha(Color4 value) Parameters value Color4 The color to premultiply. Returns Color4 A color with premultiplied alpha. Scale(Color4, float) Scales a color. public static Color4 Scale(Color4 value, float scale) Parameters value Color4 The color to scale. scale float The amount by which to scale. Returns Color4 The scaled color. Scale(ref readonly Color4, float, out Color4) Scales a color. public static void Scale(ref readonly Color4 value, float scale, out Color4 result) Parameters value Color4 The color to scale. scale float The amount by which to scale. result Color4 When the method completes, contains the scaled color. SmoothStep(Color4, Color4, float) Performs a cubic interpolation between two colors. public static Color4 SmoothStep(Color4 start, Color4 end, float amount) Parameters start Color4 Start color. end Color4 End color. amount float Value between 0 and 1 indicating the weight of end. Returns Color4 The cubic interpolation of the two colors. SmoothStep(ref readonly Color4, ref readonly Color4, float, out Color4) Performs a cubic interpolation between two colors. public static void SmoothStep(ref readonly Color4 start, ref readonly Color4 end, float amount, out Color4 result) Parameters start Color4 Start color. end Color4 End color. amount float Value between 0 and 1 indicating the weight of end. result Color4 When the method completes, contains the cubic interpolation of the two colors. Subtract(Color4, Color4) Subtracts two colors. public static Color4 Subtract(Color4 left, Color4 right) Parameters left Color4 The first color to subtract. right Color4 The second color to subtract Returns Color4 The difference of the two colors. Subtract(ref readonly Color4, ref readonly Color4, out Color4) Subtracts two colors. public static void Subtract(ref readonly Color4 left, ref readonly Color4 right, out Color4 result) Parameters left Color4 The first color to subtract. right Color4 The second color to subtract. result Color4 WHen the method completes, contains the difference of the two colors. ToArray() Creates an array containing the elements of the color. public readonly float[] ToArray() Returns float[] A four-element array containing the components of the color. ToBgra() Converts the color into a packed integer. public readonly int ToBgra() Returns int A packed integer containing all four color components. ToBgra(out byte, out byte, out byte, out byte) Converts the color into a packed integer. public readonly void ToBgra(out byte r, out byte g, out byte b, out byte a) Parameters r byte g byte b byte a byte ToColor3() Converts this color to an equivalent Color3, discarding the alpha channel. public readonly Color3 ToColor3() Returns Color3 An equivalent Color3, discarding the alpha channel. ToLinear() Converts this color from sRGB space to linear space. public readonly Color4 ToLinear() Returns Color4 A color4 in linear space. ToRgba() Converts the color into a packed integer. public readonly int ToRgba() Returns int A packed integer containing all four color components. ToSRgb() Converts this color from linear space to sRGB space. public readonly Color4 ToSRgb() Returns Color4 A color3 in sRGB space. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. ToVector3() Converts the color into a three component vector. public readonly Vector3 ToVector3() Returns Vector3 A three component vector containing the red, green, and blue components of the color. ToVector4() Converts the color into a four component vector. public readonly Vector4 ToVector4() Returns Vector4 A four component vector containing all four color components. Operators operator +(Color4, Color4) Adds two colors. public static Color4 operator +(Color4 left, Color4 right) Parameters left Color4 The first color to add. right Color4 The second color to add. Returns Color4 The sum of the two colors. operator ==(Color4, Color4) Tests for equality between two objects. public static bool operator ==(Color4 left, Color4 right) Parameters left Color4 The first value to compare. right Color4 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Color3(Color4) Performs an explicit conversion from Color4 to Color3. public static explicit operator Color3(Color4 value) Parameters value Color4 The value. Returns Color3 The result of the conversion. explicit operator ColorBGRA(Color4) Performs an explicit conversion from Vector4 to Color4. public static explicit operator ColorBGRA(Color4 value) Parameters value Color4 The value. Returns ColorBGRA The result of the conversion. explicit operator Vector3(Color4) Performs an explicit conversion from Color4 to Vector3. public static explicit operator Vector3(Color4 value) Parameters value Color4 The value. Returns Vector3 The result of the conversion. explicit operator int(Color4) Performs an explicit conversion from Color4 to int. public static explicit operator int(Color4 value) Parameters value Color4 The value. Returns int The result of the conversion. explicit operator Color4(ColorBGRA) Performs an explicit conversion from Vector3 to Color4. public static explicit operator Color4(ColorBGRA value) Parameters value ColorBGRA The value. Returns Color4 The result of the conversion. explicit operator Color4(Vector3) Performs an explicit conversion from Vector3 to Color4. public static explicit operator Color4(Vector3 value) Parameters value Vector3 The value. Returns Color4 The result of the conversion. explicit operator Color4(Vector4) Performs an explicit conversion from Vector4 to Color4. public static explicit operator Color4(Vector4 value) Parameters value Vector4 The value. Returns Color4 The result of the conversion. explicit operator Color4(int) Performs an explicit conversion from int to Color4. public static explicit operator Color4(int value) Parameters value int The value. Returns Color4 The result of the conversion. implicit operator Vector4(Color4) Performs an implicit conversion from Color4 to Vector4. public static implicit operator Vector4(Color4 value) Parameters value Color4 The value. Returns Vector4 The result of the conversion. operator !=(Color4, Color4) Tests for inequality between two objects. public static bool operator !=(Color4 left, Color4 right) Parameters left Color4 The first value to compare. right Color4 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Color4, Color4) Modulates two colors. public static Color4 operator *(Color4 left, Color4 right) Parameters left Color4 The first color to modulate. right Color4 The second color to modulate. Returns Color4 The modulated color. operator *(Color4, float) Scales a color. public static Color4 operator *(Color4 value, float scale) Parameters value Color4 The factor by which to scale the color. scale float The color to scale. Returns Color4 The scaled color. operator *(float, Color4) Scales a color. public static Color4 operator *(float scale, Color4 value) Parameters scale float The factor by which to scale the color. value Color4 The color to scale. Returns Color4 The scaled color. operator -(Color4, Color4) Subtracts two colors. public static Color4 operator -(Color4 left, Color4 right) Parameters left Color4 The first color to subtract. right Color4 The second color to subtract. Returns Color4 The difference of the two colors. operator -(Color4) Negates a color. public static Color4 operator -(Color4 value) Parameters value Color4 The color to negate. Returns Color4 A negated color. operator +(Color4) Assert a color (return it unchanged). public static Color4 operator +(Color4 value) Parameters value Color4 The color to assert (unchanged). Returns Color4 The asserted (unchanged) color."
  },
  "api/Stride.Core.Mathematics.ColorBGRA.html": {
    "href": "api/Stride.Core.Mathematics.ColorBGRA.html",
    "title": "Struct ColorBGRA | Stride API",
    "summary": "Struct ColorBGRA Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a 32-bit color (4 bytes) in the form of BGRA (in byte order: B, G, R, A). [DataContract(\"ColorBGRA\")] [DataStyle(DataStyle.Compact)] public struct ColorBGRA : IEquatable<ColorBGRA>, ISpanFormattable, IFormattable Implements IEquatable<ColorBGRA> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ColorBGRA(Vector3, float) Initializes a new instance of the ColorBGRA struct. public ColorBGRA(Vector3 value, float alpha) Parameters value Vector3 The red, green, and blue components of the color. alpha float The alpha component of the color. ColorBGRA(Vector4) Initializes a new instance of the ColorBGRA struct. public ColorBGRA(Vector4 value) Parameters value Vector4 The red, green, blue, and alpha components of the color. ColorBGRA(byte) Initializes a new instance of the ColorBGRA struct. public ColorBGRA(byte value) Parameters value byte The value that will be assigned to all components. ColorBGRA(byte, byte, byte, byte) Initializes a new instance of the ColorBGRA struct. public ColorBGRA(byte red, byte green, byte blue, byte alpha) Parameters red byte The red component of the color. green byte The green component of the color. blue byte The blue component of the color. alpha byte The alpha component of the color. ColorBGRA(byte[]) Initializes a new instance of the ColorBGRA struct. public ColorBGRA(byte[] values) Parameters values byte[] The values to assign to the red, green, and blue, alpha components of the color. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. ColorBGRA(int) Initializes a new instance of the ColorBGRA struct. public ColorBGRA(int bgra) Parameters bgra int A packed integer containing all four color components in BGRA. ColorBGRA(float) Initializes a new instance of the ColorBGRA struct. public ColorBGRA(float value) Parameters value float The value that will be assigned to all components. ColorBGRA(float, float, float, float) Initializes a new instance of the ColorBGRA struct. public ColorBGRA(float red, float green, float blue, float alpha) Parameters red float The red component of the color. green float The green component of the color. blue float The blue component of the color. alpha float The alpha component of the color. ColorBGRA(float[]) Initializes a new instance of the ColorBGRA struct. public ColorBGRA(float[] values) Parameters values float[] The values to assign to the red, green, and blue, alpha components of the color. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. ColorBGRA(uint) Initializes a new instance of the ColorBGRA struct. public ColorBGRA(uint bgra) Parameters bgra uint A packed integer containing all four color components in BGRA order. Fields A The alpha component of the color. [DataMember(3)] public byte A Field Value byte B The blue component of the color. [DataMember(0)] public byte B Field Value byte G The green component of the color. [DataMember(1)] public byte G Field Value byte R The red component of the color. [DataMember(2)] public byte R Field Value byte Properties this[int] Gets or sets the component at the specified index. public byte this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the alpha component, 1 for the red component, 2 for the green component, and 3 for the blue component. Property Value byte The value of the alpha, red, green, or blue component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 3]. Methods Add(ColorBGRA, ColorBGRA) Adds two colors. public static ColorBGRA Add(ColorBGRA left, ColorBGRA right) Parameters left ColorBGRA The first color to add. right ColorBGRA The second color to add. Returns ColorBGRA The sum of the two colors. Add(ref readonly ColorBGRA, ref readonly ColorBGRA, out ColorBGRA) Adds two colors. public static void Add(ref readonly ColorBGRA left, ref readonly ColorBGRA right, out ColorBGRA result) Parameters left ColorBGRA The first color to add. right ColorBGRA The second color to add. result ColorBGRA When the method completes, completes the sum of the two colors. AdjustContrast(ColorBGRA, float) Adjusts the contrast of a color. public static ColorBGRA AdjustContrast(ColorBGRA value, float contrast) Parameters value ColorBGRA The color whose contrast is to be adjusted. contrast float The amount by which to adjust the contrast. Returns ColorBGRA The adjusted color. AdjustContrast(ref readonly ColorBGRA, float, out ColorBGRA) Adjusts the contrast of a color. public static void AdjustContrast(ref readonly ColorBGRA value, float contrast, out ColorBGRA result) Parameters value ColorBGRA The color whose contrast is to be adjusted. contrast float The amount by which to adjust the contrast. result ColorBGRA When the method completes, contains the adjusted color. AdjustSaturation(ColorBGRA, float) Adjusts the saturation of a color. public static ColorBGRA AdjustSaturation(ColorBGRA value, float saturation) Parameters value ColorBGRA The color whose saturation is to be adjusted. saturation float The amount by which to adjust the saturation. Returns ColorBGRA The adjusted color. AdjustSaturation(ref readonly ColorBGRA, float, out ColorBGRA) Adjusts the saturation of a color. public static void AdjustSaturation(ref readonly ColorBGRA value, float saturation, out ColorBGRA result) Parameters value ColorBGRA The color whose saturation is to be adjusted. saturation float The amount by which to adjust the saturation. result ColorBGRA When the method completes, contains the adjusted color. Clamp(ColorBGRA, ColorBGRA, ColorBGRA) Restricts a value to be within a specified range. public static ColorBGRA Clamp(ColorBGRA value, ColorBGRA min, ColorBGRA max) Parameters value ColorBGRA The value to clamp. min ColorBGRA The minimum value. max ColorBGRA The maximum value. Returns ColorBGRA The clamped value. Clamp(ref readonly ColorBGRA, ref readonly ColorBGRA, ref readonly ColorBGRA, out ColorBGRA) Restricts a value to be within a specified range. public static void Clamp(ref readonly ColorBGRA value, ref readonly ColorBGRA min, ref readonly ColorBGRA max, out ColorBGRA result) Parameters value ColorBGRA The value to clamp. min ColorBGRA The minimum value. max ColorBGRA The maximum value. result ColorBGRA When the method completes, contains the clamped value. Deconstruct(out byte, out byte, out byte, out byte) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out byte r, out byte g, out byte b, out byte a) Parameters r byte The R component g byte The G component b byte The B component a byte The A component Equals(ColorBGRA) Determines whether the specified ColorBGRA is equal to this instance. public readonly bool Equals(ColorBGRA other) Parameters other ColorBGRA The ColorBGRA to compare with this instance. Returns bool true if the specified ColorBGRA is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. FromBgra(int) Converts the color from a packed BGRA integer. public static ColorBGRA FromBgra(int color) Parameters color int A packed integer containing all four color components in BGRA order Returns ColorBGRA A color. FromBgra(uint) Converts the color from a packed BGRA integer. public static ColorBGRA FromBgra(uint color) Parameters color uint A packed integer containing all four color components in BGRA order Returns ColorBGRA A color. FromRgba(int) Converts the color from a packed RGBA integer. public static ColorBGRA FromRgba(int color) Parameters color int A packed integer containing all four color components in RGBA order Returns ColorBGRA A color. FromRgba(uint) Converts the color from a packed RGBA integer. public static ColorBGRA FromRgba(uint color) Parameters color uint A packed integer containing all four color components in RGBA order Returns ColorBGRA A color. GetBrightness() Gets the brightness. public readonly float GetBrightness() Returns float The Hue-Saturation-Brightness (HSB) saturation for this Color GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. GetHue() Gets the hue. public readonly float GetHue() Returns float The Hue-Saturation-Brightness (HSB) saturation for this Color GetSaturation() Gets the saturation. public readonly float GetSaturation() Returns float The Hue-Saturation-Brightness (HSB) saturation for this Color Lerp(ColorBGRA, ColorBGRA, float) Performs a linear interpolation between two colors. public static ColorBGRA Lerp(ColorBGRA start, ColorBGRA end, float amount) Parameters start ColorBGRA Start color. end ColorBGRA End color. amount float Value between 0 and 1 indicating the weight of end. Returns ColorBGRA The linear interpolation of the two colors. Remarks Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly ColorBGRA, ref readonly ColorBGRA, float, out ColorBGRA) Performs a linear interpolation between two colors. public static void Lerp(ref readonly ColorBGRA start, ref readonly ColorBGRA end, float amount, out ColorBGRA result) Parameters start ColorBGRA Start color. end ColorBGRA End color. amount float Value between 0 and 1 indicating the weight of end. result ColorBGRA When the method completes, contains the linear interpolation of the two colors. Remarks Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(ColorBGRA, ColorBGRA) Returns a color containing the largest components of the specified colorss. public static ColorBGRA Max(ColorBGRA left, ColorBGRA right) Parameters left ColorBGRA The first source color. right ColorBGRA The second source color. Returns ColorBGRA A color containing the largest components of the source colors. Max(ref readonly ColorBGRA, ref readonly ColorBGRA, out ColorBGRA) Returns a color containing the smallest components of the specified colorss. public static void Max(ref readonly ColorBGRA left, ref readonly ColorBGRA right, out ColorBGRA result) Parameters left ColorBGRA The first source color. right ColorBGRA The second source color. result ColorBGRA When the method completes, contains an new color composed of the largest components of the source colorss. Min(ColorBGRA, ColorBGRA) Returns a color containing the smallest components of the specified colors. public static ColorBGRA Min(ColorBGRA left, ColorBGRA right) Parameters left ColorBGRA The first source color. right ColorBGRA The second source color. Returns ColorBGRA A color containing the smallest components of the source colors. Min(ref readonly ColorBGRA, ref readonly ColorBGRA, out ColorBGRA) Returns a color containing the smallest components of the specified colors. public static void Min(ref readonly ColorBGRA left, ref readonly ColorBGRA right, out ColorBGRA result) Parameters left ColorBGRA The first source color. right ColorBGRA The second source color. result ColorBGRA When the method completes, contains an new color composed of the smallest components of the source colors. Modulate(ColorBGRA, ColorBGRA) Modulates two colors. public static ColorBGRA Modulate(ColorBGRA left, ColorBGRA right) Parameters left ColorBGRA The first color to modulate. right ColorBGRA The second color to modulate. Returns ColorBGRA The modulated color. Modulate(ref readonly ColorBGRA, ref readonly ColorBGRA, out ColorBGRA) Modulates two colors. public static void Modulate(ref readonly ColorBGRA left, ref readonly ColorBGRA right, out ColorBGRA result) Parameters left ColorBGRA The first color to modulate. right ColorBGRA The second color to modulate. result ColorBGRA When the method completes, contains the modulated color. Negate(ColorBGRA) Negates a color. public static ColorBGRA Negate(ColorBGRA value) Parameters value ColorBGRA The color to negate. Returns ColorBGRA The negated color. Negate(ref readonly ColorBGRA, out ColorBGRA) Negates a color. public static void Negate(ref readonly ColorBGRA value, out ColorBGRA result) Parameters value ColorBGRA The color to negate. result ColorBGRA When the method completes, contains the negated color. Scale(ColorBGRA, float) Scales a color. public static ColorBGRA Scale(ColorBGRA value, float scale) Parameters value ColorBGRA The color to scale. scale float The amount by which to scale. Returns ColorBGRA The scaled color. Scale(ref readonly ColorBGRA, float, out ColorBGRA) Scales a color. public static void Scale(ref readonly ColorBGRA value, float scale, out ColorBGRA result) Parameters value ColorBGRA The color to scale. scale float The amount by which to scale. result ColorBGRA When the method completes, contains the scaled color. SmoothStep(ColorBGRA, ColorBGRA, float) Performs a cubic interpolation between two colors. public static ColorBGRA SmoothStep(ColorBGRA start, ColorBGRA end, float amount) Parameters start ColorBGRA Start color. end ColorBGRA End color. amount float Value between 0 and 1 indicating the weight of end. Returns ColorBGRA The cubic interpolation of the two colors. SmoothStep(ref readonly ColorBGRA, ref readonly ColorBGRA, float, out ColorBGRA) Performs a cubic interpolation between two colors. public static void SmoothStep(ref readonly ColorBGRA start, ref readonly ColorBGRA end, float amount, out ColorBGRA result) Parameters start ColorBGRA Start color. end ColorBGRA End color. amount float Value between 0 and 1 indicating the weight of end. result ColorBGRA When the method completes, contains the cubic interpolation of the two colors. Subtract(ColorBGRA, ColorBGRA) Subtracts two colors. public static ColorBGRA Subtract(ColorBGRA left, ColorBGRA right) Parameters left ColorBGRA The first color to subtract. right ColorBGRA The second color to subtract Returns ColorBGRA The difference of the two colors. Subtract(ref readonly ColorBGRA, ref readonly ColorBGRA, out ColorBGRA) Subtracts two colors. public static void Subtract(ref readonly ColorBGRA left, ref readonly ColorBGRA right, out ColorBGRA result) Parameters left ColorBGRA The first color to subtract. right ColorBGRA The second color to subtract. result ColorBGRA WHen the method completes, contains the difference of the two colors. ToArray() Creates an array containing the elements of the color. public readonly byte[] ToArray() Returns byte[] A four-element array containing the components of the color in BGRA order. ToBgra() Converts the color into a packed integer. public readonly int ToBgra() Returns int A packed integer containing all four color components. ToColor3() Converts the color into a three component color. public readonly Color3 ToColor3() Returns Color3 A three component color containing the red, green, and blue components of the color. ToRgba() Converts the color into a packed integer. public readonly int ToRgba() Returns int A packed integer containing all four color components. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. ToVector3() Converts the color into a three component vector. public readonly Vector3 ToVector3() Returns Vector3 A three component vector containing the red, green, and blue components of the color. ToVector4() Converts the color into a four component vector. public readonly Vector4 ToVector4() Returns Vector4 A four component vector containing all four color components. Operators operator +(ColorBGRA, ColorBGRA) Adds two colors. public static ColorBGRA operator +(ColorBGRA left, ColorBGRA right) Parameters left ColorBGRA The first color to add. right ColorBGRA The second color to add. Returns ColorBGRA The sum of the two colors. operator ==(ColorBGRA, ColorBGRA) Tests for equality between two objects. public static bool operator ==(ColorBGRA left, ColorBGRA right) Parameters left ColorBGRA The first value to compare. right ColorBGRA The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator ColorBGRA(Color3) Performs an explicit conversion from Color3 to ColorBGRA. public static explicit operator ColorBGRA(Color3 value) Parameters value Color3 The value. Returns ColorBGRA The result of the conversion. explicit operator ColorBGRA(Color4) Performs an explicit conversion from Color4 to ColorBGRA. public static explicit operator ColorBGRA(Color4 value) Parameters value Color4 The value. Returns ColorBGRA The result of the conversion. explicit operator Color3(ColorBGRA) Performs an explicit conversion from ColorBGRA to Color3. public static explicit operator Color3(ColorBGRA value) Parameters value ColorBGRA The value. Returns Color3 The result of the conversion. explicit operator Color4(ColorBGRA) Performs an explicit conversion from ColorBGRA to Color4. public static explicit operator Color4(ColorBGRA value) Parameters value ColorBGRA The value. Returns Color4 The result of the conversion. explicit operator Vector3(ColorBGRA) Performs an explicit conversion from ColorBGRA to Vector3. public static explicit operator Vector3(ColorBGRA value) Parameters value ColorBGRA The value. Returns Vector3 The result of the conversion. explicit operator Vector4(ColorBGRA) Performs an explicit conversion from ColorBGRA to Vector4. public static explicit operator Vector4(ColorBGRA value) Parameters value ColorBGRA The value. Returns Vector4 The result of the conversion. explicit operator int(ColorBGRA) Performs an explicit conversion from ColorBGRA to int. public static explicit operator int(ColorBGRA value) Parameters value ColorBGRA The value. Returns int The result of the conversion. explicit operator ColorBGRA(Vector3) Performs an explicit conversion from Vector3 to ColorBGRA. public static explicit operator ColorBGRA(Vector3 value) Parameters value Vector3 The value. Returns ColorBGRA The result of the conversion. explicit operator ColorBGRA(Vector4) Performs an explicit conversion from Vector4 to ColorBGRA. public static explicit operator ColorBGRA(Vector4 value) Parameters value Vector4 The value. Returns ColorBGRA The result of the conversion. explicit operator ColorBGRA(int) Performs an explicit conversion from int to ColorBGRA. public static explicit operator ColorBGRA(int value) Parameters value int The value. Returns ColorBGRA The result of the conversion. implicit operator ColorBGRA(Color) Performs an implicit conversion from Color to ColorBGRA. public static implicit operator ColorBGRA(Color value) Parameters value Color The value. Returns ColorBGRA The result of the conversion. implicit operator Color(ColorBGRA) Performs an implicit conversion from ColorBGRA to Color. public static implicit operator Color(ColorBGRA value) Parameters value ColorBGRA The value. Returns Color The result of the conversion. operator !=(ColorBGRA, ColorBGRA) Tests for inequality between two objects. public static bool operator !=(ColorBGRA left, ColorBGRA right) Parameters left ColorBGRA The first value to compare. right ColorBGRA The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(ColorBGRA, ColorBGRA) Modulates two colors. public static ColorBGRA operator *(ColorBGRA left, ColorBGRA right) Parameters left ColorBGRA The first color to modulate. right ColorBGRA The second color to modulate. Returns ColorBGRA The modulated color. operator *(ColorBGRA, float) Scales a color. public static ColorBGRA operator *(ColorBGRA value, float scale) Parameters value ColorBGRA The factor by which to scale the color. scale float The color to scale. Returns ColorBGRA The scaled color. operator *(float, ColorBGRA) Scales a color. public static ColorBGRA operator *(float scale, ColorBGRA value) Parameters scale float The factor by which to scale the color. value ColorBGRA The color to scale. Returns ColorBGRA The scaled color. operator -(ColorBGRA, ColorBGRA) Subtracts two colors. public static ColorBGRA operator -(ColorBGRA left, ColorBGRA right) Parameters left ColorBGRA The first color to subtract. right ColorBGRA The second color to subtract. Returns ColorBGRA The difference of the two colors. operator -(ColorBGRA) Negates a color. public static ColorBGRA operator -(ColorBGRA value) Parameters value ColorBGRA The color to negate. Returns ColorBGRA A negated color. operator +(ColorBGRA) Assert a color (return it unchanged). public static ColorBGRA operator +(ColorBGRA value) Parameters value ColorBGRA The color to assert (unchange). Returns ColorBGRA The asserted (unchanged) color."
  },
  "api/Stride.Core.Mathematics.ColorExtensions.html": {
    "href": "api/Stride.Core.Mathematics.ColorExtensions.html",
    "title": "Class ColorExtensions | Stride API",
    "summary": "Class ColorExtensions Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll A class containing extension methods for processing colors. public static class ColorExtensions Inheritance object ColorExtensions Methods CanConvertStringToRgba(string?) Indicates if the given string can be converted to an uint RGBA value using StringToRgba(string?). public static bool CanConvertStringToRgba(string? stringColor) Parameters stringColor string The string to convert. Returns bool True if the string can be converted, false otherwise. RgbToString(int) Converts the given RGB value to a string. public static string RgbToString(int value) Parameters value int The RGB value to convert. Returns string The converted string. RgbaToString(int) Converts the given RGBA value to a string. public static string RgbaToString(int value) Parameters value int The RGBA value to convert. Returns string The converted string. StringToRgba(string?) Converts the given string to an uint RGBA value. public static uint StringToRgba(string? stringColor) Parameters stringColor string The string to convert. Returns uint The converted RGBA value."
  },
  "api/Stride.Core.Mathematics.ColorHSV.html": {
    "href": "api/Stride.Core.Mathematics.ColorHSV.html",
    "title": "Struct ColorHSV | Stride API",
    "summary": "Struct ColorHSV Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a color in the form of Hue, Saturation, Value, Alpha. [DataContract(\"ColorHSV\")] public struct ColorHSV : IEquatable<ColorHSV>, ISpanFormattable, IFormattable Implements IEquatable<ColorHSV> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ColorHSV(float, float, float, float) Initializes a new instance of the ColorHSV struct. public ColorHSV(float h, float s, float v, float a) Parameters h float The h. s float The s. v float The v. a float A. Fields A The alpha component of the color. [DataMember(3)] public float A Field Value float H The Hue of the color. [DataMember(0)] public float H Field Value float S The Saturation of the color. [DataMember(1)] public float S Field Value float V The Value of the color. [DataMember(2)] public float V Field Value float Methods Deconstruct(out float, out float, out float, out float) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out float h, out float s, out float v, out float a) Parameters h float The H component s float The S component v float The V component a float The A component Equals(ColorHSV) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(ColorHSV other) Parameters other ColorHSV An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FromColor(Color4) Converts the color into a HSV color. public static ColorHSV FromColor(Color4 color) Parameters color Color4 The color. Returns ColorHSV A HSV color GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToColor() Converts the color into a three component vector. public readonly Color4 ToColor() Returns Color4 A three component vector containing the red, green, and blue components of the color. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance."
  },
  "api/Stride.Core.Mathematics.ContainmentType.html": {
    "href": "api/Stride.Core.Mathematics.ContainmentType.html",
    "title": "Enum ContainmentType | Stride API",
    "summary": "Enum ContainmentType Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Describes how one bounding volume contains another. public enum ContainmentType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Contains = 1 One bounding volume completely contains another. Disjoint = 0 The two bounding volumes don't intersect at all. Intersects = 2 The two bounding volumes overlap."
  },
  "api/Stride.Core.Mathematics.Double2.html": {
    "href": "api/Stride.Core.Mathematics.Double2.html",
    "title": "Struct Double2 | Stride API",
    "summary": "Struct Double2 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a two dimensional mathematical vector with double-precision floats. [DataContract(\"double2\")] [DataStyle(DataStyle.Compact)] public struct Double2 : IEquatable<Double2>, ISpanFormattable, IFormattable Implements IEquatable<Double2> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Double2(Vector2) Initializes a new instance of the Double2 struct. public Double2(Vector2 v) Parameters v Vector2 The Vector2 to construct the Double2 from. Double2(double) Initializes a new instance of the Double2 struct. public Double2(double value) Parameters value double The value that will be assigned to all components. Double2(double, double) Initializes a new instance of the Double2 struct. public Double2(double x, double y) Parameters x double Initial value for the X component of the vector. y double Initial value for the Y component of the vector. Double2(double[]) Initializes a new instance of the Double2 struct. public Double2(double[] values) Parameters values double[] The values to assign to the X and Y components of the vector. This must be an array with two elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than two elements. Fields One A Double2 with all of its components set to one. public static readonly Double2 One Field Value Double2 SizeInBytes The size of the Double2 type, in bytes. public static readonly int SizeInBytes Field Value int UnitX The X unit Double2 (1, 0). public static readonly Double2 UnitX Field Value Double2 UnitY The Y unit Double2 (0, 1). public static readonly Double2 UnitY Field Value Double2 X The X component of the vector. [DataMember(0)] public double X Field Value double Y The Y component of the vector. [DataMember(1)] public double Y Field Value double Zero A Double2 with all of its components set to zero. public static readonly Double2 Zero Field Value Double2 Properties IsNormalized Gets a value indicting whether this instance is normalized. public readonly bool IsNormalized { get; } Property Value bool this[int] Gets or sets the component at the specified index. public double this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the X component and 1 for the Y component. Property Value double The value of the X or Y component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 1]. Methods Add(Double2, Double2) Adds two vectors. public static Double2 Add(Double2 left, Double2 right) Parameters left Double2 The first vector to add. right Double2 The second vector to add. Returns Double2 The sum of the two vectors. Add(ref readonly Double2, ref readonly Double2, out Double2) Adds two vectors. public static void Add(ref readonly Double2 left, ref readonly Double2 right, out Double2 result) Parameters left Double2 The first vector to add. right Double2 The second vector to add. result Double2 When the method completes, contains the sum of the two vectors. Barycentric(Double2, Double2, Double2, double, double) Returns a Double2 containing the 2D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle. public static Double2 Barycentric(Double2 value1, Double2 value2, Double2 value3, double amount1, double amount2) Parameters value1 Double2 A Double2 containing the 2D Cartesian coordinates of vertex 1 of the triangle. value2 Double2 A Double2 containing the 2D Cartesian coordinates of vertex 2 of the triangle. value3 Double2 A Double2 containing the 2D Cartesian coordinates of vertex 3 of the triangle. amount1 double Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 double Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). Returns Double2 A new Double2 containing the 2D Cartesian coordinates of the specified point. Barycentric(ref readonly Double2, ref readonly Double2, ref readonly Double2, double, double, out Double2) Returns a Double2 containing the 2D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle. public static void Barycentric(ref readonly Double2 value1, ref readonly Double2 value2, ref readonly Double2 value3, double amount1, double amount2, out Double2 result) Parameters value1 Double2 A Double2 containing the 2D Cartesian coordinates of vertex 1 of the triangle. value2 Double2 A Double2 containing the 2D Cartesian coordinates of vertex 2 of the triangle. value3 Double2 A Double2 containing the 2D Cartesian coordinates of vertex 3 of the triangle. amount1 double Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 double Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). result Double2 When the method completes, contains the 2D Cartesian coordinates of the specified point. CatmullRom(Double2, Double2, Double2, Double2, double) Performs a Catmull-Rom interpolation using the specified positions. public static Double2 CatmullRom(Double2 value1, Double2 value2, Double2 value3, Double2 value4, double amount) Parameters value1 Double2 The first position in the interpolation. value2 Double2 The second position in the interpolation. value3 Double2 The third position in the interpolation. value4 Double2 The fourth position in the interpolation. amount double Weighting factor. Returns Double2 A vector that is the result of the Catmull-Rom interpolation. CatmullRom(ref readonly Double2, ref readonly Double2, ref readonly Double2, ref readonly Double2, double, out Double2) Performs a Catmull-Rom interpolation using the specified positions. public static void CatmullRom(ref readonly Double2 value1, ref readonly Double2 value2, ref readonly Double2 value3, ref readonly Double2 value4, double amount, out Double2 result) Parameters value1 Double2 The first position in the interpolation. value2 Double2 The second position in the interpolation. value3 Double2 The third position in the interpolation. value4 Double2 The fourth position in the interpolation. amount double Weighting factor. result Double2 When the method completes, contains the result of the Catmull-Rom interpolation. Clamp(Double2, Double2, Double2) Restricts a value to be within a specified range. public static Double2 Clamp(Double2 value, Double2 min, Double2 max) Parameters value Double2 The value to clamp. min Double2 The minimum value. max Double2 The maximum value. Returns Double2 The clamped value. Clamp(ref readonly Double2, ref readonly Double2, ref readonly Double2, out Double2) Restricts a value to be within a specified range. public static void Clamp(ref readonly Double2 value, ref readonly Double2 min, ref readonly Double2 max, out Double2 result) Parameters value Double2 The value to clamp. min Double2 The minimum value. max Double2 The maximum value. result Double2 When the method completes, contains the clamped value. Deconstruct(out double, out double) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out double x, out double y) Parameters x double The X component y double The Y component Demodulate(Double2, Double2) Demodulates a vector with another by performing component-wise division. public static Double2 Demodulate(Double2 left, Double2 right) Parameters left Double2 The first vector to demodulate. right Double2 The second vector to demodulate. Returns Double2 The demodulated vector. Demodulate(ref readonly Double2, ref readonly Double2, out Double2) Demodulates a vector with another by performing component-wise division. public static void Demodulate(ref readonly Double2 left, ref readonly Double2 right, out Double2 result) Parameters left Double2 The first vector to demodulate. right Double2 The second vector to demodulate. result Double2 When the method completes, contains the demodulated vector. Distance(Double2, Double2) Calculates the distance between two vectors. public static double Distance(Double2 value1, Double2 value2) Parameters value1 Double2 The first vector. value2 Double2 The second vector. Returns double The distance between the two vectors. Remarks DistanceSquared(Double2, Double2) may be preferred when only the relative distance is needed and speed is of the essence. Distance(ref readonly Double2, ref readonly Double2, out double) Calculates the distance between two vectors. public static void Distance(ref readonly Double2 value1, ref readonly Double2 value2, out double result) Parameters value1 Double2 The first vector. value2 Double2 The second vector. result double When the method completes, contains the distance between the two vectors. Remarks DistanceSquared(ref readonly Double2, ref readonly Double2, out double) may be preferred when only the relative distance is needed and speed is of the essence. DistanceSquared(Double2, Double2) Calculates the squared distance between two vectors. public static double DistanceSquared(Double2 value1, Double2 value2) Parameters value1 Double2 The first vector. value2 Double2 The second vector. Returns double The squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. DistanceSquared(ref readonly Double2, ref readonly Double2, out double) Calculates the squared distance between two vectors. public static void DistanceSquared(ref readonly Double2 value1, ref readonly Double2 value2, out double result) Parameters value1 Double2 The first vector. value2 Double2 The second vector result double When the method completes, contains the squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. Divide(Double2, double) Scales a vector by the given value. public static Double2 Divide(Double2 value, double scale) Parameters value Double2 The vector to scale. scale double The amount by which to scale the vector. Returns Double2 The scaled vector. Divide(ref readonly Double2, double, out Double2) Scales a vector by the given value. public static void Divide(ref readonly Double2 value, double scale, out Double2 result) Parameters value Double2 The vector to scale. scale double The amount by which to scale the vector. result Double2 When the method completes, contains the scaled vector. Dot(Double2, Double2) Calculates the dot product of two vectors. public static double Dot(Double2 left, Double2 right) Parameters left Double2 First source vector. right Double2 Second source vector. Returns double The dot product of the two vectors. Dot(ref readonly Double2, ref readonly Double2, out double) Calculates the dot product of two vectors. public static void Dot(ref readonly Double2 left, ref readonly Double2 right, out double result) Parameters left Double2 First source vector. right Double2 Second source vector. result double When the method completes, contains the dot product of the two vectors. Equals(Double2) Determines whether the specified Double2 is equal to this instance. public readonly bool Equals(Double2 other) Parameters other Double2 The Double2 to compare with this instance. Returns bool true if the specified Double2 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Hermite(Double2, Double2, Double2, Double2, double) Performs a Hermite spline interpolation. public static Double2 Hermite(Double2 value1, Double2 tangent1, Double2 value2, Double2 tangent2, double amount) Parameters value1 Double2 First source position vector. tangent1 Double2 First source tangent vector. value2 Double2 Second source position vector. tangent2 Double2 Second source tangent vector. amount double Weighting factor. Returns Double2 The result of the Hermite spline interpolation. Hermite(ref readonly Double2, ref readonly Double2, ref readonly Double2, ref readonly Double2, double, out Double2) Performs a Hermite spline interpolation. public static void Hermite(ref readonly Double2 value1, ref readonly Double2 tangent1, ref readonly Double2 value2, ref readonly Double2 tangent2, double amount, out Double2 result) Parameters value1 Double2 First source position vector. tangent1 Double2 First source tangent vector. value2 Double2 Second source position vector. tangent2 Double2 Second source tangent vector. amount double Weighting factor. result Double2 When the method completes, contains the result of the Hermite spline interpolation. Length() Calculates the length of the vector. public readonly double Length() Returns double The length of the vector. Remarks LengthSquared() may be preferred when only the relative length is needed and speed is of the essence. LengthSquared() Calculates the squared length of the vector. public readonly double LengthSquared() Returns double The squared length of the vector. Remarks This method may be preferred to Length() when only a relative length is needed and speed is of the essence. Lerp(Double2, Double2, double) Performs a linear interpolation between two vectors. public static Double2 Lerp(Double2 start, Double2 end, double amount) Parameters start Double2 Start vector. end Double2 End vector. amount double Value between 0 and 1 indicating the weight of end. Returns Double2 The linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Double2, ref readonly Double2, double, out Double2) Performs a linear interpolation between two vectors. public static void Lerp(ref readonly Double2 start, ref readonly Double2 end, double amount, out Double2 result) Parameters start Double2 Start vector. end Double2 End vector. amount double Value between 0 and 1 indicating the weight of end. result Double2 When the method completes, contains the linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Double2, Double2) Returns a vector containing the largest components of the specified vectors. public static Double2 Max(Double2 left, Double2 right) Parameters left Double2 The first source vector. right Double2 The second source vector. Returns Double2 A vector containing the largest components of the source vectors. Max(ref readonly Double2, ref readonly Double2, out Double2) Returns a vector containing the smallest components of the specified vectors. public static void Max(ref readonly Double2 left, ref readonly Double2 right, out Double2 result) Parameters left Double2 The first source vector. right Double2 The second source vector. result Double2 When the method completes, contains an new vector composed of the largest components of the source vectors. Min(Double2, Double2) Returns a vector containing the smallest components of the specified vectors. public static Double2 Min(Double2 left, Double2 right) Parameters left Double2 The first source vector. right Double2 The second source vector. Returns Double2 A vector containing the smallest components of the source vectors. Min(ref readonly Double2, ref readonly Double2, out Double2) Returns a vector containing the smallest components of the specified vectors. public static void Min(ref readonly Double2 left, ref readonly Double2 right, out Double2 result) Parameters left Double2 The first source vector. right Double2 The second source vector. result Double2 When the method completes, contains an new vector composed of the smallest components of the source vectors. Modulate(Double2, Double2) Modulates a vector with another by performing component-wise multiplication. public static Double2 Modulate(Double2 left, Double2 right) Parameters left Double2 The first vector to modulate. right Double2 The second vector to modulate. Returns Double2 The modulated vector. Modulate(ref readonly Double2, ref readonly Double2, out Double2) Modulates a vector with another by performing component-wise multiplication. public static void Modulate(ref readonly Double2 left, ref readonly Double2 right, out Double2 result) Parameters left Double2 The first vector to modulate. right Double2 The second vector to modulate. result Double2 When the method completes, contains the modulated vector. Multiply(Double2, double) Scales a vector by the given value. public static Double2 Multiply(Double2 value, double scale) Parameters value Double2 The vector to scale. scale double The amount by which to scale the vector. Returns Double2 The scaled vector. Multiply(ref readonly Double2, double, out Double2) Scales a vector by the given value. public static void Multiply(ref readonly Double2 value, double scale, out Double2 result) Parameters value Double2 The vector to scale. scale double The amount by which to scale the vector. result Double2 When the method completes, contains the scaled vector. Negate(Double2) Reverses the direction of a given vector. public static Double2 Negate(Double2 value) Parameters value Double2 The vector to negate. Returns Double2 A vector facing in the opposite direction. Negate(ref readonly Double2, out Double2) Reverses the direction of a given vector. public static void Negate(ref readonly Double2 value, out Double2 result) Parameters value Double2 The vector to negate. result Double2 When the method completes, contains a vector facing in the opposite direction. Normalize() Converts the vector into a unit vector. public void Normalize() Normalize(Double2) Converts the vector into a unit vector. public static Double2 Normalize(Double2 value) Parameters value Double2 The vector to normalize. Returns Double2 The normalized vector. Normalize(ref readonly Double2, out Double2) Converts the vector into a unit vector. public static void Normalize(ref readonly Double2 value, out Double2 result) Parameters value Double2 The vector to normalize. result Double2 When the method completes, contains the normalized vector. Orthogonalize(Double2[], params Double2[]) Orthogonalizes a list of vectors. public static void Orthogonalize(Double2[] destination, params Double2[] source) Parameters destination Double2[] The list of orthogonalized vectors. source Double2[] The list of vectors to orthogonalize. Remarks Orthogonalization is the process of making all vectors orthogonal to each other. This means that any given vector in the list will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Orthonormalize(Double2[], params Double2[]) Orthonormalizes a list of vectors. public static void Orthonormalize(Double2[] destination, params Double2[] source) Parameters destination Double2[] The list of orthonormalized vectors. source Double2[] The list of vectors to orthonormalize. Remarks Orthonormalization is the process of making all vectors orthogonal to each other and making all vectors of unit length. This means that any given vector will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Reflect(Double2, Double2) Returns the reflection of a vector off a surface that has the specified normal. public static Double2 Reflect(Double2 vector, Double2 normal) Parameters vector Double2 The source vector. normal Double2 Normal of the surface. Returns Double2 The reflected vector. Remarks Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it. Reflect(ref readonly Double2, ref readonly Double2, out Double2) Returns the reflection of a vector off a surface that has the specified normal. public static void Reflect(ref readonly Double2 vector, ref readonly Double2 normal, out Double2 result) Parameters vector Double2 The source vector. normal Double2 Normal of the surface. result Double2 When the method completes, contains the reflected vector. Remarks Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it. SmoothStep(Double2, Double2, double) Performs a cubic interpolation between two vectors. public static Double2 SmoothStep(Double2 start, Double2 end, double amount) Parameters start Double2 Start vector. end Double2 End vector. amount double Value between 0 and 1 indicating the weight of end. Returns Double2 The cubic interpolation of the two vectors. SmoothStep(ref readonly Double2, ref readonly Double2, double, out Double2) Performs a cubic interpolation between two vectors. public static void SmoothStep(ref readonly Double2 start, ref readonly Double2 end, double amount, out Double2 result) Parameters start Double2 Start vector. end Double2 End vector. amount double Value between 0 and 1 indicating the weight of end. result Double2 When the method completes, contains the cubic interpolation of the two vectors. Subtract(Double2, Double2) Subtracts two vectors. public static Double2 Subtract(Double2 left, Double2 right) Parameters left Double2 The first vector to subtract. right Double2 The second vector to subtract. Returns Double2 The difference of the two vectors. Subtract(ref readonly Double2, ref readonly Double2, out Double2) Subtracts two vectors. public static void Subtract(ref readonly Double2 left, ref readonly Double2 right, out Double2 result) Parameters left Double2 The first vector to subtract. right Double2 The second vector to subtract. result Double2 When the method completes, contains the difference of the two vectors. ToArray() Creates an array containing the elements of the vector. public readonly double[] ToArray() Returns double[] A two-element array containing the components of the vector. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transform(Double2, Matrix) Transforms a 2D vector by the given Matrix. public static Double4 Transform(Double2 vector, Matrix transform) Parameters vector Double2 The source vector. transform Matrix The transformation Matrix. Returns Double4 The transformed Double4. Transform(Double2, Quaternion) Transforms a 2D vector by the given Quaternion rotation. public static Double2 Transform(Double2 vector, Quaternion rotation) Parameters vector Double2 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. Returns Double2 The transformed Double4. Transform(ref readonly Double2, ref readonly Matrix, out Double4) Transforms a 2D vector by the given Matrix. public static void Transform(ref readonly Double2 vector, ref readonly Matrix transform, out Double4 result) Parameters vector Double2 The source vector. transform Matrix The transformation Matrix. result Double4 When the method completes, contains the transformed Double4. Transform(ref readonly Double2, ref readonly Quaternion, out Double2) Transforms a 2D vector by the given Quaternion rotation. public static void Transform(ref readonly Double2 vector, ref readonly Quaternion rotation, out Double2 result) Parameters vector Double2 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. result Double2 When the method completes, contains the transformed Double4. Transform(Double2[], ref readonly Matrix, Double4[]) Transforms an array of 2D vectors by the given Matrix. public static void Transform(Double2[] source, ref readonly Matrix transform, Double4[] destination) Parameters source Double2[] The array of vectors to transform. transform Matrix The transformation Matrix. destination Double4[] The array for which the transformed vectors are stored. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Transform(Double2[], ref readonly Quaternion, Double2[]) Transforms an array of vectors by the given Quaternion rotation. public static void Transform(Double2[] source, ref readonly Quaternion rotation, Double2[] destination) Parameters source Double2[] The array of vectors to transform. rotation Quaternion The Quaternion rotation to apply. destination Double2[] The array for which the transformed vectors are stored. This array may be the same array as source. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. TransformCoordinate(Double2, Matrix) Performs a coordinate transformation using the given Matrix. public static Double2 TransformCoordinate(Double2 coordinate, Matrix transform) Parameters coordinate Double2 The coordinate vector to transform. transform Matrix The transformation Matrix. Returns Double2 The transformed coordinates. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored. TransformCoordinate(ref readonly Double2, ref readonly Matrix, out Double2) Performs a coordinate transformation using the given Matrix. public static void TransformCoordinate(ref readonly Double2 coordinate, ref readonly Matrix transform, out Double2 result) Parameters coordinate Double2 The coordinate vector to transform. transform Matrix The transformation Matrix. result Double2 When the method completes, contains the transformed coordinates. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored. TransformCoordinate(Double2[], ref readonly Matrix, Double2[]) Performs a coordinate transformation on an array of vectors using the given Matrix. public static void TransformCoordinate(Double2[] source, ref readonly Matrix transform, Double2[] destination) Parameters source Double2[] The array of coordinate vectors to trasnform. transform Matrix The transformation Matrix. destination Double2[] The array for which the transformed vectors are stored. This array may be the same array as source. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. TransformNormal(Double2, Matrix) Performs a normal transformation using the given Matrix. public static Double2 TransformNormal(Double2 normal, Matrix transform) Parameters normal Double2 The normal vector to transform. transform Matrix The transformation Matrix. Returns Double2 The transformed normal. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. TransformNormal(ref readonly Double2, ref readonly Matrix, out Double2) Performs a normal transformation using the given Matrix. public static void TransformNormal(ref readonly Double2 normal, ref readonly Matrix transform, out Double2 result) Parameters normal Double2 The normal vector to transform. transform Matrix The transformation Matrix. result Double2 When the method completes, contains the transformed normal. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. TransformNormal(Double2[], ref readonly Matrix, Double2[]) Performs a normal transformation on an array of vectors using the given Matrix. public static void TransformNormal(Double2[] source, ref readonly Matrix transform, Double2[] destination) Parameters source Double2[] The array of normal vectors to transform. transform Matrix The transformation Matrix. destination Double2[] The array for which the transformed vectors are stored. This array may be the same array as source. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Operators operator +(Double2, Double2) Adds two vectors. public static Double2 operator +(Double2 left, Double2 right) Parameters left Double2 The first vector to add. right Double2 The second vector to add. Returns Double2 The sum of the two vectors. operator /(Double2, Double2) Divides a vector by the given vector, component-wise. public static Double2 operator /(Double2 value, Double2 by) Parameters value Double2 The vector to scale. by Double2 The by. Returns Double2 The scaled vector. operator /(Double2, double) Scales a vector by the given value. public static Double2 operator /(Double2 value, double scale) Parameters value Double2 The vector to scale. scale double The amount by which to scale the vector. Returns Double2 The scaled vector. operator /(double, Double2) Divides a numerator by a vector. public static Double2 operator /(double numerator, Double2 value) Parameters numerator double The numerator. value Double2 The value. Returns Double2 The scaled vector. operator ==(Double2, Double2) Tests for equality between two objects. public static bool operator ==(Double2 left, Double2 right) Parameters left Double2 The first value to compare. right Double2 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Double3(Double2) Performs an explicit conversion from Double2 to Double3. public static explicit operator Double3(Double2 value) Parameters value Double2 The value. Returns Double3 The result of the conversion. explicit operator Double4(Double2) Performs an explicit conversion from Double2 to Double4. public static explicit operator Double4(Double2 value) Parameters value Double2 The value. Returns Double4 The result of the conversion. explicit operator Half2(Double2) Performs an explicit conversion from Double2 to Half2. public static explicit operator Half2(Double2 value) Parameters value Double2 The value. Returns Half2 The result of the conversion. explicit operator Vector2(Double2) Performs an explicit conversion from Double2 to Vector2. public static explicit operator Vector2(Double2 value) Parameters value Double2 The value. Returns Vector2 The result of the conversion. explicit operator Vector2(Double2) Casts from Stride.Maths to System.Numerics vectors public static explicit operator Vector2(Double2 v) Parameters v Double2 Value to cast Returns Vector2 explicit operator Double2(Half2) Performs an explicit conversion from Half2 to Double2. public static explicit operator Double2(Half2 value) Parameters value Half2 The value. Returns Double2 The result of the conversion. implicit operator Double2(Vector2) Performs an implicit conversion from Vector2 to Double2. public static implicit operator Double2(Vector2 value) Parameters value Vector2 The value. Returns Double2 The result of the conversion. implicit operator Double2(Vector2) Casts from System.Numerics to Stride.Maths vectors public static implicit operator Double2(Vector2 v) Parameters v Vector2 Value to cast Returns Double2 operator !=(Double2, Double2) Tests for inequality between two objects. public static bool operator !=(Double2 left, Double2 right) Parameters left Double2 The first value to compare. right Double2 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Double2, Double2) Modulates a vector with another by performing component-wise multiplication. public static Double2 operator *(Double2 left, Double2 right) Parameters left Double2 The first vector to multiply. right Double2 The second vector to multiply. Returns Double2 The multiplication of the two vectors. operator *(Double2, double) Scales a vector by the given value. public static Double2 operator *(Double2 value, double scale) Parameters value Double2 The vector to scale. scale double The amount by which to scale the vector. Returns Double2 The scaled vector. operator *(double, Double2) Scales a vector by the given value. public static Double2 operator *(double scale, Double2 value) Parameters scale double The amount by which to scale the vector. value Double2 The vector to scale. Returns Double2 The scaled vector. operator -(Double2, Double2) Subtracts two vectors. public static Double2 operator -(Double2 left, Double2 right) Parameters left Double2 The first vector to subtract. right Double2 The second vector to subtract. Returns Double2 The difference of the two vectors. operator -(Double2) Reverses the direction of a given vector. public static Double2 operator -(Double2 value) Parameters value Double2 The vector to negate. Returns Double2 A vector facing in the opposite direction. operator +(Double2) Assert a vector (return it unchanged). public static Double2 operator +(Double2 value) Parameters value Double2 The vector to assert (unchange). Returns Double2 The asserted (unchanged) vector."
  },
  "api/Stride.Core.Mathematics.Double3.html": {
    "href": "api/Stride.Core.Mathematics.Double3.html",
    "title": "Struct Double3 | Stride API",
    "summary": "Struct Double3 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a three dimensional mathematical vector with double-precision floats. [DataContract(\"double3\")] [DataStyle(DataStyle.Compact)] public struct Double3 : IEquatable<Double3>, ISpanFormattable, IFormattable Implements IEquatable<Double3> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Double3(Double2, double) Initializes a new instance of the Double3 struct. public Double3(Double2 value, double z) Parameters value Double2 A vector containing the values with which to initialize the X and Y components. z double Initial value for the Z component of the vector. Double3(Vector3) Initializes a new instance of the Double3 struct. public Double3(Vector3 v) Parameters v Vector3 The Vector3 to construct the Double3 from. Double3(double) Initializes a new instance of the Double3 struct. public Double3(double value) Parameters value double The value that will be assigned to all components. Double3(double, double, double) Initializes a new instance of the Double3 struct. public Double3(double x, double y, double z) Parameters x double Initial value for the X component of the vector. y double Initial value for the Y component of the vector. z double Initial value for the Z component of the vector. Double3(double[]) Initializes a new instance of the Double3 struct. public Double3(double[] values) Parameters values double[] The values to assign to the X, Y, and Z components of the vector. This must be an array with three elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than three elements. Fields One A Double3 with all of its components set to one. public static readonly Double3 One Field Value Double3 SizeInBytes The size of the Double3 type, in bytes. public static readonly int SizeInBytes Field Value int UnitX The X unit Double3 (1, 0, 0). public static readonly Double3 UnitX Field Value Double3 UnitY The Y unit Double3 (0, 1, 0). public static readonly Double3 UnitY Field Value Double3 UnitZ The Z unit Double3 (0, 0, 1). public static readonly Double3 UnitZ Field Value Double3 X The X component of the vector. [DataMember(0)] public double X Field Value double Y The Y component of the vector. [DataMember(1)] public double Y Field Value double Z The Z component of the vector. [DataMember(2)] public double Z Field Value double Zero A Double3 with all of its components set to zero. public static readonly Double3 Zero Field Value Double3 Properties IsNormalized Gets a value indicting whether this instance is normalized. public readonly bool IsNormalized { get; } Property Value bool this[int] Gets or sets the component at the specified index. public double this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the X component, 1 for the Y component, and 2 for the Z component. Property Value double The value of the X, Y, or Z component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 2]. Methods Add(Double3, Double3) Adds two vectors. public static Double3 Add(Double3 left, Double3 right) Parameters left Double3 The first vector to add. right Double3 The second vector to add. Returns Double3 The sum of the two vectors. Add(ref readonly Double3, ref readonly Double3, out Double3) Adds two vectors. public static void Add(ref readonly Double3 left, ref readonly Double3 right, out Double3 result) Parameters left Double3 The first vector to add. right Double3 The second vector to add. result Double3 When the method completes, contains the sum of the two vectors. Barycentric(Double3, Double3, Double3, double, double) Returns a Double3 containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle. public static Double3 Barycentric(Double3 value1, Double3 value2, Double3 value3, double amount1, double amount2) Parameters value1 Double3 A Double3 containing the 3D Cartesian coordinates of vertex 1 of the triangle. value2 Double3 A Double3 containing the 3D Cartesian coordinates of vertex 2 of the triangle. value3 Double3 A Double3 containing the 3D Cartesian coordinates of vertex 3 of the triangle. amount1 double Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 double Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). Returns Double3 A new Double3 containing the 3D Cartesian coordinates of the specified point. Barycentric(ref readonly Double3, ref readonly Double3, ref readonly Double3, double, double, out Double3) Returns a Double3 containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle. public static void Barycentric(ref readonly Double3 value1, ref readonly Double3 value2, ref readonly Double3 value3, double amount1, double amount2, out Double3 result) Parameters value1 Double3 A Double3 containing the 3D Cartesian coordinates of vertex 1 of the triangle. value2 Double3 A Double3 containing the 3D Cartesian coordinates of vertex 2 of the triangle. value3 Double3 A Double3 containing the 3D Cartesian coordinates of vertex 3 of the triangle. amount1 double Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 double Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). result Double3 When the method completes, contains the 3D Cartesian coordinates of the specified point. CatmullRom(Double3, Double3, Double3, Double3, double) Performs a Catmull-Rom interpolation using the specified positions. public static Double3 CatmullRom(Double3 value1, Double3 value2, Double3 value3, Double3 value4, double amount) Parameters value1 Double3 The first position in the interpolation. value2 Double3 The second position in the interpolation. value3 Double3 The third position in the interpolation. value4 Double3 The fourth position in the interpolation. amount double Weighting factor. Returns Double3 A vector that is the result of the Catmull-Rom interpolation. CatmullRom(ref readonly Double3, ref readonly Double3, ref readonly Double3, ref readonly Double3, double, out Double3) Performs a Catmull-Rom interpolation using the specified positions. public static void CatmullRom(ref readonly Double3 value1, ref readonly Double3 value2, ref readonly Double3 value3, ref readonly Double3 value4, double amount, out Double3 result) Parameters value1 Double3 The first position in the interpolation. value2 Double3 The second position in the interpolation. value3 Double3 The third position in the interpolation. value4 Double3 The fourth position in the interpolation. amount double Weighting factor. result Double3 When the method completes, contains the result of the Catmull-Rom interpolation. Clamp(Double3, Double3, Double3) Restricts a value to be within a specified range. public static Double3 Clamp(Double3 value, Double3 min, Double3 max) Parameters value Double3 The value to clamp. min Double3 The minimum value. max Double3 The maximum value. Returns Double3 The clamped value. Clamp(ref readonly Double3, ref readonly Double3, ref readonly Double3, out Double3) Restricts a value to be within a specified range. public static void Clamp(ref readonly Double3 value, ref readonly Double3 min, ref readonly Double3 max, out Double3 result) Parameters value Double3 The value to clamp. min Double3 The minimum value. max Double3 The maximum value. result Double3 When the method completes, contains the clamped value. Cross(Double3, Double3) Calculates the cross product of two vectors. public static Double3 Cross(Double3 left, Double3 right) Parameters left Double3 First source vector. right Double3 Second source vector. Returns Double3 The cross product of the two vectors. Cross(ref readonly Double3, ref readonly Double3, out Double3) Calculates the cross product of two vectors. public static void Cross(ref readonly Double3 left, ref readonly Double3 right, out Double3 result) Parameters left Double3 First source vector. right Double3 Second source vector. result Double3 When the method completes, contains he cross product of the two vectors. Deconstruct(out double, out double, out double) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out double x, out double y, out double z) Parameters x double The X component y double The Y component z double The Z component Demodulate(Double3, Double3) Demodulates a vector with another by performing component-wise division. public static Double3 Demodulate(Double3 left, Double3 right) Parameters left Double3 The first vector to demodulate. right Double3 The second vector to demodulate. Returns Double3 The demodulated vector. Demodulate(ref readonly Double3, ref readonly Double3, out Double3) Demodulates a vector with another by performing component-wise division. public static void Demodulate(ref readonly Double3 left, ref readonly Double3 right, out Double3 result) Parameters left Double3 The first vector to demodulate. right Double3 The second vector to demodulate. result Double3 When the method completes, contains the demodulated vector. Distance(Double3, Double3) Calculates the distance between two vectors. public static double Distance(Double3 value1, Double3 value2) Parameters value1 Double3 The first vector. value2 Double3 The second vector. Returns double The distance between the two vectors. Remarks DistanceSquared(Double3, Double3) may be preferred when only the relative distance is needed and speed is of the essence. Distance(ref readonly Double3, ref readonly Double3, out double) Calculates the distance between two vectors. public static void Distance(ref readonly Double3 value1, ref readonly Double3 value2, out double result) Parameters value1 Double3 The first vector. value2 Double3 The second vector. result double When the method completes, contains the distance between the two vectors. Remarks DistanceSquared(ref readonly Double3, ref readonly Double3, out double) may be preferred when only the relative distance is needed and speed is of the essence. DistanceSquared(Double3, Double3) Calculates the squared distance between two vectors. public static double DistanceSquared(Double3 value1, Double3 value2) Parameters value1 Double3 The first vector. value2 Double3 The second vector. Returns double The squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. DistanceSquared(ref readonly Double3, ref readonly Double3, out double) Calculates the squared distance between two vectors. public static void DistanceSquared(ref readonly Double3 value1, ref readonly Double3 value2, out double result) Parameters value1 Double3 The first vector. value2 Double3 The second vector. result double When the method completes, contains the squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. Divide(Double3, double) Scales a vector by the given value. public static Double3 Divide(Double3 value, double scale) Parameters value Double3 The vector to scale. scale double The amount by which to scale the vector. Returns Double3 The scaled vector. Divide(ref readonly Double3, double, out Double3) Scales a vector by the given value. public static void Divide(ref readonly Double3 value, double scale, out Double3 result) Parameters value Double3 The vector to scale. scale double The amount by which to scale the vector. result Double3 When the method completes, contains the scaled vector. Dot(Double3, Double3) Calculates the dot product of two vectors. public static double Dot(Double3 left, Double3 right) Parameters left Double3 First source vector. right Double3 Second source vector. Returns double The dot product of the two vectors. Dot(ref readonly Double3, ref readonly Double3, out double) Calculates the dot product of two vectors. public static void Dot(ref readonly Double3 left, ref readonly Double3 right, out double result) Parameters left Double3 First source vector. right Double3 Second source vector. result double When the method completes, contains the dot product of the two vectors. Equals(Double3) Determines whether the specified Double3 is equal to this instance. public readonly bool Equals(Double3 other) Parameters other Double3 The Double3 to compare with this instance. Returns bool true if the specified Double3 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Hermite(Double3, Double3, Double3, Double3, double) Performs a Hermite spline interpolation. public static Double3 Hermite(Double3 value1, Double3 tangent1, Double3 value2, Double3 tangent2, double amount) Parameters value1 Double3 First source position vector. tangent1 Double3 First source tangent vector. value2 Double3 Second source position vector. tangent2 Double3 Second source tangent vector. amount double Weighting factor. Returns Double3 The result of the Hermite spline interpolation. Hermite(ref readonly Double3, ref readonly Double3, ref readonly Double3, ref readonly Double3, double, out Double3) Performs a Hermite spline interpolation. public static void Hermite(ref readonly Double3 value1, ref readonly Double3 tangent1, ref readonly Double3 value2, ref readonly Double3 tangent2, double amount, out Double3 result) Parameters value1 Double3 First source position vector. tangent1 Double3 First source tangent vector. value2 Double3 Second source position vector. tangent2 Double3 Second source tangent vector. amount double Weighting factor. result Double3 When the method completes, contains the result of the Hermite spline interpolation. Length() Calculates the length of the vector. public readonly double Length() Returns double The length of the vector. Remarks LengthSquared() may be preferred when only the relative length is needed and speed is of the essence. LengthSquared() Calculates the squared length of the vector. public readonly double LengthSquared() Returns double The squared length of the vector. Remarks This method may be preferred to Length() when only a relative length is needed and speed is of the essence. Lerp(Double3, Double3, double) Performs a linear interpolation between two vectors. public static Double3 Lerp(Double3 start, Double3 end, double amount) Parameters start Double3 Start vector. end Double3 End vector. amount double Value between 0 and 1 indicating the weight of end. Returns Double3 The linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Double3, ref readonly Double3, double, out Double3) Performs a linear interpolation between two vectors. public static void Lerp(ref readonly Double3 start, ref readonly Double3 end, double amount, out Double3 result) Parameters start Double3 Start vector. end Double3 End vector. amount double Value between 0 and 1 indicating the weight of end. result Double3 When the method completes, contains the linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Double3, Double3) Returns a vector containing the largest components of the specified vectors. public static Double3 Max(Double3 left, Double3 right) Parameters left Double3 The first source vector. right Double3 The second source vector. Returns Double3 A vector containing the largest components of the source vectors. Max(ref readonly Double3, ref readonly Double3, out Double3) Returns a vector containing the smallest components of the specified vectors. public static void Max(ref readonly Double3 left, ref readonly Double3 right, out Double3 result) Parameters left Double3 The first source vector. right Double3 The second source vector. result Double3 When the method completes, contains an new vector composed of the largest components of the source vectors. Min(Double3, Double3) Returns a vector containing the smallest components of the specified vectors. public static Double3 Min(Double3 left, Double3 right) Parameters left Double3 The first source vector. right Double3 The second source vector. Returns Double3 A vector containing the smallest components of the source vectors. Min(ref readonly Double3, ref readonly Double3, out Double3) Returns a vector containing the smallest components of the specified vectors. public static void Min(ref readonly Double3 left, ref readonly Double3 right, out Double3 result) Parameters left Double3 The first source vector. right Double3 The second source vector. result Double3 When the method completes, contains an new vector composed of the smallest components of the source vectors. Modulate(Double3, Double3) Modulates a vector with another by performing component-wise multiplication. public static Double3 Modulate(Double3 left, Double3 right) Parameters left Double3 The first vector to modulate. right Double3 The second vector to modulate. Returns Double3 The modulated vector. Modulate(ref readonly Double3, ref readonly Double3, out Double3) Modulates a vector with another by performing component-wise multiplication. public static void Modulate(ref readonly Double3 left, ref readonly Double3 right, out Double3 result) Parameters left Double3 The first vector to modulate. right Double3 The second vector to modulate. result Double3 When the method completes, contains the modulated vector. Multiply(Double3, double) Scales a vector by the given value. public static Double3 Multiply(Double3 value, double scale) Parameters value Double3 The vector to scale. scale double The amount by which to scale the vector. Returns Double3 The scaled vector. Multiply(ref readonly Double3, double, out Double3) Scales a vector by the given value. public static void Multiply(ref readonly Double3 value, double scale, out Double3 result) Parameters value Double3 The vector to scale. scale double The amount by which to scale the vector. result Double3 When the method completes, contains the scaled vector. NearEqual(Double3, Double3, Double3) Tests whether one 3D vector is near another 3D vector. public static bool NearEqual(Double3 left, Double3 right, Double3 epsilon) Parameters left Double3 The left vector. right Double3 The right vector. epsilon Double3 The epsilon. Returns bool true if left and right are near another 3D, false otherwise NearEqual(ref readonly Double3, ref readonly Double3, ref readonly Double3) Tests whether one 3D vector is near another 3D vector. public static bool NearEqual(ref readonly Double3 left, ref readonly Double3 right, ref readonly Double3 epsilon) Parameters left Double3 The left vector. right Double3 The right vector. epsilon Double3 The epsilon. Returns bool true if left and right are near another 3D, false otherwise Negate(Double3) Reverses the direction of a given vector. public static Double3 Negate(Double3 value) Parameters value Double3 The vector to negate. Returns Double3 A vector facing in the opposite direction. Negate(ref readonly Double3, out Double3) Reverses the direction of a given vector. public static void Negate(ref readonly Double3 value, out Double3 result) Parameters value Double3 The vector to negate. result Double3 When the method completes, contains a vector facing in the opposite direction. Normalize() Converts the vector into a unit vector. public void Normalize() Normalize(Double3) Converts the vector into a unit vector. public static Double3 Normalize(Double3 value) Parameters value Double3 The vector to normalize. Returns Double3 The normalized vector. Normalize(ref readonly Double3, out Double3) Converts the vector into a unit vector. public static void Normalize(ref readonly Double3 value, out Double3 result) Parameters value Double3 The vector to normalize. result Double3 When the method completes, contains the normalized vector. Orthogonalize(Double3[], params Double3[]) Orthogonalizes a list of vectors. public static void Orthogonalize(Double3[] destination, params Double3[] source) Parameters destination Double3[] The list of orthogonalized vectors. source Double3[] The list of vectors to orthogonalize. Remarks Orthogonalization is the process of making all vectors orthogonal to each other. This means that any given vector in the list will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Orthonormalize(Double3[], params Double3[]) Orthonormalizes a list of vectors. public static void Orthonormalize(Double3[] destination, params Double3[] source) Parameters destination Double3[] The list of orthonormalized vectors. source Double3[] The list of vectors to orthonormalize. Remarks Orthonormalization is the process of making all vectors orthogonal to each other and making all vectors of unit length. This means that any given vector will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Pow(double) Raises the exponent for each components. public void Pow(double exponent) Parameters exponent double The exponent. Project(Double3, double, double, double, double, double, double, Matrix) Projects a 3D vector from object space into screen space. public static Double3 Project(Double3 vector, double x, double y, double width, double height, double minZ, double maxZ, Matrix worldViewProjection) Parameters vector Double3 The vector to project. x double The X position of the viewport. y double The Y position of the viewport. width double The width of the viewport. height double The height of the viewport. minZ double The minimum depth of the viewport. maxZ double The maximum depth of the viewport. worldViewProjection Matrix The combined world-view-projection matrix. Returns Double3 The vector in screen space. Project(ref readonly Double3, double, double, double, double, double, double, ref readonly Matrix, out Double3) Projects a 3D vector from object space into screen space. public static void Project(ref readonly Double3 vector, double x, double y, double width, double height, double minZ, double maxZ, ref readonly Matrix worldViewProjection, out Double3 result) Parameters vector Double3 The vector to project. x double The X position of the viewport. y double The Y position of the viewport. width double The width of the viewport. height double The height of the viewport. minZ double The minimum depth of the viewport. maxZ double The maximum depth of the viewport. worldViewProjection Matrix The combined world-view-projection matrix. result Double3 When the method completes, contains the vector in screen space. Reflect(Double3, Double3) Returns the reflection of a vector off a surface that has the specified normal. public static Double3 Reflect(Double3 vector, Double3 normal) Parameters vector Double3 The source vector. normal Double3 Normal of the surface. Returns Double3 The reflected vector. Remarks Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it. Reflect(ref readonly Double3, ref readonly Double3, out Double3) Returns the reflection of a vector off a surface that has the specified normal. public static void Reflect(ref readonly Double3 vector, ref readonly Double3 normal, out Double3 result) Parameters vector Double3 The source vector. normal Double3 Normal of the surface. result Double3 When the method completes, contains the reflected vector. Remarks Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it. RotationYawPitchRoll(Quaternion) Calculate the yaw/pitch/roll rotation equivalent to the provided quaterion. public static Double3 RotationYawPitchRoll(Quaternion quaternion) Parameters quaternion Quaternion The input rotation as quaternion Returns Double3 The equivation yaw/pitch/roll rotation RotationYawPitchRoll(ref readonly Quaternion, out Double3) Calculate the yaw/pitch/roll rotation equivalent to the provided quaterion. public static void RotationYawPitchRoll(ref readonly Quaternion quaternion, out Double3 yawPitchRoll) Parameters quaternion Quaternion The input rotation as quaternion yawPitchRoll Double3 The equivation yaw/pitch/roll rotation SmoothStep(Double3, Double3, double) Performs a cubic interpolation between two vectors. public static Double3 SmoothStep(Double3 start, Double3 end, double amount) Parameters start Double3 Start vector. end Double3 End vector. amount double Value between 0 and 1 indicating the weight of end. Returns Double3 The cubic interpolation of the two vectors. SmoothStep(ref readonly Double3, ref readonly Double3, double, out Double3) Performs a cubic interpolation between two vectors. public static void SmoothStep(ref readonly Double3 start, ref readonly Double3 end, double amount, out Double3 result) Parameters start Double3 Start vector. end Double3 End vector. amount double Value between 0 and 1 indicating the weight of end. result Double3 When the method completes, contains the cubic interpolation of the two vectors. Subtract(Double3, Double3) Subtracts two vectors. public static Double3 Subtract(Double3 left, Double3 right) Parameters left Double3 The first vector to subtract. right Double3 The second vector to subtract. Returns Double3 The difference of the two vectors. Subtract(ref readonly Double3, ref readonly Double3, out Double3) Subtracts two vectors. public static void Subtract(ref readonly Double3 left, ref readonly Double3 right, out Double3 result) Parameters left Double3 The first vector to subtract. right Double3 The second vector to subtract. result Double3 When the method completes, contains the difference of the two vectors. ToArray() Creates an array containing the elements of the vector. public readonly double[] ToArray() Returns double[] A three-element array containing the components of the vector. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transform(Double3, Matrix) Transforms a 3D vector by the given Matrix. public static Double4 Transform(Double3 vector, Matrix transform) Parameters vector Double3 The source vector. transform Matrix The transformation Matrix. Returns Double4 The transformed Double4. Transform(Double3, Quaternion) Transforms a 3D vector by the given Quaternion rotation. public static Double3 Transform(Double3 vector, Quaternion rotation) Parameters vector Double3 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. Returns Double3 The transformed Double4. Transform(ref readonly Double3, ref readonly Matrix, out Double3) Transforms a 3D vector by the given Matrix. public static void Transform(ref readonly Double3 vector, ref readonly Matrix transform, out Double3 result) Parameters vector Double3 The source vector. transform Matrix The transformation Matrix. result Double3 When the method completes, contains the transformed Double3. Transform(ref readonly Double3, ref readonly Matrix, out Double4) Transforms a 3D vector by the given Matrix. public static void Transform(ref readonly Double3 vector, ref readonly Matrix transform, out Double4 result) Parameters vector Double3 The source vector. transform Matrix The transformation Matrix. result Double4 When the method completes, contains the transformed Double4. Transform(ref readonly Double3, ref readonly Quaternion, out Double3) Transforms a 3D vector by the given Quaternion rotation. public static void Transform(ref readonly Double3 vector, ref readonly Quaternion rotation, out Double3 result) Parameters vector Double3 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. result Double3 When the method completes, contains the transformed Double4. Transform(Double3[], ref readonly Matrix, Double4[]) Transforms an array of 3D vectors by the given Matrix. public static void Transform(Double3[] source, ref readonly Matrix transform, Double4[] destination) Parameters source Double3[] The array of vectors to transform. transform Matrix The transformation Matrix. destination Double4[] The array for which the transformed vectors are stored. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Transform(Double3[], ref readonly Quaternion, Double3[]) Transforms an array of vectors by the given Quaternion rotation. public static void Transform(Double3[] source, ref readonly Quaternion rotation, Double3[] destination) Parameters source Double3[] The array of vectors to transform. rotation Quaternion The Quaternion rotation to apply. destination Double3[] The array for which the transformed vectors are stored. This array may be the same array as source. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. TransformCoordinate(Double3, Matrix) Performs a coordinate transformation using the given Matrix. public static Double3 TransformCoordinate(Double3 coordinate, Matrix transform) Parameters coordinate Double3 The coordinate vector to transform. transform Matrix The transformation Matrix. Returns Double3 The transformed coordinates. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored. TransformCoordinate(ref readonly Double3, ref readonly Matrix, out Double3) Performs a coordinate transformation using the given Matrix. public static void TransformCoordinate(ref readonly Double3 coordinate, ref readonly Matrix transform, out Double3 result) Parameters coordinate Double3 The coordinate vector to transform. transform Matrix The transformation Matrix. result Double3 When the method completes, contains the transformed coordinates. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored. TransformCoordinate(Double3[], ref readonly Matrix, Double3[]) Performs a coordinate transformation on an array of vectors using the given Matrix. public static void TransformCoordinate(Double3[] source, ref readonly Matrix transform, Double3[] destination) Parameters source Double3[] The array of coordinate vectors to trasnform. transform Matrix The transformation Matrix. destination Double3[] The array for which the transformed vectors are stored. This array may be the same array as source. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. TransformNormal(Double3, Matrix) Performs a normal transformation using the given Matrix. public static Double3 TransformNormal(Double3 normal, Matrix transform) Parameters normal Double3 The normal vector to transform. transform Matrix The transformation Matrix. Returns Double3 The transformed normal. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. TransformNormal(ref readonly Double3, ref readonly Matrix, out Double3) Performs a normal transformation using the given Matrix. public static void TransformNormal(ref readonly Double3 normal, ref readonly Matrix transform, out Double3 result) Parameters normal Double3 The normal vector to transform. transform Matrix The transformation Matrix. result Double3 When the method completes, contains the transformed normal. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. TransformNormal(Double3[], ref readonly Matrix, Double3[]) Performs a normal transformation on an array of vectors using the given Matrix. public static void TransformNormal(Double3[] source, ref readonly Matrix transform, Double3[] destination) Parameters source Double3[] The array of normal vectors to transform. transform Matrix The transformation Matrix. destination Double3[] The array for which the transformed vectors are stored. This array may be the same array as source. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Unproject(Double3, double, double, double, double, double, double, Matrix) Projects a 3D vector from screen space into object space. public static Double3 Unproject(Double3 vector, double x, double y, double width, double height, double minZ, double maxZ, Matrix worldViewProjection) Parameters vector Double3 The vector to project. x double The X position of the viewport. y double The Y position of the viewport. width double The width of the viewport. height double The height of the viewport. minZ double The minimum depth of the viewport. maxZ double The maximum depth of the viewport. worldViewProjection Matrix The combined world-view-projection matrix. Returns Double3 The vector in object space. Unproject(ref readonly Double3, double, double, double, double, double, double, ref readonly Matrix, out Double3) Projects a 3D vector from screen space into object space. public static void Unproject(ref readonly Double3 vector, double x, double y, double width, double height, double minZ, double maxZ, ref readonly Matrix worldViewProjection, out Double3 result) Parameters vector Double3 The vector to project. x double The X position of the viewport. y double The Y position of the viewport. width double The width of the viewport. height double The height of the viewport. minZ double The minimum depth of the viewport. maxZ double The maximum depth of the viewport. worldViewProjection Matrix The combined world-view-projection matrix. result Double3 When the method completes, contains the vector in object space. Operators operator +(Double3, Double3) Adds two vectors. public static Double3 operator +(Double3 left, Double3 right) Parameters left Double3 The first vector to add. right Double3 The second vector to add. Returns Double3 The sum of the two vectors. operator +(Double3, double) Adds a vector with the given value. public static Double3 operator +(Double3 value, double scale) Parameters value Double3 The vector to scale. scale double The amount by which to scale the vector. Returns Double3 The vector offset. operator /(Double3, Double3) Divides a vector by the given vector, component-wise. public static Double3 operator /(Double3 value, Double3 by) Parameters value Double3 The vector to scale. by Double3 The by. Returns Double3 The scaled vector. operator /(Double3, double) Scales a vector by the given value. public static Double3 operator /(Double3 value, double scale) Parameters value Double3 The vector to scale. scale double The amount by which to scale the vector. Returns Double3 The scaled vector. operator /(double, Double3) Divides a numerator by a vector. public static Double3 operator /(double numerator, Double3 value) Parameters numerator double The numerator. value Double3 The value. Returns Double3 The scaled vector. operator ==(Double3, Double3) Tests for equality between two objects. public static bool operator ==(Double3 left, Double3 right) Parameters left Double3 The first value to compare. right Double3 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Double2(Double3) Performs an explicit conversion from Double3 to Double2. public static explicit operator Double2(Double3 value) Parameters value Double3 The value. Returns Double2 The result of the conversion. explicit operator Double4(Double3) Performs an explicit conversion from Double3 to Double4. public static explicit operator Double4(Double3 value) Parameters value Double3 The value. Returns Double4 The result of the conversion. explicit operator Half3(Double3) Performs an explicit conversion from Double3 to Half3. public static explicit operator Half3(Double3 value) Parameters value Double3 The value. Returns Half3 The result of the conversion. explicit operator Vector3(Double3) Performs an explicit conversion from Double3 to Vector3. public static explicit operator Vector3(Double3 value) Parameters value Double3 The value. Returns Vector3 The result of the conversion. explicit operator Vector3(Double3) Casts from Stride.Maths to System.Numerics vectors public static explicit operator Vector3(Double3 v) Parameters v Double3 Value to cast Returns Vector3 explicit operator Double3(Half3) Performs an explicit conversion from Half3 to Double3. public static explicit operator Double3(Half3 value) Parameters value Half3 The value. Returns Double3 The result of the conversion. implicit operator Double3(Vector3) Performs an implicit conversion from Vector3 to Double3. public static implicit operator Double3(Vector3 value) Parameters value Vector3 The value. Returns Double3 The result of the conversion. implicit operator Double3(Vector3) Casts from System.Numerics to Stride.Maths vectors public static implicit operator Double3(Vector3 v) Parameters v Vector3 Value to cast Returns Double3 operator !=(Double3, Double3) Tests for inequality between two objects. public static bool operator !=(Double3 left, Double3 right) Parameters left Double3 The first value to compare. right Double3 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Double3, Double3) Modulates a vector with another by performing component-wise multiplication. public static Double3 operator *(Double3 left, Double3 right) Parameters left Double3 The first vector to multiply. right Double3 The second vector to multiply. Returns Double3 The multiplication of the two vectors. operator *(Double3, double) Scales a vector by the given value. public static Double3 operator *(Double3 value, double scale) Parameters value Double3 The vector to scale. scale double The amount by which to scale the vector. Returns Double3 The scaled vector. operator *(double, Double3) Scales a vector by the given value. public static Double3 operator *(double scale, Double3 value) Parameters scale double The amount by which to scale the vector. value Double3 The vector to scale. Returns Double3 The scaled vector. operator -(Double3, Double3) Subtracts two vectors. public static Double3 operator -(Double3 left, Double3 right) Parameters left Double3 The first vector to subtract. right Double3 The second vector to subtract. Returns Double3 The difference of the two vectors. operator -(Double3, double) Substracts a vector by the given value. public static Double3 operator -(Double3 value, double scale) Parameters value Double3 The vector to scale. scale double The amount by which to scale the vector. Returns Double3 The vector offset. operator -(Double3) Reverses the direction of a given vector. public static Double3 operator -(Double3 value) Parameters value Double3 The vector to negate. Returns Double3 A vector facing in the opposite direction. operator +(Double3) Assert a vector (return it unchanged). public static Double3 operator +(Double3 value) Parameters value Double3 The vector to assert (unchange). Returns Double3 The asserted (unchanged) vector."
  },
  "api/Stride.Core.Mathematics.Double4.html": {
    "href": "api/Stride.Core.Mathematics.Double4.html",
    "title": "Struct Double4 | Stride API",
    "summary": "Struct Double4 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a four dimensional mathematical vector with double-precision floats. [DataContract(\"double4\")] [DataStyle(DataStyle.Compact)] public struct Double4 : IEquatable<Double4>, ISpanFormattable, IFormattable Implements IEquatable<Double4> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Double4(Double2, double, double) Initializes a new instance of the Double4 struct. public Double4(Double2 value, double z, double w) Parameters value Double2 A vector containing the values with which to initialize the X and Y components. z double Initial value for the Z component of the vector. w double Initial value for the W component of the vector. Double4(Double3, double) Initializes a new instance of the Double4 struct. public Double4(Double3 value, double w) Parameters value Double3 A vector containing the values with which to initialize the X, Y, and Z components. w double Initial value for the W component of the vector. Double4(Vector4) Initializes a new instance of the Double4 struct. public Double4(Vector4 v) Parameters v Vector4 The Vector4 to construct the Double4 from. Double4(double) Initializes a new instance of the Double4 struct. public Double4(double value) Parameters value double The value that will be assigned to all components. Double4(double, double, double, double) Initializes a new instance of the Double4 struct. public Double4(double x, double y, double z, double w) Parameters x double Initial value for the X component of the vector. y double Initial value for the Y component of the vector. z double Initial value for the Z component of the vector. w double Initial value for the W component of the vector. Double4(double[]) Initializes a new instance of the Double4 struct. public Double4(double[] values) Parameters values double[] The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Fields One A Double4 with all of its components set to one. public static readonly Double4 One Field Value Double4 SizeInBytes The size of the Double4 type, in bytes. public static readonly int SizeInBytes Field Value int UnitW The W unit Double4 (0, 0, 0, 1). public static readonly Double4 UnitW Field Value Double4 UnitX The X unit Double4 (1, 0, 0, 0). public static readonly Double4 UnitX Field Value Double4 UnitY The Y unit Double4 (0, 1, 0, 0). public static readonly Double4 UnitY Field Value Double4 UnitZ The Z unit Double4 (0, 0, 1, 0). public static readonly Double4 UnitZ Field Value Double4 W The W component of the vector. [DataMember(3)] public double W Field Value double X The X component of the vector. [DataMember(0)] public double X Field Value double Y The Y component of the vector. [DataMember(1)] public double Y Field Value double Z The Z component of the vector. [DataMember(2)] public double Z Field Value double Zero A Double4 with all of its components set to zero. public static readonly Double4 Zero Field Value Double4 Properties IsNormalized Gets a value indicting whether this instance is normalized. public readonly bool IsNormalized { get; } Property Value bool this[int] Gets or sets the component at the specified index. public double this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. Property Value double The value of the X, Y, Z, or W component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 3]. Methods Add(Double4, Double4) Adds two vectors. public static Double4 Add(Double4 left, Double4 right) Parameters left Double4 The first vector to add. right Double4 The second vector to add. Returns Double4 The sum of the two vectors. Add(ref readonly Double4, ref readonly Double4, out Double4) Adds two vectors. public static void Add(ref readonly Double4 left, ref readonly Double4 right, out Double4 result) Parameters left Double4 The first vector to add. right Double4 The second vector to add. result Double4 When the method completes, contains the sum of the two vectors. Barycentric(Double4, Double4, Double4, double, double) Returns a Double4 containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 4D triangle. public static Double4 Barycentric(Double4 value1, Double4 value2, Double4 value3, double amount1, double amount2) Parameters value1 Double4 A Double4 containing the 4D Cartesian coordinates of vertex 1 of the triangle. value2 Double4 A Double4 containing the 4D Cartesian coordinates of vertex 2 of the triangle. value3 Double4 A Double4 containing the 4D Cartesian coordinates of vertex 3 of the triangle. amount1 double Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 double Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). Returns Double4 A new Double4 containing the 4D Cartesian coordinates of the specified point. Barycentric(ref readonly Double4, ref readonly Double4, ref readonly Double4, double, double, out Double4) Returns a Double4 containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 4D triangle. public static void Barycentric(ref readonly Double4 value1, ref readonly Double4 value2, ref readonly Double4 value3, double amount1, double amount2, out Double4 result) Parameters value1 Double4 A Double4 containing the 4D Cartesian coordinates of vertex 1 of the triangle. value2 Double4 A Double4 containing the 4D Cartesian coordinates of vertex 2 of the triangle. value3 Double4 A Double4 containing the 4D Cartesian coordinates of vertex 3 of the triangle. amount1 double Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 double Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). result Double4 When the method completes, contains the 4D Cartesian coordinates of the specified point. CatmullRom(Double4, Double4, Double4, Double4, double) Performs a Catmull-Rom interpolation using the specified positions. public static Double4 CatmullRom(Double4 value1, Double4 value2, Double4 value3, Double4 value4, double amount) Parameters value1 Double4 The first position in the interpolation. value2 Double4 The second position in the interpolation. value3 Double4 The third position in the interpolation. value4 Double4 The fourth position in the interpolation. amount double Weighting factor. Returns Double4 A vector that is the result of the Catmull-Rom interpolation. CatmullRom(ref readonly Double4, ref readonly Double4, ref readonly Double4, ref readonly Double4, double, out Double4) Performs a Catmull-Rom interpolation using the specified positions. public static void CatmullRom(ref readonly Double4 value1, ref readonly Double4 value2, ref readonly Double4 value3, ref readonly Double4 value4, double amount, out Double4 result) Parameters value1 Double4 The first position in the interpolation. value2 Double4 The second position in the interpolation. value3 Double4 The third position in the interpolation. value4 Double4 The fourth position in the interpolation. amount double Weighting factor. result Double4 When the method completes, contains the result of the Catmull-Rom interpolation. Clamp(Double4, Double4, Double4) Restricts a value to be within a specified range. public static Double4 Clamp(Double4 value, Double4 min, Double4 max) Parameters value Double4 The value to clamp. min Double4 The minimum value. max Double4 The maximum value. Returns Double4 The clamped value. Clamp(ref readonly Double4, ref readonly Double4, ref readonly Double4, out Double4) Restricts a value to be within a specified range. public static void Clamp(ref readonly Double4 value, ref readonly Double4 min, ref readonly Double4 max, out Double4 result) Parameters value Double4 The value to clamp. min Double4 The minimum value. max Double4 The maximum value. result Double4 When the method completes, contains the clamped value. Deconstruct(out double, out double, out double, out double) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out double x, out double y, out double z, out double w) Parameters x double The X component y double The Y component z double The Z component w double The W component Demodulate(Double4, Double4) Demodulates a vector with another by performing component-wise division. public static Double4 Demodulate(Double4 left, Double4 right) Parameters left Double4 The first vector to demodulate. right Double4 The second vector to demodulate. Returns Double4 The demodulated vector. Demodulate(ref readonly Double4, ref readonly Double4, out Double4) Demodulates a vector with another by performing component-wise division. public static void Demodulate(ref readonly Double4 left, ref readonly Double4 right, out Double4 result) Parameters left Double4 The first vector to demodulate. right Double4 The second vector to demodulate. result Double4 When the method completes, contains the demodulated vector. Distance(Double4, Double4) Calculates the distance between two vectors. public static double Distance(Double4 value1, Double4 value2) Parameters value1 Double4 The first vector. value2 Double4 The second vector. Returns double The distance between the two vectors. Remarks DistanceSquared(Double4, Double4) may be preferred when only the relative distance is needed and speed is of the essence. Distance(ref readonly Double4, ref readonly Double4, out double) Calculates the distance between two vectors. public static void Distance(ref readonly Double4 value1, ref readonly Double4 value2, out double result) Parameters value1 Double4 The first vector. value2 Double4 The second vector. result double When the method completes, contains the distance between the two vectors. Remarks DistanceSquared(ref readonly Double4, ref readonly Double4, out double) may be preferred when only the relative distance is needed and speed is of the essence. DistanceSquared(Double4, Double4) Calculates the squared distance between two vectors. public static double DistanceSquared(Double4 value1, Double4 value2) Parameters value1 Double4 The first vector. value2 Double4 The second vector. Returns double The squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. DistanceSquared(ref readonly Double4, ref readonly Double4, out double) Calculates the squared distance between two vectors. public static void DistanceSquared(ref readonly Double4 value1, ref readonly Double4 value2, out double result) Parameters value1 Double4 The first vector. value2 Double4 The second vector. result double When the method completes, contains the squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. Divide(Double4, double) Scales a vector by the given value. public static Double4 Divide(Double4 value, double scale) Parameters value Double4 The vector to scale. scale double The amount by which to scale the vector. Returns Double4 The scaled vector. Divide(ref readonly Double4, double, out Double4) Scales a vector by the given value. public static void Divide(ref readonly Double4 value, double scale, out Double4 result) Parameters value Double4 The vector to scale. scale double The amount by which to scale the vector. result Double4 When the method completes, contains the scaled vector. Dot(Double4, Double4) Calculates the dot product of two vectors. public static double Dot(Double4 left, Double4 right) Parameters left Double4 First source vector. right Double4 Second source vector. Returns double The dot product of the two vectors. Dot(ref readonly Double4, ref readonly Double4, out double) Calculates the dot product of two vectors. public static void Dot(ref readonly Double4 left, ref readonly Double4 right, out double result) Parameters left Double4 First source vector right Double4 Second source vector. result double When the method completes, contains the dot product of the two vectors. Equals(Double4) Determines whether the specified Double4 is equal to this instance. public readonly bool Equals(Double4 other) Parameters other Double4 The Double4 to compare with this instance. Returns bool true if the specified Double4 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Hermite(Double4, Double4, Double4, Double4, double) Performs a Hermite spline interpolation. public static Double4 Hermite(Double4 value1, Double4 tangent1, Double4 value2, Double4 tangent2, double amount) Parameters value1 Double4 First source position vector. tangent1 Double4 First source tangent vector. value2 Double4 Second source position vector. tangent2 Double4 Second source tangent vector. amount double Weighting factor. Returns Double4 The result of the Hermite spline interpolation. Hermite(ref readonly Double4, ref readonly Double4, ref readonly Double4, ref readonly Double4, double, out Double4) Performs a Hermite spline interpolation. public static void Hermite(ref readonly Double4 value1, ref readonly Double4 tangent1, ref readonly Double4 value2, ref readonly Double4 tangent2, double amount, out Double4 result) Parameters value1 Double4 First source position vector. tangent1 Double4 First source tangent vector. value2 Double4 Second source position vector. tangent2 Double4 Second source tangent vector. amount double Weighting factor. result Double4 When the method completes, contains the result of the Hermite spline interpolation. Length() Calculates the length of the vector. public readonly double Length() Returns double The length of the vector. Remarks LengthSquared() may be preferred when only the relative length is needed and speed is of the essence. LengthSquared() Calculates the squared length of the vector. public readonly double LengthSquared() Returns double The squared length of the vector. Remarks This method may be preferred to Length() when only a relative length is needed and speed is of the essence. Lerp(Double4, Double4, double) Performs a linear interpolation between two vectors. public static Double4 Lerp(Double4 start, Double4 end, double amount) Parameters start Double4 Start vector. end Double4 End vector. amount double Value between 0 and 1 indicating the weight of end. Returns Double4 The linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Double4, ref readonly Double4, double, out Double4) Performs a linear interpolation between two vectors. public static void Lerp(ref readonly Double4 start, ref readonly Double4 end, double amount, out Double4 result) Parameters start Double4 Start vector. end Double4 End vector. amount double Value between 0 and 1 indicating the weight of end. result Double4 When the method completes, contains the linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Double4, Double4) Returns a vector containing the largest components of the specified vectors. public static Double4 Max(Double4 left, Double4 right) Parameters left Double4 The first source vector. right Double4 The second source vector. Returns Double4 A vector containing the largest components of the source vectors. Max(ref readonly Double4, ref readonly Double4, out Double4) Returns a vector containing the smallest components of the specified vectors. public static void Max(ref readonly Double4 left, ref readonly Double4 right, out Double4 result) Parameters left Double4 The first source vector. right Double4 The second source vector. result Double4 When the method completes, contains an new vector composed of the largest components of the source vectors. Min(Double4, Double4) Returns a vector containing the smallest components of the specified vectors. public static Double4 Min(Double4 left, Double4 right) Parameters left Double4 The first source vector. right Double4 The second source vector. Returns Double4 A vector containing the smallest components of the source vectors. Min(ref readonly Double4, ref readonly Double4, out Double4) Returns a vector containing the smallest components of the specified vectors. public static void Min(ref readonly Double4 left, ref readonly Double4 right, out Double4 result) Parameters left Double4 The first source vector. right Double4 The second source vector. result Double4 When the method completes, contains an new vector composed of the smallest components of the source vectors. Modulate(Double4, Double4) Modulates a vector with another by performing component-wise multiplication. public static Double4 Modulate(Double4 left, Double4 right) Parameters left Double4 The first vector to modulate. right Double4 The second vector to modulate. Returns Double4 The modulated vector. Modulate(ref readonly Double4, ref readonly Double4, out Double4) Modulates a vector with another by performing component-wise multiplication. public static void Modulate(ref readonly Double4 left, ref readonly Double4 right, out Double4 result) Parameters left Double4 The first vector to modulate. right Double4 The second vector to modulate. result Double4 When the method completes, contains the modulated vector. Multiply(Double4, double) Scales a vector by the given value. public static Double4 Multiply(Double4 value, double scale) Parameters value Double4 The vector to scale. scale double The amount by which to scale the vector. Returns Double4 The scaled vector. Multiply(ref readonly Double4, double, out Double4) Scales a vector by the given value. public static void Multiply(ref readonly Double4 value, double scale, out Double4 result) Parameters value Double4 The vector to scale. scale double The amount by which to scale the vector. result Double4 When the method completes, contains the scaled vector. Negate(Double4) Reverses the direction of a given vector. public static Double4 Negate(Double4 value) Parameters value Double4 The vector to negate. Returns Double4 A vector facing in the opposite direction. Negate(ref readonly Double4, out Double4) Reverses the direction of a given vector. public static void Negate(ref readonly Double4 value, out Double4 result) Parameters value Double4 The vector to negate. result Double4 When the method completes, contains a vector facing in the opposite direction. Normalize() Converts the vector into a unit vector. public void Normalize() Normalize(Double4) Converts the vector into a unit vector. public static Double4 Normalize(Double4 value) Parameters value Double4 The vector to normalize. Returns Double4 The normalized vector. Normalize(ref readonly Double4, out Double4) Converts the vector into a unit vector. public static void Normalize(ref readonly Double4 value, out Double4 result) Parameters value Double4 The vector to normalize. result Double4 When the method completes, contains the normalized vector. Orthogonalize(Double4[], params Double4[]) Orthogonalizes a list of vectors. public static void Orthogonalize(Double4[] destination, params Double4[] source) Parameters destination Double4[] The list of orthogonalized vectors. source Double4[] The list of vectors to orthogonalize. Remarks Orthogonalization is the process of making all vectors orthogonal to each other. This means that any given vector in the list will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Orthonormalize(Double4[], params Double4[]) Orthonormalizes a list of vectors. public static void Orthonormalize(Double4[] destination, params Double4[] source) Parameters destination Double4[] The list of orthonormalized vectors. source Double4[] The list of vectors to orthonormalize. Remarks Orthonormalization is the process of making all vectors orthogonal to each other and making all vectors of unit length. This means that any given vector will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Pow(double) Raises the exponent for each components. public void Pow(double exponent) Parameters exponent double The exponent. SmoothStep(Double4, Double4, double) Performs a cubic interpolation between two vectors. public static Double4 SmoothStep(Double4 start, Double4 end, double amount) Parameters start Double4 Start vector. end Double4 End vector. amount double Value between 0 and 1 indicating the weight of end. Returns Double4 The cubic interpolation of the two vectors. SmoothStep(ref readonly Double4, ref readonly Double4, double, out Double4) Performs a cubic interpolation between two vectors. public static void SmoothStep(ref readonly Double4 start, ref readonly Double4 end, double amount, out Double4 result) Parameters start Double4 Start vector. end Double4 End vector. amount double Value between 0 and 1 indicating the weight of end. result Double4 When the method completes, contains the cubic interpolation of the two vectors. Subtract(Double4, Double4) Subtracts two vectors. public static Double4 Subtract(Double4 left, Double4 right) Parameters left Double4 The first vector to subtract. right Double4 The second vector to subtract. Returns Double4 The difference of the two vectors. Subtract(ref readonly Double4, ref readonly Double4, out Double4) Subtracts two vectors. public static void Subtract(ref readonly Double4 left, ref readonly Double4 right, out Double4 result) Parameters left Double4 The first vector to subtract. right Double4 The second vector to subtract. result Double4 When the method completes, contains the difference of the two vectors. ToArray() Creates an array containing the elements of the vector. public readonly double[] ToArray() Returns double[] A four-element array containing the components of the vector. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transform(Double4, Matrix) Transforms a 4D vector by the given Matrix. public static Double4 Transform(Double4 vector, Matrix transform) Parameters vector Double4 The source vector. transform Matrix The transformation Matrix. Returns Double4 The transformed Double4. Transform(Double4, Quaternion) Transforms a 4D vector by the given Quaternion rotation. public static Double4 Transform(Double4 vector, Quaternion rotation) Parameters vector Double4 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. Returns Double4 The transformed Double4. Transform(ref readonly Double4, ref readonly Matrix, out Double4) Transforms a 4D vector by the given Matrix. public static void Transform(ref readonly Double4 vector, ref readonly Matrix transform, out Double4 result) Parameters vector Double4 The source vector. transform Matrix The transformation Matrix. result Double4 When the method completes, contains the transformed Double4. Transform(ref readonly Double4, ref readonly Quaternion, out Double4) Transforms a 4D vector by the given Quaternion rotation. public static void Transform(ref readonly Double4 vector, ref readonly Quaternion rotation, out Double4 result) Parameters vector Double4 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. result Double4 When the method completes, contains the transformed Double4. Transform(Double4[], ref readonly Matrix, Double4[]) Transforms an array of 4D vectors by the given Matrix. public static void Transform(Double4[] source, ref readonly Matrix transform, Double4[] destination) Parameters source Double4[] The array of vectors to transform. transform Matrix The transformation Matrix. destination Double4[] The array for which the transformed vectors are stored. This array may be the same array as source. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Transform(Double4[], ref readonly Quaternion, Double4[]) Transforms an array of vectors by the given Quaternion rotation. public static void Transform(Double4[] source, ref readonly Quaternion rotation, Double4[] destination) Parameters source Double4[] The array of vectors to transform. rotation Quaternion The Quaternion rotation to apply. destination Double4[] The array for which the transformed vectors are stored. This array may be the same array as source. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Operators operator +(Double4, Double4) Adds two vectors. public static Double4 operator +(Double4 left, Double4 right) Parameters left Double4 The first vector to add. right Double4 The second vector to add. Returns Double4 The sum of the two vectors. operator /(Double4, Double4) Divides a vector by the given vector, component-wise. public static Double4 operator /(Double4 value, Double4 by) Parameters value Double4 The vector to scale. by Double4 The by. Returns Double4 The scaled vector. operator /(Double4, double) Scales a vector by the given value. public static Double4 operator /(Double4 value, double scale) Parameters value Double4 The vector to scale. scale double The amount by which to scale the vector. Returns Double4 The scaled vector. operator /(double, Double4) Divides a numerator by a vector. public static Double4 operator /(double numerator, Double4 value) Parameters numerator double The numerator. value Double4 The value. Returns Double4 The scaled vector. operator ==(Double4, Double4) Tests for equality between two objects. public static bool operator ==(Double4 left, Double4 right) Parameters left Double4 The first value to compare. right Double4 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Double2(Double4) Performs an explicit conversion from Double4 to Double2. public static explicit operator Double2(Double4 value) Parameters value Double4 The value. Returns Double2 The result of the conversion. explicit operator Double3(Double4) Performs an explicit conversion from Double4 to Double3. public static explicit operator Double3(Double4 value) Parameters value Double4 The value. Returns Double3 The result of the conversion. explicit operator Half4(Double4) Performs an explicit conversion from Double4 to Half4. public static explicit operator Half4(Double4 value) Parameters value Double4 The value. Returns Half4 The result of the conversion. explicit operator Vector4(Double4) Performs an explicit conversion from Double4 to Vector4. public static explicit operator Vector4(Double4 value) Parameters value Double4 The value. Returns Vector4 The result of the conversion. explicit operator Vector4(Double4) Casts from Stride.Maths to System.Numerics vectors public static explicit operator Vector4(Double4 v) Parameters v Double4 Value to cast Returns Vector4 explicit operator Double4(Half4) Performs an explicit conversion from Half4 to Double4. public static explicit operator Double4(Half4 value) Parameters value Half4 The value. Returns Double4 The result of the conversion. implicit operator Double4(Vector4) Performs an implicit conversion from Vector4 to Double4. public static implicit operator Double4(Vector4 value) Parameters value Vector4 The value. Returns Double4 The result of the conversion. implicit operator Double4(Vector4) Casts from System.Numerics to Stride.Maths vectors public static implicit operator Double4(Vector4 v) Parameters v Vector4 Value to cast Returns Double4 operator !=(Double4, Double4) Tests for inequality between two objects. public static bool operator !=(Double4 left, Double4 right) Parameters left Double4 The first value to compare. right Double4 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Double4, Double4) Modulates a vector with another by performing component-wise multiplication. public static Double4 operator *(Double4 left, Double4 right) Parameters left Double4 The first vector to multiply. right Double4 The second vector to multiply. Returns Double4 The multiplication of the two vectors. operator *(Double4, double) Scales a vector by the given value. public static Double4 operator *(Double4 value, double scale) Parameters value Double4 The vector to scale. scale double The amount by which to scale the vector. Returns Double4 The scaled vector. operator *(double, Double4) Scales a vector by the given value. public static Double4 operator *(double scale, Double4 value) Parameters scale double The amount by which to scale the vector. value Double4 The vector to scale. Returns Double4 The scaled vector. operator -(Double4, Double4) Subtracts two vectors. public static Double4 operator -(Double4 left, Double4 right) Parameters left Double4 The first vector to subtract. right Double4 The second vector to subtract. Returns Double4 The difference of the two vectors. operator -(Double4) Reverses the direction of a given vector. public static Double4 operator -(Double4 value) Parameters value Double4 The vector to negate. Returns Double4 A vector facing in the opposite direction. operator +(Double4) Assert a vector (return it unchanged). public static Double4 operator +(Double4 value) Parameters value Double4 The vector to assert (unchange). Returns Double4 The asserted (unchanged) vector."
  },
  "api/Stride.Core.Mathematics.GuillotinePacker.InsertRectangleCallback.html": {
    "href": "api/Stride.Core.Mathematics.GuillotinePacker.InsertRectangleCallback.html",
    "title": "Delegate GuillotinePacker.InsertRectangleCallback | Stride API",
    "summary": "Delegate GuillotinePacker.InsertRectangleCallback Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll A delegate callback used by TryInsert(int, int, int, InsertRectangleCallback) public delegate void GuillotinePacker.InsertRectangleCallback(int cascadeIndex, ref Rectangle rectangle) Parameters cascadeIndex int The index of the rectangle rectangle Rectangle The rectangle found Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Mathematics.GuillotinePacker.html": {
    "href": "api/Stride.Core.Mathematics.GuillotinePacker.html",
    "title": "Class GuillotinePacker | Stride API",
    "summary": "Class GuillotinePacker Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Implementation of a \"Guillotine\" packer. More information at https://github.com/juj/RectangleBinPack/blob/master/RectangleBinPack.pdf. public class GuillotinePacker Inheritance object GuillotinePacker Extension Methods UnsafeUtilities.As<T>(object?) Properties Height Current height used by the packer. public int Height { get; } Property Value int Width Current width used by the packer. public int Width { get; } Property Value int Methods Clear() Clears the whole region. public virtual void Clear() Clear(int, int) Clears the specified region. public void Clear(int width, int height) Parameters width int The width. height int The height. Free(ref Rectangle) Frees the specified old rectangle. public void Free(ref Rectangle oldRectangle) Parameters oldRectangle Rectangle The old rectangle. Insert(int, int, ref Rectangle) Tries to fit a single rectangle with the specified width and height. public bool Insert(int width, int height, ref Rectangle bestRectangle) Parameters width int Width requested. height int Height requested bestRectangle Rectangle Fill with the rectangle if it was successfully inserted. Returns bool true if it was successfully inserted. TryInsert(int, int, int, InsertRectangleCallback) Tries to fit multiple rectangle with (width, height). public bool TryInsert(int width, int height, int count, GuillotinePacker.InsertRectangleCallback inserted) Parameters width int Width requested. height int Height requested count int The number of rectangle to fit. inserted GuillotinePacker.InsertRectangleCallback A callback called for each rectangle successfully fitted. Returns bool true if all rectangles were successfully fitted."
  },
  "api/Stride.Core.Mathematics.Half.html": {
    "href": "api/Stride.Core.Mathematics.Half.html",
    "title": "Struct Half | Stride API",
    "summary": "Struct Half Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll A half precision (16 bit) floating point value. [DataContract] public struct Half : ISpanFormattable, IFormattable Implements ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Half(float) Initializes a new instance of the Half structure. public Half(float value) Parameters value float The floating point value that should be stored in 16 bit format. Fields AdditionRounding Additional rounding. public const int AdditionRounding = 1 Field Value int Epsilon Smallest such that 1.0 + epsilon != 1.0 public static readonly float Epsilon Field Value float ExponentRadix Exponent radix. public const int ExponentRadix = 2 Field Value int MantissaBits Number of bits in the mantissa. public const int MantissaBits = 11 Field Value int MaxValue Maximum value of the number. public static readonly float MaxValue Field Value float MaximumBinaryExponent Maximum binary exponent. public const int MaximumBinaryExponent = 15 Field Value int MaximumDecimalExponent Maximum decimal exponent. public const int MaximumDecimalExponent = 4 Field Value int MinValue Minimum value of the number. public static readonly float MinValue Field Value float MinimumBinaryExponent Minimum binary exponent. public const int MinimumBinaryExponent = -14 Field Value int MinimumDecimalExponent Minimum decimal exponent. public const int MinimumDecimalExponent = -4 Field Value int One A Half whose value is 1.0f. public static readonly Half One Field Value Half PrecisionDigits Number of decimal digits of precision. public const int PrecisionDigits = 3 Field Value int Zero A Half whose value is 0.0f. public static readonly Half Zero Field Value Half Properties RawValue Gets or sets the raw 16 bit value used to back this half-float. public ushort RawValue { readonly get; set; } Property Value ushort Methods ConvertToFloat(Half[]) Converts an array of half precision values into full precision values. public static float[] ConvertToFloat(Half[] values) Parameters values Half[] The values to be converted. Returns float[] An array of converted values. ConvertToHalf(float[]) Converts an array of full precision values into half precision values. public static Half[] ConvertToHalf(float[] values) Parameters values float[] The values to be converted. Returns Half[] An array of converted values. Equals(Half) Returns a value that indicates whether the current instance is equal to the specified object. public readonly bool Equals(Half other) Parameters other Half Object to make the comparison with. Returns bool true if the current instance is equal to the specified object; false otherwise. Equals(ref readonly Half, ref readonly Half) Determines whether the specified object instances are considered equal. public static bool Equals(ref readonly Half value1, ref readonly Half value2) Parameters value1 Half The first value. value2 Half The second value. Returns bool true if value1 is the same instance as value2 or if both are null references or if value1.Equals(value2) returns true; otherwise, false. Equals(object?) Returns a value that indicates whether the current instance is equal to a specified object. public override readonly bool Equals(object? obj) Parameters obj object Object to make the comparison with. Returns bool true if the current instance is equal to the specified object; false otherwise. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer hash code. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator ==(Half, Half) Tests for equality between two objects. public static bool operator ==(Half left, Half right) Parameters left Half The first value to compare. right Half The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Half(float) Performs an explicit conversion from float to Half. public static explicit operator Half(float value) Parameters value float The value to be converted. Returns Half The converted value. implicit operator float(Half) Performs an implicit conversion from Half to float. public static implicit operator float(Half value) Parameters value Half The value to be converted. Returns float The converted value. operator !=(Half, Half) Tests for inequality between two objects. public static bool operator !=(Half left, Half right) Parameters left Half The first value to compare. right Half The second value to compare. Returns bool true if left has a different value than right; otherwise, false."
  },
  "api/Stride.Core.Mathematics.Half2.html": {
    "href": "api/Stride.Core.Mathematics.Half2.html",
    "title": "Struct Half2 | Stride API",
    "summary": "Struct Half2 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a two dimensional mathematical vector with half-precision floats. [DataContract] public struct Half2 : IEquatable<Half2>, ISpanFormattable, IFormattable Implements IEquatable<Half2> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Half2(Half) Initializes a new instance of the Half2 structure. public Half2(Half value) Parameters value Half The value to set for both the X and Y components. Half2(Half, Half) Initializes a new instance of the Half2 structure. public Half2(Half x, Half y) Parameters x Half The X component. y Half The Y component. Half2(Half[]) Initializes a new instance of the Half2 struct. public Half2(Half[] values) Parameters values Half[] The values to assign to the X and Y components of the vector. This must be an array with two elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than two elements. Half2(float) Initializes a new instance of the Half2 structure. public Half2(float value) Parameters value float The value to set for both the X and Y components. Half2(float, float) Initializes a new instance of the Half2 structure. public Half2(float x, float y) Parameters x float The X component. y float The Y component. Fields One A Half2 with all of its components set to one. public static readonly Half2 One Field Value Half2 SizeInBytes The size of the Half2 type, in bytes. public static readonly int SizeInBytes Field Value int UnitX The X unit Half2 (1, 0). public static readonly Half2 UnitX Field Value Half2 UnitY The Y unit Half2 (0, 1). public static readonly Half2 UnitY Field Value Half2 X Gets or sets the X component of the vector. public Half X Field Value Half The X component of the vector. Y Gets or sets the Y component of the vector. public Half Y Field Value Half The Y component of the vector. Zero A Half2 with all of its components set to zero. public static readonly Half2 Zero Field Value Half2 Methods Deconstruct(out Half, out Half) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out Half x, out Half y) Parameters x Half The X component y Half The Y component Equals(Half2) Returns a value that indicates whether the current instance is equal to the specified object. public readonly bool Equals(Half2 other) Parameters other Half2 Object to make the comparison with. Returns bool true if the current instance is equal to the specified object; false otherwise. Equals(ref readonly Half2, ref readonly Half2) Determines whether the specified object instances are considered equal. public static bool Equals(ref readonly Half2 value1, ref readonly Half2 value2) Parameters value1 Half2 The first value. value2 Half2 The second value. Returns bool true if value1 is the same instance as value2 or if both are null references or if value1.Equals(value2) returns true; otherwise, false. Equals(object?) Returns a value that indicates whether the current instance is equal to a specified object. public override readonly bool Equals(object? obj) Parameters obj object Object to make the comparison with. Returns bool true if the current instance is equal to the specified object; false otherwise. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer hash code. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator ==(Half2, Half2) Tests for equality between two objects. public static bool operator ==(Half2 left, Half2 right) Parameters left Half2 The first value to compare. right Half2 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Vector2(Half2) Performs an explicit conversion from Half2 to Vector2. public static explicit operator Vector2(Half2 value) Parameters value Half2 The value. Returns Vector2 The result of the conversion. explicit operator Half2(Vector2) Performs an explicit conversion from Vector2 to Half2. public static explicit operator Half2(Vector2 value) Parameters value Vector2 The value. Returns Half2 The result of the conversion. operator !=(Half2, Half2) Tests for inequality between two objects. public static bool operator !=(Half2 left, Half2 right) Parameters left Half2 The first value to compare. right Half2 The second value to compare. Returns bool true if left has a different value than right; otherwise, false."
  },
  "api/Stride.Core.Mathematics.Half3.html": {
    "href": "api/Stride.Core.Mathematics.Half3.html",
    "title": "Struct Half3 | Stride API",
    "summary": "Struct Half3 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a three dimensional mathematical vector with half-precision floats. [DataContract] public struct Half3 : IEquatable<Half3>, ISpanFormattable, IFormattable Implements IEquatable<Half3> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Half3(Half) Initializes a new instance of the Half3 structure. public Half3(Half value) Parameters value Half The value to set for the X, Y, and Z components. Half3(Half, Half, Half) Initializes a new instance of the Half3 structure. public Half3(Half x, Half y, Half z) Parameters x Half The X component. y Half The Y component. z Half The Z component. Half3(Half[]) Initializes a new instance of the Half3 struct. public Half3(Half[] values) Parameters values Half[] The values to assign to the X, Y, and Z components of the vector. This must be an array with three elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than three elements. Half3(float) Initializes a new instance of the Half3 structure. public Half3(float value) Parameters value float The value to set for the X, Y, and Z components. Half3(float, float, float) Initializes a new instance of the Half3 structure. public Half3(float x, float y, float z) Parameters x float The X component. y float The Y component. z float The Z component. Fields One A Half3 with all of its components set to one. public static readonly Half3 One Field Value Half3 SizeInBytes The size of the Half3 type, in bytes. public static readonly int SizeInBytes Field Value int UnitX The X unit Half3 (1, 0, 0). public static readonly Half3 UnitX Field Value Half3 UnitY The Y unit Half3 (0, 1, 0). public static readonly Half3 UnitY Field Value Half3 UnitZ The Z unit Half3 (0, 0, 1). public static readonly Half3 UnitZ Field Value Half3 X Gets or sets the X component of the vector. public Half X Field Value Half The X component of the vector. Y Gets or sets the Y component of the vector. public Half Y Field Value Half The Y component of the vector. Z Gets or sets the Z component of the vector. public Half Z Field Value Half The Z component of the vector. Zero A Half3 with all of its components set to zero. public static readonly Half3 Zero Field Value Half3 Methods Deconstruct(out Half, out Half, out Half) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out Half x, out Half y, out Half z) Parameters x Half The X component y Half The Y component z Half The Z component Equals(Half3) Returns a value that indicates whether the current instance is equal to the specified object. public readonly bool Equals(Half3 other) Parameters other Half3 Object to make the comparison with. Returns bool true if the current instance is equal to the specified object; false otherwise. Equals(ref readonly Half3, ref readonly Half3) Determines whether the specified object instances are considered equal. public static bool Equals(ref readonly Half3 value1, ref readonly Half3 value2) Parameters value1 Half3 The first value. value2 Half3 The second value. Returns bool true if value1 is the same instance as value2 or if both are null references or if value1.Equals(value2) returns true; otherwise, false. Equals(object?) Returns a value that indicates whether the current instance is equal to a specified object. public override readonly bool Equals(object? obj) Parameters obj object Object to make the comparison with. Returns bool true if the current instance is equal to the specified object; false otherwise. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer hash code. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator ==(Half3, Half3) Tests for equality between two objects. public static bool operator ==(Half3 left, Half3 right) Parameters left Half3 The first value to compare. right Half3 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Vector3(Half3) Performs an explicit conversion from Half3 to Vector3. public static explicit operator Vector3(Half3 value) Parameters value Half3 The value. Returns Vector3 The result of the conversion. explicit operator Half3(Vector3) Performs an explicit conversion from Vector3 to Half3. public static explicit operator Half3(Vector3 value) Parameters value Vector3 The value. Returns Half3 The result of the conversion. operator !=(Half3, Half3) Tests for inequality between two objects. public static bool operator !=(Half3 left, Half3 right) Parameters left Half3 The first value to compare. right Half3 The second value to compare. Returns bool true if left has a different value than right; otherwise, false."
  },
  "api/Stride.Core.Mathematics.Half4.html": {
    "href": "api/Stride.Core.Mathematics.Half4.html",
    "title": "Struct Half4 | Stride API",
    "summary": "Struct Half4 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a four dimensional mathematical vector with half-precision floats. [DataContract] public struct Half4 : IEquatable<Half4>, ISpanFormattable, IFormattable Implements IEquatable<Half4> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Half4(Half) Initializes a new instance of the Half4 structure. public Half4(Half value) Parameters value Half The value to set for the X, Y, Z, and W components. Half4(Half, Half, Half, Half) Initializes a new instance of the Half4 structure. public Half4(Half x, Half y, Half z, Half w) Parameters x Half The X component. y Half The Y component. z Half The Z component. w Half The W component. Half4(Half[]) Initializes a new instance of the Half4 struct. public Half4(Half[] values) Parameters values Half[] The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Half4(float) Initializes a new instance of the Half4 structure. public Half4(float value) Parameters value float The value to set for the X, Y, Z, and W components. Half4(float, float, float, float) Initializes a new instance of the Half4 structure. public Half4(float x, float y, float z, float w) Parameters x float The X component. y float The Y component. z float The Z component. w float The W component. Fields One A Half4 with all of its components set to one. public static readonly Half4 One Field Value Half4 SizeInBytes The size of the Half4 type, in bytes. public static readonly int SizeInBytes Field Value int UnitW The W unit Half4 (0, 0, 0, 1). public static readonly Half4 UnitW Field Value Half4 UnitX The X unit Half4 (1, 0, 0, 0). public static readonly Half4 UnitX Field Value Half4 UnitY The Y unit Half4 (0, 1, 0, 0). public static readonly Half4 UnitY Field Value Half4 UnitZ The Z unit Half4 (0, 0, 1, 0). public static readonly Half4 UnitZ Field Value Half4 W Gets or sets the W component of the vector. public Half W Field Value Half The W component of the vector. X Gets or sets the X component of the vector. public Half X Field Value Half The X component of the vector. Y Gets or sets the Y component of the vector. public Half Y Field Value Half The Y component of the vector. Z Gets or sets the Z component of the vector. public Half Z Field Value Half The Z component of the vector. Zero A Half4 with all of its components set to zero. public static readonly Half4 Zero Field Value Half4 Methods Deconstruct(out Half, out Half, out Half, out Half) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out Half x, out Half y, out Half z, out Half w) Parameters x Half The X component y Half The Y component z Half The Z component w Half The W component Equals(Half4) Returns a value that indicates whether the current instance is equal to the specified object. public readonly bool Equals(Half4 other) Parameters other Half4 Object to make the comparison with. Returns bool true if the current instance is equal to the specified object; false otherwise. Equals(ref readonly Half4, ref readonly Half4) Determines whether the specified object instances are considered equal. public static bool Equals(ref readonly Half4 value1, ref readonly Half4 value2) Parameters value1 Half4 The first value. value2 Half4 The second value. Returns bool true if value1 is the same instance as value2 or if both are null references or if value1.Equals(value2) returns true; otherwise, false. Equals(object?) Returns a value that indicates whether the current instance is equal to a specified object. public override readonly bool Equals(object? obj) Parameters obj object Object to make the comparison with. Returns bool true if the current instance is equal to the specified object; false otherwise. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer hash code. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator ==(Half4, Half4) Tests for equality between two objects. public static bool operator ==(Half4 left, Half4 right) Parameters left Half4 The first value to compare. right Half4 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Vector4(Half4) Performs an explicit conversion from Half4 to Vector4. public static explicit operator Vector4(Half4 value) Parameters value Half4 The value. Returns Vector4 The result of the conversion. explicit operator Half4(Vector4) Performs an explicit conversion from Vector4 to Half4. public static explicit operator Half4(Vector4 value) Parameters value Vector4 The value. Returns Half4 The result of the conversion. operator !=(Half4, Half4) Tests for inequality between two objects. public static bool operator !=(Half4 left, Half4 right) Parameters left Half4 The first value to compare. right Half4 The second value to compare. Returns bool true if left has a different value than right; otherwise, false."
  },
  "api/Stride.Core.Mathematics.IIntersectableWithPlane.html": {
    "href": "api/Stride.Core.Mathematics.IIntersectableWithPlane.html",
    "title": "Interface IIntersectableWithPlane | Stride API",
    "summary": "Interface IIntersectableWithPlane Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Allows to determine intersections with a Plane. public interface IIntersectableWithPlane Extension Methods UnsafeUtilities.As<T>(object?) Methods Intersects(ref readonly Plane) Determines if there is an intersection between the current object and a Plane. PlaneIntersectionType Intersects(ref readonly Plane plane) Parameters plane Plane The plane to test. Returns PlaneIntersectionType Whether the two objects intersected."
  },
  "api/Stride.Core.Mathematics.IIntersectableWithRay.html": {
    "href": "api/Stride.Core.Mathematics.IIntersectableWithRay.html",
    "title": "Interface IIntersectableWithRay | Stride API",
    "summary": "Interface IIntersectableWithRay Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Allows to determine intersections with a Ray. public interface IIntersectableWithRay Extension Methods UnsafeUtilities.As<T>(object?) Methods Intersects(ref readonly Ray) Determines if there is an intersection between the current object and a Ray. bool Intersects(ref readonly Ray ray) Parameters ray Ray The ray to test. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray, out Vector3) Determines if there is an intersection between the current object and a Ray. bool Intersects(ref readonly Ray ray, out Vector3 point) Parameters ray Ray The ray to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray, out float) Determines if there is an intersection between the current object and a Ray. bool Intersects(ref readonly Ray ray, out float distance) Parameters ray Ray The ray to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected."
  },
  "api/Stride.Core.Mathematics.Int2.html": {
    "href": "api/Stride.Core.Mathematics.Int2.html",
    "title": "Struct Int2 | Stride API",
    "summary": "Struct Int2 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a two dimensional mathematical vector. [DataContract(\"Int2\")] [DataStyle(DataStyle.Compact)] public struct Int2 : IEquatable<Int2>, ISpanFormattable, IFormattable Implements IEquatable<Int2> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Int2(Vector2) Initializes a new instance of the Int2 struct. public Int2(Vector2 value) Parameters value Vector2 A vector containing the values with which to initialize the X and Y components. Int2(int) Initializes a new instance of the Int2 struct. public Int2(int value) Parameters value int The value that will be assigned to all components. Int2(int, int) Initializes a new instance of the Int2 struct. public Int2(int x, int y) Parameters x int Initial value for the X component of the vector. y int Initial value for the Y component of the vector. Int2(int[]) Initializes a new instance of the Int2 struct. public Int2(int[] values) Parameters values int[] The values to assign to the X, Y, and Z components of the vector. This must be an array with three elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than three elements. Fields One A Int2 with all of its components set to one. public static readonly Int2 One Field Value Int2 SizeInBytes The size of the Int2 type, in bytes. public static readonly int SizeInBytes Field Value int UnitX The X unit Int2 (1, 0, 0). public static readonly Int2 UnitX Field Value Int2 UnitY The Y unit Int2 (0, 1, 0). public static readonly Int2 UnitY Field Value Int2 X The X component of the vector. [DataMember(0)] public int X Field Value int Y The Y component of the vector. [DataMember(1)] public int Y Field Value int Zero A Int2 with all of its components set to zero. public static readonly Int2 Zero Field Value Int2 Properties this[int] Gets or sets the component at the specified index. public int this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the X component and 1 for the Y component. Property Value int The value of the X or Y component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 1]. Methods Add(Int2, Int2) Adds two vectors. public static Int2 Add(Int2 left, Int2 right) Parameters left Int2 The first vector to add. right Int2 The second vector to add. Returns Int2 The sum of the two vectors. Add(ref readonly Int2, ref readonly Int2, out Int2) Adds two vectors. public static void Add(ref readonly Int2 left, ref readonly Int2 right, out Int2 result) Parameters left Int2 The first vector to add. right Int2 The second vector to add. result Int2 When the method completes, contains the sum of the two vectors. Clamp(Int2, Int2, Int2) Restricts a value to be within a specified range. public static Int2 Clamp(Int2 value, Int2 min, Int2 max) Parameters value Int2 The value to clamp. min Int2 The minimum value. max Int2 The maximum value. Returns Int2 The clamped value. Clamp(ref readonly Int2, ref readonly Int2, ref readonly Int2, out Int2) Restricts a value to be within a specified range. public static void Clamp(ref readonly Int2 value, ref readonly Int2 min, ref readonly Int2 max, out Int2 result) Parameters value Int2 The value to clamp. min Int2 The minimum value. max Int2 The maximum value. result Int2 When the method completes, contains the clamped value. Deconstruct(out int, out int) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out int x, out int y) Parameters x int The X component y int The Y component Divide(Int2, int) Scales a vector by the given value. public static Int2 Divide(Int2 value, int scale) Parameters value Int2 The vector to scale. scale int The amount by which to scale the vector. Returns Int2 The scaled vector. Divide(ref readonly Int2, int, out Int2) Scales a vector by the given value. public static void Divide(ref readonly Int2 value, int scale, out Int2 result) Parameters value Int2 The vector to scale. scale int The amount by which to scale the vector. result Int2 When the method completes, contains the scaled vector. Dot(Int2, Int2) Calculates the dot product of two vectors. public static int Dot(Int2 left, Int2 right) Parameters left Int2 First source vector. right Int2 Second source vector. Returns int The dot product of the two vectors. Dot(ref readonly Int2, ref readonly Int2, out int) Calculates the dot product of two vectors. public static void Dot(ref readonly Int2 left, ref readonly Int2 right, out int result) Parameters left Int2 First source vector. right Int2 Second source vector. result int When the method completes, contains the dot product of the two vectors. Equals(Int2) Determines whether the specified Int2 is equal to this instance. public readonly bool Equals(Int2 other) Parameters other Int2 The Int2 to compare with this instance. Returns bool true if the specified Int2 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Length() Calculates the length of the vector. public readonly int Length() Returns int The length of the vector. Remarks LengthSquared() may be preferred when only the relative length is needed and speed is of the essence. LengthSquared() Calculates the squared length of the vector. public readonly int LengthSquared() Returns int The squared length of the vector. Remarks This method may be preferred to Length() when only a relative length is needed and speed is of the essence. Lerp(Int2, Int2, float) Performs a linear interpolation between two vectors. public static Int2 Lerp(Int2 start, Int2 end, float amount) Parameters start Int2 Start vector. end Int2 End vector. amount float Value between 0 and 1 indicating the weight of end. Returns Int2 The linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Int2, ref readonly Int2, float, out Int2) Performs a linear interpolation between two vectors. public static void Lerp(ref readonly Int2 start, ref readonly Int2 end, float amount, out Int2 result) Parameters start Int2 Start vector. end Int2 End vector. amount float Value between 0 and 1 indicating the weight of end. result Int2 When the method completes, contains the linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Int2, Int2) Returns a vector containing the largest components of the specified vectors. public static Int2 Max(Int2 left, Int2 right) Parameters left Int2 The first source vector. right Int2 The second source vector. Returns Int2 A vector containing the largest components of the source vectors. Max(ref readonly Int2, ref readonly Int2, out Int2) Returns a vector containing the smallest components of the specified vectors. public static void Max(ref readonly Int2 left, ref readonly Int2 right, out Int2 result) Parameters left Int2 The first source vector. right Int2 The second source vector. result Int2 When the method completes, contains an new vector composed of the largest components of the source vectors. Min(Int2, Int2) Returns a vector containing the smallest components of the specified vectors. public static Int2 Min(Int2 left, Int2 right) Parameters left Int2 The first source vector. right Int2 The second source vector. Returns Int2 A vector containing the smallest components of the source vectors. Min(ref readonly Int2, ref readonly Int2, out Int2) Returns a vector containing the smallest components of the specified vectors. public static void Min(ref readonly Int2 left, ref readonly Int2 right, out Int2 result) Parameters left Int2 The first source vector. right Int2 The second source vector. result Int2 When the method completes, contains an new vector composed of the smallest components of the source vectors. Modulate(Int2, Int2) Modulates a vector with another by performing component-wise multiplication. public static Int2 Modulate(Int2 left, Int2 right) Parameters left Int2 The first vector to modulate. right Int2 The second vector to modulate. Returns Int2 The modulated vector. Modulate(ref readonly Int2, ref readonly Int2, out Int2) Modulates a vector with another by performing component-wise multiplication. public static void Modulate(ref readonly Int2 left, ref readonly Int2 right, out Int2 result) Parameters left Int2 The first vector to modulate. right Int2 The second vector to modulate. result Int2 When the method completes, contains the modulated vector. Multiply(Int2, int) Scales a vector by the given value. public static Int2 Multiply(Int2 value, int scale) Parameters value Int2 The vector to scale. scale int The amount by which to scale the vector. Returns Int2 The scaled vector. Multiply(ref readonly Int2, int, out Int2) Scales a vector by the given value. public static void Multiply(ref readonly Int2 value, int scale, out Int2 result) Parameters value Int2 The vector to scale. scale int The amount by which to scale the vector. result Int2 When the method completes, contains the scaled vector. Negate(Int2) Reverses the direction of a given vector. public static Int2 Negate(Int2 value) Parameters value Int2 The vector to negate. Returns Int2 A vector facing in the opposite direction. Negate(ref readonly Int2, out Int2) Reverses the direction of a given vector. public static void Negate(ref readonly Int2 value, out Int2 result) Parameters value Int2 The vector to negate. result Int2 When the method completes, contains a vector facing in the opposite direction. Pow(int) Raises the exponent for each components. public void Pow(int exponent) Parameters exponent int The exponent. SmoothStep(Int2, Int2, float) Performs a cubic interpolation between two vectors. public static Int2 SmoothStep(Int2 start, Int2 end, float amount) Parameters start Int2 Start vector. end Int2 End vector. amount float Value between 0 and 1 indicating the weight of end. Returns Int2 The cubic interpolation of the two vectors. SmoothStep(ref readonly Int2, ref readonly Int2, float, out Int2) Performs a cubic interpolation between two vectors. public static void SmoothStep(ref readonly Int2 start, ref readonly Int2 end, float amount, out Int2 result) Parameters start Int2 Start vector. end Int2 End vector. amount float Value between 0 and 1 indicating the weight of end. result Int2 When the method completes, contains the cubic interpolation of the two vectors. Subtract(Int2, Int2) Subtracts two vectors. public static Int2 Subtract(Int2 left, Int2 right) Parameters left Int2 The first vector to subtract. right Int2 The second vector to subtract. Returns Int2 The difference of the two vectors. Subtract(ref readonly Int2, ref readonly Int2, out Int2) Subtracts two vectors. public static void Subtract(ref readonly Int2 left, ref readonly Int2 right, out Int2 result) Parameters left Int2 The first vector to subtract. right Int2 The second vector to subtract. result Int2 When the method completes, contains the difference of the two vectors. ToArray() Creates an array containing the elements of the vector. public readonly int[] ToArray() Returns int[] A two-element array containing the components of the vector. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator +(Int2, Int2) Adds two vectors. public static Int2 operator +(Int2 left, Int2 right) Parameters left Int2 The first vector to add. right Int2 The second vector to add. Returns Int2 The sum of the two vectors. operator /(Int2, float) Scales a vector by the given value. public static Int2 operator /(Int2 value, float scale) Parameters value Int2 The vector to scale. scale float The amount by which to scale the vector. Returns Int2 The scaled vector. operator ==(Int2, Int2) Tests for equality between two objects. public static bool operator ==(Int2 left, Int2 right) Parameters left Int2 The first value to compare. right Int2 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Vector2(Int2) Performs an explicit conversion from Int2 to Vector2. public static explicit operator Vector2(Int2 value) Parameters value Int2 The value. Returns Vector2 The result of the conversion. explicit operator Vector4(Int2) Performs an explicit conversion from Int2 to Vector4. public static explicit operator Vector4(Int2 value) Parameters value Int2 The value. Returns Vector4 The result of the conversion. explicit operator Vector2(Int2) Casts from Stride.Maths to System.Numerics vectors public static explicit operator Vector2(Int2 v) Parameters v Int2 Value to cast Returns Vector2 explicit operator Int2(Vector2) Casts from System.Numerics to Stride.Maths vectors public static explicit operator Int2(Vector2 v) Parameters v Vector2 Value to cast Returns Int2 operator !=(Int2, Int2) Tests for inequality between two objects. public static bool operator !=(Int2 left, Int2 right) Parameters left Int2 The first value to compare. right Int2 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Int2, float) Scales a vector by the given value. public static Int2 operator *(Int2 value, float scale) Parameters value Int2 The vector to scale. scale float The amount by which to scale the vector. Returns Int2 The scaled vector. operator *(float, Int2) Scales a vector by the given value. public static Int2 operator *(float scale, Int2 value) Parameters scale float The amount by which to scale the vector. value Int2 The vector to scale. Returns Int2 The scaled vector. operator -(Int2, Int2) Subtracts two vectors. public static Int2 operator -(Int2 left, Int2 right) Parameters left Int2 The first vector to subtract. right Int2 The second vector to subtract. Returns Int2 The difference of the two vectors. operator -(Int2) Reverses the direction of a given vector. public static Int2 operator -(Int2 value) Parameters value Int2 The vector to negate. Returns Int2 A vector facing in the opposite direction. operator +(Int2) Assert a vector (return it unchanged). public static Int2 operator +(Int2 value) Parameters value Int2 The vector to assert (unchange). Returns Int2 The asserted (unchanged) vector."
  },
  "api/Stride.Core.Mathematics.Int3.html": {
    "href": "api/Stride.Core.Mathematics.Int3.html",
    "title": "Struct Int3 | Stride API",
    "summary": "Struct Int3 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a three dimensional mathematical vector. [DataContract(\"Int3\")] [DataStyle(DataStyle.Compact)] public struct Int3 : IEquatable<Int3>, ISpanFormattable, IFormattable Implements IEquatable<Int3> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Int3(Vector2, int) Initializes a new instance of the Int3 struct. public Int3(Vector2 value, int z) Parameters value Vector2 A vector containing the values with which to initialize the X and Y components. z int Initial value for the Z component of the vector. Int3(int) Initializes a new instance of the Int3 struct. public Int3(int value) Parameters value int The value that will be assigned to all components. Int3(int, int, int) Initializes a new instance of the Int3 struct. public Int3(int x, int y, int z) Parameters x int Initial value for the X component of the vector. y int Initial value for the Y component of the vector. z int Initial value for the Z component of the vector. Int3(int[]) Initializes a new instance of the Int3 struct. public Int3(int[] values) Parameters values int[] The values to assign to the X, Y, and Z components of the vector. This must be an array with three elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than three elements. Fields One A Int3 with all of its components set to one. public static readonly Int3 One Field Value Int3 SizeInBytes The size of the Int3 type, in bytes. public static readonly int SizeInBytes Field Value int UnitX The X unit Int3 (1, 0, 0). public static readonly Int3 UnitX Field Value Int3 UnitY The Y unit Int3 (0, 1, 0). public static readonly Int3 UnitY Field Value Int3 UnitZ The Z unit Int3 (0, 0, 1). public static readonly Int3 UnitZ Field Value Int3 X The X component of the vector. [DataMember(0)] public int X Field Value int Y The Y component of the vector. [DataMember(1)] public int Y Field Value int Z The Z component of the vector. [DataMember(2)] public int Z Field Value int Zero A Int3 with all of its components set to zero. public static readonly Int3 Zero Field Value Int3 Properties this[int] Gets or sets the component at the specified index. public int this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the X component, 1 for the Y component, and 2 for the Z component. Property Value int The value of the X, Y, or Z component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 2]. Methods Add(Int3, Int3) Adds two vectors. public static Int3 Add(Int3 left, Int3 right) Parameters left Int3 The first vector to add. right Int3 The second vector to add. Returns Int3 The sum of the two vectors. Add(ref readonly Int3, ref readonly Int3, out Int3) Adds two vectors. public static void Add(ref readonly Int3 left, ref readonly Int3 right, out Int3 result) Parameters left Int3 The first vector to add. right Int3 The second vector to add. result Int3 When the method completes, contains the sum of the two vectors. Clamp(Int3, Int3, Int3) Restricts a value to be within a specified range. public static Int3 Clamp(Int3 value, Int3 min, Int3 max) Parameters value Int3 The value to clamp. min Int3 The minimum value. max Int3 The maximum value. Returns Int3 The clamped value. Clamp(ref readonly Int3, ref readonly Int3, ref readonly Int3, out Int3) Restricts a value to be within a specified range. public static void Clamp(ref readonly Int3 value, ref readonly Int3 min, ref readonly Int3 max, out Int3 result) Parameters value Int3 The value to clamp. min Int3 The minimum value. max Int3 The maximum value. result Int3 When the method completes, contains the clamped value. Deconstruct(out int, out int, out int) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out int x, out int y, out int z) Parameters x int The X component y int The Y component z int The Z component Divide(Int3, int) Scales a vector by the given value. public static Int3 Divide(Int3 value, int scale) Parameters value Int3 The vector to scale. scale int The amount by which to scale the vector. Returns Int3 The scaled vector. Divide(ref readonly Int3, int, out Int3) Scales a vector by the given value. public static void Divide(ref readonly Int3 value, int scale, out Int3 result) Parameters value Int3 The vector to scale. scale int The amount by which to scale the vector. result Int3 When the method completes, contains the scaled vector. Dot(Int3, Int3) Calculates the dot product of two vectors. public static int Dot(Int3 left, Int3 right) Parameters left Int3 First source vector. right Int3 Second source vector. Returns int The dot product of the two vectors. Dot(ref readonly Int3, ref readonly Int3, out int) Calculates the dot product of two vectors. public static void Dot(ref readonly Int3 left, ref readonly Int3 right, out int result) Parameters left Int3 First source vector. right Int3 Second source vector. result int When the method completes, contains the dot product of the two vectors. Equals(Int3) Determines whether the specified Int3 is equal to this instance. public readonly bool Equals(Int3 other) Parameters other Int3 The Int3 to compare with this instance. Returns bool true if the specified Int3 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Length() Calculates the length of the vector. public readonly int Length() Returns int The length of the vector. Remarks LengthSquared() may be preferred when only the relative length is needed and speed is of the essence. LengthSquared() Calculates the squared length of the vector. public readonly int LengthSquared() Returns int The squared length of the vector. Remarks This method may be preferred to Length() when only a relative length is needed and speed is of the essence. LengthUntruncated() Calculates the untruncated length of the vector. public readonly float LengthUntruncated() Returns float The length of the vector untruncated. Lerp(Int3, Int3, float) Performs a linear interpolation between two vectors. public static Int3 Lerp(Int3 start, Int3 end, float amount) Parameters start Int3 Start vector. end Int3 End vector. amount float Value between 0 and 1 indicating the weight of end. Returns Int3 The linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Int3, ref readonly Int3, float, out Int3) Performs a linear interpolation between two vectors. public static void Lerp(ref readonly Int3 start, ref readonly Int3 end, float amount, out Int3 result) Parameters start Int3 Start vector. end Int3 End vector. amount float Value between 0 and 1 indicating the weight of end. result Int3 When the method completes, contains the linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Int3, Int3) Returns a vector containing the largest components of the specified vectors. public static Int3 Max(Int3 left, Int3 right) Parameters left Int3 The first source vector. right Int3 The second source vector. Returns Int3 A vector containing the largest components of the source vectors. Max(ref readonly Int3, ref readonly Int3, out Int3) Returns a vector containing the smallest components of the specified vectors. public static void Max(ref readonly Int3 left, ref readonly Int3 right, out Int3 result) Parameters left Int3 The first source vector. right Int3 The second source vector. result Int3 When the method completes, contains an new vector composed of the largest components of the source vectors. Min(Int3, Int3) Returns a vector containing the smallest components of the specified vectors. public static Int3 Min(Int3 left, Int3 right) Parameters left Int3 The first source vector. right Int3 The second source vector. Returns Int3 A vector containing the smallest components of the source vectors. Min(ref readonly Int3, ref readonly Int3, out Int3) Returns a vector containing the smallest components of the specified vectors. public static void Min(ref readonly Int3 left, ref readonly Int3 right, out Int3 result) Parameters left Int3 The first source vector. right Int3 The second source vector. result Int3 When the method completes, contains an new vector composed of the smallest components of the source vectors. Modulate(Int3, Int3) Modulates a vector with another by performing component-wise multiplication. public static Int3 Modulate(Int3 left, Int3 right) Parameters left Int3 The first vector to modulate. right Int3 The second vector to modulate. Returns Int3 The modulated vector. Modulate(ref readonly Int3, ref readonly Int3, out Int3) Modulates a vector with another by performing component-wise multiplication. public static void Modulate(ref readonly Int3 left, ref readonly Int3 right, out Int3 result) Parameters left Int3 The first vector to modulate. right Int3 The second vector to modulate. result Int3 When the method completes, contains the modulated vector. Multiply(Int3, int) Scales a vector by the given value. public static Int3 Multiply(Int3 value, int scale) Parameters value Int3 The vector to scale. scale int The amount by which to scale the vector. Returns Int3 The scaled vector. Multiply(ref readonly Int3, int, out Int3) Scales a vector by the given value. public static void Multiply(ref readonly Int3 value, int scale, out Int3 result) Parameters value Int3 The vector to scale. scale int The amount by which to scale the vector. result Int3 When the method completes, contains the scaled vector. Negate(Int3) Reverses the direction of a given vector. public static Int3 Negate(Int3 value) Parameters value Int3 The vector to negate. Returns Int3 A vector facing in the opposite direction. Negate(ref readonly Int3, out Int3) Reverses the direction of a given vector. public static void Negate(ref readonly Int3 value, out Int3 result) Parameters value Int3 The vector to negate. result Int3 When the method completes, contains a vector facing in the opposite direction. Pow(int) Raises the exponent for each components. public void Pow(int exponent) Parameters exponent int The exponent. Round(in Vector3, out Int3, MidpointRounding) Returns a vector containing the rounded values of the specified vector. public static void Round(in Vector3 value, out Int3 result, MidpointRounding rounding = MidpointRounding.ToEven) Parameters value Vector3 The source vector. result Int3 When the method completes, contains an new vector composed of the rounded values of the specified vector. rounding MidpointRounding The rounding strategy to use. Round(in Vector3, MidpointRounding) Returns a vector containing the rounded values of the specified vector. public static Int3 Round(in Vector3 value, MidpointRounding rounding = MidpointRounding.ToEven) Parameters value Vector3 The source vector. rounding MidpointRounding The rounding strategy to use. Returns Int3 A vector containing the rounded values of the source vector. SmoothStep(Int3, Int3, float) Performs a cubic interpolation between two vectors. public static Int3 SmoothStep(Int3 start, Int3 end, float amount) Parameters start Int3 Start vector. end Int3 End vector. amount float Value between 0 and 1 indicating the weight of end. Returns Int3 The cubic interpolation of the two vectors. SmoothStep(ref readonly Int3, ref readonly Int3, float, out Int3) Performs a cubic interpolation between two vectors. public static void SmoothStep(ref readonly Int3 start, ref readonly Int3 end, float amount, out Int3 result) Parameters start Int3 Start vector. end Int3 End vector. amount float Value between 0 and 1 indicating the weight of end. result Int3 When the method completes, contains the cubic interpolation of the two vectors. Subtract(Int3, Int3) Subtracts two vectors. public static Int3 Subtract(Int3 left, Int3 right) Parameters left Int3 The first vector to subtract. right Int3 The second vector to subtract. Returns Int3 The difference of the two vectors. Subtract(ref readonly Int3, ref readonly Int3, out Int3) Subtracts two vectors. public static void Subtract(ref readonly Int3 left, ref readonly Int3 right, out Int3 result) Parameters left Int3 The first vector to subtract. right Int3 The second vector to subtract. result Int3 When the method completes, contains the difference of the two vectors. ToArray() Creates an array containing the elements of the vector. public readonly int[] ToArray() Returns int[] A three-element array containing the components of the vector. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator +(Int3, Int3) Adds two vectors. public static Int3 operator +(Int3 left, Int3 right) Parameters left Int3 The first vector to add. right Int3 The second vector to add. Returns Int3 The sum of the two vectors. operator /(Int3, float) Scales a vector by the given value. public static Int3 operator /(Int3 value, float scale) Parameters value Int3 The vector to scale. scale float The amount by which to scale the vector. Returns Int3 The scaled vector. operator ==(Int3, Int3) Tests for equality between two objects. public static bool operator ==(Int3 left, Int3 right) Parameters left Int3 The first value to compare. right Int3 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Vector2(Int3) Performs an explicit conversion from Int3 to Vector2. public static explicit operator Vector2(Int3 value) Parameters value Int3 The value. Returns Vector2 The result of the conversion. explicit operator Vector3(Int3) Performs an explicit conversion from Int3 to Vector3. public static explicit operator Vector3(Int3 value) Parameters value Int3 The value. Returns Vector3 The result of the conversion. explicit operator Vector4(Int3) Performs an explicit conversion from Int3 to Vector4. public static explicit operator Vector4(Int3 value) Parameters value Int3 The value. Returns Vector4 The result of the conversion. explicit operator Vector3(Int3) Casts from Stride.Maths to System.Numerics vectors public static explicit operator Vector3(Int3 v) Parameters v Int3 Value to cast Returns Vector3 explicit operator Int3(Vector3) Casts from System.Numerics to Stride.Maths vectors public static explicit operator Int3(Vector3 v) Parameters v Vector3 Value to cast Returns Int3 operator !=(Int3, Int3) Tests for inequality between two objects. public static bool operator !=(Int3 left, Int3 right) Parameters left Int3 The first value to compare. right Int3 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Int3, float) Scales a vector by the given value. public static Int3 operator *(Int3 value, float scale) Parameters value Int3 The vector to scale. scale float The amount by which to scale the vector. Returns Int3 The scaled vector. operator *(float, Int3) Scales a vector by the given value. public static Int3 operator *(float scale, Int3 value) Parameters scale float The amount by which to scale the vector. value Int3 The vector to scale. Returns Int3 The scaled vector. operator -(Int3, Int3) Subtracts two vectors. public static Int3 operator -(Int3 left, Int3 right) Parameters left Int3 The first vector to subtract. right Int3 The second vector to subtract. Returns Int3 The difference of the two vectors. operator -(Int3) Reverses the direction of a given vector. public static Int3 operator -(Int3 value) Parameters value Int3 The vector to negate. Returns Int3 A vector facing in the opposite direction. operator +(Int3) Assert a vector (return it unchanged). public static Int3 operator +(Int3 value) Parameters value Int3 The vector to assert (unchange). Returns Int3 The asserted (unchanged) vector."
  },
  "api/Stride.Core.Mathematics.Int4.html": {
    "href": "api/Stride.Core.Mathematics.Int4.html",
    "title": "Struct Int4 | Stride API",
    "summary": "Struct Int4 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a four dimensional mathematical vector. [DataContract(\"Int4\")] [DataStyle(DataStyle.Compact)] public struct Int4 : IEquatable<Int4>, ISpanFormattable, IFormattable Implements IEquatable<Int4> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Int4(int) Initializes a new instance of the Int4 struct. public Int4(int value) Parameters value int The value that will be assigned to all components. Int4(int, int, int, int) Initializes a new instance of the Int4 struct. public Int4(int x, int y, int z, int w) Parameters x int Initial value for the X component of the vector. y int Initial value for the Y component of the vector. z int Initial value for the Z component of the vector. w int Initial value for the W component of the vector. Int4(int[]) Initializes a new instance of the Int4 struct. public Int4(int[] values) Parameters values int[] The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Fields One A Int4 with all of its components set to one. public static readonly Int4 One Field Value Int4 SizeInBytes The size of the Int4 type, in bytes. public static readonly int SizeInBytes Field Value int UnitW The W unit Int4 (0, 0, 0, 1). public static readonly Int4 UnitW Field Value Int4 UnitX The X unit Int4 (1, 0, 0, 0). public static readonly Int4 UnitX Field Value Int4 UnitY The Y unit Int4 (0, 1, 0, 0). public static readonly Int4 UnitY Field Value Int4 UnitZ The Z unit Int4 (0, 0, 1, 0). public static readonly Int4 UnitZ Field Value Int4 W The W component of the vector. [DataMember(3)] public int W Field Value int X The X component of the vector. [DataMember(0)] public int X Field Value int Y The Y component of the vector. [DataMember(1)] public int Y Field Value int Z The Z component of the vector. [DataMember(2)] public int Z Field Value int Zero A Int4 with all of its components set to zero. public static readonly Int4 Zero Field Value Int4 Properties this[int] Gets or sets the component at the specified index. public int this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. Property Value int The value of the X, Y, Z, or W component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 3]. Methods Add(Int4, Int4) Adds two vectors. public static Int4 Add(Int4 left, Int4 right) Parameters left Int4 The first vector to add. right Int4 The second vector to add. Returns Int4 The sum of the two vectors. Add(ref readonly Int4, ref readonly Int4, out Int4) Adds two vectors. public static void Add(ref readonly Int4 left, ref readonly Int4 right, out Int4 result) Parameters left Int4 The first vector to add. right Int4 The second vector to add. result Int4 When the method completes, contains the sum of the two vectors. Clamp(Int4, Int4, Int4) Restricts a value to be within a specified range. public static Int4 Clamp(Int4 value, Int4 min, Int4 max) Parameters value Int4 The value to clamp. min Int4 The minimum value. max Int4 The maximum value. Returns Int4 The clamped value. Clamp(ref readonly Int4, ref readonly Int4, ref readonly Int4, out Int4) Restricts a value to be within a specified range. public static void Clamp(ref readonly Int4 value, ref readonly Int4 min, ref readonly Int4 max, out Int4 result) Parameters value Int4 The value to clamp. min Int4 The minimum value. max Int4 The maximum value. result Int4 When the method completes, contains the clamped value. Deconstruct(out int, out int, out int, out int) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out int x, out int y, out int z, out int w) Parameters x int The X component y int The Y component z int The Z component w int The W component Divide(Int4, int) Scales a vector by the given value. public static Int4 Divide(Int4 value, int scale) Parameters value Int4 The vector to scale. scale int The amount by which to scale the vector. Returns Int4 The scaled vector. Divide(ref readonly Int4, int, out Int4) Scales a vector by the given value. public static void Divide(ref readonly Int4 value, int scale, out Int4 result) Parameters value Int4 The vector to scale. scale int The amount by which to scale the vector. result Int4 When the method completes, contains the scaled vector. Equals(Int4) Determines whether the specified Int4 is equal to this instance. public readonly bool Equals(Int4 other) Parameters other Int4 The Int4 to compare with this instance. Returns bool true if the specified Int4 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Length() Calculates the length of the vector. public readonly int Length() Returns int The length of the vector. Remarks LengthSquared() may be preferred when only the relative length is needed and speed is of the essence. LengthSquared() Calculates the squared length of the vector. public readonly int LengthSquared() Returns int The squared length of the vector. Remarks This method may be preferred to Length() when only a relative length is needed and speed is of the essence. Max(Int4, Int4) Returns a vector containing the largest components of the specified vectors. public static Int4 Max(Int4 left, Int4 right) Parameters left Int4 The first source vector. right Int4 The second source vector. Returns Int4 A vector containing the largest components of the source vectors. Max(ref readonly Int4, ref readonly Int4, out Int4) Returns a vector containing the smallest components of the specified vectors. public static void Max(ref readonly Int4 left, ref readonly Int4 right, out Int4 result) Parameters left Int4 The first source vector. right Int4 The second source vector. result Int4 When the method completes, contains an new vector composed of the largest components of the source vectors. Min(Int4, Int4) Returns a vector containing the smallest components of the specified vectors. public static Int4 Min(Int4 left, Int4 right) Parameters left Int4 The first source vector. right Int4 The second source vector. Returns Int4 A vector containing the smallest components of the source vectors. Min(ref readonly Int4, ref readonly Int4, out Int4) Returns a vector containing the smallest components of the specified vectors. public static void Min(ref readonly Int4 left, ref readonly Int4 right, out Int4 result) Parameters left Int4 The first source vector. right Int4 The second source vector. result Int4 When the method completes, contains an new vector composed of the smallest components of the source vectors. Modulate(Int4, Int4) Modulates a vector with another by performing component-wise multiplication. public static Int4 Modulate(Int4 left, Int4 right) Parameters left Int4 The first vector to modulate. right Int4 The second vector to modulate. Returns Int4 The modulated vector. Modulate(ref readonly Int4, ref readonly Int4, out Int4) Modulates a vector with another by performing component-wise multiplication. public static void Modulate(ref readonly Int4 left, ref readonly Int4 right, out Int4 result) Parameters left Int4 The first vector to modulate. right Int4 The second vector to modulate. result Int4 When the method completes, contains the modulated vector. Multiply(Int4, int) Scales a vector by the given value. public static Int4 Multiply(Int4 value, int scale) Parameters value Int4 The vector to scale. scale int The amount by which to scale the vector. Returns Int4 The scaled vector. Multiply(ref readonly Int4, int, out Int4) Scales a vector by the given value. public static void Multiply(ref readonly Int4 value, int scale, out Int4 result) Parameters value Int4 The vector to scale. scale int The amount by which to scale the vector. result Int4 When the method completes, contains the scaled vector. Negate(Int4) Reverses the direction of a given vector. public static Int4 Negate(Int4 value) Parameters value Int4 The vector to negate. Returns Int4 A vector facing in the opposite direction. Negate(ref readonly Int4, out Int4) Reverses the direction of a given vector. public static void Negate(ref readonly Int4 value, out Int4 result) Parameters value Int4 The vector to negate. result Int4 When the method completes, contains a vector facing in the opposite direction. Subtract(Int4, Int4) Subtracts two vectors. public static Int4 Subtract(Int4 left, Int4 right) Parameters left Int4 The first vector to subtract. right Int4 The second vector to subtract. Returns Int4 The difference of the two vectors. Subtract(ref readonly Int4, ref readonly Int4, out Int4) Subtracts two vectors. public static void Subtract(ref readonly Int4 left, ref readonly Int4 right, out Int4 result) Parameters left Int4 The first vector to subtract. right Int4 The second vector to subtract. result Int4 When the method completes, contains the difference of the two vectors. ToArray() Creates an array containing the elements of the vector. public readonly int[] ToArray() Returns int[] A four-element array containing the components of the vector. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator +(Int4, Int4) Adds two vectors. public static Int4 operator +(Int4 left, Int4 right) Parameters left Int4 The first vector to add. right Int4 The second vector to add. Returns Int4 The sum of the two vectors. operator /(Int4, int) Scales a vector by the given value. public static Int4 operator /(Int4 value, int scale) Parameters value Int4 The vector to scale. scale int The amount by which to scale the vector. Returns Int4 The scaled vector. operator ==(Int4, Int4) Tests for equality between two objects. public static bool operator ==(Int4 left, Int4 right) Parameters left Int4 The first value to compare. right Int4 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Vector2(Int4) Performs an explicit conversion from Int4 to Vector2. public static explicit operator Vector2(Int4 value) Parameters value Int4 The value. Returns Vector2 The result of the conversion. explicit operator Vector3(Int4) Performs an explicit conversion from Int4 to Vector3. public static explicit operator Vector3(Int4 value) Parameters value Int4 The value. Returns Vector3 The result of the conversion. explicit operator Vector4(Int4) Performs an explicit conversion from Int4 to Vector4. public static explicit operator Vector4(Int4 value) Parameters value Int4 The value. Returns Vector4 The result of the conversion. explicit operator Vector4(Int4) Casts from Stride.Maths to System.Numerics vectors public static explicit operator Vector4(Int4 v) Parameters v Int4 Value to cast Returns Vector4 explicit operator Int4(Vector4) Casts from System.Numerics to Stride.Maths vectors public static explicit operator Int4(Vector4 v) Parameters v Vector4 Value to cast Returns Int4 implicit operator int[](Int4) Performs an implicit conversion from Int4 to int array. public static implicit operator int[](Int4 input) Parameters input Int4 The input. Returns int[] The result of the conversion. implicit operator Int4(int[]) Performs an implicit conversion from int array to Int4. public static implicit operator Int4(int[] input) Parameters input int[] The input. Returns Int4 The result of the conversion. operator !=(Int4, Int4) Tests for inequality between two objects. public static bool operator !=(Int4 left, Int4 right) Parameters left Int4 The first value to compare. right Int4 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Int4, int) Scales a vector by the given value. public static Int4 operator *(Int4 value, int scale) Parameters value Int4 The vector to scale. scale int The amount by which to scale the vector. Returns Int4 The scaled vector. operator *(int, Int4) Scales a vector by the given value. public static Int4 operator *(int scale, Int4 value) Parameters scale int The amount by which to scale the vector. value Int4 The vector to scale. Returns Int4 The scaled vector. operator -(Int4, Int4) Subtracts two vectors. public static Int4 operator -(Int4 left, Int4 right) Parameters left Int4 The first vector to subtract. right Int4 The second vector to subtract. Returns Int4 The difference of the two vectors. operator -(Int4) Reverses the direction of a given vector. public static Int4 operator -(Int4 value) Parameters value Int4 The vector to negate. Returns Int4 A vector facing in the opposite direction. operator +(Int4) Assert a vector (return it unchanged). public static Int4 operator +(Int4 value) Parameters value Int4 The vector to assert (unchange). Returns Int4 The asserted (unchanged) vector."
  },
  "api/Stride.Core.Mathematics.MathUtil.html": {
    "href": "api/Stride.Core.Mathematics.MathUtil.html",
    "title": "Class MathUtil | Stride API",
    "summary": "Class MathUtil Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Common utility methods for math operations. public static class MathUtil Inheritance object MathUtil Fields Pi A value specifying the approximation of π which is 180 degrees. public const float Pi = 3.1415927 Field Value float PiOverFour A value specifying the approximation of π/4 which is 45 degrees. public const float PiOverFour = 0.7853982 Field Value float PiOverTwo A value specifying the approximation of π/2 which is 90 degrees. public const float PiOverTwo = 1.5707964 Field Value float TwoPi A value specifying the approximation of 2π which is 360 degrees. public const float TwoPi = 6.2831855 Field Value float ZeroTolerance The value for which all absolute numbers smaller than are considered equal to zero. public const float ZeroTolerance = 1E-06 Field Value float ZeroToleranceDouble The value for which all absolute numbers smaller than are considered equal to zero. public const double ZeroToleranceDouble = 4E-323 Field Value double Methods AlignDown(int, int) Alignes value down to match desire alignment. public static int AlignDown(int value, int alignment) Parameters value int The value. alignment int The alignment. Returns int Aligned value (multiple of alignment). AlignUp(int, int) Alignes value up to match desire alignment. public static int AlignUp(int value, int alignment) Parameters value int The value. alignment int The alignment. Returns int Aligned value (multiple of alignment). Array<T>(T, int) Creates a one-dimensional array of the specified T and length filled with the specified value. public static T[] Array<T>(T value, int length) Parameters value T The value to fill the array with. length int The size of the array to create. Returns T[] A new one-dimensional array of the specified type with the specified length and filled with the specified value. Type Parameters T The Type of the array to create. Clamp(double, double, double) Clamps the specified value. public static double Clamp(double value, double min, double max) Parameters value double The value. min double The min. max double The max. Returns double The result of clamping a value between min and max Clamp(int, int, int) Clamps the specified value. public static int Clamp(int value, int min, int max) Parameters value int The value. min int The min. max int The max. Returns int The result of clamping a value between min and max Clamp(float, float, float) Clamps the specified value. public static float Clamp(float value, float min, float max) Parameters value float The value. min float The min. max float The max. Returns float The result of clamping a value between min and max DegreesToRadians(float) Converts degrees to radians. public static float DegreesToRadians(float degree) Parameters degree float The value to convert. Returns float The converted value. DegreesToRevolutions(float) Converts degrees to revolutions. public static float DegreesToRevolutions(float degree) Parameters degree float The value to convert. Returns float The converted value. ExpDecay(double, double, double, double) Exponential damping. Alternative to a = lerp(a, b, damping * dt) using the exponential function flipped around the Y axis: e^(-t) public static double ExpDecay(double a, double b, double lambda, double dt) Parameters a double Initial value b double Plateau value lambda double Damping dt double Discrete time unit, delta time. Returns double A value interpolated from a to b depending on lambda and dt. ExpDecay(float, float, float, float) Exponential damping. Alternative to a = lerp(a, b, damping * dt) using the exponential function flipped around the Y axis: e^(-t) public static float ExpDecay(float a, float b, float lambda, float dt) Parameters a float Initial value b float Plateau value lambda float Damping dt float Discrete time unit, delta time. Returns float A value interpolated from a to b depending on lambda and dt. GradiansToDegrees(float) Converts gradians to degrees. public static float GradiansToDegrees(float gradian) Parameters gradian float The value to convert. Returns float The converted value. GradiansToRadians(float) Converts gradians to radians. public static float GradiansToRadians(float gradian) Parameters gradian float The value to convert. Returns float The converted value. GradiansToRevolutions(float) Converts gradians to revolutions. public static float GradiansToRevolutions(float gradian) Parameters gradian float The value to convert. Returns float The converted value. InverseLerp(double, double, double) Inverse-interpolates a value linearly. public static double InverseLerp(double min, double max, double value) Parameters min double Minimum value that takes place in inverse-interpolation. max double Maximum value that takes place in inverse-interpolation. value double Value to get inverse interpolation. Returns double Returns an inverse-linearly interpolated coeficient. InverseLerp(float, float, float) Inverse-interpolates a value linearly. public static float InverseLerp(float min, float max, float value) Parameters min float Minimum value that takes place in inverse-interpolation. max float Maximum value that takes place in inverse-interpolation. value float Value to get inverse interpolation. Returns float Returns an inverse-linearly interpolated coeficient. IsAligned(int, int) Determines whether the specified value is aligned. public static bool IsAligned(int value, int alignment) Parameters value int The value. alignment int The alignment. Returns bool true if the specified value is aligned; otherwise, false. IsInRange(int, int, int) Determines whether the value is inside the given range (inclusively). public static bool IsInRange(int value, int min, int max) Parameters value int The value. min int The minimum value of the range. max int The maximum value of the range. Returns bool true if value is inside the specified range; otherwise, false. IsInRange(float, float, float) Determines whether the value is inside the given range (inclusively). public static bool IsInRange(float value, float min, float max) Parameters value float The value. min float The minimum value of the range. max float The maximum value of the range. Returns bool true if value is inside the specified range; otherwise, false. IsOne(float) Determines whether the specified value is close to one (1.0f). public static bool IsOne(float a) Parameters a float The floating value. Returns bool true if the specified value is close to one (1.0f); otherwise, false. IsPow2(int) Determines whether the specified x is pow2. public static bool IsPow2(int x) Parameters x int The x. Returns bool true if the specified x is pow2; otherwise, false. IsZero(double) Determines whether the specified value is close to zero (0.0f). public static bool IsZero(double a) Parameters a double The floating value. Returns bool true if the specified value is close to zero (0.0f); otherwise, false. IsZero(float) Determines whether the specified value is close to zero (0.0f). public static bool IsZero(float a) Parameters a float The floating value. Returns bool true if the specified value is close to zero (0.0f); otherwise, false. Lerp(byte, byte, float) Interpolates between two values using a linear function by a given amount. public static byte Lerp(byte from, byte to, float amount) Parameters from byte Value to interpolate from. to byte Value to interpolate to. amount float Interpolation amount. Returns byte The result of linear interpolation of values based on the amount. Remarks See http://www.encyclopediaofmath.org/index.php/Linear_interpolation and http://fgiesen.wordpress.com/2012/08/15/linear-interpolation-past-present-and-future/ Lerp(double, double, double) Interpolates between two values using a linear function by a given amount. public static double Lerp(double from, double to, double amount) Parameters from double Value to interpolate from. to double Value to interpolate to. amount double Interpolation amount. Returns double The result of linear interpolation of values based on the amount. Remarks See http://www.encyclopediaofmath.org/index.php/Linear_interpolation and http://fgiesen.wordpress.com/2012/08/15/linear-interpolation-past-present-and-future/ Lerp(float, float, float) Interpolates between two values using a linear function by a given amount. public static float Lerp(float from, float to, float amount) Parameters from float Value to interpolate from. to float Value to interpolate to. amount float Interpolation amount. Returns float The result of linear interpolation of values based on the amount. Remarks See http://www.encyclopediaofmath.org/index.php/Linear_interpolation and http://fgiesen.wordpress.com/2012/08/15/linear-interpolation-past-present-and-future/ LinearToSRgb(float) Converts a float value from linear to sRGB. public static float LinearToSRgb(float linearValue) Parameters linearValue float The linear value. Returns float The encoded sRGB value. Log2(int) Calculate the logarithm 2 of an integer. public static int Log2(int i) Parameters i int The input integer Returns int the log2(i) rounded to lower integer Log2(float) Calculate the logarithm 2 of a floating point. public static float Log2(float x) Parameters x float The input float Returns float Log2(x) Mod(float, float) Computes standard mathematical modulo (as opposed to remainder). public static float Mod(float value, float divisor) Parameters value float The value. divisor float The divisor. Returns float A value between 0 and divisor. The result will have the same sign as divisor. NearEqual(float, float) Checks if a and b are almost equals, taking into account the magnitude of floating point numbers (unlike WithinEpsilon(float, float, float) method). See Remarks. See remarks. public static bool NearEqual(float a, float b) Parameters a float The left value to compare. b float The right value to compare. Returns bool true if a almost equal to b, false otherwise Remarks The code is using the technique described by Bruce Dawson in Comparing Floating point numbers 2012 edition. NextPowerOfTwo(int) Get the next power of two of an integer. public static int NextPowerOfTwo(int x) Parameters x int The size. Returns int System.Int32. Remarks https://graphics.stanford.edu/~seander/bithacks.html#RoundUpPowerOf2 NextPowerOfTwo(float) Get the next power of two for a size. public static float NextPowerOfTwo(float size) Parameters size float The size. Returns float System.Int32. PreviousPowerOfTwo(int) Get the previous power of two of the provided integer. public static int PreviousPowerOfTwo(int size) Parameters size int The value Returns int PreviousPowerOfTwo(float) Get the previous power of two of the provided float. public static float PreviousPowerOfTwo(float size) Parameters size float The value Returns float RadiansToDegrees(float) Converts radians to degrees. public static float RadiansToDegrees(float radian) Parameters radian float The value to convert. Returns float The converted value. RadiansToGradians(float) Converts radians to gradians. public static float RadiansToGradians(float radian) Parameters radian float The value to convert. Returns float The converted value. RadiansToRevolutions(float) Converts radians to revolutions. public static float RadiansToRevolutions(float radian) Parameters radian float The value to convert. Returns float The converted value. RevolutionsToDegrees(float) Converts revolutions to degrees. public static float RevolutionsToDegrees(float revolution) Parameters revolution float The value to convert. Returns float The converted value. RevolutionsToGradians(float) Converts revolutions to gradians. public static float RevolutionsToGradians(float revolution) Parameters revolution float The value to convert. Returns float The converted value. RevolutionsToRadians(float) Converts revolutions to radians. public static float RevolutionsToRadians(float revolution) Parameters revolution float The value to convert. Returns float The converted value. SRgbToLinear(float) Converts a float value from sRGB to linear. public static float SRgbToLinear(float sRgbValue) Parameters sRgbValue float The sRGB value. Returns float A linear value. SmoothStep(float) Performs smooth (cubic Hermite) interpolation between 0 and 1. public static float SmoothStep(float amount) Parameters amount float Value between 0 and 1 indicating interpolation amount. Returns float Remarks See https://en.wikipedia.org/wiki/Smoothstep SmootherStep(float) Performs a smooth(er) interpolation between 0 and 1 with 1st and 2nd order derivatives of zero at endpoints. public static float SmootherStep(float amount) Parameters amount float Value between 0 and 1 indicating interpolation amount. Returns float Remarks See https://en.wikipedia.org/wiki/Smoothstep Snap(Vector2, float) Snaps all vector components to the nearest interval. public static Vector2 Snap(Vector2 value, float gap) Parameters value Vector2 The vector to snap. gap float The interval gap. Returns Vector2 A vector which components are snapped to the nearest interval. Snap(Vector3, float) Snaps all vector components to the nearest interval. public static Vector3 Snap(Vector3 value, float gap) Parameters value Vector3 The vector to snap. gap float The interval gap. Returns Vector3 A vector which components are snapped to the nearest interval. Snap(Vector4, float) Snaps all vector components to the nearest interval. public static Vector4 Snap(Vector4 value, float gap) Parameters value Vector4 The vector to snap. gap float The interval gap. Returns Vector4 A vector which components are snapped to the nearest interval. Snap(double, double) Snaps a value to the nearest interval. public static double Snap(double value, double gap) Parameters value double The value to snap. gap double The interval gap. Returns double The nearest interval to the provided value. Snap(float, float) Snaps a value to the nearest interval. public static float Snap(float value, float gap) Parameters value float The value to snap. gap float The interval gap. Returns float The nearest interval to the provided value. WithinEpsilon(float, float, float) Checks if a - b are almost equals within a float epsilon. public static bool WithinEpsilon(float a, float b, float epsilon) Parameters a float The left value to compare. b float The right value to compare. epsilon float Epsilon value Returns bool true if a almost equal to b within a float epsilon, false otherwise"
  },
  "api/Stride.Core.Mathematics.Matrix.html": {
    "href": "api/Stride.Core.Mathematics.Matrix.html",
    "title": "Struct Matrix | Stride API",
    "summary": "Struct Matrix Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a 4x4 mathematical matrix. [DataContract(\"float4x4\")] [DataStyle(DataStyle.Compact)] public struct Matrix : IEquatable<Matrix>, ISpanFormattable, IFormattable Implements IEquatable<Matrix> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Matrix(float) Initializes a new instance of the Matrix struct. public Matrix(float value) Parameters value float The value that will be assigned to all components. Matrix(float, float, float, float, float, float, float, float, float, float, float, float, float, float, float, float) Initializes a new instance of the Matrix struct. public Matrix(float M11, float M12, float M13, float M14, float M21, float M22, float M23, float M24, float M31, float M32, float M33, float M34, float M41, float M42, float M43, float M44) Parameters M11 float The value to assign at row 1 column 1 of the matrix. M12 float The value to assign at row 1 column 2 of the matrix. M13 float The value to assign at row 1 column 3 of the matrix. M14 float The value to assign at row 1 column 4 of the matrix. M21 float The value to assign at row 2 column 1 of the matrix. M22 float The value to assign at row 2 column 2 of the matrix. M23 float The value to assign at row 2 column 3 of the matrix. M24 float The value to assign at row 2 column 4 of the matrix. M31 float The value to assign at row 3 column 1 of the matrix. M32 float The value to assign at row 3 column 2 of the matrix. M33 float The value to assign at row 3 column 3 of the matrix. M34 float The value to assign at row 3 column 4 of the matrix. M41 float The value to assign at row 4 column 1 of the matrix. M42 float The value to assign at row 4 column 2 of the matrix. M43 float The value to assign at row 4 column 3 of the matrix. M44 float The value to assign at row 4 column 4 of the matrix. Matrix(float[]) Initializes a new instance of the Matrix struct. public Matrix(float[] values) Parameters values float[] The values to assign to the components of the matrix. This must be an array with sixteen elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than sixteen elements. Fields Identity The identity Matrix. public static readonly Matrix Identity Field Value Matrix LayoutIsRowMajor Are matrix row or column major public const bool LayoutIsRowMajor = false Field Value bool Remarks Dotnet's Matrix4x4 are row major. M11 Value at row 1 column 1 of the matrix. public float M11 Field Value float M12 Value at row 1 column 2 of the matrix. public float M12 Field Value float M13 Value at row 1 column 3 of the matrix. public float M13 Field Value float M14 Value at row 1 column 4 of the matrix. public float M14 Field Value float M21 Value at row 2 column 1 of the matrix. public float M21 Field Value float M22 Value at row 2 column 2 of the matrix. public float M22 Field Value float M23 Value at row 2 column 3 of the matrix. public float M23 Field Value float M24 Value at row 2 column 4 of the matrix. public float M24 Field Value float M31 Value at row 3 column 1 of the matrix. public float M31 Field Value float M32 Value at row 3 column 2 of the matrix. public float M32 Field Value float M33 Value at row 3 column 3 of the matrix. public float M33 Field Value float M34 Value at row 3 column 4 of the matrix. public float M34 Field Value float M41 Value at row 4 column 1 of the matrix. public float M41 Field Value float M42 Value at row 4 column 2 of the matrix. public float M42 Field Value float M43 Value at row 4 column 3 of the matrix. public float M43 Field Value float M44 Value at row 4 column 4 of the matrix. public float M44 Field Value float SizeInBytes The size of the Matrix type, in bytes. public static readonly int SizeInBytes Field Value int Zero A Matrix with all of its components set to zero. public static readonly Matrix Zero Field Value Matrix Properties Backward Gets or sets the backward Vector3 of the matrix; that is M31, M32, and M33. public Vector3 Backward { readonly get; set; } Property Value Vector3 Column1 Gets or sets the first column in the matrix; that is M11, M21, M31, and M41. public Vector4 Column1 { readonly get; set; } Property Value Vector4 Column2 Gets or sets the second column in the matrix; that is M12, M22, M32, and M42. public Vector4 Column2 { readonly get; set; } Property Value Vector4 Column3 Gets or sets the third column in the matrix; that is M13, M23, M33, and M43. public Vector4 Column3 { readonly get; set; } Property Value Vector4 Column4 Gets or sets the fourth column in the matrix; that is M14, M24, M34, and M44. public Vector4 Column4 { readonly get; set; } Property Value Vector4 Down Gets or sets the down Vector3 of the matrix; that is -M21, -M22, and -M23. public Vector3 Down { readonly get; set; } Property Value Vector3 Forward Gets or sets the forward Vector3 of the matrix; that is -M31, -M32, and -M33. public Vector3 Forward { readonly get; set; } Property Value Vector3 IsIdentity Gets a value indicating whether this instance is an identity matrix. public readonly bool IsIdentity { get; } Property Value bool true if this instance is an identity matrix; otherwise, false. this[int] Gets or sets the component at the specified index. public float this[int index] { readonly get; set; } Parameters index int The zero-based index of the component to access. Property Value float The value of the matrix component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 15]. this[int, int] Gets or sets the component at the specified index. public float this[int row, int column] { readonly get; set; } Parameters row int The row of the matrix to access. column int The column of the matrix to access. Property Value float The value of the matrix component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the row or columnis out of the range [0, 3]. Left Gets or sets the left Vector3 of the matrix; that is -M11, -M12, and -M13. public Vector3 Left { readonly get; set; } Property Value Vector3 Right Gets or sets the right Vector3 of the matrix; that is M11, M12, and M13. public Vector3 Right { readonly get; set; } Property Value Vector3 Row1 Gets or sets the first row in the matrix; that is M11, M12, M13, and M14. public Vector4 Row1 { readonly get; set; } Property Value Vector4 Row2 Gets or sets the second row in the matrix; that is M21, M22, M23, and M24. public Vector4 Row2 { readonly get; set; } Property Value Vector4 Row3 Gets or sets the third row in the matrix; that is M31, M32, M33, and M34. public Vector4 Row3 { readonly get; set; } Property Value Vector4 Row4 Gets or sets the fourth row in the matrix; that is M41, M42, M43, and M44. public Vector4 Row4 { readonly get; set; } Property Value Vector4 ScaleVector Gets or sets the scale of the matrix; that is M11, M22, and M33. public Vector3 ScaleVector { readonly get; set; } Property Value Vector3 Remarks This property does not do any computation and will return a correct scale vector only if the matrix is a scale matrix. TranslationVector Gets or sets the translation of the matrix; that is M41, M42, and M43. public Vector3 TranslationVector { readonly get; set; } Property Value Vector3 Up Gets or sets the up Vector3 of the matrix; that is M21, M22, and M23. public Vector3 Up { readonly get; set; } Property Value Vector3 Methods Add(Matrix, Matrix) Determines the sum of two matrices. public static Matrix Add(Matrix left, Matrix right) Parameters left Matrix The first matrix to add. right Matrix The second matrix to add. Returns Matrix The sum of the two matrices. Add(ref readonly Matrix, ref readonly Matrix, out Matrix) Determines the sum of two matrices. public static void Add(ref readonly Matrix left, ref readonly Matrix right, out Matrix result) Parameters left Matrix The first matrix to add. right Matrix The second matrix to add. result Matrix When the method completes, contains the sum of the two matrices. AffineTransformation(float, Quaternion, Vector3) Creates a 3D affine transformation matrix. public static Matrix AffineTransformation(float scaling, Quaternion rotation, Vector3 translation) Parameters scaling float Scaling factor. rotation Quaternion The rotation of the transformation. translation Vector3 The translation factor of the transformation. Returns Matrix The created affine transformation matrix. AffineTransformation(float, ref readonly Quaternion, ref readonly Vector3, out Matrix) Creates a 3D affine transformation matrix. public static void AffineTransformation(float scaling, ref readonly Quaternion rotation, ref readonly Vector3 translation, out Matrix result) Parameters scaling float Scaling factor. rotation Quaternion The rotation of the transformation. translation Vector3 The translation factor of the transformation. result Matrix When the method completes, contains the created affine transformation matrix. AffineTransformation(float, Vector3, Quaternion, Vector3) Creates a 3D affine transformation matrix. public static Matrix AffineTransformation(float scaling, Vector3 rotationCenter, Quaternion rotation, Vector3 translation) Parameters scaling float Scaling factor. rotationCenter Vector3 The center of the rotation. rotation Quaternion The rotation of the transformation. translation Vector3 The translation factor of the transformation. Returns Matrix The created affine transformation matrix. AffineTransformation(float, ref readonly Vector3, ref readonly Quaternion, ref readonly Vector3, out Matrix) Creates a 3D affine transformation matrix. public static void AffineTransformation(float scaling, ref readonly Vector3 rotationCenter, ref readonly Quaternion rotation, ref readonly Vector3 translation, out Matrix result) Parameters scaling float Scaling factor. rotationCenter Vector3 The center of the rotation. rotation Quaternion The rotation of the transformation. translation Vector3 The translation factor of the transformation. result Matrix When the method completes, contains the created affine transformation matrix. AffineTransformation2D(float, Vector2, float, Vector2) Creates a 2D affine transformation matrix. public static Matrix AffineTransformation2D(float scaling, Vector2 rotationCenter, float rotation, Vector2 translation) Parameters scaling float Scaling factor. rotationCenter Vector2 The center of the rotation. rotation float The rotation of the transformation. translation Vector2 The translation factor of the transformation. Returns Matrix The created affine transformation matrix. AffineTransformation2D(float, ref readonly Vector2, float, ref readonly Vector2, out Matrix) Creates a 2D affine transformation matrix. public static void AffineTransformation2D(float scaling, ref readonly Vector2 rotationCenter, float rotation, ref readonly Vector2 translation, out Matrix result) Parameters scaling float Scaling factor. rotationCenter Vector2 The center of the rotation. rotation float The rotation of the transformation. translation Vector2 The translation factor of the transformation. result Matrix When the method completes, contains the created affine transformation matrix. AffineTransformation2D(float, float, Vector2) Creates a 2D affine transformation matrix. public static Matrix AffineTransformation2D(float scaling, float rotation, Vector2 translation) Parameters scaling float Scaling factor. rotation float The rotation of the transformation. translation Vector2 The translation factor of the transformation. Returns Matrix The created affine transformation matrix. AffineTransformation2D(float, float, ref readonly Vector2, out Matrix) Creates a 2D affine transformation matrix. public static void AffineTransformation2D(float scaling, float rotation, ref readonly Vector2 translation, out Matrix result) Parameters scaling float Scaling factor. rotation float The rotation of the transformation. translation Vector2 The translation factor of the transformation. result Matrix When the method completes, contains the created affine transformation matrix. Billboard(Vector3, Vector3, Vector3, Vector3) Creates a spherical billboard that rotates around a specified object position. public static Matrix Billboard(Vector3 objectPosition, Vector3 cameraPosition, Vector3 cameraUpVector, Vector3 cameraForwardVector) Parameters objectPosition Vector3 The position of the object around which the billboard will rotate. cameraPosition Vector3 The position of the camera. cameraUpVector Vector3 The up vector of the camera. cameraForwardVector Vector3 The forward vector of the camera. Returns Matrix The created billboard matrix. Billboard(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, out Matrix) Creates a spherical billboard that rotates around a specified object position. public static void Billboard(ref readonly Vector3 objectPosition, ref readonly Vector3 cameraPosition, ref readonly Vector3 cameraUpVector, ref readonly Vector3 cameraForwardVector, out Matrix result) Parameters objectPosition Vector3 The position of the object around which the billboard will rotate. cameraPosition Vector3 The position of the camera. cameraUpVector Vector3 The up vector of the camera. cameraForwardVector Vector3 The forward vector of the camera. result Matrix When the method completes, contains the created billboard matrix. CopyMatrixFrom(float*, int, int) Copies a nxm matrix to this instance. public void CopyMatrixFrom(float* src, int columns, int rows) Parameters src float* The source matrix. columns int The number of columns. rows int The number of rows. Decompose(out Vector3, out Matrix, out Vector3) Decomposes a matrix into a scale, rotation, and translation. public readonly bool Decompose(out Vector3 scale, out Matrix rotation, out Vector3 translation) Parameters scale Vector3 When the method completes, contains the scaling component of the decomposed matrix. rotation Matrix When the method completes, contains the rotation component of the decomposed matrix. translation Vector3 When the method completes, contains the translation component of the decomposed matrix. Returns bool Remarks This method is designed to decompose an SRT transformation matrix only. Decompose(out Vector3, out Quaternion, out Vector3) Decomposes a matrix into a scale, rotation, and translation. public readonly bool Decompose(out Vector3 scale, out Quaternion rotation, out Vector3 translation) Parameters scale Vector3 When the method completes, contains the scaling component of the decomposed matrix. rotation Quaternion When the method completes, contains the rotation component of the decomposed matrix. translation Vector3 When the method completes, contains the translation component of the decomposed matrix. Returns bool Remarks This method is designed to decompose an SRT transformation matrix only. Decompose(out Vector3, out Vector3) Decomposes a matrix into a scale, rotation, and translation. public readonly bool Decompose(out Vector3 scale, out Vector3 translation) Parameters scale Vector3 When the method completes, contains the scaling component of the decomposed matrix. translation Vector3 When the method completes, contains the translation component of the decomposed matrix. Returns bool true if a rotation exist for this matrix, false otherwise. Remarks This method is designed to decompose an SRT transformation matrix only. Decompose(out float, out float, out float) Decomposes a rotation matrix with the specified yaw, pitch, roll value (angles in radians). public readonly void Decompose(out float yaw, out float pitch, out float roll) Parameters yaw float The yaw component in radians. pitch float The pitch component in radians. roll float The roll component in radians. Remarks This rotation matrix can be represented by intrinsic rotations in the order yaw, pitch, then roll. Therefore, the extrinsic rotations to achieve this matrix is the reversed order of operations, i.e. Matrix.RotationZ(roll) * Matrix.RotationX(pitch) * Matrix.RotationY(yaw) DecomposeLQ(out Matrix, out Matrix) Decomposes a matrix into a lower triangular matrix L and an orthonormalized matrix Q. public void DecomposeLQ(out Matrix L, out Matrix Q) Parameters L Matrix When the method completes, contains the lower triangular matrix of the decomposition. Q Matrix When the method completes, contains the orthonormalized matrix of the decomposition. DecomposeQR(out Matrix, out Matrix) Decomposes a matrix into an orthonormalized matrix Q and a right triangular matrix R. public readonly void DecomposeQR(out Matrix Q, out Matrix R) Parameters Q Matrix When the method completes, contains the orthonormalized matrix of the decomposition. R Matrix When the method completes, contains the right triangular matrix of the decomposition. DecomposeXYZ(out Vector3) Decomposes a rotation matrix with the specified X, Y and Z euler angles in radians. Matrix.RotationX(rotation.X) * Matrix.RotationY(rotation.Y) * Matrix.RotationZ(rotation.Z) should represent the same rotation. public readonly void DecomposeXYZ(out Vector3 rotation) Parameters rotation Vector3 The vector containing the 3 rotations angles to be applied in order. Determinant() Calculates the determinant of the matrix. public readonly float Determinant() Returns float The determinant of the matrix. Divide(Matrix, Matrix) Determines the quotient of two matrices. public static Matrix Divide(Matrix left, Matrix right) Parameters left Matrix The first matrix to divide. right Matrix The second matrix to divide. Returns Matrix The quotient of the two matrices. Divide(Matrix, float) Scales a matrix by the given value. public static Matrix Divide(Matrix left, float right) Parameters left Matrix The matrix to scale. right float The amount by which to scale. Returns Matrix The scaled matrix. Divide(ref readonly Matrix, ref readonly Matrix, out Matrix) Determines the quotient of two matrices. public static void Divide(ref readonly Matrix left, ref readonly Matrix right, out Matrix result) Parameters left Matrix The first matrix to divide. right Matrix The second matrix to divide. result Matrix When the method completes, contains the quotient of the two matrices. Divide(ref readonly Matrix, float, out Matrix) Scales a matrix by the given value. public static void Divide(ref readonly Matrix left, float right, out Matrix result) Parameters left Matrix The matrix to scale. right float The amount by which to scale. result Matrix When the method completes, contains the scaled matrix. Equals(Matrix) Determines whether the specified Matrix is equal to this instance. public readonly bool Equals(Matrix other) Parameters other Matrix The Matrix to compare with this instance. Returns bool true if the specified Matrix is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. ExchangeColumns(int, int) Exchange columns. public void ExchangeColumns(int firstColumn, int secondColumn) Parameters firstColumn int The first column to exchange. secondColumn int The second column to exchange. ExchangeRows(int, int) Exchanges two rows in the matrix. public void ExchangeRows(int firstRow, int secondRow) Parameters firstRow int The first row to exchange. This is an index of the row starting at zero. secondRow int The second row to exchange. This is an index of the row starting at zero. Exponent(Matrix, int) Performs the exponential operation on a matrix. public static Matrix Exponent(Matrix value, int exponent) Parameters value Matrix The matrix to perform the operation on. exponent int The exponent to raise the matrix to. Returns Matrix The exponential matrix. Exceptions ArgumentOutOfRangeException Thrown when the exponent is negative. Exponent(ref readonly Matrix, int, out Matrix) Performs the exponential operation on a matrix. public static void Exponent(ref readonly Matrix value, int exponent, out Matrix result) Parameters value Matrix The matrix to perform the operation on. exponent int The exponent to raise the matrix to. result Matrix When the method completes, contains the exponential matrix. Exceptions ArgumentOutOfRangeException Thrown when the exponent is negative. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Invert() Inverts the matrix. If the matrix cannot be inverted (eg. Determinant was zero), then the matrix will be set equivalent to Zero. public void Invert() Invert(Matrix) Calculates the inverse of the specified matrix. If the matrix cannot be inverted (eg. Determinant was zero), then the returning matrix will be Zero. public static Matrix Invert(Matrix value) Parameters value Matrix The matrix whose inverse is to be calculated. Returns Matrix The inverse of the specified matrix. Invert(ref readonly Matrix, out Matrix) Calculates the inverse of the specified matrix. If the matrix cannot be inverted (eg. Determinant was zero), then result will be Zero. public static void Invert(ref readonly Matrix value, out Matrix result) Parameters value Matrix The matrix whose inverse is to be calculated. result Matrix When the method completes, contains the inverse of the specified matrix. Lerp(Matrix, Matrix, float) Performs a linear interpolation between two matrices. public static Matrix Lerp(Matrix start, Matrix end, float amount) Parameters start Matrix Start matrix. end Matrix End matrix. amount float Value between 0 and 1 indicating the weight of end. Returns Matrix The linear interpolation of the two matrices. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Matrix, ref readonly Matrix, float, out Matrix) Performs a linear interpolation between two matrices. public static void Lerp(ref readonly Matrix start, ref readonly Matrix end, float amount, out Matrix result) Parameters start Matrix Start matrix. end Matrix End matrix. amount float Value between 0 and 1 indicating the weight of end. result Matrix When the method completes, contains the linear interpolation of the two matrices. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. LookAtLH(Vector3, Vector3, Vector3) Creates a left-handed, look-at matrix. public static Matrix LookAtLH(Vector3 eye, Vector3 target, Vector3 up) Parameters eye Vector3 The position of the viewer's eye. target Vector3 The camera look-at target. up Vector3 The camera's up vector. Returns Matrix The created look-at matrix. LookAtLH(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, out Matrix) Creates a left-handed, look-at matrix. public static void LookAtLH(ref readonly Vector3 eye, ref readonly Vector3 target, ref readonly Vector3 up, out Matrix result) Parameters eye Vector3 The position of the viewer's eye. target Vector3 The camera look-at target. up Vector3 The camera's up vector. result Matrix When the method completes, contains the created look-at matrix. LookAtRH(Vector3, Vector3, Vector3) Creates a right-handed, look-at matrix. public static Matrix LookAtRH(Vector3 eye, Vector3 target, Vector3 up) Parameters eye Vector3 The position of the viewer's eye. target Vector3 The camera look-at target. up Vector3 The camera's up vector. Returns Matrix The created look-at matrix. LookAtRH(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, out Matrix) Creates a right-handed, look-at matrix. public static void LookAtRH(ref readonly Vector3 eye, ref readonly Vector3 target, ref readonly Vector3 up, out Matrix result) Parameters eye Vector3 The position of the viewer's eye. target Vector3 The camera look-at target. up Vector3 The camera's up vector. result Matrix When the method completes, contains the created look-at matrix. LowerTriangularForm(Matrix) Brings the matrix into lower triangular form using elementry row operations. public static Matrix LowerTriangularForm(Matrix value) Parameters value Matrix The matrix to put into lower triangular form. Returns Matrix The lower triangular matrix. Remarks If the matrix is not invertable (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the matrix represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist. LowerTriangularForm(ref readonly Matrix, out Matrix) Brings the matrix into lower triangular form using elementry row operations. public static void LowerTriangularForm(ref readonly Matrix value, out Matrix result) Parameters value Matrix The matrix to put into lower triangular form. result Matrix When the method completes, contains the lower triangular matrix. Remarks If the matrix is not invertable (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the matrix represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist. Multiply(Matrix, float) Scales a matrix by the given value. public static Matrix Multiply(Matrix left, float right) Parameters left Matrix The matrix to scale. right float The amount by which to scale. Returns Matrix The scaled matrix. Multiply(in Matrix, in Matrix) Determines the product of two matrices, equivalent to the '*' operator. public static Matrix Multiply(in Matrix left, in Matrix right) Parameters left Matrix The first matrix to multiply. right Matrix The second matrix to multiply. Returns Matrix The product of the two matrices. Multiply(ref readonly Matrix, ref readonly Matrix, out Matrix) Determines the product of two matrices. Variables passed as left or right must not be used as the out parameter result, because result is calculated in-place. public static void Multiply(ref readonly Matrix left, ref readonly Matrix right, out Matrix result) Parameters left Matrix The first matrix to multiply. right Matrix The second matrix to multiply. result Matrix The product of the two matrices. Multiply(ref readonly Matrix, float, out Matrix) Scales a matrix by the given value. public static void Multiply(ref readonly Matrix left, float right, out Matrix result) Parameters left Matrix The matrix to scale. right float The amount by which to scale. result Matrix When the method completes, contains the scaled matrix. MultiplyIn(in Matrix, in Matrix, out Matrix) Determines the product of two matrices. Variables passed as left or right must not be used as the out parameter result, because result is calculated in-place. public static void MultiplyIn(in Matrix left, in Matrix right, out Matrix result) Parameters left Matrix The first matrix to multiply. right Matrix The second matrix to multiply. result Matrix The product of the two matrices. Negate(Matrix) Negates a matrix. public static Matrix Negate(Matrix value) Parameters value Matrix The matrix to be negated. Returns Matrix The negated matrix. Negate(ref readonly Matrix, out Matrix) Negates a matrix. public static void Negate(ref readonly Matrix value, out Matrix result) Parameters value Matrix The matrix to be negated. result Matrix When the method completes, contains the negated matrix. OrthoLH(float, float, float, float) Creates a left-handed, orthographic projection matrix. public static Matrix OrthoLH(float width, float height, float znear, float zfar) Parameters width float Width of the viewing volume. height float Height of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. Returns Matrix The created projection matrix. OrthoLH(float, float, float, float, out Matrix) Creates a left-handed, orthographic projection matrix. public static void OrthoLH(float width, float height, float znear, float zfar, out Matrix result) Parameters width float Width of the viewing volume. height float Height of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. result Matrix When the method completes, contains the created projection matrix. OrthoOffCenterLH(float, float, float, float, float, float) Creates a left-handed, customized orthographic projection matrix. public static Matrix OrthoOffCenterLH(float left, float right, float bottom, float top, float znear, float zfar) Parameters left float Minimum x-value of the viewing volume. right float Maximum x-value of the viewing volume. bottom float Minimum y-value of the viewing volume. top float Maximum y-value of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. Returns Matrix The created projection matrix. OrthoOffCenterLH(float, float, float, float, float, float, out Matrix) Creates a left-handed, customized orthographic projection matrix. public static void OrthoOffCenterLH(float left, float right, float bottom, float top, float znear, float zfar, out Matrix result) Parameters left float Minimum x-value of the viewing volume. right float Maximum x-value of the viewing volume. bottom float Minimum y-value of the viewing volume. top float Maximum y-value of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. result Matrix When the method completes, contains the created projection matrix. OrthoOffCenterRH(float, float, float, float, float, float) Creates a right-handed, customized orthographic projection matrix. public static Matrix OrthoOffCenterRH(float left, float right, float bottom, float top, float znear, float zfar) Parameters left float Minimum x-value of the viewing volume. right float Maximum x-value of the viewing volume. bottom float Minimum y-value of the viewing volume. top float Maximum y-value of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. Returns Matrix The created projection matrix. OrthoOffCenterRH(float, float, float, float, float, float, out Matrix) Creates a right-handed, customized orthographic projection matrix. public static void OrthoOffCenterRH(float left, float right, float bottom, float top, float znear, float zfar, out Matrix result) Parameters left float Minimum x-value of the viewing volume. right float Maximum x-value of the viewing volume. bottom float Minimum y-value of the viewing volume. top float Maximum y-value of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. result Matrix When the method completes, contains the created projection matrix. OrthoRH(float, float, float, float) Creates a right-handed, orthographic projection matrix. public static Matrix OrthoRH(float width, float height, float znear, float zfar) Parameters width float Width of the viewing volume. height float Height of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. Returns Matrix The created projection matrix. OrthoRH(float, float, float, float, out Matrix) Creates a right-handed, orthographic projection matrix. public static void OrthoRH(float width, float height, float znear, float zfar, out Matrix result) Parameters width float Width of the viewing volume. height float Height of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. result Matrix When the method completes, contains the created projection matrix. Orthogonalize() Orthogonalizes the specified matrix. public void Orthogonalize() Remarks Orthogonalization is the process of making all rows orthogonal to each other. This means that any given row in the matrix will be orthogonal to any other given row in the matrix. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and then transpose the output. Orthogonalize(Matrix) Orthogonalizes the specified matrix. public static Matrix Orthogonalize(Matrix value) Parameters value Matrix The matrix to orthogonalize. Returns Matrix The orthogonalized matrix. Remarks Orthogonalization is the process of making all rows orthogonal to each other. This means that any given row in the matrix will be orthogonal to any other given row in the matrix. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output. Orthogonalize(ref readonly Matrix, out Matrix) Orthogonalizes the specified matrix. public static void Orthogonalize(ref readonly Matrix value, out Matrix result) Parameters value Matrix The matrix to orthogonalize. result Matrix When the method completes, contains the orthogonalized matrix. Remarks Orthogonalization is the process of making all rows orthogonal to each other. This means that any given row in the matrix will be orthogonal to any other given row in the matrix. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output. Orthonormalize() Orthonormalizes the specified matrix. public void Orthonormalize() Remarks Orthonormalization is the process of making all rows and columns orthogonal to each other and making all rows and columns of unit length. This means that any given row will be orthogonal to any other given row and any given column will be orthogonal to any other given column. Any given row will not be orthogonal to any given column. Every row and every column will be of unit length. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and then transpose the output. Orthonormalize(Matrix) Orthonormalizes the specified matrix. public static Matrix Orthonormalize(Matrix value) Parameters value Matrix The matrix to orthonormalize. Returns Matrix The orthonormalized matrix. Remarks Orthonormalization is the process of making all rows and columns orthogonal to each other and making all rows and columns of unit length. This means that any given row will be orthogonal to any other given row and any given column will be orthogonal to any other given column. Any given row will not be orthogonal to any given column. Every row and every column will be of unit length. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output. Orthonormalize(ref readonly Matrix, out Matrix) Orthonormalizes the specified matrix. public static void Orthonormalize(ref readonly Matrix value, out Matrix result) Parameters value Matrix The matrix to orthonormalize. result Matrix When the method completes, contains the orthonormalized matrix. Remarks Orthonormalization is the process of making all rows and columns orthogonal to each other and making all rows and columns of unit length. This means that any given row will be orthogonal to any other given row and any given column will be orthogonal to any other given column. Any given row will not be orthogonal to any given column. Every row and every column will be of unit length. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output. PerspectiveFovLH(float, float, float, float) Creates a left-handed, perspective projection matrix based on a field of view. public static Matrix PerspectiveFovLH(float fov, float aspect, float znear, float zfar) Parameters fov float Field of view in the y direction, in radians. aspect float Aspect ratio, defined as view space width divided by height. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. Returns Matrix The created projection matrix. PerspectiveFovLH(float, float, float, float, out Matrix) Creates a left-handed, perspective projection matrix based on a field of view. public static void PerspectiveFovLH(float fov, float aspect, float znear, float zfar, out Matrix result) Parameters fov float Field of view in the y direction, in radians. aspect float Aspect ratio, defined as view space width divided by height. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. result Matrix When the method completes, contains the created projection matrix. PerspectiveFovRH(float, float, float, float) Creates a right-handed, perspective projection matrix based on a field of view. public static Matrix PerspectiveFovRH(float fov, float aspect, float znear, float zfar) Parameters fov float Field of view in the y direction, in radians. aspect float Aspect ratio, defined as view space width divided by height. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. Returns Matrix The created projection matrix. PerspectiveFovRH(float, float, float, float, out Matrix) Creates a right-handed, perspective projection matrix based on a field of view. public static void PerspectiveFovRH(float fov, float aspect, float znear, float zfar, out Matrix result) Parameters fov float Field of view in the y direction, in radians. aspect float Aspect ratio, defined as view space width divided by height. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. result Matrix When the method completes, contains the created projection matrix. PerspectiveLH(float, float, float, float) Creates a left-handed, perspective projection matrix. public static Matrix PerspectiveLH(float width, float height, float znear, float zfar) Parameters width float Width of the viewing volume. height float Height of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. Returns Matrix The created projection matrix. PerspectiveLH(float, float, float, float, out Matrix) Creates a left-handed, perspective projection matrix. public static void PerspectiveLH(float width, float height, float znear, float zfar, out Matrix result) Parameters width float Width of the viewing volume. height float Height of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. result Matrix When the method completes, contains the created projection matrix. PerspectiveOffCenterLH(float, float, float, float, float, float) Creates a left-handed, customized perspective projection matrix. public static Matrix PerspectiveOffCenterLH(float left, float right, float bottom, float top, float znear, float zfar) Parameters left float Minimum x-value of the viewing volume. right float Maximum x-value of the viewing volume. bottom float Minimum y-value of the viewing volume. top float Maximum y-value of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. Returns Matrix The created projection matrix. PerspectiveOffCenterLH(float, float, float, float, float, float, out Matrix) Creates a left-handed, customized perspective projection matrix. public static void PerspectiveOffCenterLH(float left, float right, float bottom, float top, float znear, float zfar, out Matrix result) Parameters left float Minimum x-value of the viewing volume. right float Maximum x-value of the viewing volume. bottom float Minimum y-value of the viewing volume. top float Maximum y-value of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. result Matrix When the method completes, contains the created projection matrix. PerspectiveOffCenterRH(float, float, float, float, float, float) Creates a right-handed, customized perspective projection matrix. public static Matrix PerspectiveOffCenterRH(float left, float right, float bottom, float top, float znear, float zfar) Parameters left float Minimum x-value of the viewing volume. right float Maximum x-value of the viewing volume. bottom float Minimum y-value of the viewing volume. top float Maximum y-value of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. Returns Matrix The created projection matrix. PerspectiveOffCenterRH(float, float, float, float, float, float, out Matrix) Creates a right-handed, customized perspective projection matrix. public static void PerspectiveOffCenterRH(float left, float right, float bottom, float top, float znear, float zfar, out Matrix result) Parameters left float Minimum x-value of the viewing volume. right float Maximum x-value of the viewing volume. bottom float Minimum y-value of the viewing volume. top float Maximum y-value of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. result Matrix When the method completes, contains the created projection matrix. PerspectiveRH(float, float, float, float) Creates a right-handed, perspective projection matrix. public static Matrix PerspectiveRH(float width, float height, float znear, float zfar) Parameters width float Width of the viewing volume. height float Height of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. Returns Matrix The created projection matrix. PerspectiveRH(float, float, float, float, out Matrix) Creates a right-handed, perspective projection matrix. public static void PerspectiveRH(float width, float height, float znear, float zfar, out Matrix result) Parameters width float Width of the viewing volume. height float Height of the viewing volume. znear float Minimum z-value of the viewing volume. zfar float Maximum z-value of the viewing volume. result Matrix When the method completes, contains the created projection matrix. ReducedRowEchelonForm(ref readonly Matrix, ref readonly Vector4, out Matrix, out Vector4) Brings the matrix into reduced row echelon form using elementry row operations. public static void ReducedRowEchelonForm(ref readonly Matrix value, ref readonly Vector4 augment, out Matrix result, out Vector4 augmentResult) Parameters value Matrix The matrix to put into reduced row echelon form. augment Vector4 The fifth column of the matrix. result Matrix When the method completes, contains the resultant matrix after the operation. augmentResult Vector4 When the method completes, contains the resultant fifth column of the matrix. Remarks The fifth column is often called the agumented part of the matrix. This is because the fifth column is really just an extension of the matrix so that there is a place to put all of the non-zero components after the operation is complete. Often times the resultant matrix will the identity matrix or a matrix similar to the identity matrix. Sometimes, however, that is not possible and numbers other than zero and one may appear. This method can be used to solve systems of linear equations. Upon completion of this method, the augmentResult will contain the solution for the system. It is up to the user to analyze both the input and the result to determine if a solution really exists. Reflection(Plane) Builds a matrix that can be used to reflect vectors about a plane. public static Matrix Reflection(Plane plane) Parameters plane Plane The plane for which the reflection occurs. This parameter is assumed to be normalized. Returns Matrix The reflection matrix. Reflection(ref readonly Plane, out Matrix) Builds a matrix that can be used to reflect vectors about a plane. public static void Reflection(ref readonly Plane plane, out Matrix result) Parameters plane Plane The plane for which the reflection occurs. This parameter is assumed to be normalized. result Matrix When the method completes, contains the reflection matrix. RotationAxis(Vector3, float) Creates a matrix that rotates around an arbitary axis. public static Matrix RotationAxis(Vector3 axis, float angle) Parameters axis Vector3 The axis around which to rotate. This parameter is assumed to be normalized. angle float Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. Returns Matrix The created rotation matrix. RotationAxis(ref readonly Vector3, float, out Matrix) Creates a matrix that rotates around an arbitary axis. public static void RotationAxis(ref readonly Vector3 axis, float angle, out Matrix result) Parameters axis Vector3 The axis around which to rotate. This parameter is assumed to be normalized. angle float Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. result Matrix When the method completes, contains the created rotation matrix. RotationQuaternion(Quaternion) Creates a rotation matrix from a quaternion. public static Matrix RotationQuaternion(Quaternion rotation) Parameters rotation Quaternion The quaternion to use to build the matrix. Returns Matrix The created rotation matrix. RotationQuaternion(ref readonly Quaternion, out Matrix) Creates a rotation matrix from a quaternion. public static void RotationQuaternion(ref readonly Quaternion rotation, out Matrix result) Parameters rotation Quaternion The quaternion to use to build the matrix. result Matrix The created rotation matrix. RotationX(float) Creates a matrix that rotates around the x-axis. public static Matrix RotationX(float angle) Parameters angle float Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. Returns Matrix The created rotation matrix. RotationX(float, out Matrix) Creates a matrix that rotates around the x-axis. public static void RotationX(float angle, out Matrix result) Parameters angle float Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. result Matrix When the method completes, contains the created rotation matrix. RotationY(float) Creates a matrix that rotates around the y-axis. public static Matrix RotationY(float angle) Parameters angle float Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. Returns Matrix The created rotation matrix. RotationY(float, out Matrix) Creates a matrix that rotates around the y-axis. public static void RotationY(float angle, out Matrix result) Parameters angle float Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. result Matrix When the method completes, contains the created rotation matrix. RotationYawPitchRoll(float, float, float) Creates a rotation matrix with a specified yaw, pitch, and roll value (angles in radians). public static Matrix RotationYawPitchRoll(float yaw, float pitch, float roll) Parameters yaw float Yaw around the y-axis, in radians. pitch float Pitch around the x-axis, in radians. roll float Roll around the z-axis, in radians. Returns Matrix The created rotation matrix. RotationYawPitchRoll(float, float, float, out Matrix) Creates a rotation matrix with a specified yaw, pitch, and roll value (angles in radians). public static void RotationYawPitchRoll(float yaw, float pitch, float roll, out Matrix result) Parameters yaw float Yaw around the y-axis, in radians. pitch float Pitch around the x-axis, in radians. roll float Roll around the z-axis, in radians. result Matrix When the method completes, contains the created rotation matrix. RotationZ(float) Creates a matrix that rotates around the z-axis. public static Matrix RotationZ(float angle) Parameters angle float Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. Returns Matrix The created rotation matrix. RotationZ(float, out Matrix) Creates a matrix that rotates around the z-axis. public static void RotationZ(float angle, out Matrix result) Parameters angle float Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. result Matrix When the method completes, contains the created rotation matrix. RowEchelonForm(Matrix) Brings the matrix into row echelon form using elementry row operations; public static Matrix RowEchelonForm(Matrix value) Parameters value Matrix The matrix to put into row echelon form. Returns Matrix When the method completes, contains the row echelon form of the matrix. RowEchelonForm(ref readonly Matrix, out Matrix) Brings the matrix into row echelon form using elementry row operations; public static void RowEchelonForm(ref readonly Matrix value, out Matrix result) Parameters value Matrix The matrix to put into row echelon form. result Matrix When the method completes, contains the row echelon form of the matrix. Scaling(Vector3) Creates a matrix that scales along the x-axis, y-axis, and y-axis. public static Matrix Scaling(Vector3 scale) Parameters scale Vector3 Scaling factor for all three axes. Returns Matrix The created scaling matrix. Scaling(ref readonly Vector3, out Matrix) Creates a matrix that scales along the x-axis, y-axis, and y-axis. public static void Scaling(ref readonly Vector3 scale, out Matrix result) Parameters scale Vector3 Scaling factor for all three axes. result Matrix When the method completes, contains the created scaling matrix. Scaling(float) Creates a matrix that uniformally scales along all three axis. public static Matrix Scaling(float scale) Parameters scale float The uniform scale that is applied along all axis. Returns Matrix The created scaling matrix. Scaling(float, out Matrix) Creates a matrix that uniformally scales along all three axis. public static void Scaling(float scale, out Matrix result) Parameters scale float The uniform scale that is applied along all axis. result Matrix When the method completes, contains the created scaling matrix. Scaling(float, float, float) Creates a matrix that scales along the x-axis, y-axis, and y-axis. public static Matrix Scaling(float x, float y, float z) Parameters x float Scaling factor that is applied along the x-axis. y float Scaling factor that is applied along the y-axis. z float Scaling factor that is applied along the z-axis. Returns Matrix The created scaling matrix. Scaling(float, float, float, out Matrix) Creates a matrix that scales along the x-axis, y-axis, and y-axis. public static void Scaling(float x, float y, float z, out Matrix result) Parameters x float Scaling factor that is applied along the x-axis. y float Scaling factor that is applied along the y-axis. z float Scaling factor that is applied along the z-axis. result Matrix When the method completes, contains the created scaling matrix. Shadow(Vector4, Plane) Creates a matrix that flattens geometry into a shadow. public static Matrix Shadow(Vector4 light, Plane plane) Parameters light Vector4 The light direction. If the W component is 0, the light is directional light; if the W component is 1, the light is a point light. plane Plane The plane onto which to project the geometry as a shadow. This parameter is assumed to be normalized. Returns Matrix The shadow matrix. Shadow(ref readonly Vector4, ref readonly Plane, out Matrix) Creates a matrix that flattens geometry into a shadow. public static void Shadow(ref readonly Vector4 light, ref readonly Plane plane, out Matrix result) Parameters light Vector4 The light direction. If the W component is 0, the light is directional light; if the W component is 1, the light is a point light. plane Plane The plane onto which to project the geometry as a shadow. This parameter is assumed to be normalized. result Matrix When the method completes, contains the shadow matrix. SmoothStep(Matrix, Matrix, float) Performs a cubic interpolation between two matrices. public static Matrix SmoothStep(Matrix start, Matrix end, float amount) Parameters start Matrix Start matrix. end Matrix End matrix. amount float Value between 0 and 1 indicating the weight of end. Returns Matrix The cubic interpolation of the two matrices. SmoothStep(ref readonly Matrix, ref readonly Matrix, float, out Matrix) Performs a cubic interpolation between two matrices. public static void SmoothStep(ref readonly Matrix start, ref readonly Matrix end, float amount, out Matrix result) Parameters start Matrix Start matrix. end Matrix End matrix. amount float Value between 0 and 1 indicating the weight of end. result Matrix When the method completes, contains the cubic interpolation of the two matrices. Subtract(Matrix, Matrix) Determines the difference between two matrices. public static Matrix Subtract(Matrix left, Matrix right) Parameters left Matrix The first matrix to subtract. right Matrix The second matrix to subtract. Returns Matrix The difference between the two matrices. Subtract(ref readonly Matrix, ref readonly Matrix, out Matrix) Determines the difference between two matrices. public static void Subtract(ref readonly Matrix left, ref readonly Matrix right, out Matrix result) Parameters left Matrix The first matrix to subtract. right Matrix The second matrix to subtract. result Matrix When the method completes, contains the difference between the two matrices. ToArray() Creates an array containing the elements of the matrix. public readonly float[] ToArray() Returns float[] A sixteen-element array containing the components of the matrix. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transformation(Vector3, Quaternion, Vector3, Vector3, Quaternion, Vector3) Creates a transformation matrix. public static Matrix Transformation(Vector3 scalingCenter, Quaternion scalingRotation, Vector3 scaling, Vector3 rotationCenter, Quaternion rotation, Vector3 translation) Parameters scalingCenter Vector3 Center point of the scaling operation. scalingRotation Quaternion Scaling rotation amount. scaling Vector3 Scaling factor. rotationCenter Vector3 The center of the rotation. rotation Quaternion The rotation of the transformation. translation Vector3 The translation factor of the transformation. Returns Matrix The created transformation matrix. Transformation(ref readonly Vector3, ref readonly Quaternion, ref readonly Vector3, out Matrix) Creates a matrix that contains both the X, Y and Z rotation, as well as scaling and translation. Note: This function is NOT thead safe. public static void Transformation(ref readonly Vector3 scaling, ref readonly Quaternion rotation, ref readonly Vector3 translation, out Matrix result) Parameters scaling Vector3 The scaling. rotation Quaternion Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. translation Vector3 The translation. result Matrix When the method completes, contains the created rotation matrix. Transformation(ref readonly Vector3, ref readonly Quaternion, ref readonly Vector3, ref readonly Vector3, ref readonly Quaternion, ref readonly Vector3, out Matrix) Creates a transformation matrix. public static void Transformation(ref readonly Vector3 scalingCenter, ref readonly Quaternion scalingRotation, ref readonly Vector3 scaling, ref readonly Vector3 rotationCenter, ref readonly Quaternion rotation, ref readonly Vector3 translation, out Matrix result) Parameters scalingCenter Vector3 Center point of the scaling operation. scalingRotation Quaternion Scaling rotation amount. scaling Vector3 Scaling factor. rotationCenter Vector3 The center of the rotation. rotation Quaternion The rotation of the transformation. translation Vector3 The translation factor of the transformation. result Matrix When the method completes, contains the created transformation matrix. Transformation2D(Vector2, float, Vector2, Vector2, float, Vector2) Creates a 2D transformation matrix. public static Matrix Transformation2D(Vector2 scalingCenter, float scalingRotation, Vector2 scaling, Vector2 rotationCenter, float rotation, Vector2 translation) Parameters scalingCenter Vector2 Center point of the scaling operation. scalingRotation float Scaling rotation amount. scaling Vector2 Scaling factor. rotationCenter Vector2 The center of the rotation. rotation float The rotation of the transformation. translation Vector2 The translation factor of the transformation. Returns Matrix The created transformation matrix. Transformation2D(ref readonly Vector2, float, ref readonly Vector2, ref readonly Vector2, float, ref readonly Vector2, out Matrix) Creates a 2D transformation matrix. public static void Transformation2D(ref readonly Vector2 scalingCenter, float scalingRotation, ref readonly Vector2 scaling, ref readonly Vector2 rotationCenter, float rotation, ref readonly Vector2 translation, out Matrix result) Parameters scalingCenter Vector2 Center point of the scaling operation. scalingRotation float Scaling rotation amount. scaling Vector2 Scaling factor. rotationCenter Vector2 The center of the rotation. rotation float The rotation of the transformation. translation Vector2 The translation factor of the transformation. result Matrix When the method completes, contains the created transformation matrix. Translation(Vector3) Creates a translation matrix using the specified offsets. public static Matrix Translation(Vector3 value) Parameters value Vector3 The offset for all three coordinate planes. Returns Matrix The created translation matrix. Translation(ref readonly Vector3, out Matrix) Creates a translation matrix using the specified offsets. public static void Translation(ref readonly Vector3 value, out Matrix result) Parameters value Vector3 The offset for all three coordinate planes. result Matrix When the method completes, contains the created translation matrix. Translation(float, float, float) Creates a translation matrix using the specified offsets. public static Matrix Translation(float x, float y, float z) Parameters x float X-coordinate offset. y float Y-coordinate offset. z float Z-coordinate offset. Returns Matrix The created translation matrix. Translation(float, float, float, out Matrix) Creates a translation matrix using the specified offsets. public static void Translation(float x, float y, float z, out Matrix result) Parameters x float X-coordinate offset. y float Y-coordinate offset. z float Z-coordinate offset. result Matrix When the method completes, contains the created translation matrix. Transpose() Transposes the matrix. public void Transpose() Transpose(in Matrix) Calculates the transpose of the specified matrix. public static Matrix Transpose(in Matrix value) Parameters value Matrix The matrix whose transpose is to be calculated. Returns Matrix The transpose of the specified matrix. Transpose(ref readonly Matrix, out Matrix) Calculates the transpose of the specified matrix. public static void Transpose(ref readonly Matrix value, out Matrix result) Parameters value Matrix The matrix whose transpose is to be calculated. result Matrix When the method completes, contains the transpose of the specified matrix. TransposeMatrixFrom(float*, int, int) Transposes a nmx matrix to this instance. public void TransposeMatrixFrom(float* src, int columns, int rows) Parameters src float* The SRC. columns int The columns. rows int The rows. UpperTriangularForm(Matrix) Brings the matrix into upper triangular form using elementry row operations. public static Matrix UpperTriangularForm(Matrix value) Parameters value Matrix The matrix to put into upper triangular form. Returns Matrix The upper triangular matrix. Remarks If the matrix is not invertable (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the matrix represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist. UpperTriangularForm(ref readonly Matrix, out Matrix) Brings the matrix into upper triangular form using elementry row operations. public static void UpperTriangularForm(ref readonly Matrix value, out Matrix result) Parameters value Matrix The matrix to put into upper triangular form. result Matrix When the method completes, contains the upper triangular matrix. Remarks If the matrix is not invertable (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the matrix represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist. Operators operator +(in Matrix, in Matrix) Adds two matrices. public static Matrix operator +(in Matrix left, in Matrix right) Parameters left Matrix The first matrix to add. right Matrix The second matrix to add. Returns Matrix The sum of the two matrices. operator /(in Matrix, in Matrix) Divides two matrices. public static Matrix operator /(in Matrix left, in Matrix right) Parameters left Matrix The first matrix to divide. right Matrix The second matrix to divide. Returns Matrix The quotient of the two matrices. operator /(in Matrix, in float) Scales a matrix by a given value. public static Matrix operator /(in Matrix left, in float right) Parameters left Matrix The matrix to scale. right float The amount by which to scale. Returns Matrix The scaled matrix. operator ==(in Matrix, in Matrix) Tests for equality between two objects. public static bool operator ==(in Matrix left, in Matrix right) Parameters left Matrix The first value to compare. right Matrix The second value to compare. Returns bool true if left has the same value as right; otherwise, false. implicit operator Matrix4x4(Matrix) Casts from Stride.Maths to System.Numerics matrix public static implicit operator Matrix4x4(Matrix v) Parameters v Matrix Value to cast Returns Matrix4x4 implicit operator Matrix(Matrix4x4) Casts from System.Numerics to Stride.Maths matrix public static implicit operator Matrix(Matrix4x4 v) Parameters v Matrix4x4 Value to cast Returns Matrix operator !=(in Matrix, in Matrix) Tests for inequality between two objects. public static bool operator !=(in Matrix left, in Matrix right) Parameters left Matrix The first value to compare. right Matrix The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(in Matrix, in Matrix) Multiplies two matrices. public static Matrix operator *(in Matrix left, in Matrix right) Parameters left Matrix The first matrix to multiply. right Matrix The second matrix to multiply. Returns Matrix The product of the two matrices. operator *(in Matrix, float) Scales a matrix by a given value. public static Matrix operator *(in Matrix left, float right) Parameters left Matrix The matrix to scale. right float The amount by which to scale. Returns Matrix The scaled matrix. operator *(float, in Matrix) Scales a matrix by a given value. public static Matrix operator *(float left, in Matrix right) Parameters left float The amount by which to scale. right Matrix The matrix to scale. Returns Matrix The scaled matrix. operator -(in Matrix, in Matrix) Subtracts two matrices. public static Matrix operator -(in Matrix left, in Matrix right) Parameters left Matrix The first matrix to subtract. right Matrix The second matrix to subtract. Returns Matrix The difference between the two matrices. operator -(in Matrix) Negates a matrix. public static Matrix operator -(in Matrix value) Parameters value Matrix The matrix to negate. Returns Matrix The negated matrix. operator +(in Matrix) Assert a matrix (return it unchanged). public static Matrix operator +(in Matrix value) Parameters value Matrix The matrix to assert (unchange). Returns Matrix The asserted (unchanged) matrix."
  },
  "api/Stride.Core.Mathematics.Plane.html": {
    "href": "api/Stride.Core.Mathematics.Plane.html",
    "title": "Struct Plane | Stride API",
    "summary": "Struct Plane Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a plane in three dimensional space. [DataContract] public struct Plane : IEquatable<Plane>, ISpanFormattable, IFormattable, IIntersectableWithRay Implements IEquatable<Plane> ISpanFormattable IFormattable IIntersectableWithRay Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Plane(Vector3, Vector3) Initializes a new instance of the Plane struct. public Plane(Vector3 point, Vector3 normal) Parameters point Vector3 Any point that lies along the plane. normal Vector3 The normal vector to the plane. Plane(Vector3, Vector3, Vector3) Initializes a new instance of the Plane struct. public Plane(Vector3 point1, Vector3 point2, Vector3 point3) Parameters point1 Vector3 First point of a triangle defining the plane. point2 Vector3 Second point of a triangle defining the plane. point3 Vector3 Third point of a triangle defining the plane. Plane(Vector3, float) Initializes a new instance of the Plane struct. public Plane(Vector3 value, float d) Parameters value Vector3 The normal of the plane. d float The distance of the plane along its normal from the origin Plane(float) Initializes a new instance of the Plane struct. public Plane(float value) Parameters value float The value that will be assigned to all components. Plane(float, float, float, float) Initializes a new instance of the Plane struct. public Plane(float a, float b, float c, float d) Parameters a float The X component of the normal. b float The Y component of the normal. c float The Z component of the normal. d float The distance of the plane along its normal from the origin. Plane(float[]) Initializes a new instance of the Plane struct. public Plane(float[] values) Parameters values float[] The values to assign to the A, B, C, and D components of the plane. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Fields D The distance of the plane along its normal from the origin. public float D Field Value float Normal The normal vector of the plane. public Vector3 Normal Field Value Vector3 Properties this[int] Gets or sets the component at the specified index. public float this[int index] { get; set; } Parameters index int The index of the component to access. Use 0 for the A component, 1 for the B component, 2 for the C component, and 3 for the D component. Property Value float The value of the A, B, C, or D component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 3]. Methods Dot(Plane, Vector4) Calculates the dot product of the specified vector and plane. public static float Dot(Plane left, Vector4 right) Parameters left Plane The source plane. right Vector4 The source vector. Returns float The dot product of the specified plane and vector. Dot(ref readonly Plane, ref readonly Vector4, out float) Calculates the dot product of the specified vector and plane. public static void Dot(ref readonly Plane left, ref readonly Vector4 right, out float result) Parameters left Plane The source plane. right Vector4 The source vector. result float When the method completes, contains the dot product of the specified plane and vector. DotCoordinate(Plane, Vector3) Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane. public static float DotCoordinate(Plane left, Vector3 right) Parameters left Plane The source plane. right Vector3 The source vector. Returns float The dot product of a specified vector and the normal of the Plane plus the distance value of the plane. DotCoordinate(ref readonly Plane, ref readonly Vector3, out float) Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane. public static void DotCoordinate(ref readonly Plane left, ref readonly Vector3 right, out float result) Parameters left Plane The source plane. right Vector3 The source vector. result float When the method completes, contains the dot product of a specified vector and the normal of the Plane plus the distance value of the plane. DotNormal(Plane, Vector3) Calculates the dot product of the specified vector and the normal of the plane. public static float DotNormal(Plane left, Vector3 right) Parameters left Plane The source plane. right Vector3 The source vector. Returns float The dot product of the specified vector and the normal of the plane. DotNormal(ref readonly Plane, ref readonly Vector3, out float) Calculates the dot product of the specified vector and the normal of the plane. public static void DotNormal(ref readonly Plane left, ref readonly Vector3 right, out float result) Parameters left Plane The source plane. right Vector3 The source vector. result float When the method completes, contains the dot product of the specified vector and the normal of the plane. Equals(Plane) Determines whether the specified Vector4 is equal to this instance. public readonly bool Equals(Plane value) Parameters value Plane The Vector4 to compare with this instance. Returns bool true if the specified Vector4 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Intersects(ref readonly BoundingBox) Determines if there is an intersection between the current object and a BoundingBox. public PlaneIntersectionType Intersects(ref readonly BoundingBox box) Parameters box BoundingBox The box to test. Returns PlaneIntersectionType Whether the two objects intersected. Intersects(ref readonly BoundingSphere) Determines if there is an intersection between the current object and a BoundingSphere. public PlaneIntersectionType Intersects(ref readonly BoundingSphere sphere) Parameters sphere BoundingSphere The sphere to test. Returns PlaneIntersectionType Whether the two objects intersected. Intersects(ref readonly Plane) Determines if there is an intersection between the current object and a Plane. public bool Intersects(ref readonly Plane plane) Parameters plane Plane The plane to test. Returns bool Whether the two objects intersected. Intersects(ref readonly Plane, out Ray) Determines if there is an intersection between the current object and a Plane. public bool Intersects(ref readonly Plane plane, out Ray line) Parameters plane Plane The plane to test. line Ray When the method completes, contains the line of intersection as a Ray, or a zero ray if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray) Parameters ray Ray The ray to test. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray, out Vector3) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray, out Vector3 point) Parameters ray Ray The ray to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray, out float) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray, out float distance) Parameters ray Ray The ray to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Vector3) Determines if there is an intersection between the current object and a point. public PlaneIntersectionType Intersects(ref readonly Vector3 point) Parameters point Vector3 The point to test. Returns PlaneIntersectionType Whether the two objects intersected. Intersects(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3) Determines if there is an intersection between the current object and a triangle. public PlaneIntersectionType Intersects(ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3) Parameters vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triagnle to test. vertex3 Vector3 The third vertex of the triangle to test. Returns PlaneIntersectionType Whether the two objects intersected. Multiply(Plane, float) Scales the plane by the given scaling factor. public static Plane Multiply(Plane value, float scale) Parameters value Plane The plane to scale. scale float The amount by which to scale the plane. Returns Plane The scaled plane. Multiply(ref readonly Plane, float, out Plane) Scales the plane by the given scaling factor. public static void Multiply(ref readonly Plane value, float scale, out Plane result) Parameters value Plane The plane to scale. scale float The amount by which to scale the plane. result Plane When the method completes, contains the scaled plane. Negate() Negates a plane by negating all its coefficients, which result in a plane in opposite direction. public void Negate() Negate(Plane) Negates a plane by negating all its coefficients, which result in a plane in opposite direction. public static Plane Negate(Plane plane) Parameters plane Plane The source plane. Returns Plane The flipped plane. Negate(ref readonly Plane, out Plane) Negates a plane by negating all its coefficients, which result in a plane in opposite direction. public static void Negate(ref readonly Plane plane, out Plane result) Parameters plane Plane The source plane. result Plane When the method completes, contains the flipped plane. Normalize() Changes the coefficients of the normal vector of the plane to make it of unit length. public void Normalize() Normalize(Plane) Changes the coefficients of the normal vector of the plane to make it of unit length. public static Plane Normalize(Plane plane) Parameters plane Plane The source plane. Returns Plane The normalized plane. Normalize(ref readonly Plane, out Plane) Changes the coefficients of the normal vector of the plane to make it of unit length. public static void Normalize(ref readonly Plane plane, out Plane result) Parameters plane Plane The source plane. result Plane When the method completes, contains the normalized plane. Normalize(float, float, float, float, out Plane) Creates a plane of unit length. public static void Normalize(float normalX, float normalY, float normalZ, float planeD, out Plane result) Parameters normalX float The X component of the normal. normalY float The Y component of the normal. normalZ float The Z component of the normal. planeD float The distance of the plane along its normal from the origin. result Plane When the method completes, contains the normalized plane. Project(Plane, Vector3) Projects a point onto a plane. public static Vector3 Project(Plane plane, Vector3 point) Parameters plane Plane The plane to project the point to. point Vector3 The point to project. Returns Vector3 The projected point. Project(ref readonly Plane, ref readonly Vector3, out Vector3) Projects a point onto a plane. public static void Project(ref readonly Plane plane, ref readonly Vector3 point, out Vector3 result) Parameters plane Plane The plane to project the point to. point Vector3 The point to project. result Vector3 The projected point. ToArray() Creates an array containing the elements of the plane. public float[] ToArray() Returns float[] A four-element array containing the components of the plane. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transform(Plane, Matrix) Transforms a normalized plane by a matrix. public static Plane Transform(Plane plane, Matrix transformation) Parameters plane Plane The normalized source plane. transformation Matrix The transformation matrix. Returns Plane When the method completes, contains the transformed plane. Transform(Plane, Quaternion) Transforms a normalized plane by a quaternion rotation. public static Plane Transform(Plane plane, Quaternion rotation) Parameters plane Plane The normalized source plane. rotation Quaternion The quaternion rotation. Returns Plane The transformed plane. Transform(ref readonly Plane, ref readonly Matrix, out Plane) Transforms a normalized plane by a matrix. public static void Transform(ref readonly Plane plane, ref readonly Matrix transformation, out Plane result) Parameters plane Plane The normalized source plane. transformation Matrix The transformation matrix. result Plane When the method completes, contains the transformed plane. Transform(ref readonly Plane, ref readonly Quaternion, out Plane) Transforms a normalized plane by a quaternion rotation. public static void Transform(ref readonly Plane plane, ref readonly Quaternion rotation, out Plane result) Parameters plane Plane The normalized source plane. rotation Quaternion The quaternion rotation. result Plane When the method completes, contains the transformed plane. Transform(Plane[], ref readonly Matrix) Transforms an array of normalized planes by a matrix. public static void Transform(Plane[] planes, ref readonly Matrix transformation) Parameters planes Plane[] The array of normalized planes to transform. transformation Matrix The transformation matrix. Exceptions ArgumentNullException Thrown when planes is null. Transform(Plane[], ref readonly Quaternion) Transforms an array of normalized planes by a quaternion rotation. public static void Transform(Plane[] planes, ref readonly Quaternion rotation) Parameters planes Plane[] The array of normalized planes to transform. rotation Quaternion The quaternion rotation. Exceptions ArgumentNullException Thrown when planes is null. Operators operator ==(Plane, Plane) Tests for equality between two objects. public static bool operator ==(Plane left, Plane right) Parameters left Plane The first value to compare. right Plane The second value to compare. Returns bool true if left has the same value as right; otherwise, false. operator !=(Plane, Plane) Tests for inequality between two objects. public static bool operator !=(Plane left, Plane right) Parameters left Plane The first value to compare. right Plane The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Plane, float) Scales a plane by the given value. public static Plane operator *(Plane plane, float scale) Parameters plane Plane The plane to scale. scale float The amount by which to scale the plane. Returns Plane The scaled plane. operator *(float, Plane) Scales a plane by the given value. public static Plane operator *(float scale, Plane plane) Parameters scale float The amount by which to scale the plane. plane Plane The plane to scale. Returns Plane The scaled plane. operator -(Plane) Negates a plane by negating all its coefficients, which result in a plane in opposite direction. public static Plane operator -(Plane plane) Parameters plane Plane Returns Plane The negated plane."
  },
  "api/Stride.Core.Mathematics.PlaneIntersectionType.html": {
    "href": "api/Stride.Core.Mathematics.PlaneIntersectionType.html",
    "title": "Enum PlaneIntersectionType | Stride API",
    "summary": "Enum PlaneIntersectionType Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Describes the result of an intersection with a plane in three dimensions. public enum PlaneIntersectionType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Back = 0 The object is behind the plane. Front = 1 The object is in front of the plane. Intersecting = 2 The object is intersecting the plane."
  },
  "api/Stride.Core.Mathematics.Point.html": {
    "href": "api/Stride.Core.Mathematics.Point.html",
    "title": "Struct Point | Stride API",
    "summary": "Struct Point Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll A 2D point. [DataContract] public struct Point : IEquatable<Point>, ISpanFormattable, IFormattable Implements IEquatable<Point> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Point(int, int) Initializes a new instance of the Point struct. public Point(int x, int y) Parameters x int The x. y int The y. Fields X Left coordinate. [DataMember(0)] public int X Field Value int Y Top coordinate. [DataMember(1)] public int Y Field Value int Zero A point with (0,0) coordinates. public static readonly Point Zero Field Value Point Methods Deconstruct(out int, out int) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out int x, out int y) Parameters x int The X component y int The Y component Equals(Point) Determines whether the specified object is equal to this instance. public readonly bool Equals(Point other) Parameters other Point The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the fully qualified type name of this instance. public override readonly string ToString() Returns string The fully qualified type name. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator ==(Point, Point) Implements the operator ==. public static bool operator ==(Point left, Point right) Parameters left Point The left. right Point The right. Returns bool The result of the operator. explicit operator Point(Vector2) Performs an implicit conversion from Vector2 to Point. public static explicit operator Point(Vector2 value) Parameters value Vector2 The value. Returns Point The result of the conversion. implicit operator Vector2(Point) Performs an explicit conversion from Point to Vector2. public static implicit operator Vector2(Point value) Parameters value Point The value. Returns Vector2 The result of the conversion. operator !=(Point, Point) Implements the operator !=. public static bool operator !=(Point left, Point right) Parameters left Point The left. right Point The right. Returns bool The result of the operator."
  },
  "api/Stride.Core.Mathematics.Quaternion.html": {
    "href": "api/Stride.Core.Mathematics.Quaternion.html",
    "title": "Struct Quaternion | Stride API",
    "summary": "Struct Quaternion Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a four dimensional mathematical quaternion. [DataContract(\"quaternion\")] [DataStyle(DataStyle.Compact)] public struct Quaternion : IEquatable<Quaternion>, ISpanFormattable, IFormattable Implements IEquatable<Quaternion> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Quaternion(Vector2, float, float) Initializes a new instance of the Quaternion struct. public Quaternion(Vector2 value, float z, float w) Parameters value Vector2 A vector containing the values with which to initialize the X and Y components. z float Initial value for the Z component of the quaternion. w float Initial value for the W component of the quaternion. Quaternion(Vector3, float) Initializes a new instance of the Quaternion struct. public Quaternion(Vector3 value, float w) Parameters value Vector3 A vector containing the values with which to initialize the X, Y, and Z components. w float Initial value for the W component of the quaternion. Quaternion(Vector4) Initializes a new instance of the Quaternion struct. public Quaternion(Vector4 value) Parameters value Vector4 A vector containing the values with which to initialize the components. Quaternion(float) Initializes a new instance of the Quaternion struct. public Quaternion(float value) Parameters value float The value that will be assigned to all components. Quaternion(float, float, float, float) Initializes a new instance of the Quaternion struct. public Quaternion(float x, float y, float z, float w) Parameters x float Initial value for the X component of the quaternion. y float Initial value for the Y component of the quaternion. z float Initial value for the Z component of the quaternion. w float Initial value for the W component of the quaternion. Quaternion(float[]) Initializes a new instance of the Quaternion struct. public Quaternion(float[] values) Parameters values float[] The values to assign to the X, Y, Z, and W components of the quaternion. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Fields Identity The identity Quaternion (0, 0, 0, 1). public static readonly Quaternion Identity Field Value Quaternion One A Quaternion with all of its components set to one. public static readonly Quaternion One Field Value Quaternion SizeInBytes The size of the Quaternion type, in bytes. public static readonly int SizeInBytes Field Value int W The W component of the quaternion. public float W Field Value float X The X component of the quaternion. public float X Field Value float Y The Y component of the quaternion. public float Y Field Value float Z The Z component of the quaternion. public float Z Field Value float Zero A Quaternion with all of its components set to zero. public static readonly Quaternion Zero Field Value Quaternion Properties Angle Gets the angle of the quaternion. public float Angle { get; } Property Value float The quaternion's angle. Axis Gets the axis components of the quaternion. public Vector3 Axis { get; } Property Value Vector3 The axis components of the quaternion. IsIdentity Gets a value indicating whether this instance is equivalent to the identity quaternion. public bool IsIdentity { get; } Property Value bool true if this instance is an identity quaternion; otherwise, false. IsNormalized Gets a value indicting whether this instance is normalized. public bool IsNormalized { get; } Property Value bool this[int] Gets or sets the component at the specified index. public float this[int index] { get; set; } Parameters index int The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. Property Value float The value of the X, Y, Z, or W component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 3]. YawPitchRoll Gets yaw/pitch/roll equivalent of the quaternion public Vector3 YawPitchRoll { get; } Property Value Vector3 Methods Add(Quaternion, Quaternion) Adds two quaternions. public static Quaternion Add(Quaternion left, Quaternion right) Parameters left Quaternion The first quaternion to add. right Quaternion The second quaternion to add. Returns Quaternion The sum of the two quaternions. Add(ref readonly Quaternion, ref readonly Quaternion, out Quaternion) Adds two quaternions. public static void Add(ref readonly Quaternion left, ref readonly Quaternion right, out Quaternion result) Parameters left Quaternion The first quaternion to add. right Quaternion The second quaternion to add. result Quaternion When the method completes, contains the sum of the two quaternions. AngleBetween(in Quaternion, in Quaternion) Returns the absolute angle in radians between a and b public static float AngleBetween(in Quaternion a, in Quaternion b) Parameters a Quaternion b Quaternion Returns float Barycentric(Quaternion, Quaternion, Quaternion, float, float) Returns a Quaternion containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle. public static Quaternion Barycentric(Quaternion value1, Quaternion value2, Quaternion value3, float amount1, float amount2) Parameters value1 Quaternion A Quaternion containing the 4D Cartesian coordinates of vertex 1 of the triangle. value2 Quaternion A Quaternion containing the 4D Cartesian coordinates of vertex 2 of the triangle. value3 Quaternion A Quaternion containing the 4D Cartesian coordinates of vertex 3 of the triangle. amount1 float Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 float Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). Returns Quaternion A new Quaternion containing the 4D Cartesian coordinates of the specified point. Barycentric(ref readonly Quaternion, ref readonly Quaternion, ref readonly Quaternion, float, float, out Quaternion) Returns a Quaternion containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle. public static void Barycentric(ref readonly Quaternion value1, ref readonly Quaternion value2, ref readonly Quaternion value3, float amount1, float amount2, out Quaternion result) Parameters value1 Quaternion A Quaternion containing the 4D Cartesian coordinates of vertex 1 of the triangle. value2 Quaternion A Quaternion containing the 4D Cartesian coordinates of vertex 2 of the triangle. value3 Quaternion A Quaternion containing the 4D Cartesian coordinates of vertex 3 of the triangle. amount1 float Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 float Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). result Quaternion When the method completes, contains a new Quaternion containing the 4D Cartesian coordinates of the specified point. BetweenDirections(Vector3, Vector3) Computes a quaternion corresponding to the rotation transforming the vector source to the vector target. public static Quaternion BetweenDirections(Vector3 source, Vector3 target) Parameters source Vector3 The source vector of the transformation. target Vector3 The target vector of the transformation. Returns Quaternion The resulting quaternion corresponding to the transformation of the source vector to the target vector. BetweenDirections(ref readonly Vector3, ref readonly Vector3, out Quaternion) Computes a quaternion corresponding to the rotation transforming the vector source to the vector target. public static void BetweenDirections(ref readonly Vector3 source, ref readonly Vector3 target, out Quaternion result) Parameters source Vector3 The source vector of the transformation. target Vector3 The target vector of the transformation. result Quaternion The resulting quaternion corresponding to the transformation of the source vector to the target vector. Conjugate() Conjugates the quaternion. public void Conjugate() Conjugate(in Quaternion) Conjugates a quaternion. public static Quaternion Conjugate(in Quaternion value) Parameters value Quaternion The quaternion to conjugate. Returns Quaternion The conjugated quaternion. Conjugate(ref readonly Quaternion, out Quaternion) Conjugates a quaternion. public static void Conjugate(ref readonly Quaternion value, out Quaternion result) Parameters value Quaternion The quaternion to conjugate. result Quaternion When the method completes, contains the conjugated quaternion. Dot(in Quaternion, in Quaternion) Calculates the dot product of two quaternions. public static float Dot(in Quaternion left, in Quaternion right) Parameters left Quaternion First source quaternion. right Quaternion Second source quaternion. Returns float The dot product of the two quaternions. Dot(ref readonly Quaternion, ref readonly Quaternion, out float) Calculates the dot product of two quaternions. public static void Dot(ref readonly Quaternion left, ref readonly Quaternion right, out float result) Parameters left Quaternion First source quaternion. right Quaternion Second source quaternion. result float When the method completes, contains the dot product of the two quaternions. Equals(Quaternion) Determines whether the specified Quaternion is within ZeroTolerance for equality to this instance. public readonly bool Equals(Quaternion other) Parameters other Quaternion The Quaternion to compare with this instance. Returns bool true if the specified Quaternion is equal or almost equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is within ZeroTolerance for equality to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal or almost equal to this instance; otherwise, false. EqualsStrict(Quaternion) Determines whether the specified Quaternion is exactly equal to this instance. public bool EqualsStrict(Quaternion other) Parameters other Quaternion The Quaternion to compare with this instance. Returns bool true if the specified Quaternion is exactly equal to this instance; otherwise, false. Exponential(Quaternion) Exponentiates a quaternion. public static Quaternion Exponential(Quaternion value) Parameters value Quaternion The quaternion to exponentiate. Returns Quaternion The exponentiated quaternion. Exponential(ref readonly Quaternion, out Quaternion) Exponentiates a quaternion. public static void Exponential(ref readonly Quaternion value, out Quaternion result) Parameters value Quaternion The quaternion to exponentiate. result Quaternion When the method completes, contains the exponentiated quaternion. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Invert() Conjugates and renormalizes the quaternion. public void Invert() Invert(Quaternion) Conjugates and renormalizes the quaternion. public static Quaternion Invert(Quaternion value) Parameters value Quaternion The quaternion to conjugate and renormalize. Returns Quaternion The conjugated and renormalized quaternion. Invert(ref readonly Quaternion, out Quaternion) Conjugates and renormalizes the quaternion. public static void Invert(ref readonly Quaternion value, out Quaternion result) Parameters value Quaternion The quaternion to conjugate and renormalize. result Quaternion When the method completes, contains the conjugated and renormalized quaternion. Length() Calculates the length of the quaternion. public readonly float Length() Returns float The length of the quaternion. Remarks LengthSquared() may be preferred when only the relative length is needed and speed is of the essence. LengthSquared() Calculates the squared length of the quaternion. public readonly float LengthSquared() Returns float The squared length of the quaternion. Remarks This method may be preferred to Length() when only a relative length is needed and speed is of the essence. Lerp(Quaternion, Quaternion, float) Performs a linear interpolation between two quaternion. public static Quaternion Lerp(Quaternion start, Quaternion end, float amount) Parameters start Quaternion Start quaternion. end Quaternion End quaternion. amount float Value between 0 and 1 indicating the weight of end. Returns Quaternion The linear interpolation of the two quaternions. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Quaternion, ref readonly Quaternion, float, out Quaternion) Performs a linear interpolation between two quaternions. public static void Lerp(ref readonly Quaternion start, ref readonly Quaternion end, float amount, out Quaternion result) Parameters start Quaternion Start quaternion. end Quaternion End quaternion. amount float Value between 0 and 1 indicating the weight of end. result Quaternion When the method completes, contains the linear interpolation of the two quaternions. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Logarithm(Quaternion) Calculates the natural logarithm of the specified quaternion. public static Quaternion Logarithm(Quaternion value) Parameters value Quaternion The quaternion whose logarithm will be calculated. Returns Quaternion The natural logarithm of the quaternion. Logarithm(ref readonly Quaternion, out Quaternion) Calculates the natural logarithm of the specified quaternion. public static void Logarithm(ref readonly Quaternion value, out Quaternion result) Parameters value Quaternion The quaternion whose logarithm will be calculated. result Quaternion When the method completes, contains the natural logarithm of the quaternion. LookRotation(in Vector3, in Vector3) Returns a rotation whose facing direction points towards forward and whose up direction points as close as possible to up. public static Quaternion LookRotation(in Vector3 forward, in Vector3 up) Parameters forward Vector3 up Vector3 Returns Quaternion Multiply(Quaternion, float) Scales a quaternion by the given value. public static Quaternion Multiply(Quaternion value, float scale) Parameters value Quaternion The quaternion to scale. scale float The amount by which to scale the quaternion. Returns Quaternion The scaled quaternion. Multiply(in Quaternion, in Quaternion) Modulates a quaternion by another. public static Quaternion Multiply(in Quaternion left, in Quaternion right) Parameters left Quaternion The first quaternion to modulate. right Quaternion The second quaternion to modulate. Returns Quaternion The modulated quaternion. Multiply(ref readonly Quaternion, ref readonly Quaternion, out Quaternion) Modulates a quaternion by another. public static void Multiply(ref readonly Quaternion left, ref readonly Quaternion right, out Quaternion result) Parameters left Quaternion The first quaternion to modulate. right Quaternion The second quaternion to modulate. result Quaternion When the moethod completes, contains the modulated quaternion. Multiply(ref readonly Quaternion, float, out Quaternion) Scales a quaternion by the given value. public static void Multiply(ref readonly Quaternion value, float scale, out Quaternion result) Parameters value Quaternion The quaternion to scale. scale float The amount by which to scale the quaternion. result Quaternion When the method completes, contains the scaled quaternion. Negate(Quaternion) Reverses the direction of a given quaternion. public static Quaternion Negate(Quaternion value) Parameters value Quaternion The quaternion to negate. Returns Quaternion A quaternion facing in the opposite direction. Negate(ref readonly Quaternion, out Quaternion) Reverses the direction of a given quaternion. public static void Negate(ref readonly Quaternion value, out Quaternion result) Parameters value Quaternion The quaternion to negate. result Quaternion When the method completes, contains a quaternion facing in the opposite direction. Normalize() Converts the quaternion into a unit quaternion. public void Normalize() Normalize(Quaternion) Converts the quaternion into a unit quaternion. public static Quaternion Normalize(Quaternion value) Parameters value Quaternion The quaternion to normalize. Returns Quaternion The normalized quaternion. Normalize(ref readonly Quaternion, out Quaternion) Converts the quaternion into a unit quaternion. public static void Normalize(ref readonly Quaternion value, out Quaternion result) Parameters value Quaternion The quaternion to normalize. result Quaternion When the method completes, contains the normalized quaternion. Rotate(ref Vector3) Rotates a Vector3 by the specified quaternion rotation. public readonly void Rotate(ref Vector3 vector) Parameters vector Vector3 The vector to rotate. RotateTowards(in Quaternion, in Quaternion, float) Rotate current towards target by angle. public static Quaternion RotateTowards(in Quaternion current, in Quaternion target, float angle) Parameters current Quaternion target Quaternion angle float Returns Quaternion Remarks When the angle difference between current and target is less than the given angle, returns target instead of overshooting past it. RotationAxis(Vector3, float) Creates a quaternion given a rotation and an axis. public static Quaternion RotationAxis(Vector3 axis, float angle) Parameters axis Vector3 The axis of rotation. angle float The angle of rotation. Returns Quaternion The newly created quaternion. RotationAxis(ref readonly Vector3, float, out Quaternion) Creates a quaternion given a rotation and an axis. public static void RotationAxis(ref readonly Vector3 axis, float angle, out Quaternion result) Parameters axis Vector3 The axis of rotation. angle float The angle of rotation. result Quaternion When the method completes, contains the newly created quaternion. RotationMatrix(Matrix) Creates a quaternion given a rotation matrix. public static Quaternion RotationMatrix(Matrix matrix) Parameters matrix Matrix The rotation matrix. Returns Quaternion The newly created quaternion. RotationMatrix(ref readonly Matrix, out Quaternion) Creates a quaternion given a rotation matrix. public static void RotationMatrix(ref readonly Matrix matrix, out Quaternion result) Parameters matrix Matrix The rotation matrix. result Quaternion When the method completes, contains the newly created quaternion. RotationX(float) Creates a quaternion that rotates around the x-axis. public static Quaternion RotationX(float angle) Parameters angle float Angle of rotation in radians. Returns Quaternion The created rotation quaternion. RotationX(float, out Quaternion) Creates a quaternion that rotates around the x-axis. public static void RotationX(float angle, out Quaternion result) Parameters angle float Angle of rotation in radians. result Quaternion When the method completes, contains the newly created quaternion. RotationY(float) Creates a quaternion that rotates around the y-axis. public static Quaternion RotationY(float angle) Parameters angle float Angle of rotation in radians. Returns Quaternion The created rotation quaternion. RotationY(float, out Quaternion) Creates a quaternion that rotates around the y-axis. public static void RotationY(float angle, out Quaternion result) Parameters angle float Angle of rotation in radians. result Quaternion When the method completes, contains the newly created quaternion. RotationYawPitchRoll(ref readonly Quaternion, out float, out float, out float) Calculate the yaw/pitch/roll rotation equivalent to the provided quaternion. public static void RotationYawPitchRoll(ref readonly Quaternion rotation, out float yaw, out float pitch, out float roll) Parameters rotation Quaternion The input quaternion yaw float The yaw component in radians. pitch float The pitch component in radians. roll float The roll component in radians. RotationYawPitchRoll(float, float, float) Creates a quaternion given a yaw, pitch, and roll value (angles in radians). public static Quaternion RotationYawPitchRoll(float yaw, float pitch, float roll) Parameters yaw float The yaw of rotation in radians. pitch float The pitch of rotation in radians. roll float The roll of rotation in radians. Returns Quaternion The newly created quaternion. RotationYawPitchRoll(float, float, float, out Quaternion) Creates a quaternion given a yaw, pitch, and roll value (angles in radians). public static void RotationYawPitchRoll(float yaw, float pitch, float roll, out Quaternion result) Parameters yaw float The yaw of rotation in radians. pitch float The pitch of rotation in radians. roll float The roll of rotation in radians. result Quaternion When the method completes, contains the newly created quaternion. RotationZ(float) Creates a quaternion that rotates around the z-axis. public static Quaternion RotationZ(float angle) Parameters angle float Angle of rotation in radians. Returns Quaternion The created rotation quaternion. RotationZ(float, out Quaternion) Creates a quaternion that rotates around the z-axis. public static void RotationZ(float angle, out Quaternion result) Parameters angle float Angle of rotation in radians. result Quaternion When the method completes, contains the newly created quaternion. Slerp(in Quaternion, in Quaternion, float) Interpolates between two quaternions, using spherical linear interpolation. public static Quaternion Slerp(in Quaternion start, in Quaternion end, float amount) Parameters start Quaternion Start quaternion. end Quaternion End quaternion. amount float Value between 0 and 1 indicating the weight of end. Returns Quaternion The spherical linear interpolation of the two quaternions. Slerp(ref readonly Quaternion, ref readonly Quaternion, float, out Quaternion) Interpolates between two quaternions, using spherical linear interpolation. public static void Slerp(ref readonly Quaternion start, ref readonly Quaternion end, float amount, out Quaternion result) Parameters start Quaternion Start quaternion. end Quaternion End quaternion. amount float Value between 0 and 1 indicating the weight of end. result Quaternion When the method completes, contains the spherical linear interpolation of the two quaternions. Squad(Quaternion, Quaternion, Quaternion, Quaternion, float) Interpolates between quaternions, using spherical quadrangle interpolation. public static Quaternion Squad(Quaternion value1, Quaternion value2, Quaternion value3, Quaternion value4, float amount) Parameters value1 Quaternion First source quaternion. value2 Quaternion Second source quaternion. value3 Quaternion Thrid source quaternion. value4 Quaternion Fourth source quaternion. amount float Value between 0 and 1 indicating the weight of interpolation. Returns Quaternion The spherical quadrangle interpolation of the quaternions. Squad(ref readonly Quaternion, ref readonly Quaternion, ref readonly Quaternion, ref readonly Quaternion, float, out Quaternion) Interpolates between quaternions, using spherical quadrangle interpolation. public static void Squad(ref readonly Quaternion value1, ref readonly Quaternion value2, ref readonly Quaternion value3, ref readonly Quaternion value4, float amount, out Quaternion result) Parameters value1 Quaternion First source quaternion. value2 Quaternion Second source quaternion. value3 Quaternion Thrid source quaternion. value4 Quaternion Fourth source quaternion. amount float Value between 0 and 1 indicating the weight of interpolation. result Quaternion When the method completes, contains the spherical quadrangle interpolation of the quaternions. SquadSetup(Quaternion, Quaternion, Quaternion, Quaternion) Sets up control points for spherical quadrangle interpolation. public static Quaternion[] SquadSetup(Quaternion value1, Quaternion value2, Quaternion value3, Quaternion value4) Parameters value1 Quaternion First source quaternion. value2 Quaternion Second source quaternion. value3 Quaternion Third source quaternion. value4 Quaternion Fourth source quaternion. Returns Quaternion[] An array of three quaternions that represent control points for spherical quadrangle interpolation. Subtract(Quaternion, Quaternion) Subtracts two quaternions. public static Quaternion Subtract(Quaternion left, Quaternion right) Parameters left Quaternion The first quaternion to subtract. right Quaternion The second quaternion to subtract. Returns Quaternion The difference of the two quaternions. Subtract(ref readonly Quaternion, ref readonly Quaternion, out Quaternion) Subtracts two quaternions. public static void Subtract(ref readonly Quaternion left, ref readonly Quaternion right, out Quaternion result) Parameters left Quaternion The first quaternion to subtract. right Quaternion The second quaternion to subtract. result Quaternion When the method completes, contains the difference of the two quaternions. ToArray() Creates an array containing the elements of the quaternion. public float[] ToArray() Returns float[] A four-element array containing the components of the quaternion. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator +(in Quaternion, in Quaternion) Adds two quaternions. public static Quaternion operator +(in Quaternion left, in Quaternion right) Parameters left Quaternion The first quaternion to add. right Quaternion The second quaternion to add. Returns Quaternion The sum of the two quaternions. operator ==(in Quaternion, in Quaternion) Tests for equality between two objects. public static bool operator ==(in Quaternion left, in Quaternion right) Parameters left Quaternion The first value to compare. right Quaternion The second value to compare. Returns bool true if left has the same value as right; otherwise, false. Remarks Comparison is not strict, a difference of ZeroTolerance will return as equal. implicit operator Quaternion(Quaternion) Casts from Stride.Maths to System.Numerics vectors public static implicit operator Quaternion(Quaternion v) Parameters v Quaternion Value to cast Returns Quaternion implicit operator Quaternion(Quaternion) Casts from System.Numerics to Stride.Maths vectors public static implicit operator Quaternion(Quaternion v) Parameters v Quaternion Value to cast Returns Quaternion operator !=(in Quaternion, in Quaternion) Tests for inequality between two objects. public static bool operator !=(in Quaternion left, in Quaternion right) Parameters left Quaternion The first value to compare. right Quaternion The second value to compare. Returns bool true if left has a different value than right; otherwise, false. Remarks Comparison is not strict, a difference of ZeroTolerance will return as equal. operator *(in Quaternion, in Quaternion) Multiplies a quaternion by another. public static Quaternion operator *(in Quaternion left, in Quaternion right) Parameters left Quaternion The first quaternion to multiply. right Quaternion The second quaternion to multiply. Returns Quaternion The multiplied quaternion. operator *(in Quaternion, in Vector3) Return the vector rotated by the quaternion. public static Vector3 operator *(in Quaternion left, in Vector3 right) Parameters left Quaternion right Vector3 Returns Vector3 Remarks Shorthand for Rotate(ref Vector3) operator *(in Quaternion, float) Scales a quaternion by the given value. public static Quaternion operator *(in Quaternion value, float scale) Parameters value Quaternion The quaternion to scale. scale float The amount by which to scale the quaternion. Returns Quaternion The scaled quaternion. operator *(float, in Quaternion) Scales a quaternion by the given value. public static Quaternion operator *(float scale, in Quaternion value) Parameters scale float The amount by which to scale the quaternion. value Quaternion The quaternion to scale. Returns Quaternion The scaled quaternion. operator -(in Quaternion, in Quaternion) Subtracts two quaternions. public static Quaternion operator -(in Quaternion left, in Quaternion right) Parameters left Quaternion The first quaternion to subtract. right Quaternion The second quaternion to subtract. Returns Quaternion The difference of the two quaternions. operator -(in Quaternion) Reverses the direction of a given quaternion. public static Quaternion operator -(in Quaternion value) Parameters value Quaternion The quaternion to negate. Returns Quaternion A quaternion facing in the opposite direction."
  },
  "api/Stride.Core.Mathematics.RandomSeed.html": {
    "href": "api/Stride.Core.Mathematics.RandomSeed.html",
    "title": "Struct RandomSeed | Stride API",
    "summary": "Struct RandomSeed Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll The RandomSeed is a structure for deterministically acquiring random values. One RandomSeed should be able to reproduce the same pseudo-random value for a fixed offset, but provide enough random distribution for different offsets or different random seeds Although other methods exist, the current implementation can easily be replicated in the shaders if required public struct RandomSeed Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors RandomSeed(uint) Initializes a new instance of the RandomSeed struct from a target uint. public RandomSeed(uint seed) Parameters seed uint The seed value to initialize the deterministic random generator. Methods GetDouble(uint) Get a deterministic double value between 0 and 1 based on the seed public double GetDouble(uint offset) Parameters offset uint Returns double Deterministic pseudo-random value between 0 and 1 GetFloat(uint) Get a deterministic float value between 0 and 1 based on the seed The calculations are still made as doubles to prevent underflow errors. public float GetFloat(uint offset) Parameters offset uint Returns float Deterministic pseudo-random value between 0 and 1"
  },
  "api/Stride.Core.Mathematics.Ray.html": {
    "href": "api/Stride.Core.Mathematics.Ray.html",
    "title": "Struct Ray | Stride API",
    "summary": "Struct Ray Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a three dimensional line based on a point in space and a direction. [DataContract] public struct Ray : IEquatable<Ray>, ISpanFormattable, IFormattable Implements IEquatable<Ray> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Ray(Vector3, Vector3) Initializes a new instance of the Ray struct. public Ray(Vector3 position, Vector3 direction) Parameters position Vector3 The position in three dimensional space of the origin of the ray. direction Vector3 The normalized direction of the ray. Fields Direction The normalized direction in which the ray points. public Vector3 Direction Field Value Vector3 Position The position in three dimensional space where the ray starts. public Vector3 Position Field Value Vector3 Methods Equals(Ray) Determines whether the specified Vector4 is equal to this instance. public readonly bool Equals(Ray value) Parameters value Ray The Vector4 to compare with this instance. Returns bool true if the specified Vector4 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Intersects(ref readonly BoundingBox) Determines if there is an intersection between the current object and a BoundingBox. public bool Intersects(ref readonly BoundingBox box) Parameters box BoundingBox The box to test. Returns bool Whether the two objects intersected. Intersects(ref readonly BoundingBox, out Vector3) Determines if there is an intersection between the current object and a BoundingBox. public bool Intersects(ref readonly BoundingBox box, out Vector3 point) Parameters box BoundingBox The box to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly BoundingBox, out float) Determines if there is an intersection between the current object and a BoundingBox. public bool Intersects(ref readonly BoundingBox box, out float distance) Parameters box BoundingBox The box to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly BoundingSphere) Determines if there is an intersection between the current object and a BoundingSphere. public bool Intersects(ref readonly BoundingSphere sphere) Parameters sphere BoundingSphere The sphere to test. Returns bool Whether the two objects intersected. Intersects(ref readonly BoundingSphere, out Vector3) Determines if there is an intersection between the current object and a BoundingSphere. public bool Intersects(ref readonly BoundingSphere sphere, out Vector3 point) Parameters sphere BoundingSphere The sphere to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly BoundingSphere, out float) Determines if there is an intersection between the current object and a BoundingSphere. public bool Intersects(ref readonly BoundingSphere sphere, out float distance) Parameters sphere BoundingSphere The sphere to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Plane) Determines if there is an intersection between the current object and a Plane. public bool Intersects(ref readonly Plane plane) Parameters plane Plane The plane to test Returns bool Whether the two objects intersected. Intersects(ref readonly Plane, out Vector3) Determines if there is an intersection between the current object and a Plane. public bool Intersects(ref readonly Plane plane, out Vector3 point) Parameters plane Plane The plane to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Plane, out float) Determines if there is an intersection between the current object and a Plane. public bool Intersects(ref readonly Plane plane, out float distance) Parameters plane Plane The plane to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray) Parameters ray Ray The ray to test. Returns bool Whether the two objects intersected. Intersects(ref readonly Ray, out Vector3) Determines if there is an intersection between the current object and a Ray. public bool Intersects(ref readonly Ray ray, out Vector3 point) Parameters ray Ray The ray to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Vector3) Determines if there is an intersection between the current object and a point. public bool Intersects(ref readonly Vector3 point) Parameters point Vector3 The point to test. Returns bool Whether the two objects intersected. Intersects(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3) Determines if there is an intersection between the current object and a triangle. public bool Intersects(ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3) Parameters vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triangle to test. vertex3 Vector3 The third vertex of the triangle to test. Returns bool Whether the two objects intersected. Intersects(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, out Vector3) Determines if there is an intersection between the current object and a triangle. public bool Intersects(ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3, out Vector3 point) Parameters vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triangle to test. vertex3 Vector3 The third vertex of the triangle to test. point Vector3 When the method completes, contains the point of intersection, or Zero if there was no intersection. Returns bool Whether the two objects intersected. Intersects(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, out float) Determines if there is an intersection between the current object and a triangle. public bool Intersects(ref readonly Vector3 vertex1, ref readonly Vector3 vertex2, ref readonly Vector3 vertex3, out float distance) Parameters vertex1 Vector3 The first vertex of the triangle to test. vertex2 Vector3 The second vertex of the triangle to test. vertex3 Vector3 The third vertex of the triangle to test. distance float When the method completes, contains the distance of the intersection, or 0 if there was no intersection. Returns bool Whether the two objects intersected. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator ==(Ray, Ray) Tests for equality between two objects. public static bool operator ==(Ray left, Ray right) Parameters left Ray The first value to compare. right Ray The second value to compare. Returns bool true if left has the same value as right; otherwise, false. operator !=(Ray, Ray) Tests for inequality between two objects. public static bool operator !=(Ray left, Ray right) Parameters left Ray The first value to compare. right Ray The second value to compare. Returns bool true if left has a different value than right; otherwise, false."
  },
  "api/Stride.Core.Mathematics.Rectangle.html": {
    "href": "api/Stride.Core.Mathematics.Rectangle.html",
    "title": "Struct Rectangle | Stride API",
    "summary": "Struct Rectangle Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll A rectangle structure defining X,Y,Width,Height. [DataContract(\"Rectangle\")] [DataStyle(DataStyle.Compact)] public struct Rectangle : IEquatable<Rectangle>, ISpanFormattable, IFormattable Implements IEquatable<Rectangle> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Rectangle(int, int, int, int) Initializes a new instance of the Rectangle struct. public Rectangle(int x, int y, int width, int height) Parameters x int The left. y int The top. width int The width. height int The height. Fields Empty An empty rectangle. public static readonly Rectangle Empty Field Value Rectangle Height Gets or sets the height. [DataMember(3)] public int Height Field Value int The height. Width Gets or sets the width. [DataMember(2)] public int Width Field Value int The width. X Gets or sets the X position. [DataMember(0)] public int X Field Value int The X position. Y Gets or sets the Y position. [DataMember(1)] public int Y Field Value int The Y position. Properties Bottom Gets or sets the bottom. public readonly int Bottom { get; } Property Value int The bottom. BottomLeft Gets the position of the bottom-left corner of the rectangle. public readonly Point BottomLeft { get; } Property Value Point The bottom-left corner of the rectangle. BottomRight Gets the position of the bottom-right corner of the rectangle. public readonly Point BottomRight { get; } Property Value Point The bottom-right corner of the rectangle. Center Gets the Point that specifies the center of the rectangle. public readonly Point Center { get; } Property Value Point The center. IsEmpty Gets a value that indicates whether the rectangle is empty. public readonly bool IsEmpty { get; } Property Value bool true if [is empty]; otherwise, false. Left Gets or sets the left. public int Left { readonly get; set; } Property Value int The left. Location Gets or sets the location. public Point Location { readonly get; set; } Property Value Point The location. Right Gets or sets the right. public readonly int Right { get; } Property Value int The right. Size Gets or sets the size of the rectangle. public Size2 Size { readonly get; set; } Property Value Size2 The size of the rectangle. Top Gets or sets the top. public int Top { readonly get; set; } Property Value int The top. TopLeft Gets the position of the top-left corner of the rectangle. public readonly Point TopLeft { get; } Property Value Point The top-left corner of the rectangle. TopRight Gets the position of the top-right corner of the rectangle. public readonly Point TopRight { get; } Property Value Point The top-right corner of the rectangle. Methods Contains(Int2) Checks, if specified Int2 is inside Rectangle. public readonly bool Contains(Int2 int2) Parameters int2 Int2 Coordinate Int2. Returns bool true if Int2 is inside Rectangle, otherwise false. Contains(Point) Determines whether this rectangle contains a specified Point. public readonly bool Contains(Point value) Parameters value Point The Point to evaluate. Returns bool Contains(ref readonly Point, out bool) Determines whether this rectangle contains a specified Point. public readonly void Contains(ref readonly Point value, out bool result) Parameters value Point The Point to evaluate. result bool [OutAttribute] true if the specified Point is contained within this rectangle; false otherwise. Contains(Rectangle) Determines whether this rectangle entirely contains a specified rectangle. public readonly bool Contains(Rectangle value) Parameters value Rectangle The rectangle to evaluate. Returns bool Contains(ref readonly Rectangle, out bool) Determines whether this rectangle entirely contains a specified rectangle. public readonly void Contains(ref readonly Rectangle value, out bool result) Parameters value Rectangle The rectangle to evaluate. result bool [OutAttribute] On exit, is true if this rectangle entirely contains the specified rectangle, or false if not. Contains(Vector2) Checks, if specified Vector2 is inside Rectangle. public readonly bool Contains(Vector2 vector2D) Parameters vector2D Vector2 Coordinate Vector2. Returns bool true if Vector2 is inside Rectangle, otherwise false. Contains(int, int) Determines whether this rectangle contains a specified point represented by its x- and y-coordinates. public readonly bool Contains(int x, int y) Parameters x int The x-coordinate of the specified point. y int The y-coordinate of the specified point. Returns bool Contains(float, float) Checks, if specified point is inside Rectangle. public readonly bool Contains(float x, float y) Parameters x float X point coordinate. y float Y point coordinate. Returns bool true if point is inside Rectangle, otherwise false. Equals(Rectangle) Determines whether the specified Rectangle is equal to this instance. public readonly bool Equals(Rectangle other) Parameters other Rectangle The Rectangle to compare with this instance. Returns bool true if the specified Rectangle is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? obj) Parameters obj object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Inflate(int, int) Pushes the edges of the rectangle out by the horizontal and vertical values specified. public void Inflate(int horizontalAmount, int verticalAmount) Parameters horizontalAmount int Value to push the sides out by. verticalAmount int Value to push the top and bottom out by. Intersect(Rectangle, Rectangle) Creates a rectangle defining the area where one rectangle overlaps with another rectangle. public static Rectangle Intersect(Rectangle value1, Rectangle value2) Parameters value1 Rectangle The first rectangle to compare. value2 Rectangle The second rectangle to compare. Returns Rectangle The intersection rectangle. Intersect(ref readonly Rectangle, ref readonly Rectangle, out Rectangle) Creates a rectangle defining the area where one rectangle overlaps with another rectangle. public static void Intersect(ref readonly Rectangle value1, ref readonly Rectangle value2, out Rectangle result) Parameters value1 Rectangle The first rectangle to compare. value2 Rectangle The second rectangle to compare. result Rectangle [OutAttribute] The area where the two first parameters overlap. Intersects(Rectangle) Determines whether a specified rectangle intersects with this rectangle. public readonly bool Intersects(Rectangle value) Parameters value Rectangle The rectangle to evaluate. Returns bool Intersects(ref readonly Rectangle, out bool) Determines whether a specified rectangle intersects with this rectangle. public readonly void Intersects(ref readonly Rectangle value, out bool result) Parameters value Rectangle The rectangle to evaluate result bool [OutAttribute] true if the specified rectangle intersects with this one; false otherwise. Offset(Point) Changes the position of the rectangle. public void Offset(Point amount) Parameters amount Point The values to adjust the position of the rectangle by. Offset(int, int) Changes the position of the rectangle. public void Offset(int offsetX, int offsetY) Parameters offsetX int Change in the x-position. offsetY int Change in the y-position. ToString() Returns the fully qualified type name of this instance. public override readonly string ToString() Returns string The fully qualified type name. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Union(Rectangle, Int2) Creates a new rectangle that incorporate the provided point to the given rectangle. public static Rectangle Union(Rectangle rectangle, Int2 point) Parameters rectangle Rectangle The original rectangle. point Int2 The point to incorporate. Returns Rectangle The union rectangle. Union(Rectangle, Rectangle) Creates a new rectangle that exactly contains two other rectangles. public static Rectangle Union(Rectangle value1, Rectangle value2) Parameters value1 Rectangle The first rectangle to contain. value2 Rectangle The second rectangle to contain. Returns Rectangle The union rectangle. Union(ref readonly Rectangle, ref readonly Rectangle, out Rectangle) Creates a new rectangle that exactly contains two other rectangles. public static void Union(ref readonly Rectangle value1, ref readonly Rectangle value2, out Rectangle result) Parameters value1 Rectangle The first rectangle to contain. value2 Rectangle The second rectangle to contain. result Rectangle [OutAttribute] The rectangle that must be the union of the first two rectangles. Operators operator ==(Rectangle, Rectangle) Implements the operator ==. public static bool operator ==(Rectangle left, Rectangle right) Parameters left Rectangle The left. right Rectangle The right. Returns bool The result of the operator. implicit operator RectangleF(Rectangle) Performs an implicit conversion to the RectangleF structure. public static implicit operator RectangleF(Rectangle value) Parameters value Rectangle The source Rectangle value. Returns RectangleF The converted structure. Remarks Performs direct converstion from int to float. operator !=(Rectangle, Rectangle) Implements the operator !=. public static bool operator !=(Rectangle left, Rectangle right) Parameters left Rectangle The left. right Rectangle The right. Returns bool The result of the operator."
  },
  "api/Stride.Core.Mathematics.RectangleF.html": {
    "href": "api/Stride.Core.Mathematics.RectangleF.html",
    "title": "Struct RectangleF | Stride API",
    "summary": "Struct RectangleF Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Define a RectangleF. [DataContract(\"RectangleF\")] [DataStyle(DataStyle.Compact)] public struct RectangleF : IEquatable<RectangleF>, ISpanFormattable, IFormattable Implements IEquatable<RectangleF> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors RectangleF(float, float, float, float) Initializes a new instance of the RectangleF struct. public RectangleF(float x, float y, float width, float height) Parameters x float The left. y float The top. width float The width. height float The height. Fields Empty An empty rectangle public static readonly RectangleF Empty Field Value RectangleF Height Gets or sets the height. [DataMember(3)] public float Height Field Value float The height. Width Gets or sets the width. [DataMember(2)] public float Width Field Value float The width. X Gets or sets the X position. [DataMember(0)] public float X Field Value float The X position. Y Gets or sets the Y position. [DataMember(1)] public float Y Field Value float The Y position. Properties Bottom Gets the bottom. public readonly float Bottom { get; } Property Value float The bottom. BottomLeft Gets the position of the bottom-left corner of the rectangle. public readonly Vector2 BottomLeft { get; } Property Value Vector2 The bottom-left corner of the rectangle. BottomRight Gets the position of the bottom-right corner of the rectangle. public readonly Vector2 BottomRight { get; } Property Value Vector2 The bottom-right corner of the rectangle. Center Gets the Point that specifies the center of the rectangle. public readonly Vector2 Center { get; } Property Value Vector2 The center. IsEmpty Gets a value that indicates whether the rectangle is empty. public readonly bool IsEmpty { get; } Property Value bool true if [is empty]; otherwise, false. Left Gets or sets the X position of the left edge. public float Left { readonly get; set; } Property Value float The left. Location Gets or sets the location. public Vector2 Location { readonly get; set; } Property Value Vector2 The location. Right Gets the right. public readonly float Right { get; } Property Value float The right. Size Gets or sets the size of the rectangle. public Size2F Size { readonly get; set; } Property Value Size2F The size of the rectangle. Top Gets or sets the top. public float Top { readonly get; set; } Property Value float The top. TopLeft Gets the position of the top-left corner of the rectangle. public readonly Vector2 TopLeft { get; } Property Value Vector2 The top-left corner of the rectangle. TopRight Gets the position of the top-right corner of the rectangle. public readonly Vector2 TopRight { get; } Property Value Vector2 The top-right corner of the rectangle. Methods Contains(Int2) Checks, if specified Int2 is inside Rectangle. public readonly bool Contains(Int2 int2) Parameters int2 Int2 Coordinate Int2. Returns bool true if Int2 is inside Rectangle, otherwise false. Contains(Point) Checks, if specified Point is inside RectangleF. public readonly bool Contains(Point point) Parameters point Point Coordinate Point. Returns bool true if Point is inside RectangleF, otherwise false. Contains(Rectangle) Determines whether this rectangle entirely contains a specified rectangle. public readonly bool Contains(Rectangle value) Parameters value Rectangle The rectangle to evaluate. Returns bool Contains(ref readonly RectangleF, out bool) Determines whether this rectangle entirely contains a specified rectangle. public readonly void Contains(ref readonly RectangleF value, out bool result) Parameters value RectangleF The rectangle to evaluate. result bool [OutAttribute] On exit, is true if this rectangle entirely contains the specified rectangle, or false if not. Contains(Vector2) Checks, if specified Vector2 is inside RectangleF. public readonly bool Contains(Vector2 vector2D) Parameters vector2D Vector2 Coordinate Vector2. Returns bool true if Vector2 is inside RectangleF, otherwise false. Contains(ref readonly Vector2, out bool) Determines whether this rectangle contains a specified Point. public readonly void Contains(ref readonly Vector2 value, out bool result) Parameters value Vector2 The Point to evaluate. result bool [OutAttribute] true if the specified Point is contained within this rectangle; false otherwise. Contains(float, float) Checks, if specified point is inside RectangleF. public readonly bool Contains(float x, float y) Parameters x float X point coordinate. y float Y point coordinate. Returns bool true if point is inside RectangleF, otherwise false. Equals(RectangleF) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(RectangleF other) Parameters other RectangleF An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? obj) Parameters obj object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Inflate(float, float) Pushes the edges of the rectangle out by the horizontal and vertical values specified. public void Inflate(float horizontalAmount, float verticalAmount) Parameters horizontalAmount float Value to push the sides out by. verticalAmount float Value to push the top and bottom out by. Intersect(RectangleF, RectangleF) Creates a rectangle defining the area where one rectangle overlaps with another rectangle. public static RectangleF Intersect(RectangleF value1, RectangleF value2) Parameters value1 RectangleF The first Rectangle to compare. value2 RectangleF The second Rectangle to compare. Returns RectangleF The intersection rectangle. Intersect(ref readonly RectangleF, ref readonly RectangleF, out RectangleF) Creates a rectangle defining the area where one rectangle overlaps with another rectangle. public static void Intersect(ref readonly RectangleF value1, ref readonly RectangleF value2, out RectangleF result) Parameters value1 RectangleF The first rectangle to compare. value2 RectangleF The second rectangle to compare. result RectangleF [OutAttribute] The area where the two first parameters overlap. Intersects(RectangleF) Determines whether a specified rectangle intersects with this rectangle. public readonly bool Intersects(RectangleF value) Parameters value RectangleF The rectangle to evaluate. Returns bool Intersects(ref readonly RectangleF, out bool) Determines whether a specified rectangle intersects with this rectangle. public readonly void Intersects(ref readonly RectangleF value, out bool result) Parameters value RectangleF The rectangle to evaluate result bool [OutAttribute] true if the specified rectangle intersects with this one; false otherwise. Offset(Point) Changes the position of the rectangle. public void Offset(Point amount) Parameters amount Point The values to adjust the position of the rectangle by. Offset(Vector2) Changes the position of the rectangle. public void Offset(Vector2 amount) Parameters amount Vector2 The values to adjust the position of the rectangle by. Offset(float, float) Changes the position of the rectangle. public void Offset(float offsetX, float offsetY) Parameters offsetX float Change in the x-position. offsetY float Change in the y-position. ToString() Returns the fully qualified type name of this instance. public override readonly string ToString() Returns string The fully qualified type name. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Union(RectangleF, RectangleF) Creates a new rectangle that exactly contains two other rectangles. public static RectangleF Union(RectangleF value1, RectangleF value2) Parameters value1 RectangleF The first rectangle to contain. value2 RectangleF The second rectangle to contain. Returns RectangleF The union rectangle. Union(ref readonly RectangleF, ref readonly RectangleF, out RectangleF) Creates a new rectangle that exactly contains two other rectangles. public static void Union(ref readonly RectangleF value1, ref readonly RectangleF value2, out RectangleF result) Parameters value1 RectangleF The first rectangle to contain. value2 RectangleF The second rectangle to contain. result RectangleF [OutAttribute] The rectangle that must be the union of the first two rectangles. Operators operator ==(RectangleF, RectangleF) Implements the operator ==. public static bool operator ==(RectangleF left, RectangleF right) Parameters left RectangleF The left. right RectangleF The right. Returns bool The result of the operator. explicit operator Rectangle(RectangleF) Performs an explicit conversion to Rectangle structure. public static explicit operator Rectangle(RectangleF value) Parameters value RectangleF The source RectangleF value. Returns Rectangle A converted Rectangle structure. Remarks Performs direct float to int conversion, any fractional data is truncated. operator !=(RectangleF, RectangleF) Implements the operator !=. public static bool operator !=(RectangleF left, RectangleF right) Parameters left RectangleF The left. right RectangleF The right. Returns bool The result of the operator."
  },
  "api/Stride.Core.Mathematics.Size2.html": {
    "href": "api/Stride.Core.Mathematics.Size2.html",
    "title": "Struct Size2 | Stride API",
    "summary": "Struct Size2 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Defines a 2D rectangular size (width,height). [DataContract(\"!Size2\")] [DataStyle(DataStyle.Compact)] public struct Size2 : IEquatable<Size2>, ISpanFormattable, IFormattable Implements IEquatable<Size2> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Size2(int, int) Initializes a new instance of the Size2 struct. public Size2(int width, int height) Parameters width int The x. height int The y. Fields Empty A zero size with (width, height) = (0,0) public static readonly Size2 Empty Field Value Size2 Height Height. [DataMember(1)] public int Height Field Value int Width Width. [DataMember(0)] public int Width Field Value int Zero A zero size with (width, height) = (0,0) public static readonly Size2 Zero Field Value Size2 Methods Deconstruct(out int, out int) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out int width, out int height) Parameters width int The Width component height int The Height component Equals(Size2) Determines whether the specified object is equal to this instance. public readonly bool Equals(Size2 other) Parameters other Size2 The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the fully qualified type name of this instance. public override readonly string ToString() Returns string The fully qualified type name. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator ==(Size2, Size2) Implements the operator ==. public static bool operator ==(Size2 left, Size2 right) Parameters left Size2 The left. right Size2 The right. Returns bool The result of the operator. operator !=(Size2, Size2) Implements the operator !=. public static bool operator !=(Size2 left, Size2 right) Parameters left Size2 The left. right Size2 The right. Returns bool The result of the operator."
  },
  "api/Stride.Core.Mathematics.Size2F.html": {
    "href": "api/Stride.Core.Mathematics.Size2F.html",
    "title": "Struct Size2F | Stride API",
    "summary": "Struct Size2F Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Defines a 2D rectangular size (width,height). [DataContract(\"Size2F\")] [DataStyle(DataStyle.Compact)] public struct Size2F : IEquatable<Size2F>, ISpanFormattable, IFormattable Implements IEquatable<Size2F> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Size2F(float, float) Initializes a new instance of the Size2F struct. public Size2F(float width, float height) Parameters width float The x. height float The y. Fields Empty A zero size with (width, height) = (0,0) public static readonly Size2F Empty Field Value Size2F Height Height. [DataMember(1)] public float Height Field Value float Width Width. [DataMember(0)] public float Width Field Value float Zero A zero size with (width, height) = (0,0) public static readonly Size2F Zero Field Value Size2F Methods Deconstruct(out float, out float) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out float width, out float height) Parameters width float The Width component height float The Height component Equals(Size2F) Determines whether the specified object is equal to this instance. public readonly bool Equals(Size2F other) Parameters other Size2F The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the fully qualified type name of this instance. public override readonly string ToString() Returns string The fully qualified type name. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator ==(Size2F, Size2F) Implements the operator ==. public static bool operator ==(Size2F left, Size2F right) Parameters left Size2F The left. right Size2F The right. Returns bool The result of the operator. operator !=(Size2F, Size2F) Implements the operator !=. public static bool operator !=(Size2F left, Size2F right) Parameters left Size2F The left. right Size2F The right. Returns bool The result of the operator."
  },
  "api/Stride.Core.Mathematics.Size3.html": {
    "href": "api/Stride.Core.Mathematics.Size3.html",
    "title": "Struct Size3 | Stride API",
    "summary": "Struct Size3 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Structure providing Width, Height and Depth. [DataContract(\"!Size3\")] [DataStyle(DataStyle.Compact)] public struct Size3 : IEquatable<Size3>, IComparable<Size3>, ISpanFormattable, IFormattable Implements IEquatable<Size3> IComparable<Size3> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Size3(int, int, int) Initializes a new instance of the Size3 struct. public Size3(int width, int height, int depth) Parameters width int The x. height int The y. depth int The depth. Fields Depth Height. [DataMember(2)] public int Depth Field Value int Empty A zero size with (width, height, depth) = (0,0,0) public static readonly Size3 Empty Field Value Size3 Height Height. [DataMember(1)] public int Height Field Value int One A one size with (width, height, depth) = (1,1,1) public static readonly Size3 One Field Value Size3 Width Width. [DataMember(0)] public int Width Field Value int Zero A zero size with (width, height, depth) = (0,0,0) public static readonly Size3 Zero Field Value Size3 Methods CompareTo(Size3) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. public readonly int CompareTo(Size3 other) Parameters other Size3 An object to compare with this instance. Returns int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order. Deconstruct(out int, out int, out int) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out int width, out int height, out int depth) Parameters width int The Width component height int The Height component depth int The Depth component Down2(int) Calculates the next down mip-level (/2) of this size. public readonly Size3 Down2(int count = 1) Parameters count int The count. Returns Size3 A next down mip-level Size3. Equals(Size3) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(Size3 other) Parameters other Size3 An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Mip(int) Calculates the mip size based on a direction. public readonly Size3 Mip(int direction) Parameters direction int The direction < 0 then Down2(int), > 0 then Up2(int), else this unchanged. Returns Size3 Size3. ToString() Returns the fully qualified type name of this instance. public override readonly string ToString() Returns string The fully qualified type name. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Up2(int) Calculates the next up mip-level (*2) of this size. public readonly Size3 Up2(int count = 1) Parameters count int Returns Size3 A next up mip-level Size3. Operators operator ==(Size3, Size3) Implements the ==. public static bool operator ==(Size3 left, Size3 right) Parameters left Size3 The left. right Size3 The right. Returns bool The result of the operator. operator >(Size3, Size3) Implements the < or ==. public static bool operator >(Size3 left, Size3 right) Parameters left Size3 The left. right Size3 The right. Returns bool The result of the operator. operator >=(Size3, Size3) Implements the > or ==. public static bool operator >=(Size3 left, Size3 right) Parameters left Size3 The left. right Size3 The right. Returns bool The result of the operator. operator !=(Size3, Size3) Implements the !=. public static bool operator !=(Size3 left, Size3 right) Parameters left Size3 The left. right Size3 The right. Returns bool The result of the operator. operator <(Size3, Size3) Implements the <. public static bool operator <(Size3 left, Size3 right) Parameters left Size3 The left. right Size3 The right. Returns bool The result of the operator. operator <=(Size3, Size3) Implements the <. public static bool operator <=(Size3 left, Size3 right) Parameters left Size3 The left. right Size3 The right. Returns bool The result of the operator."
  },
  "api/Stride.Core.Mathematics.SphericalHarmonics-1.html": {
    "href": "api/Stride.Core.Mathematics.SphericalHarmonics-1.html",
    "title": "Class SphericalHarmonics<TDataType> | Stride API",
    "summary": "Class SphericalHarmonics<TDataType> Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll A representation of a sphere of values via Spherical Harmonics (SH). [DataContract(\"SphericalHarmonicsGeneric\")] public abstract class SphericalHarmonics<TDataType> Type Parameters TDataType The type of data contained by the sphere Inheritance object SphericalHarmonics<TDataType> Derived SphericalHarmonics Extension Methods UnsafeUtilities.As<T>(object?) Constructors SphericalHarmonics(int) Initializes a new instance of the SphericalHarmonics<TDataType> class. protected SphericalHarmonics(int order) Parameters order int The order of the harmonics Fields MaximumOrder The maximum order supported. public const int MaximumOrder = 5 Field Value int Properties Coefficients Get the coefficients defining the spherical harmonics (the spherical coordinates x{l,m} multiplying the spherical base Y{l,m}). [DataMember(1)] public TDataType[] Coefficients { get; } Property Value TDataType[] this[int, int] Returns the coefficient x{l,m} of the spherical harmonics (the {l,m} spherical coordinate corresponding to the spherical base Y{l,m}). public TDataType this[int l, int m] { get; set; } Parameters l int the l index of the coefficient m int the m index of the coefficient Property Value TDataType the value of the coefficient Order The order of calculation of the spherical harmonic. [DataMember(0)] public int Order { get; } Property Value int Methods Evaluate(Vector3) Evaluate the value of the spherical harmonics in the provided direction. public abstract TDataType Evaluate(Vector3 direction) Parameters direction Vector3 The direction Returns TDataType The value of the spherical harmonics in the direction"
  },
  "api/Stride.Core.Mathematics.SphericalHarmonics.html": {
    "href": "api/Stride.Core.Mathematics.SphericalHarmonics.html",
    "title": "Class SphericalHarmonics | Stride API",
    "summary": "Class SphericalHarmonics Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll A spherical harmonics representation of a cubemap. [DataContract(\"SphericalHarmonics\")] public class SphericalHarmonics : SphericalHarmonics<Color3> Inheritance object SphericalHarmonics<Color3> SphericalHarmonics Inherited Members SphericalHarmonics<Color3>.MaximumOrder SphericalHarmonics<Color3>.Order SphericalHarmonics<Color3>.Coefficients SphericalHarmonics<Color3>.this[int, int] Extension Methods UnsafeUtilities.As<T>(object?) Constructors SphericalHarmonics(int) Initializes a new instance of the SphericalHarmonics class. public SphericalHarmonics(int order) Parameters order int The order of the harmonics Fields BaseCoefficients Base coefficients for SH. public static readonly float[] BaseCoefficients Field Value float[] Methods Evaluate(Vector3) Evaluates the color for the specified direction. public override Color3 Evaluate(Vector3 direction) Parameters direction Vector3 The direction to evaluate. Returns Color3 The color computed for this direction."
  },
  "api/Stride.Core.Mathematics.UInt4.html": {
    "href": "api/Stride.Core.Mathematics.UInt4.html",
    "title": "Struct UInt4 | Stride API",
    "summary": "Struct UInt4 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a four dimensional mathematical vector. [DataContract] public struct UInt4 : IEquatable<UInt4>, ISpanFormattable, IFormattable Implements IEquatable<UInt4> ISpanFormattable IFormattable Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors UInt4(uint) Initializes a new instance of the UInt4 struct. public UInt4(uint value) Parameters value uint The value that will be assigned to all components. UInt4(uint, uint, uint, uint) Initializes a new instance of the UInt4 struct. public UInt4(uint x, uint y, uint z, uint w) Parameters x uint Initial value for the X component of the vector. y uint Initial value for the Y component of the vector. z uint Initial value for the Z component of the vector. w uint Initial value for the W component of the vector. UInt4(uint[]) Initializes a new instance of the UInt4 struct. public UInt4(uint[] values) Parameters values uint[] The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Fields One A UInt4 with all of its components set to one. public static readonly UInt4 One Field Value UInt4 SizeInBytes The size of the UInt4 type, in bytes. public static readonly int SizeInBytes Field Value int UnitW The W unit UInt4 (0, 0, 0, 1). public static readonly UInt4 UnitW Field Value UInt4 UnitX The X unit UInt4 (1, 0, 0, 0). public static readonly UInt4 UnitX Field Value UInt4 UnitY The Y unit UInt4 (0, 1, 0, 0). public static readonly UInt4 UnitY Field Value UInt4 UnitZ The Z unit UInt4 (0, 0, 1, 0). public static readonly UInt4 UnitZ Field Value UInt4 W The W component of the vector. public uint W Field Value uint X The X component of the vector. public uint X Field Value uint Y The Y component of the vector. public uint Y Field Value uint Z The Z component of the vector. public uint Z Field Value uint Zero A UInt4 with all of its components set to zero. public static readonly UInt4 Zero Field Value UInt4 Properties this[uint] Gets or sets the component at the specified index. public uint this[uint index] { get; set; } Parameters index uint The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. Property Value uint The value of the X, Y, Z, or W component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 3]. Methods Add(UInt4, UInt4) Adds two vectors. public static UInt4 Add(UInt4 left, UInt4 right) Parameters left UInt4 The first vector to add. right UInt4 The second vector to add. Returns UInt4 The sum of the two vectors. Add(ref readonly UInt4, ref readonly UInt4, out UInt4) Adds two vectors. public static void Add(ref readonly UInt4 left, ref readonly UInt4 right, out UInt4 result) Parameters left UInt4 The first vector to add. right UInt4 The second vector to add. result UInt4 When the method completes, contains the sum of the two vectors. Clamp(UInt4, UInt4, UInt4) Restricts a value to be within a specified range. public static UInt4 Clamp(UInt4 value, UInt4 min, UInt4 max) Parameters value UInt4 The value to clamp. min UInt4 The minimum value. max UInt4 The maximum value. Returns UInt4 The clamped value. Clamp(ref readonly UInt4, ref readonly UInt4, ref readonly UInt4, out UInt4) Restricts a value to be within a specified range. public static void Clamp(ref readonly UInt4 value, ref readonly UInt4 min, ref readonly UInt4 max, out UInt4 result) Parameters value UInt4 The value to clamp. min UInt4 The minimum value. max UInt4 The maximum value. result UInt4 When the method completes, contains the clamped value. Deconstruct(out uint, out uint, out uint, out uint) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out uint x, out uint y, out uint z, out uint w) Parameters x uint The X component y uint The Y component z uint The Z component w uint The W component Divide(UInt4, uint) Scales a vector by the given value. public static UInt4 Divide(UInt4 value, uint scale) Parameters value UInt4 The vector to scale. scale uint The amount by which to scale the vector. Returns UInt4 The scaled vector. Divide(ref readonly UInt4, uint, out UInt4) Scales a vector by the given value. public static void Divide(ref readonly UInt4 value, uint scale, out UInt4 result) Parameters value UInt4 The vector to scale. scale uint The amount by which to scale the vector. result UInt4 When the method completes, contains the scaled vector. Equals(UInt4) Determines whether the specified UInt4 is equal to this instance. public readonly bool Equals(UInt4 other) Parameters other UInt4 The UInt4 to compare with this instance. Returns bool true if the specified UInt4 is equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is equal to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Max(UInt4, UInt4) Returns a vector containing the largest components of the specified vectors. public static UInt4 Max(UInt4 left, UInt4 right) Parameters left UInt4 The first source vector. right UInt4 The second source vector. Returns UInt4 A vector containing the largest components of the source vectors. Max(ref readonly UInt4, ref readonly UInt4, out UInt4) Returns a vector containing the smallest components of the specified vectors. public static void Max(ref readonly UInt4 left, ref readonly UInt4 right, out UInt4 result) Parameters left UInt4 The first source vector. right UInt4 The second source vector. result UInt4 When the method completes, contains an new vector composed of the largest components of the source vectors. Min(UInt4, UInt4) Returns a vector containing the smallest components of the specified vectors. public static UInt4 Min(UInt4 left, UInt4 right) Parameters left UInt4 The first source vector. right UInt4 The second source vector. Returns UInt4 A vector containing the smallest components of the source vectors. Min(ref readonly UInt4, ref readonly UInt4, out UInt4) Returns a vector containing the smallest components of the specified vectors. public static void Min(ref readonly UInt4 left, ref readonly UInt4 right, out UInt4 result) Parameters left UInt4 The first source vector. right UInt4 The second source vector. result UInt4 When the method completes, contains an new vector composed of the smallest components of the source vectors. Modulate(UInt4, UInt4) Modulates a vector with another by performing component-wise multiplication. public static UInt4 Modulate(UInt4 left, UInt4 right) Parameters left UInt4 The first vector to modulate. right UInt4 The second vector to modulate. Returns UInt4 The modulated vector. Modulate(ref readonly UInt4, ref readonly UInt4, out UInt4) Modulates a vector with another by performing component-wise multiplication. public static void Modulate(ref readonly UInt4 left, ref readonly UInt4 right, out UInt4 result) Parameters left UInt4 The first vector to modulate. right UInt4 The second vector to modulate. result UInt4 When the method completes, contains the modulated vector. Multiply(UInt4, uint) Scales a vector by the given value. public static UInt4 Multiply(UInt4 value, uint scale) Parameters value UInt4 The vector to scale. scale uint The amount by which to scale the vector. Returns UInt4 The scaled vector. Multiply(ref readonly UInt4, uint, out UInt4) Scales a vector by the given value. public static void Multiply(ref readonly UInt4 value, uint scale, out UInt4 result) Parameters value UInt4 The vector to scale. scale uint The amount by which to scale the vector. result UInt4 When the method completes, contains the scaled vector. Subtract(UInt4, UInt4) Subtracts two vectors. public static UInt4 Subtract(UInt4 left, UInt4 right) Parameters left UInt4 The first vector to subtract. right UInt4 The second vector to subtract. Returns UInt4 The difference of the two vectors. Subtract(ref readonly UInt4, ref readonly UInt4, out UInt4) Subtracts two vectors. public static void Subtract(ref readonly UInt4 left, ref readonly UInt4 right, out UInt4 result) Parameters left UInt4 The first vector to subtract. right UInt4 The second vector to subtract. result UInt4 When the method completes, contains the difference of the two vectors. ToArray() Creates an array containing the elements of the vector. public uint[] ToArray() Returns uint[] A four-element array containing the components of the vector. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Operators operator +(UInt4, UInt4) Adds two vectors. public static UInt4 operator +(UInt4 left, UInt4 right) Parameters left UInt4 The first vector to add. right UInt4 The second vector to add. Returns UInt4 The sum of the two vectors. operator /(UInt4, uint) Scales a vector by the given value. public static UInt4 operator /(UInt4 value, uint scale) Parameters value UInt4 The vector to scale. scale uint The amount by which to scale the vector. Returns UInt4 The scaled vector. operator ==(UInt4, UInt4) Tests for equality between two objects. public static bool operator ==(UInt4 left, UInt4 right) Parameters left UInt4 The first value to compare. right UInt4 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. explicit operator Vector2(UInt4) Performs an explicit conversion from UInt4 to Vector2. public static explicit operator Vector2(UInt4 value) Parameters value UInt4 The value. Returns Vector2 The result of the conversion. explicit operator Vector3(UInt4) Performs an explicit conversion from UInt4 to Vector3. public static explicit operator Vector3(UInt4 value) Parameters value UInt4 The value. Returns Vector3 The result of the conversion. explicit operator Vector4(UInt4) Performs an explicit conversion from UInt4 to Vector4. public static explicit operator Vector4(UInt4 value) Parameters value UInt4 The value. Returns Vector4 The result of the conversion. explicit operator Vector4(UInt4) Casts from Stride.Maths to System.Numerics vectors public static explicit operator Vector4(UInt4 v) Parameters v UInt4 Value to cast Returns Vector4 explicit operator UInt4(Vector4) Casts from System.Numerics to Stride.Maths vectors public static explicit operator UInt4(Vector4 v) Parameters v Vector4 Value to cast Returns UInt4 implicit operator uint[](UInt4) Performs an implicit conversion from UInt4 to int array. public static implicit operator uint[](UInt4 input) Parameters input UInt4 The input. Returns uint[] The result of the conversion. implicit operator UInt4(uint[]) Performs an implicit conversion from uint array to UInt4. public static implicit operator UInt4(uint[] input) Parameters input uint[] The input. Returns UInt4 The result of the conversion. operator !=(UInt4, UInt4) Tests for inequality between two objects. public static bool operator !=(UInt4 left, UInt4 right) Parameters left UInt4 The first value to compare. right UInt4 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(UInt4, uint) Scales a vector by the given value. public static UInt4 operator *(UInt4 value, uint scale) Parameters value UInt4 The vector to scale. scale uint The amount by which to scale the vector. Returns UInt4 The scaled vector. operator *(uint, UInt4) Scales a vector by the given value. public static UInt4 operator *(uint scale, UInt4 value) Parameters scale uint The amount by which to scale the vector. value UInt4 The vector to scale. Returns UInt4 The scaled vector. operator -(UInt4, UInt4) Subtracts two vectors. public static UInt4 operator -(UInt4 left, UInt4 right) Parameters left UInt4 The first vector to subtract. right UInt4 The second vector to subtract. Returns UInt4 The difference of the two vectors. operator +(UInt4) Assert a vector (return it unchanged). public static UInt4 operator +(UInt4 value) Parameters value UInt4 The vector to assert (unchange). Returns UInt4 The asserted (unchanged) vector."
  },
  "api/Stride.Core.Mathematics.Vector2.html": {
    "href": "api/Stride.Core.Mathematics.Vector2.html",
    "title": "Struct Vector2 | Stride API",
    "summary": "Struct Vector2 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a two dimensional mathematical vector. [DataContract(\"float2\")] [DataStyle(DataStyle.Compact)] public struct Vector2 : IEquatable<Vector2>, ISpanFormattable, IFormattable Implements IEquatable<Vector2> ISpanFormattable IFormattable Extension Methods VectorExtensions.YX(Vector2) UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Vector2(float) Initializes a new instance of the Vector2 struct. public Vector2(float value) Parameters value float The value that will be assigned to all components. Vector2(float, float) Initializes a new instance of the Vector2 struct. public Vector2(float x, float y) Parameters x float Initial value for the X component of the vector. y float Initial value for the Y component of the vector. Vector2(float[]) Initializes a new instance of the Vector2 struct. public Vector2(float[] values) Parameters values float[] The values to assign to the X and Y components of the vector. This must be an array with two elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than two elements. Fields One A Vector2 with all of its components set to one. public static readonly Vector2 One Field Value Vector2 SizeInBytes The size of the Vector2 type, in bytes. public static readonly int SizeInBytes Field Value int UnitX The X unit Vector2 (1, 0). public static readonly Vector2 UnitX Field Value Vector2 UnitY The Y unit Vector2 (0, 1). public static readonly Vector2 UnitY Field Value Vector2 X The X component of the vector. [DataMember(0)] public float X Field Value float Y The Y component of the vector. [DataMember(1)] public float Y Field Value float Zero A Vector2 with all of its components set to zero. public static readonly Vector2 Zero Field Value Vector2 Properties IsNormalized Gets a value indicting whether this instance is normalized. public bool IsNormalized { get; } Property Value bool this[int] Gets or sets the component at the specified index. public float this[int index] { get; set; } Parameters index int The index of the component to access. Use 0 for the X component and 1 for the Y component. Property Value float The value of the X or Y component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 1]. Methods Add(Vector2, Vector2) Adds two vectors. public static Vector2 Add(Vector2 left, Vector2 right) Parameters left Vector2 The first vector to add. right Vector2 The second vector to add. Returns Vector2 The sum of the two vectors. Add(ref readonly Vector2, ref readonly Vector2, out Vector2) Adds two vectors. public static void Add(ref readonly Vector2 left, ref readonly Vector2 right, out Vector2 result) Parameters left Vector2 The first vector to add. right Vector2 The second vector to add. result Vector2 When the method completes, contains the sum of the two vectors. Barycentric(Vector2, Vector2, Vector2, float, float) Returns a Vector2 containing the 2D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle. public static Vector2 Barycentric(Vector2 value1, Vector2 value2, Vector2 value3, float amount1, float amount2) Parameters value1 Vector2 A Vector2 containing the 2D Cartesian coordinates of vertex 1 of the triangle. value2 Vector2 A Vector2 containing the 2D Cartesian coordinates of vertex 2 of the triangle. value3 Vector2 A Vector2 containing the 2D Cartesian coordinates of vertex 3 of the triangle. amount1 float Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 float Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). Returns Vector2 A new Vector2 containing the 2D Cartesian coordinates of the specified point. Barycentric(ref readonly Vector2, ref readonly Vector2, ref readonly Vector2, float, float, out Vector2) Returns a Vector2 containing the 2D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle. public static void Barycentric(ref readonly Vector2 value1, ref readonly Vector2 value2, ref readonly Vector2 value3, float amount1, float amount2, out Vector2 result) Parameters value1 Vector2 A Vector2 containing the 2D Cartesian coordinates of vertex 1 of the triangle. value2 Vector2 A Vector2 containing the 2D Cartesian coordinates of vertex 2 of the triangle. value3 Vector2 A Vector2 containing the 2D Cartesian coordinates of vertex 3 of the triangle. amount1 float Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 float Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). result Vector2 When the method completes, contains the 2D Cartesian coordinates of the specified point. CatmullRom(Vector2, Vector2, Vector2, Vector2, float) Performs a Catmull-Rom interpolation using the specified positions. public static Vector2 CatmullRom(Vector2 value1, Vector2 value2, Vector2 value3, Vector2 value4, float amount) Parameters value1 Vector2 The first position in the interpolation. value2 Vector2 The second position in the interpolation. value3 Vector2 The third position in the interpolation. value4 Vector2 The fourth position in the interpolation. amount float Weighting factor. Returns Vector2 A vector that is the result of the Catmull-Rom interpolation. CatmullRom(ref readonly Vector2, ref readonly Vector2, ref readonly Vector2, ref readonly Vector2, float, out Vector2) Performs a Catmull-Rom interpolation using the specified positions. public static void CatmullRom(ref readonly Vector2 value1, ref readonly Vector2 value2, ref readonly Vector2 value3, ref readonly Vector2 value4, float amount, out Vector2 result) Parameters value1 Vector2 The first position in the interpolation. value2 Vector2 The second position in the interpolation. value3 Vector2 The third position in the interpolation. value4 Vector2 The fourth position in the interpolation. amount float Weighting factor. result Vector2 When the method completes, contains the result of the Catmull-Rom interpolation. Clamp(Vector2, Vector2, Vector2) Restricts a value to be within a specified range. public static Vector2 Clamp(Vector2 value, Vector2 min, Vector2 max) Parameters value Vector2 The value to clamp. min Vector2 The minimum value. max Vector2 The maximum value. Returns Vector2 The clamped value. Clamp(ref readonly Vector2, ref readonly Vector2, ref readonly Vector2, out Vector2) Restricts a value to be within a specified range. public static void Clamp(ref readonly Vector2 value, ref readonly Vector2 min, ref readonly Vector2 max, out Vector2 result) Parameters value Vector2 The value to clamp. min Vector2 The minimum value. max Vector2 The maximum value. result Vector2 When the method completes, contains the clamped value. Deconstruct(out float, out float) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out float x, out float y) Parameters x float The X component y float The Y component Demodulate(Vector2, Vector2) Demodulates a vector with another by performing component-wise division. public static Vector2 Demodulate(Vector2 left, Vector2 right) Parameters left Vector2 The first vector to demodulate. right Vector2 The second vector to demodulate. Returns Vector2 The demodulated vector. Demodulate(ref readonly Vector2, ref readonly Vector2, out Vector2) Demodulates a vector with another by performing component-wise division. public static void Demodulate(ref readonly Vector2 left, ref readonly Vector2 right, out Vector2 result) Parameters left Vector2 The first vector to demodulate. right Vector2 The second vector to demodulate. result Vector2 When the method completes, contains the demodulated vector. Distance(Vector2, Vector2) Calculates the distance between two vectors. public static float Distance(Vector2 value1, Vector2 value2) Parameters value1 Vector2 The first vector. value2 Vector2 The second vector. Returns float The distance between the two vectors. Remarks DistanceSquared(Vector2, Vector2) may be preferred when only the relative distance is needed and speed is of the essence. Distance(ref readonly Vector2, ref readonly Vector2, out float) Calculates the distance between two vectors. public static void Distance(ref readonly Vector2 value1, ref readonly Vector2 value2, out float result) Parameters value1 Vector2 The first vector. value2 Vector2 The second vector. result float When the method completes, contains the distance between the two vectors. Remarks DistanceSquared(ref readonly Vector2, ref readonly Vector2, out float) may be preferred when only the relative distance is needed and speed is of the essence. DistanceSquared(Vector2, Vector2) Calculates the squared distance between two vectors. public static float DistanceSquared(Vector2 value1, Vector2 value2) Parameters value1 Vector2 The first vector. value2 Vector2 The second vector. Returns float The squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. DistanceSquared(ref readonly Vector2, ref readonly Vector2, out float) Calculates the squared distance between two vectors. public static void DistanceSquared(ref readonly Vector2 value1, ref readonly Vector2 value2, out float result) Parameters value1 Vector2 The first vector. value2 Vector2 The second vector result float When the method completes, contains the squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. Divide(Vector2, float) Scales a vector by the given value. public static Vector2 Divide(Vector2 value, float scale) Parameters value Vector2 The vector to scale. scale float The amount by which to scale the vector. Returns Vector2 The scaled vector. Divide(ref readonly Vector2, float, out Vector2) Scales a vector by the given value. public static void Divide(ref readonly Vector2 value, float scale, out Vector2 result) Parameters value Vector2 The vector to scale. scale float The amount by which to scale the vector. result Vector2 When the method completes, contains the scaled vector. Dot(Vector2, Vector2) Calculates the dot product of two vectors. public static float Dot(Vector2 left, Vector2 right) Parameters left Vector2 First source vector. right Vector2 Second source vector. Returns float The dot product of the two vectors. Dot(ref readonly Vector2, ref readonly Vector2, out float) Calculates the dot product of two vectors. public static void Dot(ref readonly Vector2 left, ref readonly Vector2 right, out float result) Parameters left Vector2 First source vector. right Vector2 Second source vector. result float When the method completes, contains the dot product of the two vectors. Equals(Vector2) Determines whether the specified Vector2 is within ZeroTolerance for equality to this instance. public readonly bool Equals(Vector2 other) Parameters other Vector2 The Vector2 to compare with this instance. Returns bool true if the specified Vector2 is equal or almost equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is within ZeroTolerance for equality to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal or almost equal to this instance; otherwise, false. EqualsStrict(Vector2) Determines whether the specified Vector2 is exactly equal to this instance. public bool EqualsStrict(Vector2 other) Parameters other Vector2 The Vector2 to compare with this instance. Returns bool true if the specified Vector2 is exactly equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Hermite(Vector2, Vector2, Vector2, Vector2, float) Performs a Hermite spline interpolation. public static Vector2 Hermite(Vector2 value1, Vector2 tangent1, Vector2 value2, Vector2 tangent2, float amount) Parameters value1 Vector2 First source position vector. tangent1 Vector2 First source tangent vector. value2 Vector2 Second source position vector. tangent2 Vector2 Second source tangent vector. amount float Weighting factor. Returns Vector2 The result of the Hermite spline interpolation. Hermite(ref readonly Vector2, ref readonly Vector2, ref readonly Vector2, ref readonly Vector2, float, out Vector2) Performs a Hermite spline interpolation. public static void Hermite(ref readonly Vector2 value1, ref readonly Vector2 tangent1, ref readonly Vector2 value2, ref readonly Vector2 tangent2, float amount, out Vector2 result) Parameters value1 Vector2 First source position vector. tangent1 Vector2 First source tangent vector. value2 Vector2 Second source position vector. tangent2 Vector2 Second source tangent vector. amount float Weighting factor. result Vector2 When the method completes, contains the result of the Hermite spline interpolation. Length() Calculates the length of the vector. public readonly float Length() Returns float The length of the vector. Remarks LengthSquared() may be preferred when only the relative length is needed and speed is of the essence. LengthSquared() Calculates the squared length of the vector. public float LengthSquared() Returns float The squared length of the vector. Remarks This method may be preferred to Length() when only a relative length is needed and speed is of the essence. Lerp(Vector2, Vector2, float) Performs a linear interpolation between two vectors. public static Vector2 Lerp(Vector2 start, Vector2 end, float amount) Parameters start Vector2 Start vector. end Vector2 End vector. amount float Value between 0 and 1 indicating the weight of end. Returns Vector2 The linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Vector2, ref readonly Vector2, float, out Vector2) Performs a linear interpolation between two vectors. public static void Lerp(ref readonly Vector2 start, ref readonly Vector2 end, float amount, out Vector2 result) Parameters start Vector2 Start vector. end Vector2 End vector. amount float Value between 0 and 1 indicating the weight of end. result Vector2 When the method completes, contains the linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Vector2, Vector2) Returns a vector containing the largest components of the specified vectors. public static Vector2 Max(Vector2 left, Vector2 right) Parameters left Vector2 The first source vector. right Vector2 The second source vector. Returns Vector2 A vector containing the largest components of the source vectors. Max(ref readonly Vector2, ref readonly Vector2, out Vector2) Returns a vector containing the smallest components of the specified vectors. public static void Max(ref readonly Vector2 left, ref readonly Vector2 right, out Vector2 result) Parameters left Vector2 The first source vector. right Vector2 The second source vector. result Vector2 When the method completes, contains an new vector composed of the largest components of the source vectors. Min(Vector2, Vector2) Returns a vector containing the smallest components of the specified vectors. public static Vector2 Min(Vector2 left, Vector2 right) Parameters left Vector2 The first source vector. right Vector2 The second source vector. Returns Vector2 A vector containing the smallest components of the source vectors. Min(ref readonly Vector2, ref readonly Vector2, out Vector2) Returns a vector containing the smallest components of the specified vectors. public static void Min(ref readonly Vector2 left, ref readonly Vector2 right, out Vector2 result) Parameters left Vector2 The first source vector. right Vector2 The second source vector. result Vector2 When the method completes, contains an new vector composed of the smallest components of the source vectors. Modulate(Vector2, Vector2) Modulates a vector with another by performing component-wise multiplication. public static Vector2 Modulate(Vector2 left, Vector2 right) Parameters left Vector2 The first vector to modulate. right Vector2 The second vector to modulate. Returns Vector2 The modulated vector. Modulate(ref readonly Vector2, ref readonly Vector2, out Vector2) Modulates a vector with another by performing component-wise multiplication. public static void Modulate(ref readonly Vector2 left, ref readonly Vector2 right, out Vector2 result) Parameters left Vector2 The first vector to modulate. right Vector2 The second vector to modulate. result Vector2 When the method completes, contains the modulated vector. MoveTo(in Vector2, in Vector2, float) Moves the first vector2 to the second one in a straight line. public static Vector2 MoveTo(in Vector2 from, in Vector2 to, float maxTravelDistance) Parameters from Vector2 The first point. to Vector2 The second point. maxTravelDistance float The rate at which the first point is going to move towards the second point. Returns Vector2 Multiply(Vector2, float) Scales a vector by the given value. public static Vector2 Multiply(Vector2 value, float scale) Parameters value Vector2 The vector to scale. scale float The amount by which to scale the vector. Returns Vector2 The scaled vector. Multiply(ref readonly Vector2, float, out Vector2) Scales a vector by the given value. public static void Multiply(ref readonly Vector2 value, float scale, out Vector2 result) Parameters value Vector2 The vector to scale. scale float The amount by which to scale the vector. result Vector2 When the method completes, contains the scaled vector. Negate(Vector2) Reverses the direction of a given vector. public static Vector2 Negate(Vector2 value) Parameters value Vector2 The vector to negate. Returns Vector2 A vector facing in the opposite direction. Negate(ref readonly Vector2, out Vector2) Reverses the direction of a given vector. public static void Negate(ref readonly Vector2 value, out Vector2 result) Parameters value Vector2 The vector to negate. result Vector2 When the method completes, contains a vector facing in the opposite direction. Normalize() Converts the vector into a unit vector. public void Normalize() Normalize(Vector2) Converts the vector into a unit vector. public static Vector2 Normalize(Vector2 value) Parameters value Vector2 The vector to normalize. Returns Vector2 The normalized vector. Normalize(ref readonly Vector2, out Vector2) Converts the vector into a unit vector. public static void Normalize(ref readonly Vector2 value, out Vector2 result) Parameters value Vector2 The vector to normalize. result Vector2 When the method completes, contains the normalized vector. Orthogonalize(Vector2[], params Vector2[]) Orthogonalizes a list of vectors. public static void Orthogonalize(Vector2[] destination, params Vector2[] source) Parameters destination Vector2[] The list of orthogonalized vectors. source Vector2[] The list of vectors to orthogonalize. Remarks Orthogonalization is the process of making all vectors orthogonal to each other. This means that any given vector in the list will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Orthonormalize(Vector2[], params Vector2[]) Orthonormalizes a list of vectors. public static void Orthonormalize(Vector2[] destination, params Vector2[] source) Parameters destination Vector2[] The list of orthonormalized vectors. source Vector2[] The list of vectors to orthonormalize. Remarks Orthonormalization is the process of making all vectors orthogonal to each other and making all vectors of unit length. This means that any given vector will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Reflect(Vector2, Vector2) Returns the reflection of a vector off a surface that has the specified normal. public static Vector2 Reflect(Vector2 vector, Vector2 normal) Parameters vector Vector2 The source vector. normal Vector2 Normal of the surface. Returns Vector2 The reflected vector. Remarks Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it. Reflect(ref readonly Vector2, ref readonly Vector2, out Vector2) Returns the reflection of a vector off a surface that has the specified normal. public static void Reflect(ref readonly Vector2 vector, ref readonly Vector2 normal, out Vector2 result) Parameters vector Vector2 The source vector. normal Vector2 Normal of the surface. result Vector2 When the method completes, contains the reflected vector. Remarks Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it. SmoothStep(Vector2, Vector2, float) Performs a cubic interpolation between two vectors. public static Vector2 SmoothStep(Vector2 start, Vector2 end, float amount) Parameters start Vector2 Start vector. end Vector2 End vector. amount float Value between 0 and 1 indicating the weight of end. Returns Vector2 The cubic interpolation of the two vectors. SmoothStep(ref readonly Vector2, ref readonly Vector2, float, out Vector2) Performs a cubic interpolation between two vectors. public static void SmoothStep(ref readonly Vector2 start, ref readonly Vector2 end, float amount, out Vector2 result) Parameters start Vector2 Start vector. end Vector2 End vector. amount float Value between 0 and 1 indicating the weight of end. result Vector2 When the method completes, contains the cubic interpolation of the two vectors. Subtract(in Vector2, in Vector2) Subtracts two vectors. public static Vector2 Subtract(in Vector2 left, in Vector2 right) Parameters left Vector2 The first vector to subtract. right Vector2 The second vector to subtract. Returns Vector2 The difference of the two vectors. Subtract(ref readonly Vector2, ref readonly Vector2, out Vector2) Subtracts two vectors. public static void Subtract(ref readonly Vector2 left, ref readonly Vector2 right, out Vector2 result) Parameters left Vector2 The first vector to subtract. right Vector2 The second vector to subtract. result Vector2 When the method completes, contains the difference of the two vectors. ToArray() Creates an array containing the elements of the vector. public float[] ToArray() Returns float[] A two-element array containing the components of the vector. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transform(Vector2, Matrix) Transforms a 2D vector by the given Matrix. public static Vector4 Transform(Vector2 vector, Matrix transform) Parameters vector Vector2 The source vector. transform Matrix The transformation Matrix. Returns Vector4 The transformed Vector4. Transform(Vector2, Quaternion) Transforms a 2D vector by the given Quaternion rotation. public static Vector2 Transform(Vector2 vector, Quaternion rotation) Parameters vector Vector2 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. Returns Vector2 The transformed Vector4. Transform(ref readonly Vector2, ref readonly Matrix, out Vector4) Transforms a 2D vector by the given Matrix. public static void Transform(ref readonly Vector2 vector, ref readonly Matrix transform, out Vector4 result) Parameters vector Vector2 The source vector. transform Matrix The transformation Matrix. result Vector4 When the method completes, contains the transformed Vector4. Transform(ref readonly Vector2, ref readonly Quaternion, out Vector2) Transforms a 2D vector by the given Quaternion rotation. public static void Transform(ref readonly Vector2 vector, ref readonly Quaternion rotation, out Vector2 result) Parameters vector Vector2 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. result Vector2 When the method completes, contains the transformed Vector4. Transform(Vector2[], ref readonly Matrix, Vector4[]) Transforms an array of 2D vectors by the given Matrix. public static void Transform(Vector2[] source, ref readonly Matrix transform, Vector4[] destination) Parameters source Vector2[] The array of vectors to transform. transform Matrix The transformation Matrix. destination Vector4[] The array for which the transformed vectors are stored. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Transform(Vector2[], ref readonly Quaternion, Vector2[]) Transforms an array of vectors by the given Quaternion rotation. public static void Transform(Vector2[] source, ref readonly Quaternion rotation, Vector2[] destination) Parameters source Vector2[] The array of vectors to transform. rotation Quaternion The Quaternion rotation to apply. destination Vector2[] The array for which the transformed vectors are stored. This array may be the same array as source. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. TransformCoordinate(Vector2, Matrix) Performs a coordinate transformation using the given Matrix. public static Vector2 TransformCoordinate(Vector2 coordinate, Matrix transform) Parameters coordinate Vector2 The coordinate vector to transform. transform Matrix The transformation Matrix. Returns Vector2 The transformed coordinates. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the w component to be one and therefore makes the vector homogeneous. The homogeneous vector is often preferred when working with coordinates as the w component can safely be ignored. TransformCoordinate(ref readonly Vector2, ref readonly Matrix, out Vector2) Performs a coordinate transformation using the given Matrix. public static void TransformCoordinate(ref readonly Vector2 coordinate, ref readonly Matrix transform, out Vector2 result) Parameters coordinate Vector2 The coordinate vector to transform. transform Matrix The transformation Matrix. result Vector2 When the method completes, contains the transformed coordinates. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the w component to be one and therefore makes the vector homogeneous. The homogeneous vector is often preferred when working with coordinates as the w component can safely be ignored. TransformCoordinate(Vector2[], ref readonly Matrix, Vector2[]) Performs a coordinate transformation on an array of vectors using the given Matrix. public static void TransformCoordinate(Vector2[] source, ref readonly Matrix transform, Vector2[] destination) Parameters source Vector2[] The array of coordinate vectors to transform. transform Matrix The transformation Matrix. destination Vector2[] The array for which the transformed vectors are stored. This array may be the same array as source. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the w component to be one and therefore makes the vector homogeneous. The homogeneous vector is often preferred when working with coordinates as the w component can safely be ignored. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. TransformNormal(Vector2, Matrix) Performs a normal transformation using the given Matrix. public static Vector2 TransformNormal(Vector2 normal, Matrix transform) Parameters normal Vector2 The normal vector to transform. transform Matrix The transformation Matrix. Returns Vector2 The transformed normal. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth column of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often preferred for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. TransformNormal(ref readonly Vector2, ref readonly Matrix, out Vector2) Performs a normal transformation using the given Matrix. public static void TransformNormal(ref readonly Vector2 normal, ref readonly Matrix transform, out Vector2 result) Parameters normal Vector2 The normal vector to transform. transform Matrix The transformation Matrix. result Vector2 When the method completes, contains the transformed normal. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth column of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often preferred for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. TransformNormal(Vector2[], ref readonly Matrix, Vector2[]) Performs a normal transformation on an array of vectors using the given Matrix. public static void TransformNormal(Vector2[] source, ref readonly Matrix transform, Vector2[] destination) Parameters source Vector2[] The array of normal vectors to transform. transform Matrix The transformation Matrix. destination Vector2[] The array for which the transformed vectors are stored. This array may be the same array as source. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth column of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often preferred for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Operators operator +(Vector2, Vector2) Adds two vectors. public static Vector2 operator +(Vector2 left, Vector2 right) Parameters left Vector2 The first vector to add. right Vector2 The second vector to add. Returns Vector2 The sum of the two vectors. operator /(Vector2, Vector2) Divides a vector by the given vector, component-wise. public static Vector2 operator /(Vector2 value, Vector2 by) Parameters value Vector2 The vector to scale. by Vector2 The by. Returns Vector2 The scaled vector. operator /(Vector2, float) Scales a vector by the given value. public static Vector2 operator /(Vector2 value, float scale) Parameters value Vector2 The vector to scale. scale float The amount by which to scale the vector. Returns Vector2 The scaled vector. operator /(float, Vector2) Divides a numerator by a vector. public static Vector2 operator /(float numerator, Vector2 value) Parameters numerator float The numerator. value Vector2 The value. Returns Vector2 The scaled vector. operator ==(Vector2, Vector2) Tests for equality between two objects. public static bool operator ==(Vector2 left, Vector2 right) Parameters left Vector2 The first value to compare. right Vector2 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. Remarks Comparison is not strict, a difference of ZeroTolerance will return as equal. explicit operator Vector3(Vector2) Performs an explicit conversion from Vector2 to Vector3. public static explicit operator Vector3(Vector2 value) Parameters value Vector2 The value. Returns Vector3 The result of the conversion. explicit operator Vector4(Vector2) Performs an explicit conversion from Vector2 to Vector4. public static explicit operator Vector4(Vector2 value) Parameters value Vector2 The value. Returns Vector4 The result of the conversion. implicit operator Vector2(Vector2) Casts from Stride.Maths to System.Numerics vectors public static implicit operator Vector2(Vector2 v) Parameters v Vector2 Value to cast Returns Vector2 implicit operator Vector2(Vector2) Casts from System.Numerics to Stride.Maths vectors public static implicit operator Vector2(Vector2 v) Parameters v Vector2 Value to cast Returns Vector2 operator !=(Vector2, Vector2) Tests for inequality between two objects. public static bool operator !=(Vector2 left, Vector2 right) Parameters left Vector2 The first value to compare. right Vector2 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. Remarks Comparison is not strict, a difference of ZeroTolerance will return as equal. operator *(Vector2, Vector2) Modulates a vector with another by performing component-wise multiplication. public static Vector2 operator *(Vector2 left, Vector2 right) Parameters left Vector2 The first vector to multiply. right Vector2 The second vector to multiply. Returns Vector2 The multiplication of the two vectors. operator *(Vector2, float) Scales a vector by the given value. public static Vector2 operator *(Vector2 value, float scale) Parameters value Vector2 The vector to scale. scale float The amount by which to scale the vector. Returns Vector2 The scaled vector. operator *(float, Vector2) Scales a vector by the given value. public static Vector2 operator *(float scale, Vector2 value) Parameters scale float The amount by which to scale the vector. value Vector2 The vector to scale. Returns Vector2 The scaled vector. operator -(Vector2, Vector2) Subtracts two vectors. public static Vector2 operator -(Vector2 left, Vector2 right) Parameters left Vector2 The first vector to subtract. right Vector2 The second vector to subtract. Returns Vector2 The difference of the two vectors. operator -(Vector2) Reverses the direction of a given vector. public static Vector2 operator -(Vector2 value) Parameters value Vector2 The vector to negate. Returns Vector2 A vector facing in the opposite direction. operator +(Vector2) Assert a vector (return it unchanged). public static Vector2 operator +(Vector2 value) Parameters value Vector2 The vector to assert (unchanged). Returns Vector2 The asserted (unchanged) vector."
  },
  "api/Stride.Core.Mathematics.Vector3.html": {
    "href": "api/Stride.Core.Mathematics.Vector3.html",
    "title": "Struct Vector3 | Stride API",
    "summary": "Struct Vector3 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a three dimensional mathematical vector. [DataContract(\"float3\")] [DataStyle(DataStyle.Compact)] public struct Vector3 : IEquatable<Vector3>, ISpanFormattable, IFormattable Implements IEquatable<Vector3> ISpanFormattable IFormattable Extension Methods VectorExtensions.XY(Vector3) VectorExtensions.XZ(Vector3) VectorExtensions.YZ(Vector3) UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Vector3(Vector2, float) Initializes a new instance of the Vector3 struct. public Vector3(Vector2 value, float z) Parameters value Vector2 A vector containing the values with which to initialize the X and Y components. z float Initial value for the Z component of the vector. Vector3(float) Initializes a new instance of the Vector3 struct. public Vector3(float value) Parameters value float The value that will be assigned to all components. Vector3(float, float, float) Initializes a new instance of the Vector3 struct. public Vector3(float x, float y, float z) Parameters x float Initial value for the X component of the vector. y float Initial value for the Y component of the vector. z float Initial value for the Z component of the vector. Vector3(float[]) Initializes a new instance of the Vector3 struct. public Vector3(float[] values) Parameters values float[] The values to assign to the X, Y, and Z components of the vector. This must be an array with three elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than three elements. Fields One A Vector3 with all of its components set to one. public static readonly Vector3 One Field Value Vector3 SizeInBytes The size of the Vector3 type, in bytes. public static readonly int SizeInBytes Field Value int UnitX The X unit Vector3 (1, 0, 0). public static readonly Vector3 UnitX Field Value Vector3 UnitY The Y unit Vector3 (0, 1, 0). public static readonly Vector3 UnitY Field Value Vector3 UnitZ The Z unit Vector3 (0, 0, 1). public static readonly Vector3 UnitZ Field Value Vector3 X The X component of the vector. [DataMember(0)] public float X Field Value float Y The Y component of the vector. [DataMember(1)] public float Y Field Value float Z The Z component of the vector. [DataMember(2)] public float Z Field Value float Zero A Vector3 with all of its components set to zero. public static readonly Vector3 Zero Field Value Vector3 Properties IsNormalized Gets a value indicting whether this instance is normalized. public readonly bool IsNormalized { get; } Property Value bool this[int] Gets or sets the component at the specified index. public float this[int index] { get; set; } Parameters index int The index of the component to access. Use 0 for the X component, 1 for the Y component, and 2 for the Z component. Property Value float The value of the X, Y, or Z component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 2]. Methods Add(Vector3, Vector3) Adds two vectors. public static Vector3 Add(Vector3 left, Vector3 right) Parameters left Vector3 The first vector to add. right Vector3 The second vector to add. Returns Vector3 The sum of the two vectors. Add(ref readonly Vector3, ref readonly Vector3, out Vector3) Adds two vectors. public static void Add(ref readonly Vector3 left, ref readonly Vector3 right, out Vector3 result) Parameters left Vector3 The first vector to add. right Vector3 The second vector to add. result Vector3 When the method completes, contains the sum of the two vectors. Barycentric(Vector3, Vector3, Vector3, float, float) Returns a Vector3 containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle. public static Vector3 Barycentric(Vector3 value1, Vector3 value2, Vector3 value3, float amount1, float amount2) Parameters value1 Vector3 A Vector3 containing the 3D Cartesian coordinates of vertex 1 of the triangle. value2 Vector3 A Vector3 containing the 3D Cartesian coordinates of vertex 2 of the triangle. value3 Vector3 A Vector3 containing the 3D Cartesian coordinates of vertex 3 of the triangle. amount1 float Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 float Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). Returns Vector3 A new Vector3 containing the 3D Cartesian coordinates of the specified point. Barycentric(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, float, float, out Vector3) Returns a Vector3 containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle. public static void Barycentric(ref readonly Vector3 value1, ref readonly Vector3 value2, ref readonly Vector3 value3, float amount1, float amount2, out Vector3 result) Parameters value1 Vector3 A Vector3 containing the 3D Cartesian coordinates of vertex 1 of the triangle. value2 Vector3 A Vector3 containing the 3D Cartesian coordinates of vertex 2 of the triangle. value3 Vector3 A Vector3 containing the 3D Cartesian coordinates of vertex 3 of the triangle. amount1 float Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 float Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). result Vector3 When the method completes, contains the 3D Cartesian coordinates of the specified point. CatmullRom(Vector3, Vector3, Vector3, Vector3, float) Performs a Catmull-Rom interpolation using the specified positions. public static Vector3 CatmullRom(Vector3 value1, Vector3 value2, Vector3 value3, Vector3 value4, float amount) Parameters value1 Vector3 The first position in the interpolation. value2 Vector3 The second position in the interpolation. value3 Vector3 The third position in the interpolation. value4 Vector3 The fourth position in the interpolation. amount float Weighting factor. Returns Vector3 A vector that is the result of the Catmull-Rom interpolation. CatmullRom(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, float, out Vector3) Performs a Catmull-Rom interpolation using the specified positions. public static void CatmullRom(ref readonly Vector3 value1, ref readonly Vector3 value2, ref readonly Vector3 value3, ref readonly Vector3 value4, float amount, out Vector3 result) Parameters value1 Vector3 The first position in the interpolation. value2 Vector3 The second position in the interpolation. value3 Vector3 The third position in the interpolation. value4 Vector3 The fourth position in the interpolation. amount float Weighting factor. result Vector3 When the method completes, contains the result of the Catmull-Rom interpolation. Clamp(Vector3, Vector3, Vector3) Restricts a value to be within a specified range. public static Vector3 Clamp(Vector3 value, Vector3 min, Vector3 max) Parameters value Vector3 The value to clamp. min Vector3 The minimum value. max Vector3 The maximum value. Returns Vector3 The clamped value. Clamp(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, out Vector3) Restricts a value to be within a specified range. public static void Clamp(ref readonly Vector3 value, ref readonly Vector3 min, ref readonly Vector3 max, out Vector3 result) Parameters value Vector3 The value to clamp. min Vector3 The minimum value. max Vector3 The maximum value. result Vector3 When the method completes, contains the clamped value. Cross(in Vector3, in Vector3) Calculates the cross product of two vectors. public static Vector3 Cross(in Vector3 left, in Vector3 right) Parameters left Vector3 First source vector. right Vector3 Second source vector. Returns Vector3 The cross product of the two vectors. Cross(ref readonly Vector3, ref readonly Vector3, out Vector3) Calculates the cross product of two vectors. public static void Cross(ref readonly Vector3 left, ref readonly Vector3 right, out Vector3 result) Parameters left Vector3 First source vector. right Vector3 Second source vector. result Vector3 When the method completes, contains he cross product of the two vectors. Deconstruct(out float, out float, out float) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out float x, out float y, out float z) Parameters x float The X component y float The Y component z float The Z component Demodulate(Vector3, Vector3) Demodulates a vector with another by performing component-wise division. public static Vector3 Demodulate(Vector3 left, Vector3 right) Parameters left Vector3 The first vector to demodulate. right Vector3 The second vector to demodulate. Returns Vector3 The demodulated vector. Demodulate(ref readonly Vector3, ref readonly Vector3, out Vector3) Demodulates a vector with another by performing component-wise division. public static void Demodulate(ref readonly Vector3 left, ref readonly Vector3 right, out Vector3 result) Parameters left Vector3 The first vector to demodulate. right Vector3 The second vector to demodulate. result Vector3 When the method completes, contains the demodulated vector. Distance(Vector3, Vector3) Calculates the distance between two vectors. public static float Distance(Vector3 value1, Vector3 value2) Parameters value1 Vector3 The first vector. value2 Vector3 The second vector. Returns float The distance between the two vectors. Remarks DistanceSquared(Vector3, Vector3) may be preferred when only the relative distance is needed and speed is of the essence. Distance(ref readonly Vector3, ref readonly Vector3, out float) Calculates the distance between two vectors. public static void Distance(ref readonly Vector3 value1, ref readonly Vector3 value2, out float result) Parameters value1 Vector3 The first vector. value2 Vector3 The second vector. result float When the method completes, contains the distance between the two vectors. Remarks DistanceSquared(ref readonly Vector3, ref readonly Vector3, out float) may be preferred when only the relative distance is needed and speed is of the essence. DistanceSquared(Vector3, Vector3) Calculates the squared distance between two vectors. public static float DistanceSquared(Vector3 value1, Vector3 value2) Parameters value1 Vector3 The first vector. value2 Vector3 The second vector. Returns float The squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. DistanceSquared(ref readonly Vector3, ref readonly Vector3, out float) Calculates the squared distance between two vectors. public static void DistanceSquared(ref readonly Vector3 value1, ref readonly Vector3 value2, out float result) Parameters value1 Vector3 The first vector. value2 Vector3 The second vector. result float When the method completes, contains the squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. Divide(Vector3, float) Scales a vector by the given value. public static Vector3 Divide(Vector3 value, float scale) Parameters value Vector3 The vector to scale. scale float The amount by which to scale the vector. Returns Vector3 The scaled vector. Divide(ref readonly Vector3, float, out Vector3) Scales a vector by the given value. public static void Divide(ref readonly Vector3 value, float scale, out Vector3 result) Parameters value Vector3 The vector to scale. scale float The amount by which to scale the vector. result Vector3 When the method completes, contains the scaled vector. Dot(Vector3, Vector3) Calculates the dot product of two vectors. public static float Dot(Vector3 left, Vector3 right) Parameters left Vector3 First source vector. right Vector3 Second source vector. Returns float The dot product of the two vectors. Dot(ref readonly Vector3, ref readonly Vector3, out float) Calculates the dot product of two vectors. public static void Dot(ref readonly Vector3 left, ref readonly Vector3 right, out float result) Parameters left Vector3 First source vector. right Vector3 Second source vector. result float When the method completes, contains the dot product of the two vectors. Equals(Vector3) Determines whether the specified Vector3 is within ZeroTolerance for equality to this instance. public readonly bool Equals(Vector3 other) Parameters other Vector3 The Vector3 to compare with this instance. Returns bool true if the specified Vector3 is equal or almost equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is within ZeroTolerance for equality to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal or almost equal to this instance; otherwise, false. EqualsStrict(Vector3) Determines whether the specified Vector3 is exactly equal to this instance. public readonly bool EqualsStrict(Vector3 other) Parameters other Vector3 The Vector3 to compare with this instance. Returns bool true if the specified Vector3 is exactly equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Hermite(Vector3, Vector3, Vector3, Vector3, float) Performs a Hermite spline interpolation. public static Vector3 Hermite(Vector3 value1, Vector3 tangent1, Vector3 value2, Vector3 tangent2, float amount) Parameters value1 Vector3 First source position vector. tangent1 Vector3 First source tangent vector. value2 Vector3 Second source position vector. tangent2 Vector3 Second source tangent vector. amount float Weighting factor. Returns Vector3 The result of the Hermite spline interpolation. Hermite(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, ref readonly Vector3, float, out Vector3) Performs a Hermite spline interpolation. public static void Hermite(ref readonly Vector3 value1, ref readonly Vector3 tangent1, ref readonly Vector3 value2, ref readonly Vector3 tangent2, float amount, out Vector3 result) Parameters value1 Vector3 First source position vector. tangent1 Vector3 First source tangent vector. value2 Vector3 Second source position vector. tangent2 Vector3 Second source tangent vector. amount float Weighting factor. result Vector3 When the method completes, contains the result of the Hermite spline interpolation. Length() Calculates the length of the vector. public readonly float Length() Returns float The length of the vector. Remarks LengthSquared() may be preferred when only the relative length is needed and speed is of the essence. LengthSquared() Calculates the squared length of the vector. public readonly float LengthSquared() Returns float The squared length of the vector. Remarks This method may be preferred to Length() when only a relative length is needed and speed is of the essence. Lerp(Vector3, Vector3, float) Performs a linear interpolation between two vectors. public static Vector3 Lerp(Vector3 start, Vector3 end, float amount) Parameters start Vector3 Start vector. end Vector3 End vector. amount float Value between 0 and 1 indicating the weight of end. Returns Vector3 The linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Vector3, ref readonly Vector3, float, out Vector3) Performs a linear interpolation between two vectors. public static void Lerp(ref readonly Vector3 start, ref readonly Vector3 end, float amount, out Vector3 result) Parameters start Vector3 Start vector. end Vector3 End vector. amount float Value between 0 and 1 indicating the weight of end. result Vector3 When the method completes, contains the linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Vector3, Vector3) Returns a vector containing the largest components of the specified vectors. public static Vector3 Max(Vector3 left, Vector3 right) Parameters left Vector3 The first source vector. right Vector3 The second source vector. Returns Vector3 A vector containing the largest components of the source vectors. Max(ref readonly Vector3, ref readonly Vector3, out Vector3) Returns a vector containing the largest components of the specified vectors. public static void Max(ref readonly Vector3 left, ref readonly Vector3 right, out Vector3 result) Parameters left Vector3 The first source vector. right Vector3 The second source vector. result Vector3 When the method completes, contains an new vector composed of the largest components of the source vectors. Min(Vector3, Vector3) Returns a vector containing the smallest components of the specified vectors. public static Vector3 Min(Vector3 left, Vector3 right) Parameters left Vector3 The first source vector. right Vector3 The second source vector. Returns Vector3 A vector containing the smallest components of the source vectors. Min(ref readonly Vector3, ref readonly Vector3, out Vector3) Returns a vector containing the smallest components of the specified vectors. public static void Min(ref readonly Vector3 left, ref readonly Vector3 right, out Vector3 result) Parameters left Vector3 The first source vector. right Vector3 The second source vector. result Vector3 When the method completes, contains an new vector composed of the smallest components of the source vectors. Mod(Vector3, Vector3) Performs mathematical modulo component-wise (see MathUtil.Mod). public static Vector3 Mod(Vector3 left, Vector3 right) Parameters left Vector3 The first source vector. right Vector3 The second source vector. Returns Vector3 When the method completes, contains an new vector composed of each component's modulo. Mod(ref readonly Vector3, ref readonly Vector3, out Vector3) Performs mathematical modulo component-wise (see MathUtil.Mod). public static void Mod(ref readonly Vector3 left, ref readonly Vector3 right, out Vector3 result) Parameters left Vector3 The first source vector. right Vector3 The second source vector. result Vector3 When the method completes, contains an new vector composed of each component's modulo. Modulate(Vector3, Vector3) Modulates a vector with another by performing component-wise multiplication. public static Vector3 Modulate(Vector3 left, Vector3 right) Parameters left Vector3 The first vector to modulate. right Vector3 The second vector to modulate. Returns Vector3 The modulated vector. Modulate(ref readonly Vector3, ref readonly Vector3, out Vector3) Modulates a vector with another by performing component-wise multiplication. public static void Modulate(ref readonly Vector3 left, ref readonly Vector3 right, out Vector3 result) Parameters left Vector3 The first vector to modulate. right Vector3 The second vector to modulate. result Vector3 When the method completes, contains the modulated vector. MoveTo(in Vector3, in Vector3, float) Moves the first vector3 to the second one in a straight line. public static Vector3 MoveTo(in Vector3 from, in Vector3 to, float maxTravelDistance) Parameters from Vector3 The first point. to Vector3 The second point. maxTravelDistance float The rate at which the first point is going to move towards the second point. Returns Vector3 Multiply(Vector3, float) Scales a vector by the given value. public static Vector3 Multiply(Vector3 value, float scale) Parameters value Vector3 The vector to scale. scale float The amount by which to scale the vector. Returns Vector3 The scaled vector. Multiply(ref readonly Vector3, float, out Vector3) Scales a vector by the given value. public static void Multiply(ref readonly Vector3 value, float scale, out Vector3 result) Parameters value Vector3 The vector to scale. scale float The amount by which to scale the vector. result Vector3 When the method completes, contains the scaled vector. NearEqual(ref readonly Vector3, ref readonly Vector3, ref readonly Vector3) Tests whether one 3D vector is near another 3D vector. public static bool NearEqual(ref readonly Vector3 left, ref readonly Vector3 right, ref readonly Vector3 epsilon) Parameters left Vector3 The left vector. right Vector3 The right vector. epsilon Vector3 The epsilon. Returns bool true if left and right are near another 3D, false otherwise Negate(Vector3) Reverses the direction of a given vector. public static Vector3 Negate(Vector3 value) Parameters value Vector3 The vector to negate. Returns Vector3 A vector facing in the opposite direction. Negate(ref readonly Vector3, out Vector3) Reverses the direction of a given vector. public static void Negate(ref readonly Vector3 value, out Vector3 result) Parameters value Vector3 The vector to negate. result Vector3 When the method completes, contains a vector facing in the opposite direction. Normalize() Converts the vector into a unit vector. public void Normalize() Normalize(Vector3) Converts the vector into a unit vector. public static Vector3 Normalize(Vector3 value) Parameters value Vector3 The vector to normalize. Returns Vector3 The normalized vector. Normalize(ref readonly Vector3, out Vector3) Converts the vector into a unit vector. public static void Normalize(ref readonly Vector3 value, out Vector3 result) Parameters value Vector3 The vector to normalize. result Vector3 When the method completes, contains the normalized vector. Orthogonalize(Vector3[], params Vector3[]) Orthogonalizes a list of vectors. public static void Orthogonalize(Vector3[] destination, params Vector3[] source) Parameters destination Vector3[] The list of orthogonalized vectors. source Vector3[] The list of vectors to orthogonalize. Remarks Orthogonalization is the process of making all vectors orthogonal to each other. This means that any given vector in the list will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Orthonormalize(Vector3[], params Vector3[]) Orthonormalizes a list of vectors. public static void Orthonormalize(Vector3[] destination, params Vector3[] source) Parameters destination Vector3[] The list of orthonormalized vectors. source Vector3[] The list of vectors to orthonormalize. Remarks Orthonormalization is the process of making all vectors orthogonal to each other and making all vectors of unit length. This means that any given vector will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Pow(float) Raises the exponent for each components. public void Pow(float exponent) Parameters exponent float The exponent. Project(Vector3, float, float, float, float, float, float, Matrix) Projects a 3D vector from object space into screen space. public static Vector3 Project(Vector3 vector, float x, float y, float width, float height, float minZ, float maxZ, Matrix worldViewProjection) Parameters vector Vector3 The vector to project. x float The X position of the viewport. y float The Y position of the viewport. width float The width of the viewport. height float The height of the viewport. minZ float The minimum depth of the viewport. maxZ float The maximum depth of the viewport. worldViewProjection Matrix The combined world-view-projection matrix. Returns Vector3 The vector in screen space. Project(ref readonly Vector3, float, float, float, float, float, float, ref readonly Matrix, out Vector3) Projects a 3D vector from object space into screen space. public static void Project(ref readonly Vector3 vector, float x, float y, float width, float height, float minZ, float maxZ, ref readonly Matrix worldViewProjection, out Vector3 result) Parameters vector Vector3 The vector to project. x float The X position of the viewport. y float The Y position of the viewport. width float The width of the viewport. height float The height of the viewport. minZ float The minimum depth of the viewport. maxZ float The maximum depth of the viewport. worldViewProjection Matrix The combined world-view-projection matrix. result Vector3 When the method completes, contains the vector in screen space. Reflect(Vector3, Vector3) Returns the reflection of a vector off a surface that has the specified normal. public static Vector3 Reflect(Vector3 vector, Vector3 normal) Parameters vector Vector3 The source vector. normal Vector3 Normal of the surface. Returns Vector3 The reflected vector. Remarks Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it. Reflect(ref readonly Vector3, ref readonly Vector3, out Vector3) Returns the reflection of a vector off a surface that has the specified normal. public static void Reflect(ref readonly Vector3 vector, ref readonly Vector3 normal, out Vector3 result) Parameters vector Vector3 The source vector. normal Vector3 Normal of the surface. result Vector3 When the method completes, contains the reflected vector. Remarks Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it. RotateAround(in Vector3, in Vector3, in Vector3, float) Rotates the source around the target by the rotation angle around the supplied axis. public static Vector3 RotateAround(in Vector3 source, in Vector3 target, in Vector3 axis, float angle) Parameters source Vector3 The position to rotate. target Vector3 The point to rotate around. axis Vector3 The axis of rotation. angle float The angle to rotate by in radians. Returns Vector3 The rotated vector. RotationYawPitchRoll(Quaternion) Calculate the yaw/pitch/roll rotation equivalent to the provided quaterion. public static Vector3 RotationYawPitchRoll(Quaternion quaternion) Parameters quaternion Quaternion The input rotation as quaternion Returns Vector3 The equivation yaw/pitch/roll rotation RotationYawPitchRoll(ref readonly Quaternion, out Vector3) Calculate the yaw/pitch/roll rotation equivalent to the provided quaterion. public static void RotationYawPitchRoll(ref readonly Quaternion quaternion, out Vector3 yawPitchRoll) Parameters quaternion Quaternion The input rotation as quaternion yawPitchRoll Vector3 The equivation yaw/pitch/roll rotation SmoothStep(Vector3, Vector3, float) Performs a cubic interpolation between two vectors. public static Vector3 SmoothStep(Vector3 start, Vector3 end, float amount) Parameters start Vector3 Start vector. end Vector3 End vector. amount float Value between 0 and 1 indicating the weight of end. Returns Vector3 The cubic interpolation of the two vectors. SmoothStep(ref readonly Vector3, ref readonly Vector3, float, out Vector3) Performs a cubic interpolation between two vectors. public static void SmoothStep(ref readonly Vector3 start, ref readonly Vector3 end, float amount, out Vector3 result) Parameters start Vector3 Start vector. end Vector3 End vector. amount float Value between 0 and 1 indicating the weight of end. result Vector3 When the method completes, contains the cubic interpolation of the two vectors. Subtract(in Vector3, in Vector3) Subtracts two vectors. public static Vector3 Subtract(in Vector3 left, in Vector3 right) Parameters left Vector3 The first vector to subtract. right Vector3 The second vector to subtract. Returns Vector3 The difference of the two vectors. Subtract(ref readonly Vector3, ref readonly Vector3, out Vector3) Subtracts two vectors. public static void Subtract(ref readonly Vector3 left, ref readonly Vector3 right, out Vector3 result) Parameters left Vector3 The first vector to subtract. right Vector3 The second vector to subtract. result Vector3 When the method completes, contains the difference of the two vectors. ToArray() Creates an array containing the elements of the vector. public float[] ToArray() Returns float[] A three-element array containing the components of the vector. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transform(Vector3, Matrix) Transforms a 3D vector by the given Matrix. public static Vector4 Transform(Vector3 vector, Matrix transform) Parameters vector Vector3 The source vector. transform Matrix The transformation Matrix. Returns Vector4 The transformed Vector4. Transform(Vector3, Quaternion) Transforms a 3D vector by the given Quaternion rotation. public static Vector3 Transform(Vector3 vector, Quaternion rotation) Parameters vector Vector3 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. Returns Vector3 The transformed Vector4. Transform(ref readonly Vector3, ref readonly Matrix, out Vector3) Transforms a 3D vector by the given Matrix. public static void Transform(ref readonly Vector3 vector, ref readonly Matrix transform, out Vector3 result) Parameters vector Vector3 The source vector. transform Matrix The transformation Matrix. result Vector3 When the method completes, contains the transformed Vector3. Transform(ref readonly Vector3, ref readonly Matrix, out Vector4) Transforms a 3D vector by the given Matrix. public static void Transform(ref readonly Vector3 vector, ref readonly Matrix transform, out Vector4 result) Parameters vector Vector3 The source vector. transform Matrix The transformation Matrix. result Vector4 When the method completes, contains the transformed Vector4. Transform(ref readonly Vector3, ref readonly Quaternion, out Vector3) Transforms a 3D vector by the given Quaternion rotation. public static void Transform(ref readonly Vector3 vector, ref readonly Quaternion rotation, out Vector3 result) Parameters vector Vector3 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. result Vector3 When the method completes, contains the transformed Vector4. Transform(Vector3[], ref readonly Matrix, Vector4[]) Transforms an array of 3D vectors by the given Matrix. public static void Transform(Vector3[] source, ref readonly Matrix transform, Vector4[] destination) Parameters source Vector3[] The array of vectors to transform. transform Matrix The transformation Matrix. destination Vector4[] The array for which the transformed vectors are stored. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Transform(Vector3[], ref readonly Quaternion, Vector3[]) Transforms an array of vectors by the given Quaternion rotation. public static void Transform(Vector3[] source, ref readonly Quaternion rotation, Vector3[] destination) Parameters source Vector3[] The array of vectors to transform. rotation Quaternion The Quaternion rotation to apply. destination Vector3[] The array for which the transformed vectors are stored. This array may be the same array as source. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. TransformCoordinate(Vector3, Matrix) Performs a coordinate transformation using the given Matrix. public static Vector3 TransformCoordinate(Vector3 coordinate, Matrix transform) Parameters coordinate Vector3 The coordinate vector to transform. transform Matrix The transformation Matrix. Returns Vector3 The transformed coordinates. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored. TransformCoordinate(ref readonly Vector3, ref readonly Matrix, out Vector3) Performs a coordinate transformation using the given Matrix. public static void TransformCoordinate(ref readonly Vector3 coordinate, ref readonly Matrix transform, out Vector3 result) Parameters coordinate Vector3 The coordinate vector to transform. transform Matrix The transformation Matrix. result Vector3 When the method completes, contains the transformed coordinates. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored. TransformCoordinate(Vector3[], ref readonly Matrix, Vector3[]) Performs a coordinate transformation on an array of vectors using the given Matrix. public static void TransformCoordinate(Vector3[] source, ref readonly Matrix transform, Vector3[] destination) Parameters source Vector3[] The array of coordinate vectors to trasnform. transform Matrix The transformation Matrix. destination Vector3[] The array for which the transformed vectors are stored. This array may be the same array as source. Remarks A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. TransformNormal(Vector3, Matrix) Performs a normal transformation using the given Matrix. public static Vector3 TransformNormal(Vector3 normal, Matrix transform) Parameters normal Vector3 The normal vector to transform. transform Matrix The transformation Matrix. Returns Vector3 The transformed normal. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. TransformNormal(ref readonly Vector3, ref readonly Matrix, out Vector3) Performs a normal transformation using the given Matrix. public static void TransformNormal(ref readonly Vector3 normal, ref readonly Matrix transform, out Vector3 result) Parameters normal Vector3 The normal vector to transform. transform Matrix The transformation Matrix. result Vector3 When the method completes, contains the transformed normal. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. TransformNormal(Vector3[], ref readonly Matrix, Vector3[]) Performs a normal transformation on an array of vectors using the given Matrix. public static void TransformNormal(Vector3[] source, ref readonly Matrix transform, Vector3[] destination) Parameters source Vector3[] The array of normal vectors to transform. transform Matrix The transformation Matrix. destination Vector3[] The array for which the transformed vectors are stored. This array may be the same array as source. Remarks A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Unproject(Vector3, float, float, float, float, float, float, Matrix) Projects a 3D vector from screen space into object space. public static Vector3 Unproject(Vector3 vector, float x, float y, float width, float height, float minZ, float maxZ, Matrix worldViewProjection) Parameters vector Vector3 The vector to project. x float The X position of the viewport. y float The Y position of the viewport. width float The width of the viewport. height float The height of the viewport. minZ float The minimum depth of the viewport. maxZ float The maximum depth of the viewport. worldViewProjection Matrix The combined world-view-projection matrix. Returns Vector3 The vector in object space. Unproject(ref readonly Vector3, float, float, float, float, float, float, ref readonly Matrix, out Vector3) Projects a 3D vector from screen space into object space. public static void Unproject(ref readonly Vector3 vector, float x, float y, float width, float height, float minZ, float maxZ, ref readonly Matrix worldViewProjection, out Vector3 result) Parameters vector Vector3 The vector to project. x float The X position of the viewport. y float The Y position of the viewport. width float The width of the viewport. height float The height of the viewport. minZ float The minimum depth of the viewport. maxZ float The maximum depth of the viewport. worldViewProjection Matrix The combined world-view-projection matrix. result Vector3 When the method completes, contains the vector in object space. Operators operator +(in Vector3, in Vector3) Adds two vectors. public static Vector3 operator +(in Vector3 left, in Vector3 right) Parameters left Vector3 The first vector to add. right Vector3 The second vector to add. Returns Vector3 The sum of the two vectors. operator +(in Vector3, float) Adds a vector with the given value. public static Vector3 operator +(in Vector3 value, float scale) Parameters value Vector3 The vector to scale. scale float The amount by which to scale the vector. Returns Vector3 The vector offset. operator /(in Vector3, in Vector3) Divides a vector by the given vector, component-wise. public static Vector3 operator /(in Vector3 value, in Vector3 by) Parameters value Vector3 The vector to scale. by Vector3 The by. Returns Vector3 The scaled vector. operator /(in Vector3, float) Scales a vector by the given value. public static Vector3 operator /(in Vector3 value, float scale) Parameters value Vector3 The vector to scale. scale float The amount by which to scale the vector. Returns Vector3 The scaled vector. operator /(float, in Vector3) Divides a numerator by a vector. public static Vector3 operator /(float numerator, in Vector3 value) Parameters numerator float The numerator. value Vector3 The value. Returns Vector3 The scaled vector. operator ==(Vector3, Vector3) Tests for equality between two objects. public static bool operator ==(Vector3 left, Vector3 right) Parameters left Vector3 The first value to compare. right Vector3 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. Remarks Comparison is not strict, a difference of ZeroTolerance will return as equal. explicit operator Int3(in Vector3) Performs an explicit conversion from Vector3 to Int3. public static explicit operator Int3(in Vector3 value) Parameters value Vector3 The value. Returns Int3 The result of the conversion. explicit operator Vector2(in Vector3) Performs an explicit conversion from Vector3 to Vector2. public static explicit operator Vector2(in Vector3 value) Parameters value Vector3 The value. Returns Vector2 The result of the conversion. explicit operator Vector4(in Vector3) Performs an explicit conversion from Vector3 to Vector4. public static explicit operator Vector4(in Vector3 value) Parameters value Vector3 The value. Returns Vector4 The result of the conversion. implicit operator Vector3(Vector3) Casts from Stride.Maths to System.Numerics vectors public static implicit operator Vector3(Vector3 v) Parameters v Vector3 Value to cast Returns Vector3 implicit operator Vector3(Vector3) Casts from System.Numerics to Stride.Maths vectors public static implicit operator Vector3(Vector3 v) Parameters v Vector3 Value to cast Returns Vector3 operator !=(Vector3, Vector3) Tests for inequality between two objects. public static bool operator !=(Vector3 left, Vector3 right) Parameters left Vector3 The first value to compare. right Vector3 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. Remarks Comparison is not strict, a difference of ZeroTolerance will return as equal. operator *(in Vector3, in Vector3) Modulates a vector with another by performing component-wise multiplication. public static Vector3 operator *(in Vector3 left, in Vector3 right) Parameters left Vector3 The first vector to multiply. right Vector3 The second vector to multiply. Returns Vector3 The multiplication of the two vectors. operator *(in Vector3, float) Scales a vector by the given value. public static Vector3 operator *(in Vector3 value, float scale) Parameters value Vector3 The vector to scale. scale float The amount by which to scale the vector. Returns Vector3 The scaled vector. operator *(float, in Vector3) Scales a vector by the given value. public static Vector3 operator *(float scale, in Vector3 value) Parameters scale float The amount by which to scale the vector. value Vector3 The vector to scale. Returns Vector3 The scaled vector. operator -(in Vector3, in Vector3) Subtracts two vectors. public static Vector3 operator -(in Vector3 left, in Vector3 right) Parameters left Vector3 The first vector to subtract. right Vector3 The second vector to subtract. Returns Vector3 The difference of the two vectors. operator -(in Vector3, float) Substracts a vector by the given value. public static Vector3 operator -(in Vector3 value, float scale) Parameters value Vector3 The vector to scale. scale float The amount by which to scale the vector. Returns Vector3 The vector offset. operator -(in Vector3) Reverses the direction of a given vector. public static Vector3 operator -(in Vector3 value) Parameters value Vector3 The vector to negate. Returns Vector3 A vector facing in the opposite direction. operator +(in Vector3) Assert a vector (return it unchanged). public static Vector3 operator +(in Vector3 value) Parameters value Vector3 The vector to assert (unchange). Returns Vector3 The asserted (unchanged) vector."
  },
  "api/Stride.Core.Mathematics.Vector4.html": {
    "href": "api/Stride.Core.Mathematics.Vector4.html",
    "title": "Struct Vector4 | Stride API",
    "summary": "Struct Vector4 Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Represents a four dimensional mathematical vector. [DataContract(\"float4\")] [DataStyle(DataStyle.Compact)] public struct Vector4 : IEquatable<Vector4>, ISpanFormattable, IFormattable Implements IEquatable<Vector4> ISpanFormattable IFormattable Extension Methods VectorExtensions.XY(Vector4) VectorExtensions.XYZ(Vector4) UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Vector4(Vector2, float, float) Initializes a new instance of the Vector4 struct. public Vector4(Vector2 value, float z, float w) Parameters value Vector2 A vector containing the values with which to initialize the X and Y components. z float Initial value for the Z component of the vector. w float Initial value for the W component of the vector. Vector4(Vector3, float) Initializes a new instance of the Vector4 struct. public Vector4(Vector3 value, float w) Parameters value Vector3 A vector containing the values with which to initialize the X, Y, and Z components. w float Initial value for the W component of the vector. Vector4(float) Initializes a new instance of the Vector4 struct. public Vector4(float value) Parameters value float The value that will be assigned to all components. Vector4(float, float, float, float) Initializes a new instance of the Vector4 struct. public Vector4(float x, float y, float z, float w) Parameters x float Initial value for the X component of the vector. y float Initial value for the Y component of the vector. z float Initial value for the Z component of the vector. w float Initial value for the W component of the vector. Vector4(float[]) Initializes a new instance of the Vector4 struct. public Vector4(float[] values) Parameters values float[] The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements. Exceptions ArgumentNullException Thrown when values is null. ArgumentOutOfRangeException Thrown when values contains more or less than four elements. Fields One A Vector4 with all of its components set to one. public static readonly Vector4 One Field Value Vector4 SizeInBytes The size of the Vector4 type, in bytes. public static readonly int SizeInBytes Field Value int UnitW The W unit Vector4 (0, 0, 0, 1). public static readonly Vector4 UnitW Field Value Vector4 UnitX The X unit Vector4 (1, 0, 0, 0). public static readonly Vector4 UnitX Field Value Vector4 UnitY The Y unit Vector4 (0, 1, 0, 0). public static readonly Vector4 UnitY Field Value Vector4 UnitZ The Z unit Vector4 (0, 0, 1, 0). public static readonly Vector4 UnitZ Field Value Vector4 W The W component of the vector. [DataMember(3)] public float W Field Value float X The X component of the vector. [DataMember(0)] public float X Field Value float Y The Y component of the vector. [DataMember(1)] public float Y Field Value float Z The Z component of the vector. [DataMember(2)] public float Z Field Value float Zero A Vector4 with all of its components set to zero. public static readonly Vector4 Zero Field Value Vector4 Properties IsNormalized Gets a value indicting whether this instance is normalized. public readonly bool IsNormalized { get; } Property Value bool this[int] Gets or sets the component at the specified index. public float this[int index] { readonly get; set; } Parameters index int The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. Property Value float The value of the X, Y, Z, or W component, depending on the index. Exceptions ArgumentOutOfRangeException Thrown when the index is out of the range [0, 3]. Methods Add(Vector4, Vector4) Adds two vectors. public static Vector4 Add(Vector4 left, Vector4 right) Parameters left Vector4 The first vector to add. right Vector4 The second vector to add. Returns Vector4 The sum of the two vectors. Add(ref readonly Vector4, ref readonly Vector4, out Vector4) Adds two vectors. public static void Add(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result) Parameters left Vector4 The first vector to add. right Vector4 The second vector to add. result Vector4 When the method completes, contains the sum of the two vectors. Barycentric(Vector4, Vector4, Vector4, float, float) Returns a Vector4 containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 4D triangle. public static Vector4 Barycentric(Vector4 value1, Vector4 value2, Vector4 value3, float amount1, float amount2) Parameters value1 Vector4 A Vector4 containing the 4D Cartesian coordinates of vertex 1 of the triangle. value2 Vector4 A Vector4 containing the 4D Cartesian coordinates of vertex 2 of the triangle. value3 Vector4 A Vector4 containing the 4D Cartesian coordinates of vertex 3 of the triangle. amount1 float Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 float Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). Returns Vector4 A new Vector4 containing the 4D Cartesian coordinates of the specified point. Barycentric(ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, float, float, out Vector4) Returns a Vector4 containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 4D triangle. public static void Barycentric(ref readonly Vector4 value1, ref readonly Vector4 value2, ref readonly Vector4 value3, float amount1, float amount2, out Vector4 result) Parameters value1 Vector4 A Vector4 containing the 4D Cartesian coordinates of vertex 1 of the triangle. value2 Vector4 A Vector4 containing the 4D Cartesian coordinates of vertex 2 of the triangle. value3 Vector4 A Vector4 containing the 4D Cartesian coordinates of vertex 3 of the triangle. amount1 float Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2). amount2 float Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3). result Vector4 When the method completes, contains the 4D Cartesian coordinates of the specified point. CatmullRom(Vector4, Vector4, Vector4, Vector4, float) Performs a Catmull-Rom interpolation using the specified positions. public static Vector4 CatmullRom(Vector4 value1, Vector4 value2, Vector4 value3, Vector4 value4, float amount) Parameters value1 Vector4 The first position in the interpolation. value2 Vector4 The second position in the interpolation. value3 Vector4 The third position in the interpolation. value4 Vector4 The fourth position in the interpolation. amount float Weighting factor. Returns Vector4 A vector that is the result of the Catmull-Rom interpolation. CatmullRom(ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, float, out Vector4) Performs a Catmull-Rom interpolation using the specified positions. public static void CatmullRom(ref readonly Vector4 value1, ref readonly Vector4 value2, ref readonly Vector4 value3, ref readonly Vector4 value4, float amount, out Vector4 result) Parameters value1 Vector4 The first position in the interpolation. value2 Vector4 The second position in the interpolation. value3 Vector4 The third position in the interpolation. value4 Vector4 The fourth position in the interpolation. amount float Weighting factor. result Vector4 When the method completes, contains the result of the Catmull-Rom interpolation. Clamp(Vector4, Vector4, Vector4) Restricts a value to be within a specified range. public static Vector4 Clamp(Vector4 value, Vector4 min, Vector4 max) Parameters value Vector4 The value to clamp. min Vector4 The minimum value. max Vector4 The maximum value. Returns Vector4 The clamped value. Clamp(ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, out Vector4) Restricts a value to be within a specified range. public static void Clamp(ref readonly Vector4 value, ref readonly Vector4 min, ref readonly Vector4 max, out Vector4 result) Parameters value Vector4 The value to clamp. min Vector4 The minimum value. max Vector4 The maximum value. result Vector4 When the method completes, contains the clamped value. Deconstruct(out float, out float, out float, out float) Deconstructs the vector's components into named variables. public readonly void Deconstruct(out float x, out float y, out float z, out float w) Parameters x float The X component y float The Y component z float The Z component w float The W component Demodulate(Vector4, Vector4) Demodulates a vector with another by performing component-wise division. public static Vector4 Demodulate(Vector4 left, Vector4 right) Parameters left Vector4 The first vector to demodulate. right Vector4 The second vector to demodulate. Returns Vector4 The demodulated vector. Demodulate(ref readonly Vector4, ref readonly Vector4, out Vector4) Demodulates a vector with another by performing component-wise division. public static void Demodulate(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result) Parameters left Vector4 The first vector to demodulate. right Vector4 The second vector to demodulate. result Vector4 When the method completes, contains the demodulated vector. Distance(Vector4, Vector4) Calculates the distance between two vectors. public static float Distance(Vector4 value1, Vector4 value2) Parameters value1 Vector4 The first vector. value2 Vector4 The second vector. Returns float The distance between the two vectors. Remarks DistanceSquared(Vector4, Vector4) may be preferred when only the relative distance is needed and speed is of the essence. Distance(ref readonly Vector4, ref readonly Vector4, out float) Calculates the distance between two vectors. public static void Distance(ref readonly Vector4 value1, ref readonly Vector4 value2, out float result) Parameters value1 Vector4 The first vector. value2 Vector4 The second vector. result float When the method completes, contains the distance between the two vectors. Remarks DistanceSquared(ref readonly Vector4, ref readonly Vector4, out float) may be preferred when only the relative distance is needed and speed is of the essence. DistanceSquared(Vector4, Vector4) Calculates the squared distance between two vectors. public static float DistanceSquared(Vector4 value1, Vector4 value2) Parameters value1 Vector4 The first vector. value2 Vector4 The second vector. Returns float The squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. DistanceSquared(ref readonly Vector4, ref readonly Vector4, out float) Calculates the squared distance between two vectors. public static void DistanceSquared(ref readonly Vector4 value1, ref readonly Vector4 value2, out float result) Parameters value1 Vector4 The first vector. value2 Vector4 The second vector. result float When the method completes, contains the squared distance between the two vectors. Remarks Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots. Divide(Vector4, float) Scales a vector by the given value. public static Vector4 Divide(Vector4 value, float scale) Parameters value Vector4 The vector to scale. scale float The amount by which to scale the vector. Returns Vector4 The scaled vector. Divide(ref readonly Vector4, float, out Vector4) Scales a vector by the given value. public static void Divide(ref readonly Vector4 value, float scale, out Vector4 result) Parameters value Vector4 The vector to scale. scale float The amount by which to scale the vector. result Vector4 When the method completes, contains the scaled vector. Dot(Vector4, Vector4) Calculates the dot product of two vectors. public static float Dot(Vector4 left, Vector4 right) Parameters left Vector4 First source vector. right Vector4 Second source vector. Returns float The dot product of the two vectors. Dot(ref readonly Vector4, ref readonly Vector4, out float) Calculates the dot product of two vectors. public static void Dot(ref readonly Vector4 left, ref readonly Vector4 right, out float result) Parameters left Vector4 First source vector right Vector4 Second source vector. result float When the method completes, contains the dot product of the two vectors. Equals(Vector4) Determines whether the specified Vector4 is within ZeroTolerance for equality to this instance. public readonly bool Equals(Vector4 other) Parameters other Vector4 The Vector4 to compare with this instance. Returns bool true if the specified Vector4 is equal or almost equal to this instance; otherwise, false. Equals(object?) Determines whether the specified object is within ZeroTolerance for equality to this instance. public override readonly bool Equals(object? value) Parameters value object The object to compare with this instance. Returns bool true if the specified object is equal or almost equal to this instance; otherwise, false. EqualsStrict(Vector4) Determines whether the specified Vector4 is exactly equal to this instance. public readonly bool EqualsStrict(Vector4 other) Parameters other Vector4 The Vector4 to compare with this instance. Returns bool true if the specified Vector4 is exactly equal to this instance; otherwise, false. GetHashCode() Returns a hash code for this instance. public override readonly int GetHashCode() Returns int A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Hermite(Vector4, Vector4, Vector4, Vector4, float) Performs a Hermite spline interpolation. public static Vector4 Hermite(Vector4 value1, Vector4 tangent1, Vector4 value2, Vector4 tangent2, float amount) Parameters value1 Vector4 First source position vector. tangent1 Vector4 First source tangent vector. value2 Vector4 Second source position vector. tangent2 Vector4 Second source tangent vector. amount float Weighting factor. Returns Vector4 The result of the Hermite spline interpolation. Hermite(ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, float, out Vector4) Performs a Hermite spline interpolation. public static void Hermite(ref readonly Vector4 value1, ref readonly Vector4 tangent1, ref readonly Vector4 value2, ref readonly Vector4 tangent2, float amount, out Vector4 result) Parameters value1 Vector4 First source position vector. tangent1 Vector4 First source tangent vector. value2 Vector4 Second source position vector. tangent2 Vector4 Second source tangent vector. amount float Weighting factor. result Vector4 When the method completes, contains the result of the Hermite spline interpolation. Length() Calculates the length of the vector. public readonly float Length() Returns float The length of the vector. Remarks LengthSquared() may be preferred when only the relative length is needed and speed is of the essence. LengthSquared() Calculates the squared length of the vector. public readonly float LengthSquared() Returns float The squared length of the vector. Remarks This method may be preferred to Length() when only a relative length is needed and speed is of the essence. Lerp(Vector4, Vector4, float) Performs a linear interpolation between two vectors. public static Vector4 Lerp(Vector4 start, Vector4 end, float amount) Parameters start Vector4 Start vector. end Vector4 End vector. amount float Value between 0 and 1 indicating the weight of end. Returns Vector4 The linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Lerp(ref readonly Vector4, ref readonly Vector4, float, out Vector4) Performs a linear interpolation between two vectors. public static void Lerp(ref readonly Vector4 start, ref readonly Vector4 end, float amount, out Vector4 result) Parameters start Vector4 Start vector. end Vector4 End vector. amount float Value between 0 and 1 indicating the weight of end. result Vector4 When the method completes, contains the linear interpolation of the two vectors. Remarks This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned. Max(Vector4, Vector4) Returns a vector containing the largest components of the specified vectors. public static Vector4 Max(Vector4 left, Vector4 right) Parameters left Vector4 The first source vector. right Vector4 The second source vector. Returns Vector4 A vector containing the largest components of the source vectors. Max(ref readonly Vector4, ref readonly Vector4, out Vector4) Returns a vector containing the smallest components of the specified vectors. public static void Max(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result) Parameters left Vector4 The first source vector. right Vector4 The second source vector. result Vector4 When the method completes, contains an new vector composed of the largest components of the source vectors. Min(Vector4, Vector4) Returns a vector containing the smallest components of the specified vectors. public static Vector4 Min(Vector4 left, Vector4 right) Parameters left Vector4 The first source vector. right Vector4 The second source vector. Returns Vector4 A vector containing the smallest components of the source vectors. Min(ref readonly Vector4, ref readonly Vector4, out Vector4) Returns a vector containing the smallest components of the specified vectors. public static void Min(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result) Parameters left Vector4 The first source vector. right Vector4 The second source vector. result Vector4 When the method completes, contains an new vector composed of the smallest components of the source vectors. Modulate(Vector4, Vector4) Modulates a vector with another by performing component-wise multiplication. public static Vector4 Modulate(Vector4 left, Vector4 right) Parameters left Vector4 The first vector to modulate. right Vector4 The second vector to modulate. Returns Vector4 The modulated vector. Modulate(ref readonly Vector4, ref readonly Vector4, out Vector4) Modulates a vector with another by performing component-wise multiplication. public static void Modulate(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result) Parameters left Vector4 The first vector to modulate. right Vector4 The second vector to modulate. result Vector4 When the method completes, contains the modulated vector. Moveto(in Vector4, in Vector4, float) Moves the first vector4 to the second one in a straight line. public static Vector4 Moveto(in Vector4 from, in Vector4 to, float maxTravelDistance) Parameters from Vector4 The first point. to Vector4 The second point. maxTravelDistance float The rate at which the first point is going to move towards the second point. Returns Vector4 Multiply(Vector4, float) Scales a vector by the given value. public static Vector4 Multiply(Vector4 value, float scale) Parameters value Vector4 The vector to scale. scale float The amount by which to scale the vector. Returns Vector4 The scaled vector. Multiply(ref readonly Vector4, float, out Vector4) Scales a vector by the given value. public static void Multiply(ref readonly Vector4 value, float scale, out Vector4 result) Parameters value Vector4 The vector to scale. scale float The amount by which to scale the vector. result Vector4 When the method completes, contains the scaled vector. Negate(Vector4) Reverses the direction of a given vector. public static Vector4 Negate(Vector4 value) Parameters value Vector4 The vector to negate. Returns Vector4 A vector facing in the opposite direction. Negate(ref readonly Vector4, out Vector4) Reverses the direction of a given vector. public static void Negate(ref readonly Vector4 value, out Vector4 result) Parameters value Vector4 The vector to negate. result Vector4 When the method completes, contains a vector facing in the opposite direction. Normalize() Converts the vector into a unit vector. public void Normalize() Normalize(Vector4) Converts the vector into a unit vector. public static Vector4 Normalize(Vector4 value) Parameters value Vector4 The vector to normalize. Returns Vector4 The normalized vector. Normalize(ref readonly Vector4, out Vector4) Converts the vector into a unit vector. public static void Normalize(ref readonly Vector4 value, out Vector4 result) Parameters value Vector4 The vector to normalize. result Vector4 When the method completes, contains the normalized vector. Orthogonalize(Vector4[], params Vector4[]) Orthogonalizes a list of vectors. public static void Orthogonalize(Vector4[] destination, params Vector4[] source) Parameters destination Vector4[] The list of orthogonalized vectors. source Vector4[] The list of vectors to orthogonalize. Remarks Orthogonalization is the process of making all vectors orthogonal to each other. This means that any given vector in the list will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Orthonormalize(Vector4[], params Vector4[]) Orthonormalizes a list of vectors. public static void Orthonormalize(Vector4[] destination, params Vector4[] source) Parameters destination Vector4[] The list of orthonormalized vectors. source Vector4[] The list of vectors to orthonormalize. Remarks Orthonormalization is the process of making all vectors orthogonal to each other and making all vectors of unit length. This means that any given vector will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Pow(float) Raises the exponent for each components. public void Pow(float exponent) Parameters exponent float The exponent. SmoothStep(Vector4, Vector4, float) Performs a cubic interpolation between two vectors. public static Vector4 SmoothStep(Vector4 start, Vector4 end, float amount) Parameters start Vector4 Start vector. end Vector4 End vector. amount float Value between 0 and 1 indicating the weight of end. Returns Vector4 The cubic interpolation of the two vectors. SmoothStep(ref readonly Vector4, ref readonly Vector4, float, out Vector4) Performs a cubic interpolation between two vectors. public static void SmoothStep(ref readonly Vector4 start, ref readonly Vector4 end, float amount, out Vector4 result) Parameters start Vector4 Start vector. end Vector4 End vector. amount float Value between 0 and 1 indicating the weight of end. result Vector4 When the method completes, contains the cubic interpolation of the two vectors. Subtract(in Vector4, in Vector4) Subtracts two vectors. public static Vector4 Subtract(in Vector4 left, in Vector4 right) Parameters left Vector4 The first vector to subtract. right Vector4 The second vector to subtract. Returns Vector4 The difference of the two vectors. Subtract(ref readonly Vector4, ref readonly Vector4, out Vector4) Subtracts two vectors. public static void Subtract(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result) Parameters left Vector4 The first vector to subtract. right Vector4 The second vector to subtract. result Vector4 When the method completes, contains the difference of the two vectors. ToArray() Creates an array containing the elements of the vector. public readonly float[] ToArray() Returns float[] A four-element array containing the components of the vector. ToString() Returns a string that represents this instance. public override readonly string ToString() Returns string A string that represents this instance. ToString(string?, IFormatProvider?) Returns a string that represents this instance. public readonly string ToString(string? format, IFormatProvider? formatProvider) Parameters format string The format. formatProvider IFormatProvider The format provider. Returns string A string that represents this instance. Transform(Vector4, Matrix) Transforms a 4D vector by the given Matrix. public static Vector4 Transform(Vector4 vector, Matrix transform) Parameters vector Vector4 The source vector. transform Matrix The transformation Matrix. Returns Vector4 The transformed Vector4. Transform(Vector4, Quaternion) Transforms a 4D vector by the given Quaternion rotation. public static Vector4 Transform(Vector4 vector, Quaternion rotation) Parameters vector Vector4 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. Returns Vector4 The transformed Vector4. Transform(ref readonly Vector4, ref readonly Matrix, out Vector4) Transforms a 4D vector by the given Matrix. public static void Transform(ref readonly Vector4 vector, ref readonly Matrix transform, out Vector4 result) Parameters vector Vector4 The source vector. transform Matrix The transformation Matrix. result Vector4 When the method completes, contains the transformed Vector4. Transform(ref readonly Vector4, ref readonly Quaternion, out Vector4) Transforms a 4D vector by the given Quaternion rotation. public static void Transform(ref readonly Vector4 vector, ref readonly Quaternion rotation, out Vector4 result) Parameters vector Vector4 The vector to rotate. rotation Quaternion The Quaternion rotation to apply. result Vector4 When the method completes, contains the transformed Vector4. Transform(Vector4[], ref readonly Matrix, Vector4[]) Transforms an array of 4D vectors by the given Matrix. public static void Transform(Vector4[] source, ref readonly Matrix transform, Vector4[] destination) Parameters source Vector4[] The array of vectors to transform. transform Matrix The transformation Matrix. destination Vector4[] The array for which the transformed vectors are stored. This array may be the same array as source. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Transform(Vector4[], ref readonly Quaternion, Vector4[]) Transforms an array of vectors by the given Quaternion rotation. public static void Transform(Vector4[] source, ref readonly Quaternion rotation, Vector4[] destination) Parameters source Vector4[] The array of vectors to transform. rotation Quaternion The Quaternion rotation to apply. destination Vector4[] The array for which the transformed vectors are stored. This array may be the same array as source. Exceptions ArgumentNullException Thrown when source or destination is null. ArgumentOutOfRangeException Thrown when destination is shorter in length than source. Operators operator +(Vector4, Vector4) Adds two vectors. public static Vector4 operator +(Vector4 left, Vector4 right) Parameters left Vector4 The first vector to add. right Vector4 The second vector to add. Returns Vector4 The sum of the two vectors. operator /(Vector4, Vector4) Divides a vector by the given vector, component-wise. public static Vector4 operator /(Vector4 value, Vector4 by) Parameters value Vector4 The vector to scale. by Vector4 The by. Returns Vector4 The scaled vector. operator /(Vector4, float) Scales a vector by the given value. public static Vector4 operator /(Vector4 value, float scale) Parameters value Vector4 The vector to scale. scale float The amount by which to scale the vector. Returns Vector4 The scaled vector. operator /(float, Vector4) Divides a numerator by a vector. public static Vector4 operator /(float numerator, Vector4 value) Parameters numerator float The numerator. value Vector4 The value. Returns Vector4 The scaled vector. operator ==(Vector4, Vector4) Tests for equality between two objects. public static bool operator ==(Vector4 left, Vector4 right) Parameters left Vector4 The first value to compare. right Vector4 The second value to compare. Returns bool true if left has the same value as right; otherwise, false. Remarks Comparison is not strict, a difference of ZeroTolerance will return as equal. explicit operator Vector2(Vector4) Performs an explicit conversion from Vector4 to Vector2. public static explicit operator Vector2(Vector4 value) Parameters value Vector4 The value. Returns Vector2 The result of the conversion. explicit operator Vector3(Vector4) Performs an explicit conversion from Vector4 to Vector3. public static explicit operator Vector3(Vector4 value) Parameters value Vector4 The value. Returns Vector3 The result of the conversion. implicit operator Vector4(Vector4) Casts from Stride.Maths to System.Numerics vectors public static implicit operator Vector4(Vector4 v) Parameters v Vector4 Value to cast Returns Vector4 implicit operator Vector4(Vector4) Casts from System.Numerics to Stride.Maths vectors public static implicit operator Vector4(Vector4 v) Parameters v Vector4 Value to cast Returns Vector4 operator !=(Vector4, Vector4) Tests for inequality between two objects. public static bool operator !=(Vector4 left, Vector4 right) Parameters left Vector4 The first value to compare. right Vector4 The second value to compare. Returns bool true if left has a different value than right; otherwise, false. operator *(Vector4, Vector4) Modulates a vector with another by performing component-wise multiplication. public static Vector4 operator *(Vector4 left, Vector4 right) Parameters left Vector4 The first vector to multiply. right Vector4 The second vector to multiply. Returns Vector4 The multiplication of the two vectors. operator *(Vector4, float) Scales a vector by the given value. public static Vector4 operator *(Vector4 value, float scale) Parameters value Vector4 The vector to scale. scale float The amount by which to scale the vector. Returns Vector4 The scaled vector. operator *(float, Vector4) Scales a vector by the given value. public static Vector4 operator *(float scale, Vector4 value) Parameters scale float The amount by which to scale the vector. value Vector4 The vector to scale. Returns Vector4 The scaled vector. operator -(Vector4, Vector4) Subtracts two vectors. public static Vector4 operator -(Vector4 left, Vector4 right) Parameters left Vector4 The first vector to subtract. right Vector4 The second vector to subtract. Returns Vector4 The difference of the two vectors. operator -(Vector4) Reverses the direction of a given vector. public static Vector4 operator -(Vector4 value) Parameters value Vector4 The vector to negate. Returns Vector4 A vector facing in the opposite direction. operator +(Vector4) Assert a vector (return it unchanged). public static Vector4 operator +(Vector4 value) Parameters value Vector4 The vector to assert (unchange). Returns Vector4 The asserted (unchanged) vector."
  },
  "api/Stride.Core.Mathematics.VectorExtensions.html": {
    "href": "api/Stride.Core.Mathematics.VectorExtensions.html",
    "title": "Class VectorExtensions | Stride API",
    "summary": "Class VectorExtensions Namespace Stride.Core.Mathematics Assembly Stride.Core.Mathematics.dll Extensions methods of the vector classes. public static class VectorExtensions Inheritance object VectorExtensions Methods XY(Vector3) Return the X/Y components of the vector. public static Vector2 XY(this Vector3 vector) Parameters vector Vector3 the input vector Returns Vector2 XY(Vector4) Return the X/Y components of the vector. public static Vector2 XY(this Vector4 vector) Parameters vector Vector4 the input vector Returns Vector2 XYZ(Vector4) Return the X/Y/Z components of the vector. public static Vector3 XYZ(this Vector4 vector) Parameters vector Vector4 the input vector Returns Vector3 XZ(Vector3) Return the X/Z components of the vector. public static Vector2 XZ(this Vector3 vector) Parameters vector Vector3 the input vector Returns Vector2 YX(Vector2) Return the Y/X components of the vector in the inverse order. public static Vector2 YX(this Vector2 vector) Parameters vector Vector2 the input vector Returns Vector2 YZ(Vector3) Return the Y/Z components of the vector. public static Vector2 YZ(this Vector3 vector) Parameters vector Vector3 the input vector Returns Vector2"
  },
  "api/Stride.Core.Mathematics.html": {
    "href": "api/Stride.Core.Mathematics.html",
    "title": "Namespace Stride.Core.Mathematics | Stride API",
    "summary": "Namespace Stride.Core.Mathematics Classes CollisionHelper Contains static methods to help in determining intersections, containment, etc. ColorExtensions A class containing extension methods for processing colors. GuillotinePacker Implementation of a \"Guillotine\" packer. More information at https://github.com/juj/RectangleBinPack/blob/master/RectangleBinPack.pdf. MathUtil Common utility methods for math operations. SphericalHarmonics A spherical harmonics representation of a cubemap. SphericalHarmonics<TDataType> A representation of a sphere of values via Spherical Harmonics (SH). VectorExtensions Extensions methods of the vector classes. Structs AngleSingle Represents a unit independant angle using a single-precision floating-point internal representation. BoundingBox Represents an axis-aligned bounding box in three dimensional space. BoundingBoxExt Represents an axis-aligned bounding box in three dimensional space that store only the Center and Extent. BoundingFrustum A bounding frustum. BoundingSphere Represents a bounding sphere in three dimensional space. Color Represents a 32-bit color (4 bytes) in the form of RGBA (in byte order: R, G, B, A). Color3 Represents a color in the form of rgb. Color4 A RGBA color value with 32-bit floating-point precision per channel. ColorBGRA Represents a 32-bit color (4 bytes) in the form of BGRA (in byte order: B, G, R, A). ColorHSV Represents a color in the form of Hue, Saturation, Value, Alpha. Double2 Represents a two dimensional mathematical vector with double-precision floats. Double3 Represents a three dimensional mathematical vector with double-precision floats. Double4 Represents a four dimensional mathematical vector with double-precision floats. Half A half precision (16 bit) floating point value. Half2 Represents a two dimensional mathematical vector with half-precision floats. Half3 Represents a three dimensional mathematical vector with half-precision floats. Half4 Represents a four dimensional mathematical vector with half-precision floats. Int2 Represents a two dimensional mathematical vector. Int3 Represents a three dimensional mathematical vector. Int4 Represents a four dimensional mathematical vector. Matrix Represents a 4x4 mathematical matrix. Plane Represents a plane in three dimensional space. Point A 2D point. Quaternion Represents a four dimensional mathematical quaternion. RandomSeed The RandomSeed is a structure for deterministically acquiring random values. One RandomSeed should be able to reproduce the same pseudo-random value for a fixed offset, but provide enough random distribution for different offsets or different random seeds Although other methods exist, the current implementation can easily be replicated in the shaders if required Ray Represents a three dimensional line based on a point in space and a direction. Rectangle A rectangle structure defining X,Y,Width,Height. RectangleF Define a RectangleF. Size2 Defines a 2D rectangular size (width,height). Size2F Defines a 2D rectangular size (width,height). Size3 Structure providing Width, Height and Depth. UInt4 Represents a four dimensional mathematical vector. Vector2 Represents a two dimensional mathematical vector. Vector3 Represents a three dimensional mathematical vector. Vector4 Represents a four dimensional mathematical vector. Interfaces IIntersectableWithPlane Allows to determine intersections with a Plane. IIntersectableWithRay Allows to determine intersections with a Ray. Enums AngleType Describes the type of angle. ContainmentType Describes how one bounding volume contains another. PlaneIntersectionType Describes the result of an intersection with a plane in three dimensions. Delegates GuillotinePacker.InsertRectangleCallback A delegate callback used by TryInsert(int, int, int, InsertRectangleCallback)"
  },
  "api/Stride.Core.MemoryUtilities.html": {
    "href": "api/Stride.Core.MemoryUtilities.html",
    "title": "Class MemoryUtilities | Stride API",
    "summary": "Class MemoryUtilities Namespace Stride.Core Assembly Stride.Core.dll Provides a set of static utility methods for memory management. public static class MemoryUtilities Inheritance object MemoryUtilities Methods Allocate(int, int) Allocates an aligned memory buffer of the requested size. public static nint Allocate(int sizeInBytes, int alignment = 16) Parameters sizeInBytes int The size of the buffer to allocate. alignment int The memory alignment. It must be a positive power of two value. Defaults to 16 bytes. Returns nint A pointer to the allocated aligned buffer. Remarks To free the buffer allocated by this method, use the Free(nint) method Exceptions ArgumentException The alignment parameter is not a positive power of two value. AllocateCleared(int, byte, int) Allocates an aligned memory buffer of the requested size, and clears its contents. public static nint AllocateCleared(int sizeInBytes, byte clearValue = 0, int alignment = 16) Parameters sizeInBytes int The size of the buffer to allocate. clearValue byte The value to use to clear the buffer. Default is 0. alignment int The memory alignment. It must be a positive power of two value. Defaults to 16 bytes. Returns nint A pointer to the allocated aligned buffer. Remarks To free the buffer allocated by this method, use the Free(nint) method Clear(ref byte, uint) Clears the contents of memory at a provided address, zeroing it out. public static void Clear(ref byte startAddress, uint byteCount) Parameters startAddress byte A reference to the starting byte of the memory to clear. byteCount uint The number of bytes to clear. Clear(nint, uint) Clears the contents of memory at a provided address, zeroing it out. public static void Clear(nint startAddress, uint byteCount) Parameters startAddress nint The starting address of the memory to clear. byteCount uint The number of bytes to clear. Clear(void*, uint) Clears the contents of memory at a provided address, zeroing it out. public static void Clear(void* startAddress, uint byteCount) Parameters startAddress void* The starting address of the memory to clear. byteCount uint The number of bytes to clear. CopyWithAlignmentFallback(ref byte, ref readonly byte, uint) Copies bytes from the source address to the destination address. public static void CopyWithAlignmentFallback(ref byte destination, ref readonly byte source, uint byteCount) Parameters destination byte The managed pointer corresponding to the destination address to copy to. source byte The managed pointer corresponding to the source address to copy from. byteCount uint The number of bytes to copy. Remarks Some platform architectures do not support arbitrary unaligned memory reads or writes. This method checks whether unaligned memory access is safe on the current architecture and uses the most efficient method available. Use this method instead of other memory copying methods if you are not sure whether the pointers or references you pass in are aligned. CopyWithAlignmentFallback(nint, nint, uint) Copies bytes from the source address to the destination address. public static void CopyWithAlignmentFallback(nint destination, nint source, uint byteCount) Parameters destination nint The managed pointer corresponding to the destination address to copy to. source nint The managed pointer corresponding to the source address to copy from. byteCount uint The number of bytes to copy. Remarks Some platform architectures do not support arbitrary unaligned memory reads or writes. This method checks whether unaligned memory access is safe on the current architecture and uses the most efficient method available. Use this method instead of other memory copying methods if you are not sure whether the pointers or references you pass in are aligned. CopyWithAlignmentFallback(void*, void*, uint) Copies bytes from the source address to the destination address. public static void CopyWithAlignmentFallback(void* destination, void* source, uint byteCount) Parameters destination void* The managed pointer corresponding to the destination address to copy to. source void* The managed pointer corresponding to the source address to copy from. byteCount uint The number of bytes to copy. Remarks Some platform architectures do not support arbitrary unaligned memory reads or writes. This method checks whether unaligned memory access is safe on the current architecture and uses the most efficient method available. Use this method instead of other memory copying methods if you are not sure whether the pointers or references you pass in are aligned. Free(nint) Frees an aligned memory buffer. public static void Free(nint alignedBuffer) Parameters alignedBuffer nint The aligned buffer to free. Remarks The buffer must have been allocated with AllocateMemory. IsAligned(ref byte, int) Determines whether the specified memory reference is aligned. public static bool IsAligned(ref byte memoryRef, int alignment = 16) Parameters memoryRef byte The memory reference. alignment int The memory alignment. It must be a positive power of two value. Defaults to 16 bytes. Returns bool true if the specified memoryRef is aligned to the given alignment; otherwise, false. Exceptions ArgumentException The alignment parameter is not a positive power of two value. IsAligned(nint, int) Determines whether the specified memory address is aligned. public static bool IsAligned(nint memoryAddress, int alignment = 16) Parameters memoryAddress nint The memory address. alignment int The memory alignment. It must be a positive power of two value. Defaults to 16 bytes. Returns bool true if the specified memoryAddress is aligned to the given alignment; otherwise, false. Exceptions ArgumentException The alignment parameter is not a positive power of two value. IsAligned(Memory<byte>, int) Determines whether the specified memory is aligned. public static bool IsAligned(Memory<byte> memory, int alignment = 16) Parameters memory Memory<byte> The memory memory. alignment int The memory alignment. It must be a positive power of two value. Defaults to 16 bytes. Returns bool true if the specified memory is aligned to the given alignment; otherwise, false. Exceptions ArgumentException The alignment parameter is not a positive power of two value. IsAligned(ReadOnlyMemory<byte>, int) Determines whether the specified memory is aligned. public static bool IsAligned(ReadOnlyMemory<byte> memory, int alignment = 16) Parameters memory ReadOnlyMemory<byte> The memory. alignment int The memory alignment. It must be a positive power of two value. Defaults to 16 bytes. Returns bool true if the specified memory is aligned to the given alignment; otherwise, false. Exceptions ArgumentException The alignment parameter is not a positive power of two value. IsAligned(ReadOnlySpan<byte>, int) Determines whether the specified span is aligned. public static bool IsAligned(ReadOnlySpan<byte> span, int alignment = 16) Parameters span ReadOnlySpan<byte> The memory span. alignment int The memory alignment. It must be a positive power of two value. Defaults to 16 bytes. Returns bool true if the specified span is aligned to the given alignment; otherwise, false. Exceptions ArgumentException The alignment parameter is not a positive power of two value. IsAligned(Span<byte>, int) Determines whether the specified span is aligned. public static bool IsAligned(Span<byte> span, int alignment = 16) Parameters span Span<byte> The memory span. alignment int The memory alignment. It must be a positive power of two value. Defaults to 16 bytes. Returns bool true if the specified span is aligned to the given alignment; otherwise, false. Exceptions ArgumentException The alignment parameter is not a positive power of two value. IsAligned(void*, int) Determines whether the specified memory pointer is aligned. public static bool IsAligned(void* memoryPtr, int alignment = 16) Parameters memoryPtr void* The memory pointer. alignment int The memory alignment. It must be a positive power of two value. Defaults to 16 bytes. Returns bool true if the specified memoryPtr is aligned to the given alignment; otherwise, false. Exceptions ArgumentException The alignment parameter is not a positive power of two value. Swap<T>(ref T, ref T) Swaps two values. public static void Swap<T>(ref T left, ref T right) Parameters left T The left value. right T The right value. Type Parameters T The type of the values to swap."
  },
  "api/Stride.Core.MicroThreading.AsyncAutoResetEvent.html": {
    "href": "api/Stride.Core.MicroThreading.AsyncAutoResetEvent.html",
    "title": "Class AsyncAutoResetEvent | Stride API",
    "summary": "Class AsyncAutoResetEvent Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public class AsyncAutoResetEvent Inheritance object AsyncAutoResetEvent Extension Methods UnsafeUtilities.As<T>(object?) Methods Set() public void Set() WaitAsync() public Task WaitAsync() Returns Task"
  },
  "api/Stride.Core.MicroThreading.AsyncSignal.html": {
    "href": "api/Stride.Core.MicroThreading.AsyncSignal.html",
    "title": "Class AsyncSignal | Stride API",
    "summary": "Class AsyncSignal Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public class AsyncSignal Inheritance object AsyncSignal Extension Methods UnsafeUtilities.As<T>(object?) Methods Set() public void Set() WaitAsync() public Task WaitAsync() Returns Task"
  },
  "api/Stride.Core.MicroThreading.Channel-1.html": {
    "href": "api/Stride.Core.MicroThreading.Channel-1.html",
    "title": "Class Channel<T> | Stride API",
    "summary": "Class Channel<T> Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll Provides a communication mechanism between MicroThread. public class Channel<T> Type Parameters T The type of element handled by this channel. Inheritance object Channel<T> Extension Methods UnsafeUtilities.As<T>(object?) Remarks MicroThread can send and receive to a Channel<T>. Depending on the Preference, sending or receiving MicroThread might be suspended and yield execution to another MicroThread. Constructors Channel() public Channel() Properties Balance Gets the balance, which is the number of MicroThread waiting to send (if greater than 0) or receive (if smaller than 0). public int Balance { get; } Property Value int The balance. Preference Gets or sets the preference, allowing you to customize how Send(T) and Receive() behave regarding scheduling. public ChannelPreference Preference { get; set; } Property Value ChannelPreference The preference. Methods Receive() Receives a value over the channel. If no other MicroThread is sending data, the receiver will be blocked. If someone was sending data, which of the sender or receiver continues next depends on Preference. public ChannelMicroThreadAwaiter<T> Receive() Returns ChannelMicroThreadAwaiter<T> Awaitable data. Reset() public void Reset() Send(T) Sends a value over the channel. If no other MicroThread is waiting for data, the sender will be blocked. If someone was waiting for data, which of the sender or receiver continues next depends on Preference. public ChannelMicroThreadAwaiter<T> Send(T data) Parameters data T The data. Returns ChannelMicroThreadAwaiter<T> Awaitable data."
  },
  "api/Stride.Core.MicroThreading.ChannelMicroThreadAwaiter-1.html": {
    "href": "api/Stride.Core.MicroThreading.ChannelMicroThreadAwaiter-1.html",
    "title": "Class ChannelMicroThreadAwaiter<T> | Stride API",
    "summary": "Class ChannelMicroThreadAwaiter<T> Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public class ChannelMicroThreadAwaiter<T> : ICriticalNotifyCompletion, INotifyCompletion Type Parameters T Inheritance object ChannelMicroThreadAwaiter<T> Implements ICriticalNotifyCompletion INotifyCompletion Extension Methods UnsafeUtilities.As<T>(object?) Constructors ChannelMicroThreadAwaiter(MicroThread) public ChannelMicroThreadAwaiter(MicroThread microThread) Parameters microThread MicroThread Properties IsCompleted public bool IsCompleted { get; set; } Property Value bool Methods GetAwaiter() public ChannelMicroThreadAwaiter<T> GetAwaiter() Returns ChannelMicroThreadAwaiter<T> GetResult() public T GetResult() Returns T New(MicroThread) public static ChannelMicroThreadAwaiter<T> New(MicroThread microThread) Parameters microThread MicroThread Returns ChannelMicroThreadAwaiter<T> OnCompleted(Action) Schedules the continuation action that's invoked when the instance completes. public void OnCompleted(Action continuation) Parameters continuation Action The action to invoke when the operation completes. Exceptions ArgumentNullException The continuation argument is null (Nothing in Visual Basic). UnsafeOnCompleted(Action) Schedules the continuation action that's invoked when the instance completes. public void UnsafeOnCompleted(Action continuation) Parameters continuation Action The action to invoke when the operation completes. Exceptions ArgumentNullException The continuation argument is null (Nothing in Visual Basic)."
  },
  "api/Stride.Core.MicroThreading.ChannelPreference.html": {
    "href": "api/Stride.Core.MicroThreading.ChannelPreference.html",
    "title": "Enum ChannelPreference | Stride API",
    "summary": "Enum ChannelPreference Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public enum ChannelPreference Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields PreferReceiver = -1 PreferSender = 1"
  },
  "api/Stride.Core.MicroThreading.MicroThread.html": {
    "href": "api/Stride.Core.MicroThreading.MicroThread.html",
    "title": "Class MicroThread | Stride API",
    "summary": "Class MicroThread Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll Represents an execution context managed by a Scheduler, that can cooperatively yield execution to another MicroThread at any point (usually using async calls). public class MicroThread Inheritance object MicroThread Extension Methods UnsafeUtilities.As<T>(object?) Constructors MicroThread(Scheduler, MicroThreadFlags) public MicroThread(Scheduler scheduler, MicroThreadFlags flags = MicroThreadFlags.None) Parameters scheduler Scheduler flags MicroThreadFlags Fields Tags Gets the attached properties to this component. public PropertyContainer Tags Field Value PropertyContainer Properties CancellationToken A token for listening to the cancellation of the MicroThread. public CancellationToken CancellationToken { get; } Property Value CancellationToken Current Gets the current micro thread (self). public static MicroThread? Current { get; } Property Value MicroThread The current micro thread (self). Exception Gets the exception that was thrown by this MicroThread. public Exception? Exception { get; } Property Value Exception The exception. Flags Gets the MicroThread flags. public MicroThreadFlags Flags { get; } Property Value MicroThreadFlags The flags. Id Gets the id of this MicroThread. public long Id { get; } Property Value long The id. IsOver Indicates whether the MicroThread is terminated or not, either in Completed, Canceled or Failed status. public bool IsOver { get; } Property Value bool Name Gets or sets the name of this MicroThread. public string? Name { get; set; } Property Value string The name. Priority Gets or sets the priority of this MicroThread. public long Priority { get; set; } Property Value long The priority. ScheduleMode Gets or sets the MicroThread scheduling mode. public ScheduleMode ScheduleMode { get; set; } Property Value ScheduleMode The scheduling mode. Scheduler Gets the scheduler associated with this MicroThread. public Scheduler Scheduler { get; } Property Value Scheduler The scheduler associated with this MicroThread. State Gets the state of this MicroThread. public MicroThreadState State { get; } Property Value MicroThreadState The state of this MicroThread. Methods Cancel() Cancels the MicroThread. public void Cancel() Migrate(Scheduler) public void Migrate(Scheduler scheduler) Parameters scheduler Scheduler Remove() public void Remove() Run() Yields to this MicroThread. public Task Run() Returns Task Task. Start(Func<Task>, ScheduleMode) Starts this MicroThread with the specified function. public void Start(Func<Task> microThreadFunction, ScheduleMode scheduleMode = ScheduleMode.Last) Parameters microThreadFunction Func<Task> The micro thread function. scheduleMode ScheduleMode The schedule mode. Exceptions InvalidOperationException MicroThread was already started before."
  },
  "api/Stride.Core.MicroThreading.MicroThreadEvent.html": {
    "href": "api/Stride.Core.MicroThreading.MicroThreadEvent.html",
    "title": "Enum MicroThreadEvent | Stride API",
    "summary": "Enum MicroThreadEvent Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public enum MicroThreadEvent Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields CallbackEnd = 3 CallbackStart = 2 MicroThreadEnd = 1 MicroThreadStart = 0"
  },
  "api/Stride.Core.MicroThreading.MicroThreadFlags.html": {
    "href": "api/Stride.Core.MicroThreading.MicroThreadFlags.html",
    "title": "Enum MicroThreadFlags | Stride API",
    "summary": "Enum MicroThreadFlags Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll [Flags] public enum MicroThreadFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields IgnoreExceptions = 1 If a faulted MicroThread is not being waited on, do not propgate exception outside of Run(). If an exception happens in a MicroThread, two things can happen. Either something was waiting on it (i.e. with WhenAll(params MicroThread[])), in that case exception will be propagated to waiting code. Otherwise, exception will be rethrow outside of Run(). This flags allows exception to be ignored even if nothing was waiting on it. None = 0"
  },
  "api/Stride.Core.MicroThreading.MicroThreadLocal-1.html": {
    "href": "api/Stride.Core.MicroThreading.MicroThreadLocal-1.html",
    "title": "Class MicroThreadLocal<T> | Stride API",
    "summary": "Class MicroThreadLocal<T> Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll Provides microthread-local storage of data. public class MicroThreadLocal<T> where T : class Type Parameters T Type of data stored. Inheritance object MicroThreadLocal<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors MicroThreadLocal() Initializes a new instance of the MicroThreadLocal<T> class. public MicroThreadLocal() MicroThreadLocal(Func<T>?) Initializes a new instance of the MicroThreadLocal<T> class. public MicroThreadLocal(Func<T>? valueFactory) Parameters valueFactory Func<T> The value factory invoked to create a value when Value is retrieved before having been previously initialized. Properties IsValueCreated public bool IsValueCreated { get; } Property Value bool Value Gets or sets the value for the current microthread. public T? Value { get; set; } Property Value T The value for the current microthread. Methods ClearValue() public void ClearValue()"
  },
  "api/Stride.Core.MicroThreading.MicroThreadProfilingKeys.html": {
    "href": "api/Stride.Core.MicroThreading.MicroThreadProfilingKeys.html",
    "title": "Class MicroThreadProfilingKeys | Stride API",
    "summary": "Class MicroThreadProfilingKeys Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public static class MicroThreadProfilingKeys Inheritance object MicroThreadProfilingKeys Fields ProfilingKey public static readonly ProfilingKey ProfilingKey Field Value ProfilingKey"
  },
  "api/Stride.Core.MicroThreading.MicroThreadState.html": {
    "href": "api/Stride.Core.MicroThreading.MicroThreadState.html",
    "title": "Enum MicroThreadState | Stride API",
    "summary": "Enum MicroThreadState Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public enum MicroThreadState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Canceled = 4 Completed = 3 Failed = 5 None = 0 Running = 2 Starting = 1"
  },
  "api/Stride.Core.MicroThreading.MicroThreadSynchronizationContext.html": {
    "href": "api/Stride.Core.MicroThreading.MicroThreadSynchronizationContext.html",
    "title": "Class MicroThreadSynchronizationContext | Stride API",
    "summary": "Class MicroThreadSynchronizationContext Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public class MicroThreadSynchronizationContext : SynchronizationContext Inheritance object SynchronizationContext MicroThreadSynchronizationContext Inherited Members SynchronizationContext.IsWaitNotificationRequired() SynchronizationContext.OperationCompleted() SynchronizationContext.OperationStarted() SynchronizationContext.Send(SendOrPostCallback, object) SynchronizationContext.SetSynchronizationContext(SynchronizationContext) SynchronizationContext.SetWaitNotificationRequired() SynchronizationContext.Wait(nint[], bool, int) SynchronizationContext.WaitHelper(nint[], bool, int) SynchronizationContext.Current Extension Methods UnsafeUtilities.As<T>(object?) Constructors MicroThreadSynchronizationContext(MicroThread) public MicroThreadSynchronizationContext(MicroThread microThread) Parameters microThread MicroThread Methods CreateCopy() When overridden in a derived class, creates a copy of the synchronization context. public override SynchronizationContext CreateCopy() Returns SynchronizationContext A new SynchronizationContext object. Post(SendOrPostCallback, object?) When overridden in a derived class, dispatches an asynchronous message to a synchronization context. public override void Post(SendOrPostCallback d, object? state) Parameters d SendOrPostCallback The SendOrPostCallback delegate to call. state object The object passed to the delegate."
  },
  "api/Stride.Core.MicroThreading.MicroThreadYieldAwaiter.html": {
    "href": "api/Stride.Core.MicroThreading.MicroThreadYieldAwaiter.html",
    "title": "Struct MicroThreadYieldAwaiter | Stride API",
    "summary": "Struct MicroThreadYieldAwaiter Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public readonly struct MicroThreadYieldAwaiter : INotifyCompletion Implements INotifyCompletion Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors MicroThreadYieldAwaiter(MicroThread) public MicroThreadYieldAwaiter(MicroThread microThread) Parameters microThread MicroThread Properties IsCompleted public bool IsCompleted { get; } Property Value bool Methods GetAwaiter() public MicroThreadYieldAwaiter GetAwaiter() Returns MicroThreadYieldAwaiter GetResult() public void GetResult() OnCompleted(Action) Schedules the continuation action that's invoked when the instance completes. public void OnCompleted(Action continuation) Parameters continuation Action The action to invoke when the operation completes. Exceptions ArgumentNullException The continuation argument is null (Nothing in Visual Basic)."
  },
  "api/Stride.Core.MicroThreading.MicrothreadProxySynchronizationContext.html": {
    "href": "api/Stride.Core.MicroThreading.MicrothreadProxySynchronizationContext.html",
    "title": "Class MicrothreadProxySynchronizationContext | Stride API",
    "summary": "Class MicrothreadProxySynchronizationContext Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public class MicrothreadProxySynchronizationContext : SynchronizationContext Inheritance object SynchronizationContext MicrothreadProxySynchronizationContext Inherited Members SynchronizationContext.CreateCopy() SynchronizationContext.IsWaitNotificationRequired() SynchronizationContext.OperationCompleted() SynchronizationContext.OperationStarted() SynchronizationContext.Post(SendOrPostCallback, object) SynchronizationContext.Send(SendOrPostCallback, object) SynchronizationContext.SetSynchronizationContext(SynchronizationContext) SynchronizationContext.SetWaitNotificationRequired() SynchronizationContext.Wait(nint[], bool, int) SynchronizationContext.WaitHelper(nint[], bool, int) SynchronizationContext.Current Extension Methods UnsafeUtilities.As<T>(object?) Constructors MicrothreadProxySynchronizationContext(MicroThread?) public MicrothreadProxySynchronizationContext(MicroThread? microThread) Parameters microThread MicroThread"
  },
  "api/Stride.Core.MicroThreading.ScheduleMode.html": {
    "href": "api/Stride.Core.MicroThreading.ScheduleMode.html",
    "title": "Enum ScheduleMode | Stride API",
    "summary": "Enum ScheduleMode Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public enum ScheduleMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields First = 0 Last = 1"
  },
  "api/Stride.Core.MicroThreading.Scheduler.html": {
    "href": "api/Stride.Core.MicroThreading.Scheduler.html",
    "title": "Class Scheduler | Stride API",
    "summary": "Class Scheduler Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll Scheduler that manage a group of cooperating MicroThread. public class Scheduler : IDisposable Inheritance object Scheduler Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks Microthreading provides a way to execute many small execution contexts who cooperatively yield to each others. Constructors Scheduler() Initializes a new instance of the Scheduler class. public Scheduler() Properties Current Gets the scheduler associated with current micro thread. public static Scheduler? Current { get; } Property Value Scheduler The scheduler associated with current micro thread. CurrentMicroThread Gets the current micro thread (self). public static MicroThread? CurrentMicroThread { get; } Property Value MicroThread The current micro thread (self). FrameChannel protected Channel<int> FrameChannel { get; } Property Value Channel<int> MicroThreads Gets the list of every non-stopped micro threads. public ICollection<MicroThread> MicroThreads { get; } Property Value ICollection<MicroThread> The list of every non-stopped micro threads. RunningMicroThread Gets the current running micro thread in this scheduler through Run(). public MicroThread? RunningMicroThread { get; } Property Value MicroThread The current running micro thread in this scheduler. Methods Add(Func<Task>, MicroThreadFlags) Creates a micro thread out of the specified function and schedules it as last micro thread to run in this scheduler. Note that in case of multithreaded scheduling, it might start before this function returns. public MicroThread Add(Func<Task> microThreadFunction, MicroThreadFlags flags = MicroThreadFlags.None) Parameters microThreadFunction Func<Task> The function to create a micro thread from. flags MicroThreadFlags The flags. Returns MicroThread A micro thread. Create() Creates a new empty micro thread, that could later be started with Start(Func<Task>, ScheduleMode). public MicroThread Create() Returns MicroThread A new empty micro thread. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool NextFrame() Yields execution until next frame. public ChannelMicroThreadAwaiter<int> NextFrame() Returns ChannelMicroThreadAwaiter<int> Task that will resume next frame. Run() Runs until no runnable tasklets left. This function is reentrant. public void Run() WhenAll(params MicroThread[]) Task that will completes when all MicroThread executions are completed. public Task WhenAll(params MicroThread[] microThreads) Parameters microThreads MicroThread[] The micro threads. Returns Task A task that will complete when all micro threads are complete. Yield() Yields execution. If any other micro thread is pending, it will be run now and current micro thread will be scheduled as last. public static MicroThreadYieldAwaiter Yield() Returns MicroThreadYieldAwaiter Task that will resume later during same frame. Events MicroThreadCallbackEnd public event EventHandler<SchedulerThreadEventArgs>? MicroThreadCallbackEnd Event Type EventHandler<SchedulerThreadEventArgs> MicroThreadCallbackStart public event EventHandler<SchedulerThreadEventArgs>? MicroThreadCallbackStart Event Type EventHandler<SchedulerThreadEventArgs> MicroThreadEnded public event EventHandler<SchedulerThreadEventArgs>? MicroThreadEnded Event Type EventHandler<SchedulerThreadEventArgs> MicroThreadStarted public event EventHandler<SchedulerThreadEventArgs>? MicroThreadStarted Event Type EventHandler<SchedulerThreadEventArgs>"
  },
  "api/Stride.Core.MicroThreading.SchedulerThreadEventArgs.html": {
    "href": "api/Stride.Core.MicroThreading.SchedulerThreadEventArgs.html",
    "title": "Class SchedulerThreadEventArgs | Stride API",
    "summary": "Class SchedulerThreadEventArgs Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll Provides data for the MicroThreadStarted, MicroThreadEnded, MicroThreadCallbackStart and MicroThreadCallbackEnd events. public class SchedulerThreadEventArgs : EventArgs Inheritance object EventArgs SchedulerThreadEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors SchedulerThreadEventArgs(MicroThread, int) Initializes a new instance of the SchedulerThreadEventArgs class. public SchedulerThreadEventArgs(MicroThread microThread, int threadId) Parameters microThread MicroThread The micro thread. threadId int The managed thread identifier. Properties MicroThread Gets the MicroThread this event concerns. public MicroThread MicroThread { get; } Property Value MicroThread The micro thread. ThreadId Gets the ManagedThreadId active when this event happened. public int ThreadId { get; } Property Value int The managed thread identifier."
  },
  "api/Stride.Core.MicroThreading.ScriptFlags.html": {
    "href": "api/Stride.Core.MicroThreading.ScriptFlags.html",
    "title": "Enum ScriptFlags | Stride API",
    "summary": "Enum ScriptFlags Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll [Flags] public enum ScriptFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AssemblyFirstStartup = 2 Automatically run on assembly first startup (not executed if assembly is reloaded). AssemblyStartup = 1 Automatically run on assembly startup. AssemblyUnload = 4 Automatically run on assembly unload. KeepAliveWhenUnload = 8 MicroThread won't be killed if assembly is unloaded (including reload). None = 0 Empty value."
  },
  "api/Stride.Core.MicroThreading.StrideScriptAttribute.html": {
    "href": "api/Stride.Core.MicroThreading.StrideScriptAttribute.html",
    "title": "Class StrideScriptAttribute | Stride API",
    "summary": "Class StrideScriptAttribute Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method)] public class StrideScriptAttribute : Attribute Inheritance object Attribute StrideScriptAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors StrideScriptAttribute(ScriptFlags) public StrideScriptAttribute(ScriptFlags flags = ScriptFlags.None) Parameters flags ScriptFlags Properties Flags public ScriptFlags Flags { get; set; } Property Value ScriptFlags"
  },
  "api/Stride.Core.MicroThreading.SwitchToAwaiter.html": {
    "href": "api/Stride.Core.MicroThreading.SwitchToAwaiter.html",
    "title": "Class SwitchToAwaiter | Stride API",
    "summary": "Class SwitchToAwaiter Namespace Stride.Core.MicroThreading Assembly Stride.Core.MicroThreading.dll public class SwitchToAwaiter : INotifyCompletion Inheritance object SwitchToAwaiter Implements INotifyCompletion Extension Methods UnsafeUtilities.As<T>(object?) Constructors SwitchToAwaiter(Scheduler) public SwitchToAwaiter(Scheduler scheduler) Parameters scheduler Scheduler Properties IsCompleted public bool IsCompleted { get; } Property Value bool Methods GetAwaiter() public SwitchToAwaiter GetAwaiter() Returns SwitchToAwaiter GetResult() public IDisposable GetResult() Returns IDisposable OnCompleted(Action) Schedules the continuation action that's invoked when the instance completes. public void OnCompleted(Action continuation) Parameters continuation Action The action to invoke when the operation completes. Exceptions ArgumentNullException The continuation argument is null (Nothing in Visual Basic)."
  },
  "api/Stride.Core.MicroThreading.html": {
    "href": "api/Stride.Core.MicroThreading.html",
    "title": "Namespace Stride.Core.MicroThreading | Stride API",
    "summary": "Namespace Stride.Core.MicroThreading Classes AsyncAutoResetEvent AsyncSignal ChannelMicroThreadAwaiter<T> Channel<T> Provides a communication mechanism between MicroThread. MicroThread Represents an execution context managed by a Scheduler, that can cooperatively yield execution to another MicroThread at any point (usually using async calls). MicroThreadLocal<T> Provides microthread-local storage of data. MicroThreadProfilingKeys MicroThreadSynchronizationContext MicrothreadProxySynchronizationContext Scheduler Scheduler that manage a group of cooperating MicroThread. SchedulerThreadEventArgs Provides data for the MicroThreadStarted, MicroThreadEnded, MicroThreadCallbackStart and MicroThreadCallbackEnd events. StrideScriptAttribute SwitchToAwaiter Structs MicroThreadYieldAwaiter Enums ChannelPreference MicroThreadEvent MicroThreadFlags MicroThreadState ScheduleMode ScriptFlags"
  },
  "api/Stride.Core.ModuleInitializerAttribute.html": {
    "href": "api/Stride.Core.ModuleInitializerAttribute.html",
    "title": "Class ModuleInitializerAttribute | Stride API",
    "summary": "Class ModuleInitializerAttribute Namespace Stride.Core Assembly Stride.Core.dll [AttributeUsage(AttributeTargets.Method)] public class ModuleInitializerAttribute : Attribute Inheritance object Attribute ModuleInitializerAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors ModuleInitializerAttribute() public ModuleInitializerAttribute() ModuleInitializerAttribute(int) public ModuleInitializerAttribute(int order) Parameters order int Properties Order public int Order { get; } Property Value int"
  },
  "api/Stride.Core.NativeLibraryHelper.html": {
    "href": "api/Stride.Core.NativeLibraryHelper.html",
    "title": "Class NativeLibraryHelper | Stride API",
    "summary": "Class NativeLibraryHelper Namespace Stride.Core Assembly Stride.Core.dll Provides helper methods for locating, preloading, registering, and unloading native libraries and executables across different platforms. public static class NativeLibraryHelper Inheritance object NativeLibraryHelper Remarks NativeLibraryHelper is designed to support scenarios where managed assemblies depend on platform-specific native binaries, such as when distributing .NET assemblies with associated CPU-architecture-specific libraries. It abstracts the complexity of locating and loading these native libraries from various runtime and environment-specific locations, and ensures that libraries are loaded and unloaded in a thread-safe manner. Methods in this class are particularly useful for applications that need to dynamically resolve and manage native dependencies at runtime, such as plugins or cross-platform frameworks. Methods LocateExecutable(string, Type) Locates the full path to a native executable file by searching known locations and runtime-specific directories. public static string LocateExecutable(string executableName, Type ownerType) Parameters executableName string The name of the executable file to locate, including the extension. ownerType Type The type whose assembly is used to determine runtime-specific search paths for the executable. Returns string The full path to the located executable file. Remarks This method is typically used to resolve platform-specific native binaries required by managed code. Exceptions FileNotFoundException Thrown if the executable file cannot be found in any of the searched locations. PreloadLibrary(string, Type) Try to preload a native library. public static void PreloadLibrary(string libraryName, Type ownerType) Parameters libraryName string The name of the library, without the extension. ownerType Type The Type whose Assembly location is related to the native library. This is needed because GetCallingAssembly() cannot be used, as it might be wrong due to optimizations. Remarks Preloading native libraries can be useful when we want to have a .NET assembly for the AnyCPU platform, and an associated CPU-specific native library. By preloading the native library, we ensure that it is loaded before any P/Invoke calls, so those calls use the already loaded library instead of trying to load it again. Exceptions DllNotFoundException The library with name libraryName could not be loaded. RegisterDependency(string) Registers a native library as a dependency. public static void RegisterDependency(string libraryPath) Parameters libraryPath string The full path to the native library. Exceptions ArgumentNullException libraryPath is null. Unload(string) Unloads a native library that was loaded previously by PreloadLibrary(string, Type). public static void Unload(string libraryName) Parameters libraryName string The name of the library to unload. UnloadAll() Unloads all native libraries that were loaded previously by PreloadLibrary(string, Type). public static void UnloadAll()"
  },
  "api/Stride.Core.ObjectCollector.html": {
    "href": "api/Stride.Core.ObjectCollector.html",
    "title": "Struct ObjectCollector | Stride API",
    "summary": "Struct ObjectCollector Namespace Stride.Core Assembly Stride.Core.dll A struct to collect objects implementing the IDisposable, or IReferencable interfaces, or pointers to memory allocated with Allocate(int, int), so they can be disposed in bulk at a later time. public struct ObjectCollector : IDisposable Implements IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Count Gets the number of elements collected to be disposed. public readonly int Count { get; } Property Value int Methods Add<T>(T) Adds an object implementing the IDisposable or IReferencable interfaces, or a nint to an object allocated using Allocate(int, int) to the list of the objects to dispose. public T Add<T>(T objectToDispose) where T : notnull Parameters objectToDispose T The object to add to the collector to be disposed at a later time. Returns T Type Parameters T The type of the object to add. Exceptions ArgumentException objectToDispose does not implement the interface IDisposable, IReferencable, and is not a valid memory pointer allocated by Allocate(int, int). Dispose() Disposes all the objects collected by this collector and clears the list. The collector can still be used for collecting. public readonly void Dispose() EnsureValid() Ensures this collector is ready to be used for collecting object instances. public void EnsureValid() RemoveAndDispose<T>(ref T) Removes an object from this collector and disposes it immediately, setting the reference to null. public readonly void RemoveAndDispose<T>(ref T objectToDispose) where T : notnull Parameters objectToDispose T The object to remove and dispose. Type Parameters T Remove<T>(T) Removes a disposable object from the list of the objects to dispose. public readonly void Remove<T>(T objectToDispose) where T : notnull Parameters objectToDispose T The object to be removed from the list of objects to dispose. Type Parameters T The type of the object to remove."
  },
  "api/Stride.Core.ObjectInvalidationCallback-1.html": {
    "href": "api/Stride.Core.ObjectInvalidationCallback-1.html",
    "title": "Delegate ObjectInvalidationCallback<T> | Stride API",
    "summary": "Delegate ObjectInvalidationCallback<T> Namespace Stride.Core Assembly Stride.Core.dll Delegate ObjectInvalidatorCallback used by ObjectInvalidationMetadata. public delegate void ObjectInvalidationCallback<T>(object propertyOwner, PropertyKey<T> propertyKey, T? propertyOldValue) Parameters propertyOwner object The owner of the property that changed. propertyKey PropertyKey<T> The key of the property that changed. propertyOldValue T The value of the property before its modification. Type Parameters T Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.ObjectInvalidationMetadata-1.html": {
    "href": "api/Stride.Core.ObjectInvalidationMetadata-1.html",
    "title": "Class ObjectInvalidationMetadata<T> | Stride API",
    "summary": "Class ObjectInvalidationMetadata<T> Namespace Stride.Core Assembly Stride.Core.dll Metadata used to invalidate an object state after a property value modification. public class ObjectInvalidationMetadata<T> : ObjectInvalidationMetadata Type Parameters T Inheritance object PropertyKeyMetadata ObjectInvalidationMetadata ObjectInvalidationMetadata<T> Inherited Members ObjectInvalidationMetadata.New<T>(ObjectInvalidationCallback<T>) ObjectInvalidationMetadata.NewRef<T>(ObjectInvalidationRefCallback<T>) Extension Methods UnsafeUtilities.As<T>(object?) Constructors ObjectInvalidationMetadata(ObjectInvalidationCallback<T>) Initializes a new instance of the ObjectInvalidationMetadata<T> class. public ObjectInvalidationMetadata(ObjectInvalidationCallback<T> invalidationCallback) Parameters invalidationCallback ObjectInvalidationCallback<T> The object invalidation callback. Exceptions ArgumentNullException Parameter invalidationCallback is null. ObjectInvalidationMetadata(ObjectInvalidationRefCallback<T>) Initializes a new instance of the ObjectInvalidationMetadata<T> class. public ObjectInvalidationMetadata(ObjectInvalidationRefCallback<T> invalidationRefCallback) Parameters invalidationRefCallback ObjectInvalidationRefCallback<T> The object invalidation callback. Exceptions ArgumentNullException Parameter invalidationRefCallback is null. Methods Invalidate(object, PropertyKey, object?) public override void Invalidate(object propertyOwner, PropertyKey propertyKey, object? propertyOldValue) Parameters propertyOwner object propertyKey PropertyKey propertyOldValue object Invalidate(object, PropertyKey<T>, ref T?) public void Invalidate(object propertyOwner, PropertyKey<T> propertyKey, ref T? propertyOldValue) Parameters propertyOwner object propertyKey PropertyKey<T> propertyOldValue T"
  },
  "api/Stride.Core.ObjectInvalidationMetadata.html": {
    "href": "api/Stride.Core.ObjectInvalidationMetadata.html",
    "title": "Class ObjectInvalidationMetadata | Stride API",
    "summary": "Class ObjectInvalidationMetadata Namespace Stride.Core Assembly Stride.Core.dll public abstract class ObjectInvalidationMetadata : PropertyKeyMetadata Inheritance object PropertyKeyMetadata ObjectInvalidationMetadata Derived ObjectInvalidationMetadata<T> Extension Methods UnsafeUtilities.As<T>(object?) Methods Invalidate(object, PropertyKey, object?) public abstract void Invalidate(object propertyOwner, PropertyKey propertyKey, object? propertyOldValue) Parameters propertyOwner object propertyKey PropertyKey propertyOldValue object NewRef<T>(ObjectInvalidationRefCallback<T>) public static ObjectInvalidationMetadata NewRef<T>(ObjectInvalidationRefCallback<T> invalidationRefCallback) Parameters invalidationRefCallback ObjectInvalidationRefCallback<T> Returns ObjectInvalidationMetadata Type Parameters T New<T>(ObjectInvalidationCallback<T>) public static ObjectInvalidationMetadata New<T>(ObjectInvalidationCallback<T> invalidationCallback) Parameters invalidationCallback ObjectInvalidationCallback<T> Returns ObjectInvalidationMetadata Type Parameters T"
  },
  "api/Stride.Core.ObjectInvalidationRefCallback-1.html": {
    "href": "api/Stride.Core.ObjectInvalidationRefCallback-1.html",
    "title": "Delegate ObjectInvalidationRefCallback<T> | Stride API",
    "summary": "Delegate ObjectInvalidationRefCallback<T> Namespace Stride.Core Assembly Stride.Core.dll public delegate void ObjectInvalidationRefCallback<T>(object propertyOwner, PropertyKey<T> propertyKey, ref T? propertyOldValue) Parameters propertyOwner object propertyKey PropertyKey<T> propertyOldValue T Type Parameters T Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Platform.html": {
    "href": "api/Stride.Core.Platform.html",
    "title": "Class Platform | Stride API",
    "summary": "Class Platform Namespace Stride.Core Assembly Stride.Core.dll Platform specific queries and functions. public static class Platform Inheritance object Platform Fields IsRunningDebugAssembly Gets a value indicating whether the running assembly is a debug assembly. public static readonly bool IsRunningDebugAssembly Field Value bool IsWindowsDesktop Gets a value indicating whether the running platform is windows desktop. public static readonly bool IsWindowsDesktop Field Value bool true if this instance is windows desktop; otherwise, false. Type The current running PlatformType. public static readonly PlatformType Type Field Value PlatformType"
  },
  "api/Stride.Core.PlatformFolders.html": {
    "href": "api/Stride.Core.PlatformFolders.html",
    "title": "Class PlatformFolders | Stride API",
    "summary": "Class PlatformFolders Namespace Stride.Core Assembly Stride.Core.dll Folders used for the running platform. public static class PlatformFolders Inheritance object PlatformFolders Fields ApplicationBinaryDirectory The application directory, where assemblies are deployed. It could be read-only on some platforms. public static readonly string ApplicationBinaryDirectory Field Value string ApplicationCacheDirectory The application cache directory, where user can write data that won't be backup. public static readonly string ApplicationCacheDirectory Field Value string ApplicationDataDirectory The application data directory, where data is deployed. It could be read-only on some platforms. public static readonly string ApplicationDataDirectory Field Value string ApplicationExecutablePath Get the path to the application executable. public static readonly string? ApplicationExecutablePath Field Value string Remarks Might be null if start executable is unknown. ApplicationLocalDirectory The application local directory, where user can write local data (included in backup). public static readonly string ApplicationLocalDirectory Field Value string ApplicationRoamingDirectory The application roaming directory, where user can write roaming data (included in backup). public static readonly string ApplicationRoamingDirectory Field Value string ApplicationTemporaryDirectory The Application temporary directory. public static readonly string ApplicationTemporaryDirectory Field Value string TemporaryDirectory The system temporary directory. public static readonly string TemporaryDirectory Field Value string Properties ApplicationDataSubDirectory The (optional) application data subdirectory. If not null or empty, /data will be mounted on ApplicationDataDirectory/ApplicationDataSubDirectory public static string ApplicationDataSubDirectory { get; set; } Property Value string Remarks This property should not be written after the VirtualFileSystem static initialization. If so, an InvalidOperationExeception will be thrown. IsVirtualFileSystemInitialized public static bool IsVirtualFileSystemInitialized { get; } Property Value bool"
  },
  "api/Stride.Core.PlatformType.html": {
    "href": "api/Stride.Core.PlatformType.html",
    "title": "Enum PlatformType | Stride API",
    "summary": "Enum PlatformType Namespace Stride.Core Assembly Stride.Core.dll Defines the platform Stride is running on. [DataContract(\"PlatformType\")] public enum PlatformType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Android = 2 The Android operating system for mobile devices and tablets. Linux = 5 The Linux operating system, typically used for servers and desktops. Shared = 0 This is shared across platforms UWP = 4 The Universal Windows Platform (UWP) for applications that run on Windows 10 and later devices, and XBox gaming consoles. Windows = 1 The Windows operating system for desktop applications. iOS = 3 The iOS operating system for Apple mobile devices such as iPhone and iPad. macOS = 6 The macOS operating system for Apple desktop and laptop computers. Remarks The platform can define the target operating system or environment where the application is running."
  },
  "api/Stride.Core.PropertyContainer.PropertyUpdatedDelegate.html": {
    "href": "api/Stride.Core.PropertyContainer.PropertyUpdatedDelegate.html",
    "title": "Delegate PropertyContainer.PropertyUpdatedDelegate | Stride API",
    "summary": "Delegate PropertyContainer.PropertyUpdatedDelegate Namespace Stride.Core Assembly Stride.Core.dll Property changed delegate. public delegate void PropertyContainer.PropertyUpdatedDelegate(ref PropertyContainer propertyContainer, PropertyKey propertyKey, object newValue, object? oldValue) Parameters propertyContainer PropertyContainer The property container. propertyKey PropertyKey The property key. newValue object The property new value. oldValue object The property old value. Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.PropertyContainer.html": {
    "href": "api/Stride.Core.PropertyContainer.html",
    "title": "Struct PropertyContainer | Stride API",
    "summary": "Struct PropertyContainer Namespace Stride.Core Assembly Stride.Core.dll Represents a container that can hold properties, lightweight to embed (lazy initialized). [DataContract] [DataSerializer(typeof(DictionaryAllSerializer<PropertyContainer, PropertyKey, object>))] public struct PropertyContainer : IDictionary<PropertyKey, object>, ICollection<KeyValuePair<PropertyKey, object>>, IReadOnlyDictionary<PropertyKey, object>, IReadOnlyCollection<KeyValuePair<PropertyKey, object>>, IEnumerable<KeyValuePair<PropertyKey, object>>, IEnumerable Implements IDictionary<PropertyKey, object> ICollection<KeyValuePair<PropertyKey, object>> IReadOnlyDictionary<PropertyKey, object> IReadOnlyCollection<KeyValuePair<PropertyKey, object>> IEnumerable<KeyValuePair<PropertyKey, object>> IEnumerable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Remarks Tag properties system purpose is to allow binding of properties that aren't logically supposed to be in a general class (probably because the property exists only in a higher level part of the engine). A typical example includes source mesh, collision data and various bouding volumes for a Geometry object: including them directly in the low-level Geometry class would be a terrible design decision ! And the other well known solution, which consist of maintaining a Dictionary of object to properties isn't really nice either (especially with non-deterministic object destruction, it's hard to clean it up, would require lot of events). As a result, a specific system has been implemented. A class that could hold such tag properties should have an instance of PropertyContainer as a mutable field member. An cool feature of this system is that if a property doesn't exist, it could be generated during first access from a delegate or come from a default value. Constructors PropertyContainer(object) public PropertyContainer(object owner) Parameters owner object Properties Count Gets the number of properties stored in this container. public int Count { get; } Property Value int The count of properties. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. this[PropertyKey] Gets or sets the element with the specified key. public object this[PropertyKey key] { get; set; } Parameters key PropertyKey The key of the element to get or set. Property Value object The element with the specified key. Exceptions ArgumentNullException key is null. KeyNotFoundException The property is retrieved and key is not found. NotSupportedException The property is set and the IDictionary<TKey, TValue> is read-only. Keys Gets an ICollection<T> containing the keys of the IDictionary<TKey, TValue>. public readonly ICollection<PropertyKey> Keys { get; } Property Value ICollection<PropertyKey> An ICollection<T> containing the keys of the object that implements IDictionary<TKey, TValue>. Owner public readonly object Owner { get; } Property Value object Values Gets an ICollection<T> containing the values in the IDictionary<TKey, TValue>. public readonly ICollection<object> Values { get; } Property Value ICollection<object> An ICollection<T> containing the values in the object that implements IDictionary<TKey, TValue>. Methods AddAccessorProperty(Type, PropertyKey) public static void AddAccessorProperty(Type type, PropertyKey propertyKey) Parameters type Type propertyKey PropertyKey Add<T>(PropertyKey<T>, T) Adds the specified key-value pair. public void Add<T>(PropertyKey<T> key, T value) Parameters key PropertyKey<T> The key. value T The value. Type Parameters T Type of the property key Clear() Removes all items from the ICollection<T>. public readonly void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. ContainsKey(PropertyKey) Determines whether the specified instance contains this key. public readonly bool ContainsKey(PropertyKey key) Parameters key PropertyKey The key. Returns bool true if the specified instance contains this key; otherwise, false. CopyTo(ref PropertyContainer) Copies properties from this instance to a container. public void CopyTo(ref PropertyContainer destination) Parameters destination PropertyContainer The destination. Get(PropertyKey) Gets the specified tag value. public object Get(PropertyKey propertyKey) Parameters propertyKey PropertyKey The tag property. Returns object Value of the tag property GetEnumerator() Gets the key-properties value pairs in this instance. public IEnumerator<KeyValuePair<PropertyKey, object>> GetEnumerator() Returns IEnumerator<KeyValuePair<PropertyKey, object>> GetSafe<T>(PropertyKey<T>) Gets the value of a property key or throw an error if the value was not found public T GetSafe<T>(PropertyKey<T> propertyKey) Parameters propertyKey PropertyKey<T> The property key. Returns T The value associated with this property key. Type Parameters T Type of the property key Exceptions ArgumentNullException propertyKey ArgumentException Unable to retrieve value for [{0}].ToFormat(propertyKey) Get<T>(PropertyKey<T>) Gets the specified tag value. public T? Get<T>(PropertyKey<T> propertyKey) Parameters propertyKey PropertyKey<T> The tag property. Returns T Typed value of the tag property Type Parameters T Type of the tag value Remove(PropertyKey) Removes the element with the specified key from the IDictionary<TKey, TValue>. public bool Remove(PropertyKey propertyKey) Parameters propertyKey PropertyKey Returns bool true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary<TKey, TValue>. Exceptions ArgumentNullException key is null. NotSupportedException The IDictionary<TKey, TValue> is read-only. SetObject(PropertyKey, object) Sets the specified tag value. public void SetObject(PropertyKey propertyKey, object tagValue) Parameters propertyKey PropertyKey The tag property. tagValue object The tag value. Set<T>(PropertyKey<T>, T) Sets the specified tag value. public void Set<T>(PropertyKey<T> propertyKey, T tagValue) Parameters propertyKey PropertyKey<T> The tag property. tagValue T The tag value. Type Parameters T Type of the tag value TryGetValue(PropertyKey, out object) Tries to get a tag value. public bool TryGetValue(PropertyKey propertyKey, out object value) Parameters propertyKey PropertyKey The tag property. value object The value or default vaue if not found Returns bool Returns true if the was found; false otherwise TryGetValue<T>(PropertyKey<T>, out T) Tries to get a tag value. public bool TryGetValue<T>(PropertyKey<T> propertyKey, out T value) Parameters propertyKey PropertyKey<T> The tag property. value T The value or default vaue if not found Returns bool Returns true if the was found; false otherwise Type Parameters T Type of the tag value Events PropertyUpdated Occurs when a property is modified. public event PropertyContainer.PropertyUpdatedDelegate? PropertyUpdated Event Type PropertyContainer.PropertyUpdatedDelegate"
  },
  "api/Stride.Core.PropertyContainerClass.html": {
    "href": "api/Stride.Core.PropertyContainerClass.html",
    "title": "Class PropertyContainerClass | Stride API",
    "summary": "Class PropertyContainerClass Namespace Stride.Core Assembly Stride.Core.dll Class wrapper around PropertyContainer. [DataContract] [DataSerializer(typeof(DictionaryAllSerializer<PropertyContainerClass, PropertyKey, object>))] public class PropertyContainerClass : IDictionary<PropertyKey, object>, ICollection<KeyValuePair<PropertyKey, object>>, IReadOnlyDictionary<PropertyKey, object>, IReadOnlyCollection<KeyValuePair<PropertyKey, object>>, IEnumerable<KeyValuePair<PropertyKey, object>>, IEnumerable Inheritance object PropertyContainerClass Implements IDictionary<PropertyKey, object> ICollection<KeyValuePair<PropertyKey, object>> IReadOnlyDictionary<PropertyKey, object> IReadOnlyCollection<KeyValuePair<PropertyKey, object>> IEnumerable<KeyValuePair<PropertyKey, object>> IEnumerable Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors PropertyContainerClass() public PropertyContainerClass() PropertyContainerClass(object) public PropertyContainerClass(object owner) Parameters owner object Properties Count Gets the number of elements contained in the ICollection<T>. public int Count { get; } Property Value int The number of elements contained in the ICollection<T>. IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. public bool IsReadOnly { get; } Property Value bool true if the ICollection<T> is read-only; otherwise, false. this[PropertyKey] Gets or sets the element with the specified key. public object this[PropertyKey key] { get; set; } Parameters key PropertyKey The key of the element to get or set. Property Value object The element with the specified key. Exceptions ArgumentNullException key is null. KeyNotFoundException The property is retrieved and key is not found. NotSupportedException The property is set and the IDictionary<TKey, TValue> is read-only. Keys Gets an ICollection<T> containing the keys of the IDictionary<TKey, TValue>. public ICollection<PropertyKey> Keys { get; } Property Value ICollection<PropertyKey> An ICollection<T> containing the keys of the object that implements IDictionary<TKey, TValue>. Owner public object Owner { get; } Property Value object Values Gets an ICollection<T> containing the values in the IDictionary<TKey, TValue>. public ICollection<object> Values { get; } Property Value ICollection<object> An ICollection<T> containing the values in the object that implements IDictionary<TKey, TValue>. Methods Add<T>(PropertyKey<T>, T) public void Add<T>(PropertyKey<T> key, T value) Parameters key PropertyKey<T> value T Type Parameters T Clear() Removes all items from the ICollection<T>. public void Clear() Exceptions NotSupportedException The ICollection<T> is read-only. ContainsKey(PropertyKey) Determines whether the IDictionary<TKey, TValue> contains an element with the specified key. public bool ContainsKey(PropertyKey key) Parameters key PropertyKey The key to locate in the IDictionary<TKey, TValue>. Returns bool true if the IDictionary<TKey, TValue> contains an element with the key; otherwise, false. Exceptions ArgumentNullException key is null. CopyTo(ref PropertyContainer) public void CopyTo(ref PropertyContainer destination) Parameters destination PropertyContainer CopyTo(PropertyContainerClass) public void CopyTo(PropertyContainerClass destination) Parameters destination PropertyContainerClass Get(PropertyKey) public object Get(PropertyKey propertyKey) Parameters propertyKey PropertyKey Returns object GetSafe<T>(PropertyKey<T>) public T GetSafe<T>(PropertyKey<T> propertyKey) Parameters propertyKey PropertyKey<T> Returns T Type Parameters T Get<T>(PropertyKey<T>) public T Get<T>(PropertyKey<T> propertyKey) Parameters propertyKey PropertyKey<T> Returns T Type Parameters T Remove(PropertyKey) Removes the element with the specified key from the IDictionary<TKey, TValue>. public bool Remove(PropertyKey propertyKey) Parameters propertyKey PropertyKey Returns bool true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary<TKey, TValue>. Exceptions ArgumentNullException key is null. NotSupportedException The IDictionary<TKey, TValue> is read-only. SetObject(PropertyKey, object) public void SetObject(PropertyKey propertyKey, object tagValue) Parameters propertyKey PropertyKey tagValue object Set<T>(PropertyKey<T>, T) public void Set<T>(PropertyKey<T> propertyKey, T tagValue) Parameters propertyKey PropertyKey<T> tagValue T Type Parameters T TryGetValue(PropertyKey, out object) Gets the value associated with the specified key. public bool TryGetValue(PropertyKey propertyKey, out object value) Parameters propertyKey PropertyKey value object When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized. Returns bool true if the object that implements IDictionary<TKey, TValue> contains an element with the specified key; otherwise, false. Exceptions ArgumentNullException key is null. TryGetValue<T>(PropertyKey<T>, out T) public bool TryGetValue<T>(PropertyKey<T> propertyKey, out T value) Parameters propertyKey PropertyKey<T> value T Returns bool Type Parameters T Events PropertyUpdated public event PropertyContainer.PropertyUpdatedDelegate PropertyUpdated Event Type PropertyContainer.PropertyUpdatedDelegate"
  },
  "api/Stride.Core.PropertyKey-1.html": {
    "href": "api/Stride.Core.PropertyKey-1.html",
    "title": "Class PropertyKey<T> | Stride API",
    "summary": "Class PropertyKey<T> Namespace Stride.Core Assembly Stride.Core.dll A class that represents a typed tag propety. public sealed class PropertyKey<T> : PropertyKey, IComparable Type Parameters T Type of the property Inheritance object PropertyKey PropertyKey<T> Implements IComparable Inherited Members PropertyKey.Name PropertyKey.Metadatas PropertyKey.OwnerType PropertyKey.PropertyType PropertyKey.CompareTo(object) PropertyKey.ToString() Extension Methods UnsafeUtilities.As<T>(object?) Constructors PropertyKey(string, Type, params PropertyKeyMetadata[]) Initializes a new instance of the PropertyKey<T> class. public PropertyKey(string name, Type ownerType, params PropertyKeyMetadata[] metadatas) Parameters name string The name. ownerType Type Type of the owner. metadatas PropertyKeyMetadata[] The metadatas. Properties DefaultValueMetadataT Gets the default value metadata. public DefaultValueMetadata<T> DefaultValueMetadataT { get; } Property Value DefaultValueMetadata<T> IsValueType public override bool IsValueType { get; } Property Value bool ObjectInvalidationMetadataT Gets the object invalidation metadata (may be null). public ObjectInvalidationMetadata<T> ObjectInvalidationMetadataT { get; } Property Value ObjectInvalidationMetadata<T> The object invalidation metadata. ValidateValueMetadataT Gets the validate value metadata (may be null). public ValidateValueMetadata<T> ValidateValueMetadataT { get; } Property Value ValidateValueMetadata<T> The validate value metadata."
  },
  "api/Stride.Core.PropertyKey.html": {
    "href": "api/Stride.Core.PropertyKey.html",
    "title": "Class PropertyKey | Stride API",
    "summary": "Class PropertyKey Namespace Stride.Core Assembly Stride.Core.dll A class that represents a tag propety. [DataContract] [DataSerializer(typeof(PropertyKeySerializer<>), Mode = DataSerializerGenericMode.Type)] public abstract class PropertyKey : IComparable Inheritance object PropertyKey Implements IComparable Derived PropertyKey<T> ParameterKey Extension Methods UnsafeUtilities.As<T>(object?) Constructors PropertyKey(string, Type, Type, params PropertyKeyMetadata[]) Initializes a new instance of the PropertyKey class. protected PropertyKey(string name, Type propertyType, Type ownerType, params PropertyKeyMetadata[] metadatas) Parameters name string The name. propertyType Type Type of the property. ownerType Type Type of the owner. metadatas PropertyKeyMetadata[] The metadatas. Fields name protected string name Field Value string Properties IsValueType public abstract bool IsValueType { get; } Property Value bool Metadatas Gets the metadatas. public PropertyKeyMetadata[] Metadatas { get; } Property Value PropertyKeyMetadata[] Name Gets the name of this key. public string Name { get; init; } Property Value string OwnerType Gets the type of the owner. public Type OwnerType { get; protected set; } Property Value Type The type of the owner. PropertyType Gets the type of the property. public Type PropertyType { get; protected set; } Property Value Type The type of the property. Methods CompareTo(object?) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. public int CompareTo(object? obj) Parameters obj object An object to compare with this instance. Returns int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order. Exceptions ArgumentException obj is not the same type as this instance. SetupMetadata(PropertyKeyMetadata) protected virtual void SetupMetadata(PropertyKeyMetadata metadata) Parameters metadata PropertyKeyMetadata SetupMetadatas() protected virtual void SetupMetadatas() ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.PropertyKeyMetadata.html": {
    "href": "api/Stride.Core.PropertyKeyMetadata.html",
    "title": "Class PropertyKeyMetadata | Stride API",
    "summary": "Class PropertyKeyMetadata Namespace Stride.Core Assembly Stride.Core.dll Specifies metadata for an PropertyKey. public abstract class PropertyKeyMetadata Inheritance object PropertyKeyMetadata Derived AccessorMetadata DefaultValueMetadata ObjectInvalidationMetadata ValidateValueMetadata ParameterKeyValueMetadata DependencyPropertyKeyMetadata Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.ReferenceBase.html": {
    "href": "api/Stride.Core.ReferenceBase.html",
    "title": "Class ReferenceBase | Stride API",
    "summary": "Class ReferenceBase Namespace Stride.Core Assembly Stride.Core.dll Base class for a IReferencable class. public abstract class ReferenceBase : IReferencable Inheritance object ReferenceBase Implements IReferencable Derived Blob Extension Methods ComponentBaseExtensions.KeepReference<T>(T) ComponentBaseExtensions.ReleaseBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveReleaseBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties ReferenceCount Gets the reference count of this instance. public int ReferenceCount { get; } Property Value int The reference count. Methods AddReference() Increments the reference count of this instance. public virtual int AddReference() Returns int The new reference count. Destroy() Releases unmanaged and - optionally - managed resources protected abstract void Destroy() Release() Decrements the reference count of this instance. public virtual int Release() Returns int The new reference count. Remarks When the reference count reaches 0, the component should release / dispose dependent objects."
  },
  "api/Stride.Core.ReferenceEqualityComparer-1.html": {
    "href": "api/Stride.Core.ReferenceEqualityComparer-1.html",
    "title": "Class ReferenceEqualityComparer<T> | Stride API",
    "summary": "Class ReferenceEqualityComparer<T> Namespace Stride.Core Assembly Stride.Core.dll A Comparator to use object.ReferenceEquals(object, object) method. public class ReferenceEqualityComparer<T> : EqualityComparer<T>, IEqualityComparer<T>, IEqualityComparer where T : class Type Parameters T Type of the comparer Inheritance object EqualityComparer<T> ReferenceEqualityComparer<T> Implements IEqualityComparer<T> IEqualityComparer Inherited Members EqualityComparer<T>.Create(Func<T, T, bool>, Func<T, int>) Extension Methods UnsafeUtilities.As<T>(object?) Properties Default Gets the default. public static IEqualityComparer<T> Default { get; } Property Value IEqualityComparer<T> Methods Equals(T?, T?) When overridden in a derived class, determines whether two objects of type T are equal. public override bool Equals(T? x, T? y) Parameters x T The first object to compare. y T The second object to compare. Returns bool true if the specified objects are equal; otherwise, false. GetHashCode(T) When overridden in a derived class, serves as a hash function for the specified object for hashing algorithms and data structures, such as a hash table. public override int GetHashCode(T obj) Parameters obj T The object for which to get a hash code. Returns int A hash code for the specified object. Exceptions ArgumentNullException The type of obj is a reference type and obj is null."
  },
  "api/Stride.Core.Reflection.AbstractObjectInstantiator.html": {
    "href": "api/Stride.Core.Reflection.AbstractObjectInstantiator.html",
    "title": "Class AbstractObjectInstantiator | Stride API",
    "summary": "Class AbstractObjectInstantiator Namespace Stride.Core.Reflection Assembly Stride.Core.Assets.dll public static class AbstractObjectInstantiator Inheritance object AbstractObjectInstantiator Methods CreateConcreteInstance(Type) Creates an instance of a type implementing the specified baseType. public static object CreateConcreteInstance(Type baseType) Parameters baseType Type Returns object An instance of a type implementing the specified baseType. Remarks If baseType is already a concrete type (not an abstract type nor an interface, the method returns an instance of baseType itself. See Also CreateInstance(Type) InitializeTypeBuilderFromType(TypeBuilder, Type) Initializes the typeBuilder using the provided baseType. public static void InitializeTypeBuilderFromType(TypeBuilder typeBuilder, Type baseType) Parameters typeBuilder TypeBuilder The type builder to initialize. baseType Type The base type of the type currently under construction."
  },
  "api/Stride.Core.Reflection.AssemblyCommonCategories.html": {
    "href": "api/Stride.Core.Reflection.AssemblyCommonCategories.html",
    "title": "Class AssemblyCommonCategories | Stride API",
    "summary": "Class AssemblyCommonCategories Namespace Stride.Core.Reflection Assembly Stride.Core.dll Common categories that can be used with AssemblyRegistry public static class AssemblyCommonCategories Inheritance object AssemblyCommonCategories Fields Assets The assembly is containing assets data. public const string Assets = \"assets\" Field Value string Engine The assembly is containing engine data. public const string Engine = \"engine\" Field Value string"
  },
  "api/Stride.Core.Reflection.AssemblyRegisteredEventArgs.html": {
    "href": "api/Stride.Core.Reflection.AssemblyRegisteredEventArgs.html",
    "title": "Class AssemblyRegisteredEventArgs | Stride API",
    "summary": "Class AssemblyRegisteredEventArgs Namespace Stride.Core.Reflection Assembly Stride.Core.dll An event occurring when an assembly is registered with AssemblyRegistry. public class AssemblyRegisteredEventArgs : EventArgs Inheritance object EventArgs AssemblyRegisteredEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssemblyRegisteredEventArgs(Assembly, HashSet<string>) Initializes a new instance of the AssemblyRegisteredEventArgs class. public AssemblyRegisteredEventArgs(Assembly assembly, HashSet<string> categories) Parameters assembly Assembly The assembly. categories HashSet<string> The categories. Properties Assembly Gets the assembly that has been registered. public Assembly Assembly { get; } Property Value Assembly The assembly. Categories Gets the new categories registered for the specified Assembly public HashSet<string> Categories { get; } Property Value HashSet<string> The categories."
  },
  "api/Stride.Core.Reflection.AssemblyRegistry.ScanTypes.html": {
    "href": "api/Stride.Core.Reflection.AssemblyRegistry.ScanTypes.html",
    "title": "Class AssemblyRegistry.ScanTypes | Stride API",
    "summary": "Class AssemblyRegistry.ScanTypes Namespace Stride.Core.Reflection Assembly Stride.Core.dll List types that matches a given AssemblyScanAttribute for a given assembly. public class AssemblyRegistry.ScanTypes Inheritance object AssemblyRegistry.ScanTypes Extension Methods UnsafeUtilities.As<T>(object?) Constructors ScanTypes(Dictionary<Type, List<Type>>) public ScanTypes(Dictionary<Type, List<Type>> types) Parameters types Dictionary<Type, List<Type>> Properties Types public IReadOnlyDictionary<Type, List<Type>> Types { get; } Property Value IReadOnlyDictionary<Type, List<Type>>"
  },
  "api/Stride.Core.Reflection.AssemblyRegistry.html": {
    "href": "api/Stride.Core.Reflection.AssemblyRegistry.html",
    "title": "Class AssemblyRegistry | Stride API",
    "summary": "Class AssemblyRegistry Namespace Stride.Core.Reflection Assembly Stride.Core.dll Provides a basic infrastructure to associate an assembly with some categories and to query and register on new registered assembly event. public static class AssemblyRegistry Inheritance object AssemblyRegistry Methods Find(IEnumerable<string>) Finds registered assemblies that are associated with the specified categories. public static HashSet<Assembly> Find(IEnumerable<string> categories) Parameters categories IEnumerable<string> The categories. Returns HashSet<Assembly> A set of assembly associated with the specified categories. Exceptions ArgumentNullException categories Find(params string[]) Finds registered assemblies that are associated with the specified categories. public static HashSet<Assembly> Find(params string[] categories) Parameters categories string[] The categories. Returns HashSet<Assembly> A set of assemblies associated with the specified categories. Exceptions ArgumentNullException categories FindAll() Finds all registered assemblies. public static HashSet<Assembly> FindAll() Returns HashSet<Assembly> A set of all assembly registered. Exceptions ArgumentNullException categories FindCategories(Assembly) Finds registered categories that are associated with the specified assembly. public static HashSet<string> FindCategories(Assembly assembly) Parameters assembly Assembly The assembly. Returns HashSet<string> A set of category associated with the specified assembly. Exceptions ArgumentNullException categories GetScanTypes(Assembly) public static AssemblyRegistry.ScanTypes? GetScanTypes(Assembly assembly) Parameters assembly Assembly Returns AssemblyRegistry.ScanTypes GetType(string, bool) Gets a type by its typename already loaded in the assembly registry. public static Type? GetType(string fullyQualifiedTypeName, bool throwOnError = true) Parameters fullyQualifiedTypeName string The typename throwOnError bool Returns Type The type instance or null if not found. See Also GetType(string, bool) GetType(string, bool) GetTypeFromAlias(string) Gets a type from its Alias or Name. public static Type? GetTypeFromAlias(string alias) Parameters alias string Returns Type Register(Assembly, IEnumerable<string>) Registers an assembly with the specified categories. public static void Register(Assembly assembly, IEnumerable<string> categories) Parameters assembly Assembly The assembly. categories IEnumerable<string> The categories to associate with this assembly. Exceptions ArgumentNullException assembly or categories Register(Assembly, params string[]) Registers an assembly with the specified categories. public static void Register(Assembly assembly, params string[] categories) Parameters assembly Assembly The assembly. categories string[] The categories to associate with this assembly. Exceptions ArgumentNullException assembly or categories RegisterScanTypes(Assembly, ScanTypes) public static void RegisterScanTypes(Assembly assembly, AssemblyRegistry.ScanTypes types) Parameters assembly Assembly types AssemblyRegistry.ScanTypes Unregister(Assembly) Unregisters the specified assembly. public static void Unregister(Assembly assembly) Parameters assembly Assembly The assembly. Events AssemblyRegistered Occurs when an assembly is registered. public static event EventHandler<AssemblyRegisteredEventArgs>? AssemblyRegistered Event Type EventHandler<AssemblyRegisteredEventArgs> AssemblyUnregistered Occurs when an assembly is registered. public static event EventHandler<AssemblyRegisteredEventArgs>? AssemblyUnregistered Event Type EventHandler<AssemblyRegisteredEventArgs>"
  },
  "api/Stride.Core.Reflection.AssemblyScanAttribute.html": {
    "href": "api/Stride.Core.Reflection.AssemblyScanAttribute.html",
    "title": "Class AssemblyScanAttribute | Stride API",
    "summary": "Class AssemblyScanAttribute Namespace Stride.Core.Reflection Assembly Stride.Core.dll This attribute can be either used on class or interfaces to scan for types inheriting from them, or on an attribute to scan for types having this specific attribute. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Interface)] public class AssemblyScanAttribute : Attribute Inheritance object Attribute AssemblyScanAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Reflection.CollectionItemIdHelper.html": {
    "href": "api/Stride.Core.Reflection.CollectionItemIdHelper.html",
    "title": "Class CollectionItemIdHelper | Stride API",
    "summary": "Class CollectionItemIdHelper Namespace Stride.Core.Reflection Assembly Stride.Core.Assets.dll A helper static class to retrieve CollectionItemIdentifiers from a collection or dictionary through the Stride.Core.Reflection.ShadowObject registry. public static class CollectionItemIdHelper Inheritance object CollectionItemIdHelper Methods GetCollectionItemIds(object) public static CollectionItemIdentifiers GetCollectionItemIds(object instance) Parameters instance object Returns CollectionItemIdentifiers HasCollectionItemIds(object?) public static bool HasCollectionItemIds(object? instance) Parameters instance object Returns bool TryGetCollectionItemIds(object?, out CollectionItemIdentifiers) public static bool TryGetCollectionItemIds(object? instance, out CollectionItemIdentifiers itemIds) Parameters instance object itemIds CollectionItemIdentifiers Returns bool"
  },
  "api/Stride.Core.Reflection.CollectionItemIdentifiers.html": {
    "href": "api/Stride.Core.Reflection.CollectionItemIdentifiers.html",
    "title": "Class CollectionItemIdentifiers | Stride API",
    "summary": "Class CollectionItemIdentifiers Namespace Stride.Core.Reflection Assembly Stride.Core.Assets.dll A container for item identifiers and similar metadata that is associated to a collection or a dictionary. public class CollectionItemIdentifiers : IEnumerable<KeyValuePair<object, ItemId>>, IEnumerable Inheritance object CollectionItemIdentifiers Implements IEnumerable<KeyValuePair<object, ItemId>> IEnumerable Extension Methods EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Properties DeletedCount Gets the number of deleted identifiers that are being kept in this CollectionItemIdentifiers. public int DeletedCount { get; } Property Value int DeletedItems Gets the list of ItemId corresponding to deleted items that are being kept in this CollectionItemIdentifiers. public IEnumerable<ItemId> DeletedItems { get; } Property Value IEnumerable<ItemId> this[object] Gets or sets the ItemId corresponding to the given key. public ItemId this[object key] { get; set; } Parameters key object The key for which to retrieve the ItemId. Property Value ItemId The ItemId corresponding to the given key. KeyCount Gets the number of keys/identifiers in this CollectionItemIdentifiers. public int KeyCount { get; } Property Value int Methods Add(object, ItemId) public void Add(object key, ItemId id) Parameters key object id ItemId Clear() public void Clear() CloneInto(CollectionItemIdentifiers, IReadOnlyDictionary<object, object>?) public void CloneInto(CollectionItemIdentifiers target, IReadOnlyDictionary<object, object>? referenceTypeClonedKeys) Parameters target CollectionItemIdentifiers referenceTypeClonedKeys IReadOnlyDictionary<object, object> ContainsKey(object) public bool ContainsKey(object key) Parameters key object Returns bool Delete(object, bool) public ItemId Delete(object key, bool markAsDeleted = true) Parameters key object markAsDeleted bool Returns ItemId DeleteAndShift(int, bool) public ItemId DeleteAndShift(int index, bool markAsDeleted = true) Parameters index int markAsDeleted bool Returns ItemId GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<KeyValuePair<object, ItemId>> GetEnumerator() Returns IEnumerator<KeyValuePair<object, ItemId>> An enumerator that can be used to iterate through the collection. GetKey(ItemId) public object? GetKey(ItemId itemId) Parameters itemId ItemId Returns object Insert(int, ItemId) public void Insert(int index, ItemId id) Parameters index int id ItemId IsDeleted(ItemId) public bool IsDeleted(ItemId itemId) Parameters itemId ItemId Returns bool MarkAsDeleted(ItemId) public void MarkAsDeleted(ItemId id) Parameters id ItemId Set(object, ItemId) public void Set(object key, ItemId id) Parameters key object id ItemId TryGet(object, out ItemId) public bool TryGet(object key, out ItemId id) Parameters key object id ItemId Returns bool UnmarkAsDeleted(ItemId) public void UnmarkAsDeleted(ItemId id) Parameters id ItemId Validate(bool) public void Validate(bool isList) Parameters isList bool"
  },
  "api/Stride.Core.Reflection.CustomAttributeExtensions.html": {
    "href": "api/Stride.Core.Reflection.CustomAttributeExtensions.html",
    "title": "Class CustomAttributeExtensions | Stride API",
    "summary": "Class CustomAttributeExtensions Namespace Stride.Core.Reflection Assembly Stride.Core.dll public static class CustomAttributeExtensions Inheritance object CustomAttributeExtensions Methods GetCustomAttributeEx(Assembly, Type) public static Attribute? GetCustomAttributeEx(this Assembly assembly, Type attributeType) Parameters assembly Assembly attributeType Type Returns Attribute GetCustomAttributeEx<T>(Assembly) public static T? GetCustomAttributeEx<T>(this Assembly assembly) where T : Attribute Parameters assembly Assembly Returns T Type Parameters T GetCustomAttributesEx(Assembly, Type) public static IEnumerable<Attribute> GetCustomAttributesEx(this Assembly assembly, Type attributeType) Parameters assembly Assembly attributeType Type Returns IEnumerable<Attribute> GetCustomAttributesEx<T>(Assembly) public static IEnumerable<T> GetCustomAttributesEx<T>(this Assembly assembly) where T : Attribute Parameters assembly Assembly Returns IEnumerable<T> Type Parameters T"
  },
  "api/Stride.Core.Reflection.IObjectFactory.html": {
    "href": "api/Stride.Core.Reflection.IObjectFactory.html",
    "title": "Interface IObjectFactory | Stride API",
    "summary": "Interface IObjectFactory Namespace Stride.Core.Reflection Assembly Stride.Core.dll Interface of a factory that can create instances of a type. public interface IObjectFactory Extension Methods UnsafeUtilities.As<T>(object?) Methods New(Type) Creates a new instance of a type. object New(Type type) Parameters type Type The type of the instance to create. Returns object A new default instance of a type."
  },
  "api/Stride.Core.Reflection.ItemId.html": {
    "href": "api/Stride.Core.Reflection.ItemId.html",
    "title": "Struct ItemId | Stride API",
    "summary": "Struct ItemId Namespace Stride.Core.Reflection Assembly Stride.Core.Assets.dll Represents the identifier of an item in a collection or an entry in a dictionary. [DataContract] public readonly struct ItemId : IComparable<ItemId>, IEquatable<ItemId> Implements IComparable<ItemId> IEquatable<ItemId> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ItemId(ObjectId) Initializes a new instance of the ItemId structure from an ObjectId. public ItemId(ObjectId id) Parameters id ObjectId The ObjectId from which to create this ItemId. ItemId(byte[]) Initializes a new instance of the ItemId structure from an array of bytes. public ItemId(byte[] bytes) Parameters bytes byte[] The array of bytes from which to create this ItemId. Properties Empty Gets an ItemId representing an empty or non-existing item. public static ItemId Empty { get; } Property Value ItemId Methods CompareTo(ItemId) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. public int CompareTo(ItemId other) Parameters other ItemId An object to compare with this instance. Returns int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order. Equals(ItemId) Indicates whether the current object is equal to another object of the same type. public bool Equals(ItemId other) Parameters other ItemId An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. New() Generates a new random ItemId. public static ItemId New() Returns ItemId Parse(string) Parses an ItemId from a string. public static ItemId Parse(string input) Parameters input string The input string to parse. Returns ItemId An ItemId corresponding to the parsed string. Exceptions FormatException The given string cannot be parsed as an ItemId. ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. TryParse(string, out ItemId) Attempts to parse an ItemId from a string. public static bool TryParse(string input, out ItemId itemId) Parameters input string The input string to parse. itemId ItemId The resulting ItemId. Returns bool True if the string could be successfully parsed, False otherwise. Operators operator ==(ItemId, ItemId) public static bool operator ==(ItemId left, ItemId right) Parameters left ItemId right ItemId Returns bool operator !=(ItemId, ItemId) public static bool operator !=(ItemId left, ItemId right) Parameters left ItemId right ItemId Returns bool"
  },
  "api/Stride.Core.Reflection.ModuleRuntimeHelpers.html": {
    "href": "api/Stride.Core.Reflection.ModuleRuntimeHelpers.html",
    "title": "Class ModuleRuntimeHelpers | Stride API",
    "summary": "Class ModuleRuntimeHelpers Namespace Stride.Core.Reflection Assembly Stride.Core.dll public static class ModuleRuntimeHelpers Inheritance object ModuleRuntimeHelpers Methods RunModuleConstructor(Module) public static void RunModuleConstructor(Module module) Parameters module Module"
  },
  "api/Stride.Core.Reflection.ObjectFactoryRegistry.html": {
    "href": "api/Stride.Core.Reflection.ObjectFactoryRegistry.html",
    "title": "Class ObjectFactoryRegistry | Stride API",
    "summary": "Class ObjectFactoryRegistry Namespace Stride.Core.Reflection Assembly Stride.Core.dll A registry of IObjectFactory used to instantiate instances of types used at design-time. public static class ObjectFactoryRegistry Inheritance object ObjectFactoryRegistry Methods CanCreateInstance(Type) Returns true if the object of the specific type can be created. public static bool CanCreateInstance(Type objectType) Parameters objectType Type Type of the object. Returns bool True if it can be created, false otherwise. GetFactory(Type) Gets the factory corresponding to the given object type, if available. public static IObjectFactory? GetFactory(Type objectType) Parameters objectType Type The object type for which to retrieve the factory. Returns IObjectFactory The factory corresponding to the given object type if available, null otherwise. Exceptions ArgumentNullException objectType NewInstance(Type) Creates a default instance for an object type. public static object NewInstance(Type objectType) Parameters objectType Type Type of the object. Returns object A new default instance of an object. NewInstance<T>() Creates a default instance for an object type. public static T NewInstance<T>() Returns T A new instance of T Type Parameters T Type of the object to create"
  },
  "api/Stride.Core.Reflection.OverridePostfixes.html": {
    "href": "api/Stride.Core.Reflection.OverridePostfixes.html",
    "title": "Class OverridePostfixes | Stride API",
    "summary": "Class OverridePostfixes Namespace Stride.Core.Reflection Assembly Stride.Core.Assets.dll public static class OverridePostfixes Inheritance object OverridePostfixes Methods ToText(OverrideType) public static string ToText(this OverrideType type) Parameters type OverrideType Returns string"
  },
  "api/Stride.Core.Reflection.OverrideTarget.html": {
    "href": "api/Stride.Core.Reflection.OverrideTarget.html",
    "title": "Enum OverrideTarget | Stride API",
    "summary": "Enum OverrideTarget Namespace Stride.Core.Reflection Assembly Stride.Core.Assets.dll Describes what is targeted by an override information. public enum OverrideTarget Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Content = 0 The content itself. Item = 1 An item of the content if it's a collection, or a value of the content if it's a dictionary. Key = 2 A key of the content. This is valid only for dictionary."
  },
  "api/Stride.Core.Reflection.OverrideType.html": {
    "href": "api/Stride.Core.Reflection.OverrideType.html",
    "title": "Enum OverrideType | Stride API",
    "summary": "Enum OverrideType Namespace Stride.Core.Reflection Assembly Stride.Core.Assets.dll A Type of override used on a member value. [Flags] public enum OverrideType Extension Methods OverridePostfixes.ToText(OverrideType) UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Base = 0 The value is taken from a base value or this instance if no base (default). New = 1 The value is new and overridden locally. Base value is ignored. Sealed = 2 The value is sealed and cannot be changed by inherited instances."
  },
  "api/Stride.Core.Reflection.html": {
    "href": "api/Stride.Core.Reflection.html",
    "title": "Namespace Stride.Core.Reflection | Stride API",
    "summary": "Namespace Stride.Core.Reflection Classes AbstractObjectInstantiator AssemblyCommonCategories Common categories that can be used with AssemblyRegistry AssemblyRegisteredEventArgs An event occurring when an assembly is registered with AssemblyRegistry. AssemblyRegistry Provides a basic infrastructure to associate an assembly with some categories and to query and register on new registered assembly event. AssemblyRegistry.ScanTypes List types that matches a given AssemblyScanAttribute for a given assembly. AssemblyScanAttribute This attribute can be either used on class or interfaces to scan for types inheriting from them, or on an attribute to scan for types having this specific attribute. CollectionItemIdHelper A helper static class to retrieve CollectionItemIdentifiers from a collection or dictionary through the Stride.Core.Reflection.ShadowObject registry. CollectionItemIdentifiers A container for item identifiers and similar metadata that is associated to a collection or a dictionary. CustomAttributeExtensions ModuleRuntimeHelpers ObjectFactoryRegistry A registry of IObjectFactory used to instantiate instances of types used at design-time. OverridePostfixes Structs ItemId Represents the identifier of an item in a collection or an entry in a dictionary. Interfaces IObjectFactory Interface of a factory that can create instances of a type. Enums OverrideTarget Describes what is targeted by an override information. OverrideType A Type of override used on a member value."
  },
  "api/Stride.Core.RuntimeIdHelper.html": {
    "href": "api/Stride.Core.RuntimeIdHelper.html",
    "title": "Class RuntimeIdHelper | Stride API",
    "summary": "Class RuntimeIdHelper Namespace Stride.Core Assembly Stride.Core.dll Extension methods to get a runtime unique id from a live object. public static class RuntimeIdHelper Inheritance object RuntimeIdHelper Methods ToRuntimeId(object) Computes an unique runtime id (32bits) valid for the specified object. public static int ToRuntimeId(object instance) Parameters instance object Returns int An unique runtime identifier (32bits)"
  },
  "api/Stride.Core.ScalarStyle.html": {
    "href": "api/Stride.Core.ScalarStyle.html",
    "title": "Enum ScalarStyle | Stride API",
    "summary": "Enum ScalarStyle Namespace Stride.Core Assembly Stride.Core.dll Specifies the style used for textual serialization of scalars. public enum ScalarStyle Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Any = 0 Let the emitter choose the style. DoubleQuoted = 3 The double-quoted scalar style. Folded = 5 The folded scalar style. Literal = 4 The literal scalar style. Plain = 1 The plain scalar style. SingleQuoted = 2 The single-quoted scalar style."
  },
  "api/Stride.Core.Serialization.ArchiveMode.html": {
    "href": "api/Stride.Core.Serialization.ArchiveMode.html",
    "title": "Enum ArchiveMode | Stride API",
    "summary": "Enum ArchiveMode Namespace Stride.Core.Serialization Assembly Stride.Core.dll Enumerates the different mode of serialization (either serialization or deserialization). public enum ArchiveMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Deserialize = 1 The serializer is in deserialize mode. Serialize = 0 The serializer is in serialize mode."
  },
  "api/Stride.Core.Serialization.AssemblySerializerEntry.html": {
    "href": "api/Stride.Core.Serialization.AssemblySerializerEntry.html",
    "title": "Struct AssemblySerializerEntry | Stride API",
    "summary": "Struct AssemblySerializerEntry Namespace Stride.Core.Serialization Assembly Stride.Core.dll An entry to a serialized object. public struct AssemblySerializerEntry Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors AssemblySerializerEntry(ObjectId, Type, Type) Initializes a new instance of the AssemblySerializerEntry struct. public AssemblySerializerEntry(ObjectId id, Type objectType, Type serializerType) Parameters id ObjectId objectType Type serializerType Type Fields Id The id of the object. public readonly ObjectId Id Field Value ObjectId ObjectType The type of the object. public readonly Type ObjectType Field Value Type SerializerType The type of the serialized object. public readonly Type SerializerType Field Value Type"
  },
  "api/Stride.Core.Serialization.AssemblySerializerFactoryAttribute.html": {
    "href": "api/Stride.Core.Serialization.AssemblySerializerFactoryAttribute.html",
    "title": "Class AssemblySerializerFactoryAttribute | Stride API",
    "summary": "Class AssemblySerializerFactoryAttribute Namespace Stride.Core.Serialization Assembly Stride.Core.dll Used internally by assembly processor when generating serializer factories. public class AssemblySerializerFactoryAttribute Inheritance object AssemblySerializerFactoryAttribute Extension Methods UnsafeUtilities.As<T>(object?) Fields Type The type of the serializer factory. public Type Type Field Value Type"
  },
  "api/Stride.Core.Serialization.AssemblySerializers.DataContractAlias.html": {
    "href": "api/Stride.Core.Serialization.AssemblySerializers.DataContractAlias.html",
    "title": "Struct AssemblySerializers.DataContractAlias | Stride API",
    "summary": "Struct AssemblySerializers.DataContractAlias Namespace Stride.Core.Serialization Assembly Stride.Core.dll public struct AssemblySerializers.DataContractAlias Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors DataContractAlias(string, Type, bool) public DataContractAlias(string name, Type type, bool isAlias) Parameters name string type Type isAlias bool Fields IsAlias True if generated from a DataAliasAttribute, false if generated from a DataContractAttribute. public bool IsAlias Field Value bool Name public string Name Field Value string Type public Type Type Field Value Type"
  },
  "api/Stride.Core.Serialization.AssemblySerializers.html": {
    "href": "api/Stride.Core.Serialization.AssemblySerializers.html",
    "title": "Class AssemblySerializers | Stride API",
    "summary": "Class AssemblySerializers Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class AssemblySerializers Inheritance object AssemblySerializers Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssemblySerializers(Assembly) public AssemblySerializers(Assembly assembly) Parameters assembly Assembly Properties Assembly public Assembly Assembly { get; } Property Value Assembly DataContractAliases public List<AssemblySerializers.DataContractAlias> DataContractAliases { get; } Property Value List<AssemblySerializers.DataContractAlias> Modules public List<Module> Modules { get; } Property Value List<Module> Profiles public Dictionary<string, AssemblySerializersPerProfile> Profiles { get; } Property Value Dictionary<string, AssemblySerializersPerProfile> Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Serialization.AssemblySerializersPerProfile.html": {
    "href": "api/Stride.Core.Serialization.AssemblySerializersPerProfile.html",
    "title": "Class AssemblySerializersPerProfile | Stride API",
    "summary": "Class AssemblySerializersPerProfile Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class AssemblySerializersPerProfile : Collection<AssemblySerializerEntry>, IList<AssemblySerializerEntry>, ICollection<AssemblySerializerEntry>, IReadOnlyList<AssemblySerializerEntry>, IReadOnlyCollection<AssemblySerializerEntry>, IEnumerable<AssemblySerializerEntry>, IList, ICollection, IEnumerable Inheritance object Collection<AssemblySerializerEntry> AssemblySerializersPerProfile Implements IList<AssemblySerializerEntry> ICollection<AssemblySerializerEntry> IReadOnlyList<AssemblySerializerEntry> IReadOnlyCollection<AssemblySerializerEntry> IEnumerable<AssemblySerializerEntry> IList ICollection IEnumerable Inherited Members Collection<AssemblySerializerEntry>.Add(AssemblySerializerEntry) Collection<AssemblySerializerEntry>.Clear() Collection<AssemblySerializerEntry>.ClearItems() Collection<AssemblySerializerEntry>.Contains(AssemblySerializerEntry) Collection<AssemblySerializerEntry>.CopyTo(AssemblySerializerEntry[], int) Collection<AssemblySerializerEntry>.GetEnumerator() Collection<AssemblySerializerEntry>.IndexOf(AssemblySerializerEntry) Collection<AssemblySerializerEntry>.Insert(int, AssemblySerializerEntry) Collection<AssemblySerializerEntry>.InsertItem(int, AssemblySerializerEntry) Collection<AssemblySerializerEntry>.Remove(AssemblySerializerEntry) Collection<AssemblySerializerEntry>.RemoveAt(int) Collection<AssemblySerializerEntry>.RemoveItem(int) Collection<AssemblySerializerEntry>.SetItem(int, AssemblySerializerEntry) Collection<AssemblySerializerEntry>.Count Collection<AssemblySerializerEntry>.this[int] Collection<AssemblySerializerEntry>.Items Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Serialization.AttachedReference.html": {
    "href": "api/Stride.Core.Serialization.AttachedReference.html",
    "title": "Class AttachedReference | Stride API",
    "summary": "Class AttachedReference Namespace Stride.Core.Serialization Assembly Stride.Core.Serialization.dll Stores the object reference information, so that it is easy to work on partially loaded or CPU version of assets with ContentManager. public class AttachedReference : IReference Inheritance object AttachedReference Implements IReference Extension Methods UnsafeUtilities.As<T>(object?) Fields Data Data representation (useful if your object is a GPU object but you want to manipulate a CPU version of it). This needs to be manually interpreted by a custom DataSerializer<T> implementation. public object Data Field Value object Id The asset unique identifier. public AssetId Id Field Value AssetId IsProxy If yes, this object won't be recursively saved in a separate chunk by ContentManager. Use this if you only care about the Url reference. public bool IsProxy Field Value bool Url The asset URL of the referenced data. public string Url Field Value string Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Core.Serialization.AttachedReferenceManager.html": {
    "href": "api/Stride.Core.Serialization.AttachedReferenceManager.html",
    "title": "Class AttachedReferenceManager | Stride API",
    "summary": "Class AttachedReferenceManager Namespace Stride.Core.Serialization Assembly Stride.Core.Serialization.dll Manage object reference information externally, not stored in the object but in a separate AttachedReference object. public static class AttachedReferenceManager Inheritance object AttachedReferenceManager Methods CreateProxyObject(Type, AssetId, string) Creates a proxy object with AttachedReference designing it as a proxy with a given id and location (that can be used with ContentManager). This allows to construct and save object references without actually loading them. public static object CreateProxyObject(Type type, AssetId id, string location) Parameters type Type The type. id AssetId The identifier. location string The location. Returns object CreateProxyObject<T>(AssetId, string) Creates a proxy object with AttachedReference designing it as a proxy with a given id and location (that can be used with ContentManager). This allows to construct and save object references without actually loading them. public static T CreateProxyObject<T>(AssetId id, string location) where T : class, new() Parameters id AssetId The identifier. location string The location. Returns T Type Parameters T CreateProxyObject<T>(IReference) Creates a proxy object with AttachedReference designing it as a proxy with a given id and location (that can be used with ContentManager). This allows to construct and save object references without actually loading them. public static T CreateProxyObject<T>(IReference reference) where T : class, new() Parameters reference IReference The content reference. Returns T T. Type Parameters T Exceptions ArgumentNullException reference GetAttachedReference(object?) Gets the reference info of attached to a given object, if it exists. public static AttachedReference? GetAttachedReference(object? obj) Parameters obj object The object for which to get the attached reference. Can be null, in this case this method returns null. Returns AttachedReference The AttachedReference attached to the given object if available, null otherwise. GetOrCreateAttachedReference(object) Gets or creates the object reference info of a given object. public static AttachedReference GetOrCreateAttachedReference(object obj) Parameters obj object The object. Returns AttachedReference GetUrl(object) Gets the URL of a given object. public static string? GetUrl(object obj) Parameters obj object The object. Returns string The URL. SetUrl(object, string) Sets the URL of a given object. public static void SetUrl(object obj, string url) Parameters obj object The object. url string The URL."
  },
  "api/Stride.Core.Serialization.BinarySerializationReader.html": {
    "href": "api/Stride.Core.Serialization.BinarySerializationReader.html",
    "title": "Class BinarySerializationReader | Stride API",
    "summary": "Class BinarySerializationReader Namespace Stride.Core.Serialization Assembly Stride.Core.dll Implements SerializationStream as a binary reader. public class BinarySerializationReader : SerializationStream Inheritance object SerializationStream BinarySerializationReader Inherited Members SerializationStream.BufferTLSSize SerializationStream.UnderlyingStream SerializationStream.Context Extension Methods SerializerExtensions.ReadBoolean(SerializationStream) SerializerExtensions.ReadByte(SerializationStream) SerializerExtensions.ReadBytes(SerializationStream, int) SerializerExtensions.ReadChar(SerializationStream) SerializerExtensions.ReadDouble(SerializationStream) SerializerExtensions.ReadInt16(SerializationStream) SerializerExtensions.ReadInt32(SerializationStream) SerializerExtensions.ReadInt64(SerializationStream) SerializerExtensions.ReadSByte(SerializationStream) SerializerExtensions.ReadSingle(SerializationStream) SerializerExtensions.ReadString(SerializationStream) SerializerExtensions.ReadUInt16(SerializationStream) SerializerExtensions.ReadUInt32(SerializationStream) SerializerExtensions.ReadUInt64(SerializationStream) SerializerExtensions.Read<T>(SerializationStream) SerializerExtensions.SerializeExtended<T>(SerializationStream, T, ArchiveMode, DataSerializer<T>?) SerializerExtensions.SerializeExtended<T>(SerializationStream, ref T, ArchiveMode, DataSerializer<T>?) SerializerExtensions.Serialize<T>(SerializationStream, ref T) SerializerExtensions.Serialize<T>(SerializationStream, ref T, ArchiveMode) SerializerExtensions.Write(SerializationStream, bool) SerializerExtensions.Write(SerializationStream, byte) SerializerExtensions.Write(SerializationStream, byte[], int, int) SerializerExtensions.Write(SerializationStream, char) SerializerExtensions.Write(SerializationStream, double) SerializerExtensions.Write(SerializationStream, short) SerializerExtensions.Write(SerializationStream, int) SerializerExtensions.Write(SerializationStream, long) SerializerExtensions.Write(SerializationStream, sbyte) SerializerExtensions.Write(SerializationStream, float) SerializerExtensions.Write(SerializationStream, string) SerializerExtensions.Write(SerializationStream, ushort) SerializerExtensions.Write(SerializationStream, uint) SerializerExtensions.Write(SerializationStream, ulong) SerializerExtensions.Write<T>(SerializationStream, T) UnsafeUtilities.As<T>(object?) Constructors BinarySerializationReader(Stream) Initializes a new instance of the BinarySerializationReader class. public BinarySerializationReader(Stream inputStream) Parameters inputStream Stream The input stream to read from. Methods Flush() Flushes all recent writes (for better batching). Please note that if only Serialize has been used (no PopTag()), Flush() should be called manually. public override void Flush() Serialize(ref bool) Serializes the specified boolean value. public override void Serialize(ref bool value) Parameters value bool The value to serialize Serialize(ref byte) Serializes the specified byte value. public override void Serialize(ref byte value) Parameters value byte The value to serialize Serialize(byte[], int, int) Serializes the specified byte array. public override void Serialize(byte[] values, int offset, int count) Parameters values byte[] The buffer to serialize. offset int The starting offset in the buffer to begin serializing. count int The size, in bytes, to serialize. Serialize(ref char) Serializes the specified char value. public override void Serialize(ref char value) Parameters value char The value to serialize Serialize(ref double) Serializes the specified double value. public override void Serialize(ref double value) Parameters value double The value to serialize Serialize(ref short) Serializes the specified short value. public override void Serialize(ref short value) Parameters value short The value to serialize Serialize(ref int) Serializes the specified integer value. public override void Serialize(ref int value) Parameters value int The value to serialize Serialize(ref long) Serializes the specified long value. public override void Serialize(ref long value) Parameters value long The value to serialize Serialize(ref sbyte) Serializes the specified signed byte value. public override void Serialize(ref sbyte value) Parameters value sbyte The value to serialize Serialize(ref float) Serializes the specified float value. public override void Serialize(ref float value) Parameters value float The value to serialize Serialize(Span<byte>) Serializes the specified memory area. public override void Serialize(Span<byte> buffer) Parameters buffer Span<byte> Serialize(ref string) Serializes the specified string value. public override void Serialize(ref string value) Parameters value string The value to serialize Serialize(ref ushort) Serializes the specified ushort value. public override void Serialize(ref ushort value) Parameters value ushort The value to serialize Serialize(ref uint) Serializes the specified unsigned integer value. public override void Serialize(ref uint value) Parameters value uint The value to serialize Serialize(ref ulong) Serializes the specified unsigned long value. public override void Serialize(ref ulong value) Parameters value ulong The value to serialize"
  },
  "api/Stride.Core.Serialization.BinarySerializationWriter.html": {
    "href": "api/Stride.Core.Serialization.BinarySerializationWriter.html",
    "title": "Class BinarySerializationWriter | Stride API",
    "summary": "Class BinarySerializationWriter Namespace Stride.Core.Serialization Assembly Stride.Core.dll Implements SerializationStream as a binary writer. public class BinarySerializationWriter : SerializationStream Inheritance object SerializationStream BinarySerializationWriter Derived HashSerializationWriter Inherited Members SerializationStream.BufferTLSSize SerializationStream.UnderlyingStream SerializationStream.Context Extension Methods SerializerExtensions.ReadBoolean(SerializationStream) SerializerExtensions.ReadByte(SerializationStream) SerializerExtensions.ReadBytes(SerializationStream, int) SerializerExtensions.ReadChar(SerializationStream) SerializerExtensions.ReadDouble(SerializationStream) SerializerExtensions.ReadInt16(SerializationStream) SerializerExtensions.ReadInt32(SerializationStream) SerializerExtensions.ReadInt64(SerializationStream) SerializerExtensions.ReadSByte(SerializationStream) SerializerExtensions.ReadSingle(SerializationStream) SerializerExtensions.ReadString(SerializationStream) SerializerExtensions.ReadUInt16(SerializationStream) SerializerExtensions.ReadUInt32(SerializationStream) SerializerExtensions.ReadUInt64(SerializationStream) SerializerExtensions.Read<T>(SerializationStream) SerializerExtensions.SerializeExtended<T>(SerializationStream, T, ArchiveMode, DataSerializer<T>?) SerializerExtensions.SerializeExtended<T>(SerializationStream, ref T, ArchiveMode, DataSerializer<T>?) SerializerExtensions.Serialize<T>(SerializationStream, ref T) SerializerExtensions.Serialize<T>(SerializationStream, ref T, ArchiveMode) SerializerExtensions.Write(SerializationStream, bool) SerializerExtensions.Write(SerializationStream, byte) SerializerExtensions.Write(SerializationStream, byte[], int, int) SerializerExtensions.Write(SerializationStream, char) SerializerExtensions.Write(SerializationStream, double) SerializerExtensions.Write(SerializationStream, short) SerializerExtensions.Write(SerializationStream, int) SerializerExtensions.Write(SerializationStream, long) SerializerExtensions.Write(SerializationStream, sbyte) SerializerExtensions.Write(SerializationStream, float) SerializerExtensions.Write(SerializationStream, string) SerializerExtensions.Write(SerializationStream, ushort) SerializerExtensions.Write(SerializationStream, uint) SerializerExtensions.Write(SerializationStream, ulong) SerializerExtensions.Write<T>(SerializationStream, T) UnsafeUtilities.As<T>(object?) Constructors BinarySerializationWriter(Stream) Initializes a new instance of the BinarySerializationWriter class. public BinarySerializationWriter(Stream outputStream) Parameters outputStream Stream The output stream. Methods Flush() Flushes all recent writes (for better batching). Please note that if only Serialize has been used (no PopTag()), Flush() should be called manually. public override void Flush() Serialize(ref bool) Serializes the specified boolean value. public override void Serialize(ref bool value) Parameters value bool The value to serialize Serialize(ref byte) Serializes the specified byte value. public override void Serialize(ref byte value) Parameters value byte The value to serialize Serialize(byte[], int, int) Serializes the specified byte array. public override void Serialize(byte[] values, int offset, int count) Parameters values byte[] The buffer to serialize. offset int The starting offset in the buffer to begin serializing. count int The size, in bytes, to serialize. Serialize(ref char) Serializes the specified char value. public override void Serialize(ref char value) Parameters value char The value to serialize Serialize(ref double) Serializes the specified double value. public override void Serialize(ref double value) Parameters value double The value to serialize Serialize(ref short) Serializes the specified short value. public override void Serialize(ref short value) Parameters value short The value to serialize Serialize(ref int) Serializes the specified integer value. public override void Serialize(ref int value) Parameters value int The value to serialize Serialize(ref long) Serializes the specified long value. public override void Serialize(ref long value) Parameters value long The value to serialize Serialize(ref sbyte) Serializes the specified signed byte value. public override void Serialize(ref sbyte value) Parameters value sbyte The value to serialize Serialize(ref float) Serializes the specified float value. public override void Serialize(ref float value) Parameters value float The value to serialize Serialize(Span<byte>) Serializes the specified memory area. public override void Serialize(Span<byte> buffer) Parameters buffer Span<byte> Serialize(ref string) Serializes the specified string value. public override void Serialize(ref string value) Parameters value string The value to serialize Serialize(ref ushort) Serializes the specified ushort value. public override void Serialize(ref ushort value) Parameters value ushort The value to serialize Serialize(ref uint) Serializes the specified unsigned integer value. public override void Serialize(ref uint value) Parameters value uint The value to serialize Serialize(ref ulong) Serializes the specified unsigned long value. public override void Serialize(ref ulong value) Parameters value ulong The value to serialize"
  },
  "api/Stride.Core.Serialization.ClassDataSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.ClassDataSerializer-1.html",
    "title": "Class ClassDataSerializer<T> | Stride API",
    "summary": "Class ClassDataSerializer<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll public abstract class ClassDataSerializer<T> : DataSerializer<T> where T : class, new() Type Parameters T Inheritance object DataSerializer DataSerializer<T> ClassDataSerializer<T> Derived ParameterCollectionHashSerializer ParameterCollection.Serializer Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods PreSerialize(ref T, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it."
  },
  "api/Stride.Core.Serialization.ContentRefOutOfSyncException.html": {
    "href": "api/Stride.Core.Serialization.ContentRefOutOfSyncException.html",
    "title": "Class ContentRefOutOfSyncException | Stride API",
    "summary": "Class ContentRefOutOfSyncException Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class ContentRefOutOfSyncException : InvalidOperationException, ISerializable Inheritance object Exception SystemException InvalidOperationException ContentRefOutOfSyncException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState Extension Methods UnsafeUtilities.As<T>(object?) Constructors ContentRefOutOfSyncException() public ContentRefOutOfSyncException()"
  },
  "api/Stride.Core.Serialization.Contents.ChunkHeader.html": {
    "href": "api/Stride.Core.Serialization.Contents.ChunkHeader.html",
    "title": "Class ChunkHeader | Stride API",
    "summary": "Class ChunkHeader Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll This class describes the header of an asset serialized in a blob file. Its (serialized) size has to remain constant public sealed class ChunkHeader Inheritance object ChunkHeader Extension Methods UnsafeUtilities.As<T>(object?) Constructors ChunkHeader() public ChunkHeader() Fields CurrentVersion public const int CurrentVersion = 1 Field Value int Magic public const int Magic = 1128812107 Field Value int Properties OffsetToObject public int OffsetToObject { get; set; } Property Value int OffsetToReferences public int OffsetToReferences { get; set; } Property Value int Type public string Type { get; set; } Property Value string Version public int Version { get; set; } Property Value int Methods Read(SerializationStream) public static ChunkHeader Read(SerializationStream stream) Parameters stream SerializationStream Returns ChunkHeader Write(SerializationStream) public void Write(SerializationStream stream) Parameters stream SerializationStream"
  },
  "api/Stride.Core.Serialization.Contents.ChunkReference.html": {
    "href": "api/Stride.Core.Serialization.Contents.ChunkReference.html",
    "title": "Struct ChunkReference | Stride API",
    "summary": "Struct ChunkReference Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll Describe a reference between an object and another. [DataSerializer(typeof(ChunkReference.Serializer))] public readonly struct ChunkReference : IEquatable<ChunkReference> Implements IEquatable<ChunkReference> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks This class is IEquatable, and equality is true if and only if Location and ObjType properties match Constructors ChunkReference(Type, string) public ChunkReference(Type objectType, string location) Parameters objectType Type location string Fields Location public readonly string Location Field Value string NullIdentifier public const int NullIdentifier = -1 Field Value int ObjectType public readonly Type ObjectType Field Value Type Methods Equals(ChunkReference) Indicates whether the current object is equal to another object of the same type. public bool Equals(ChunkReference other) Parameters other ChunkReference An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(ChunkReference, ChunkReference) public static bool operator ==(ChunkReference left, ChunkReference right) Parameters left ChunkReference right ChunkReference Returns bool operator !=(ChunkReference, ChunkReference) public static bool operator !=(ChunkReference left, ChunkReference right) Parameters left ChunkReference right ChunkReference Returns bool"
  },
  "api/Stride.Core.Serialization.Contents.ContentData.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentData.html",
    "title": "Class ContentData | Stride API",
    "summary": "Class ContentData Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll [DataSerializer(typeof(EmptyDataSerializer<ContentData>))] [DataContract(Inherited = true)] public abstract class ContentData : IContentData Inheritance object ContentData Implements IContentData Extension Methods UnsafeUtilities.As<T>(object?) Properties Url public string Url { get; set; } Property Value string"
  },
  "api/Stride.Core.Serialization.Contents.ContentIndexMap.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentIndexMap.html",
    "title": "Class ContentIndexMap | Stride API",
    "summary": "Class ContentIndexMap Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll public sealed class ContentIndexMap : DictionaryStore<string, ObjectId>, IContentIndexMap, IDisposable Inheritance object Store<KeyValuePair<string, ObjectId>> DictionaryStore<string, ObjectId> ContentIndexMap Implements IContentIndexMap IDisposable Inherited Members DictionaryStore<string, ObjectId>.GetValues() DictionaryStore<string, ObjectId>.Contains(string) DictionaryStore<string, ObjectId>.this[string] DictionaryStore<string, ObjectId>.TryGetValue(string, out ObjectId) DictionaryStore<string, ObjectId>.SearchValues(Func<KeyValuePair<string, ObjectId>, bool>) Store<KeyValuePair<string, ObjectId>>.UseTransaction Store<KeyValuePair<string, ObjectId>>.AutoLoadNewValues Store<KeyValuePair<string, ObjectId>>.Dispose() Store<KeyValuePair<string, ObjectId>>.AddValues(IEnumerable<KeyValuePair<string, ObjectId>>) Store<KeyValuePair<string, ObjectId>>.AddValue(KeyValuePair<string, ObjectId>) Store<KeyValuePair<string, ObjectId>>.Save() Store<KeyValuePair<string, ObjectId>>.Reset() Store<KeyValuePair<string, ObjectId>>.LoadNewValues() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Methods CreateInMemory() public static ContentIndexMap CreateInMemory() Returns ContentIndexMap GetMergedIdMap() public IEnumerable<KeyValuePair<string, ObjectId>> GetMergedIdMap() Returns IEnumerable<KeyValuePair<string, ObjectId>> GetTransactionIdMap() public IEnumerable<KeyValuePair<string, ObjectId>> GetTransactionIdMap() Returns IEnumerable<KeyValuePair<string, ObjectId>> Load(string, bool) public static ContentIndexMap Load(string indexFile, bool isReadOnly = false) Parameters indexFile string isReadOnly bool Returns ContentIndexMap NewTool(string) public static ContentIndexMap NewTool(string indexName) Parameters indexName string Returns ContentIndexMap ReadEntries(Stream) protected override List<KeyValuePair<string, ObjectId>> ReadEntries(Stream localStream) Parameters localStream Stream Returns List<KeyValuePair<string, ObjectId>> WriteEntry(Stream, KeyValuePair<string, ObjectId>) protected override void WriteEntry(Stream localStream, KeyValuePair<string, ObjectId> value) Parameters localStream Stream value KeyValuePair<string, ObjectId>"
  },
  "api/Stride.Core.Serialization.Contents.ContentManager.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentManager.html",
    "title": "Class ContentManager | Stride API",
    "summary": "Class ContentManager Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll Loads and saves assets. public sealed class ContentManager : IContentManager Inheritance object ContentManager Implements IContentManager Extension Methods UrlReferenceContentManagerExtenstions.Exists(IContentManager, IUrlReference) UrlReferenceContentManagerExtenstions.Get<T>(IContentManager, UrlReference<T>) UrlReferenceContentManagerExtenstions.IsLoaded(IContentManager, IUrlReference, bool) UrlReferenceContentManagerExtenstions.LoadAsync<T>(IContentManager, UrlReference<T>, ContentManagerLoaderSettings?) UrlReferenceContentManagerExtenstions.Load<T>(IContentManager, UrlReference<T>, ContentManagerLoaderSettings?) UrlReferenceContentManagerExtenstions.OpenAsStream(IContentManager, UrlReference, StreamFlags) UrlReferenceContentManagerExtenstions.Unload(IContentManager, IUrlReference) UnsafeUtilities.As<T>(object?) Constructors ContentManager(IDatabaseFileProviderService) public ContentManager(IDatabaseFileProviderService fileProvider) Parameters fileProvider IDatabaseFileProviderService ContentManager(IServiceRegistry) public ContentManager(IServiceRegistry services) Parameters services IServiceRegistry Properties FileProvider public DatabaseFileProvider FileProvider { get; } Property Value DatabaseFileProvider Serializer Gets the serializer. public ContentSerializer Serializer { get; } Property Value ContentSerializer The serializer. Methods Exists(string) Check if the specified asset exists. public bool Exists(string url) Parameters url string The URL. Returns bool true if the specified asset url exists, false otherwise. Get(Type, string) Gets a previously loaded asset from its URL. public object? Get(Type type, string url) Parameters type Type The type of asset to retrieve. url string The URL of the asset to retrieve. Returns object The loaded asset, or null if the asset has not been loaded. Remarks This function does not increase the reference count on the asset. GetStats() Computes statistics about the assets that are currently loaded. This method is intended to be used for debug purpose only. public ContentManagerStats GetStats() Returns ContentManagerStats The statistics. Get<T>(string) Gets a previously loaded asset from its URL. public T? Get<T>(string url) where T : class Parameters url string The URL of the asset to retrieve. Returns T The loaded asset, or null if the asset has not been loaded. Type Parameters T The type of asset to retrieve. Remarks This function does not increase the reference count on the asset. IsLoaded(string, bool) Gets whether an asset with the given URL is currently loaded. public bool IsLoaded(string url, bool loadedManuallyOnly = false) Parameters url string The URL to check. loadedManuallyOnly bool If true, this method will return true only if an asset with the given URL has been manually loaded via Load(Type, string, ContentManagerLoaderSettings?), and not if the asset has been only loaded indirectly from another asset. Returns bool True if an asset with the given URL is currently loaded, false otherwise. Load(Type, string, ContentManagerLoaderSettings?) Loads content from the specified URL. public object Load(Type type, string url, ContentManagerLoaderSettings? settings = null) Parameters type Type The type. url string The URL. settings ContentManagerLoaderSettings The settings. Returns object The loaded content. Remarks If the asset is already loaded, it just increases the reference count of the asset and return the same instance. Exceptions ArgumentNullException url LoadAsync(Type, string, ContentManagerLoaderSettings?) Loads an asset from the specified URL asynchronously. public Task<object> LoadAsync(Type type, string url, ContentManagerLoaderSettings? settings = null) Parameters type Type The type. url string The URL. settings ContentManagerLoaderSettings The settings. Returns Task<object> The loaded content. Remarks If the asset is already loaded, it just increases the reference count of the asset and return the same instance. LoadAsync<T>(string, ContentManagerLoaderSettings?) Loads an asset from the specified URL asynchronously. public Task<T> LoadAsync<T>(string url, ContentManagerLoaderSettings? settings = null) where T : class Parameters url string The URL to load from. settings ContentManagerLoaderSettings The settings. If null, fallback to Default. Returns Task<T> The loaded content. Type Parameters T The content type. Remarks If the asset is already loaded, it just increases the reference count of the asset and return the same instance. Load<T>(string, ContentManagerLoaderSettings?) Loads content from the specified URL. public T Load<T>(string url, ContentManagerLoaderSettings? settings = null) where T : class Parameters url string The URL to load from. settings ContentManagerLoaderSettings The settings. If null, fallback to Default. Returns T The loaded content. Type Parameters T The content type. Remarks If the asset is already loaded, it just increases the reference count of the asset and return the same instance. OpenAsStream(string, StreamFlags) Opens the specified URL as a stream used for custom raw asset loading. public Stream OpenAsStream(string url, StreamFlags streamFlags = StreamFlags.None) Parameters url string The URL to the raw asset. streamFlags StreamFlags The type of stream needed Returns Stream A stream to the raw asset. Reload(object, string?, ContentManagerLoaderSettings?) Reloads a content. If possible, same recursively referenced objects are reused. public bool Reload(object obj, string? newUrl = null, ContentManagerLoaderSettings? settings = null) Parameters obj object The object to reload. newUrl string The url of the new object to load. This allows to replace an asset by another one, or to handle renamed content. settings ContentManagerLoaderSettings The loader settings. Returns bool True if it could be reloaded, false otherwise. Exceptions InvalidOperationException Content not loaded through this ContentManager. ReloadAsync(object, string?, ContentManagerLoaderSettings?) Reloads a content asynchronously. If possible, same recursively referenced objects are reused. public Task<bool> ReloadAsync(object obj, string? newUrl = null, ContentManagerLoaderSettings? settings = null) Parameters obj object The object to reload. newUrl string The url of the new object to load. This allows to replace an asset by another one, or to handle renamed content. settings ContentManagerLoaderSettings The loader settings. Returns Task<bool> A task that completes when the content has been reloaded. The result of the task is True if it could be reloaded, false otherwise. Exceptions InvalidOperationException Content not loaded through this ContentManager. Save(string, object, Type?) Saves an asset at a specific URL. public void Save(string url, object asset, Type? storageType = null) Parameters url string The URL. asset object The asset. storageType Type The custom storage type to use. Use null as default. Exceptions ArgumentNullException url or asset TryGetAssetUrl(object, out string?) public bool TryGetAssetUrl(object obj, out string? url) Parameters obj object url string Returns bool TryGetLoadedAsset(string, out object?) public bool TryGetLoadedAsset(string url, out object? asset) Parameters url string asset object Returns bool Unload(object) Unloads the specified asset. public void Unload(object obj) Parameters obj object The object to unload. Exceptions InvalidOperationException Content not loaded through this ContentManager. Unload(string) Unloads the asset at the specified URL. public void Unload(string url) Parameters url string The URL. Exceptions InvalidOperationException Content not loaded through this ContentManager."
  },
  "api/Stride.Core.Serialization.Contents.ContentManagerLoaderSettings.ContentFilterDelegate.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentManagerLoaderSettings.ContentFilterDelegate.html",
    "title": "Delegate ContentManagerLoaderSettings.ContentFilterDelegate | Stride API",
    "summary": "Delegate ContentManagerLoaderSettings.ContentFilterDelegate Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll public delegate void ContentManagerLoaderSettings.ContentFilterDelegate(ILoadableReference reference, ref bool shouldBeLoaded) Parameters reference ILoadableReference shouldBeLoaded bool Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Serialization.Contents.ContentManagerLoaderSettings.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentManagerLoaderSettings.html",
    "title": "Class ContentManagerLoaderSettings | Stride API",
    "summary": "Class ContentManagerLoaderSettings Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll Specifies settings for Load<T>(string, ContentManagerLoaderSettings?) operations. public sealed class ContentManagerLoaderSettings Inheritance object ContentManagerLoaderSettings Extension Methods UnsafeUtilities.As<T>(object?) Properties AllowContentStreaming Gets or sets a value indicating whether assets can be loading using streaming service. public bool AllowContentStreaming { get; set; } Property Value bool true if load content using streaming service; otherwise, false. ContentFilter Gets or sets a filter that can indicate whether IReference should be loaded. public ContentManagerLoaderSettings.ContentFilterDelegate? ContentFilter { get; set; } Property Value ContentManagerLoaderSettings.ContentFilterDelegate The content reference filter. Default Gets the default loader settings. public static ContentManagerLoaderSettings Default { get; } Property Value ContentManagerLoaderSettings The default loader settings. IgnoreReferences Gets the loader settings which doesn't load content references. public static ContentManagerLoaderSettings IgnoreReferences { get; } Property Value ContentManagerLoaderSettings The loader settings which doesn't load content references. LoadContentReferences Gets or sets a value indicating whether IReference should be loaded. public bool LoadContentReferences { get; set; } Property Value bool true if IReference should be loaded; otherwise, false. StreamingDisabled Gets the loader settings which doesn't support resources streaming. Resources will be loaded without async streaming. public static ContentManagerLoaderSettings StreamingDisabled { get; } Property Value ContentManagerLoaderSettings The loader settings which doesn't support resources streaming. Methods NewContentFilterByType(params Type[]) Creates a new content filter that won't load chunk if not one of the given types. public static ContentManagerLoaderSettings.ContentFilterDelegate NewContentFilterByType(params Type[] types) Parameters types Type[] The accepted types. Returns ContentManagerLoaderSettings.ContentFilterDelegate"
  },
  "api/Stride.Core.Serialization.Contents.ContentManagerStats.LoadedAsset.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentManagerStats.LoadedAsset.html",
    "title": "Class ContentManagerStats.LoadedAsset | Stride API",
    "summary": "Class ContentManagerStats.LoadedAsset Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll A class representing information on a single loaded asset. This class is intended to be used for debug purpose only. public class ContentManagerStats.LoadedAsset Inheritance object ContentManagerStats.LoadedAsset Extension Methods UnsafeUtilities.As<T>(object?) Fields PrivateReferenceCount The private reference count, corresponding to the number of times this asset has been loaded indirectly because it is referenced by another asset. public readonly int PrivateReferenceCount Field Value int PublicReferenceCount The public reference count, corresponding to the number of times this asset has been manually loaded. public readonly int PublicReferenceCount Field Value int Url The url of the loaded asset. public readonly string Url Field Value string"
  },
  "api/Stride.Core.Serialization.Contents.ContentManagerStats.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentManagerStats.html",
    "title": "Class ContentManagerStats | Stride API",
    "summary": "Class ContentManagerStats Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll A class representing stats computed for an instance of ContentManager at a given time. This class is intended to be used for debug purpose only. public class ContentManagerStats Inheritance object ContentManagerStats Extension Methods UnsafeUtilities.As<T>(object?) Properties LoadedAssets Gets a collection representing information on all currently loaded assets. public IReadOnlyCollection<ContentManagerStats.LoadedAsset> LoadedAssets { get; } Property Value IReadOnlyCollection<ContentManagerStats.LoadedAsset>"
  },
  "api/Stride.Core.Serialization.Contents.ContentProfilingKeys.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentProfilingKeys.html",
    "title": "Class ContentProfilingKeys | Stride API",
    "summary": "Class ContentProfilingKeys Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll Keys used for profiling the game class. public static class ContentProfilingKeys Inheritance object ContentProfilingKeys Fields Content public static readonly ProfilingKey Content Field Value ProfilingKey ContentLoad Profiling load of an asset. public static readonly ProfilingKey ContentLoad Field Value ProfilingKey ContentReload Profiling load of an asset. public static readonly ProfilingKey ContentReload Field Value ProfilingKey ContentSave Profiling save of an asset. public static readonly ProfilingKey ContentSave Field Value ProfilingKey"
  },
  "api/Stride.Core.Serialization.Contents.ContentReferenceState.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentReferenceState.html",
    "title": "Enum ContentReferenceState | Stride API",
    "summary": "Enum ContentReferenceState Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll public enum ContentReferenceState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Loaded = 3 Data reference has already been loaded. Modified = 5 Data reference has been set to a new value by the user. It will be changed to Loaded as soon as it has been written by the ContentManager. NeverLoad = 0 Never try to load the data reference."
  },
  "api/Stride.Core.Serialization.Contents.ContentSerializer.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentSerializer.html",
    "title": "Class ContentSerializer | Stride API",
    "summary": "Class ContentSerializer Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll public class ContentSerializer Inheritance object ContentSerializer Extension Methods UnsafeUtilities.As<T>(object?) Constructors ContentSerializer() public ContentSerializer() Fields SerializerContextTags public PropertyContainer SerializerContextTags Field Value PropertyContainer Properties LowLevelSerializerSelector public SerializerSelector LowLevelSerializerSelector { get; set; } Property Value SerializerSelector LowLevelSerializerSelectorWithReuse public SerializerSelector LowLevelSerializerSelectorWithReuse { get; set; } Property Value SerializerSelector Methods RegisterSerializer(IContentSerializer) Registers a serializer with this ContentSerializer. public void RegisterSerializer(IContentSerializer serializer) Parameters serializer IContentSerializer The serializer."
  },
  "api/Stride.Core.Serialization.Contents.ContentSerializerAttribute.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentSerializerAttribute.html",
    "title": "Class ContentSerializerAttribute | Stride API",
    "summary": "Class ContentSerializerAttribute Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll Allows customization of IContentSerializer through an attribute. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Interface, AllowMultiple = true, Inherited = false)] public class ContentSerializerAttribute : Attribute Inheritance object Attribute ContentSerializerAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors ContentSerializerAttribute() Initializes a new instance of the ContentSerializerAttribute class. public ContentSerializerAttribute() ContentSerializerAttribute(Type) Initializes a new instance of the ContentSerializerAttribute class. public ContentSerializerAttribute(Type contentSerializerType) Parameters contentSerializerType Type Type of the content serializer. Properties ContentSerializerType Gets the type of the content serializer. public Type? ContentSerializerType { get; } Property Value Type The type of the content serializer."
  },
  "api/Stride.Core.Serialization.Contents.ContentSerializerBase-1.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentSerializerBase-1.html",
    "title": "Class ContentSerializerBase<T> | Stride API",
    "summary": "Class ContentSerializerBase<T> Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll Base class for Content Serializer with empty virtual implementation. public class ContentSerializerBase<T> : IContentSerializer<T>, IContentSerializer Type Parameters T Runtime type being serialized. Inheritance object ContentSerializerBase<T> Implements IContentSerializer<T> IContentSerializer Derived DataContentSerializer<T> Extension Methods UnsafeUtilities.As<T>(object?) Properties ActualType Gets the actual runtime type of object being serialized by Serialize(ContentSerializerContext, SerializationStream, object). It could be different than SerializationType if a conversion happened. public virtual Type ActualType { get; } Property Value Type The actual type. SerializationType Gets the type stored on HDD. Usually matches ActualType, but sometimes it might be converted to a different format (i.e. a GPU Texture is saved as an Image). public virtual Type SerializationType { get; } Property Value Type The type stored on HDD. Methods Construct(ContentSerializerContext) Constructs the specified object. This is useful if there is any cycle in the object graph reference. public virtual object Construct(ContentSerializerContext context) Parameters context ContentSerializerContext The context. Returns object The newly built object. Serialize(ContentSerializerContext, SerializationStream, object) Serializes the specified object. public void Serialize(ContentSerializerContext context, SerializationStream stream, object obj) Parameters context ContentSerializerContext The context. stream SerializationStream The stream. obj object The object. Serialize(ContentSerializerContext, SerializationStream, T) public virtual void Serialize(ContentSerializerContext context, SerializationStream stream, T obj) Parameters context ContentSerializerContext stream SerializationStream obj T"
  },
  "api/Stride.Core.Serialization.Contents.ContentSerializerContext.AttachedReferenceSerialization.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentSerializerContext.AttachedReferenceSerialization.html",
    "title": "Enum ContentSerializerContext.AttachedReferenceSerialization | Stride API",
    "summary": "Enum ContentSerializerContext.AttachedReferenceSerialization Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll public enum ContentSerializerContext.AttachedReferenceSerialization Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AsNull = 2 AsSerializableVersion = 1 Clone = 3 Unset = 0"
  },
  "api/Stride.Core.Serialization.Contents.ContentSerializerContext.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentSerializerContext.html",
    "title": "Class ContentSerializerContext | Stride API",
    "summary": "Class ContentSerializerContext Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll [DataSerializerGlobal(typeof(ListSerializer<ChunkReference>), null, DataSerializerGenericMode.None, false, false)] public class ContentSerializerContext Inheritance object ContentSerializerContext Extension Methods UnsafeUtilities.As<T>(object?) Fields ContentSerializerContextProperty public static PropertyKey<ContentSerializerContext> ContentSerializerContextProperty Field Value PropertyKey<ContentSerializerContext> SerializeAttachedReferenceProperty public static PropertyKey<ContentSerializerContext.AttachedReferenceSerialization> SerializeAttachedReferenceProperty Field Value PropertyKey<ContentSerializerContext.AttachedReferenceSerialization> Properties AllowContentStreaming public bool AllowContentStreaming { get; set; } Property Value bool ContentManager public ContentManager ContentManager { get; } Property Value ContentManager Mode public ArchiveMode Mode { get; } Property Value ArchiveMode Url public string Url { get; } Property Value string"
  },
  "api/Stride.Core.Serialization.Contents.ContentSerializerExtensionAttribute.html": {
    "href": "api/Stride.Core.Serialization.Contents.ContentSerializerExtensionAttribute.html",
    "title": "Class ContentSerializerExtensionAttribute | Stride API",
    "summary": "Class ContentSerializerExtensionAttribute Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] public class ContentSerializerExtensionAttribute : Attribute Inheritance object Attribute ContentSerializerExtensionAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors ContentSerializerExtensionAttribute(string) public ContentSerializerExtensionAttribute(string supportedExtension) Parameters supportedExtension string Properties SupportedExtension public string SupportedExtension { get; } Property Value string"
  },
  "api/Stride.Core.Serialization.Contents.DataContentSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Contents.DataContentSerializer-1.html",
    "title": "Class DataContentSerializer<T> | Stride API",
    "summary": "Class DataContentSerializer<T> Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll ContentSerializer that simply defers serialization to low level serialization. public class DataContentSerializer<T> : ContentSerializerBase<T>, IContentSerializer<T>, IContentSerializer Type Parameters T The type to serialize. Inheritance object ContentSerializerBase<T> DataContentSerializer<T> Implements IContentSerializer<T> IContentSerializer Derived DataContentSerializerWithReuse<T> Inherited Members ContentSerializerBase<T>.SerializationType ContentSerializerBase<T>.ActualType ContentSerializerBase<T>.Construct(ContentSerializerContext) ContentSerializerBase<T>.Serialize(ContentSerializerContext, SerializationStream, object) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ContentSerializerContext, SerializationStream, T) public override void Serialize(ContentSerializerContext context, SerializationStream stream, T obj) Parameters context ContentSerializerContext stream SerializationStream obj T"
  },
  "api/Stride.Core.Serialization.Contents.DataContentSerializerHelper-1.html": {
    "href": "api/Stride.Core.Serialization.Contents.DataContentSerializerHelper-1.html",
    "title": "Class DataContentSerializerHelper<T> | Stride API",
    "summary": "Class DataContentSerializerHelper<T> Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll public class DataContentSerializerHelper<T> Type Parameters T Inheritance object DataContentSerializerHelper<T> Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ContentSerializerContext, SerializationStream, T) public void Serialize(ContentSerializerContext context, SerializationStream stream, T obj) Parameters context ContentSerializerContext stream SerializationStream obj T"
  },
  "api/Stride.Core.Serialization.Contents.DataContentSerializerWithReuse-1.html": {
    "href": "api/Stride.Core.Serialization.Contents.DataContentSerializerWithReuse-1.html",
    "title": "Class DataContentSerializerWithReuse<T> | Stride API",
    "summary": "Class DataContentSerializerWithReuse<T> Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll ContentSerializer that simply defers serialization to low level serialization, with ReuseReferences set to true. public class DataContentSerializerWithReuse<T> : DataContentSerializer<T>, IContentSerializer<T>, IContentSerializer where T : new() Type Parameters T The type to serialize. Inheritance object ContentSerializerBase<T> DataContentSerializer<T> DataContentSerializerWithReuse<T> Implements IContentSerializer<T> IContentSerializer Inherited Members ContentSerializerBase<T>.SerializationType ContentSerializerBase<T>.ActualType ContentSerializerBase<T>.Construct(ContentSerializerContext) ContentSerializerBase<T>.Serialize(ContentSerializerContext, SerializationStream, object) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ContentSerializerContext, SerializationStream, T) public override void Serialize(ContentSerializerContext context, SerializationStream stream, T obj) Parameters context ContentSerializerContext stream SerializationStream obj T"
  },
  "api/Stride.Core.Serialization.Contents.IContentData.html": {
    "href": "api/Stride.Core.Serialization.Contents.IContentData.html",
    "title": "Interface IContentData | Stride API",
    "summary": "Interface IContentData Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll A content data storing its own Location. public interface IContentData Extension Methods UnsafeUtilities.As<T>(object?) Properties Url string Url { get; set; } Property Value string"
  },
  "api/Stride.Core.Serialization.Contents.IContentIndexMap.html": {
    "href": "api/Stride.Core.Serialization.Contents.IContentIndexMap.html",
    "title": "Interface IContentIndexMap | Stride API",
    "summary": "Interface IContentIndexMap Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll public interface IContentIndexMap : IDisposable Inherited Members IDisposable.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties this[string] ObjectId this[string url] { get; set; } Parameters url string Property Value ObjectId Methods Contains(string) bool Contains(string url) Parameters url string Returns bool GetMergedIdMap() IEnumerable<KeyValuePair<string, ObjectId>> GetMergedIdMap() Returns IEnumerable<KeyValuePair<string, ObjectId>> SearchValues(Func<KeyValuePair<string, ObjectId>, bool>) IEnumerable<KeyValuePair<string, ObjectId>> SearchValues(Func<KeyValuePair<string, ObjectId>, bool> predicate) Parameters predicate Func<KeyValuePair<string, ObjectId>, bool> Returns IEnumerable<KeyValuePair<string, ObjectId>> TryGetValue(string, out ObjectId) bool TryGetValue(string url, out ObjectId objectId) Parameters url string objectId ObjectId Returns bool"
  },
  "api/Stride.Core.Serialization.Contents.IContentManager.html": {
    "href": "api/Stride.Core.Serialization.Contents.IContentManager.html",
    "title": "Interface IContentManager | Stride API",
    "summary": "Interface IContentManager Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll Interface of the asset manager. public interface IContentManager Extension Methods UrlReferenceContentManagerExtenstions.Exists(IContentManager, IUrlReference) UrlReferenceContentManagerExtenstions.Get<T>(IContentManager, UrlReference<T>) UrlReferenceContentManagerExtenstions.IsLoaded(IContentManager, IUrlReference, bool) UrlReferenceContentManagerExtenstions.LoadAsync<T>(IContentManager, UrlReference<T>, ContentManagerLoaderSettings?) UrlReferenceContentManagerExtenstions.Load<T>(IContentManager, UrlReference<T>, ContentManagerLoaderSettings?) UrlReferenceContentManagerExtenstions.OpenAsStream(IContentManager, UrlReference, StreamFlags) UrlReferenceContentManagerExtenstions.Unload(IContentManager, IUrlReference) UnsafeUtilities.As<T>(object?) Properties Serializer Gets the serializer. ContentSerializer Serializer { get; } Property Value ContentSerializer The serializer. Methods Exists(string) Check if the specified asset url exists. bool Exists(string url) Parameters url string The URL. Returns bool true if the specified asset url exists, false otherwise. Get<T>(string) Gets a previously loaded asset from its URL. T? Get<T>(string url) where T : class Parameters url string The URL of the asset to retrieve. Returns T The loaded asset, or null if the asset has not been loaded. Type Parameters T The type of asset to retrieve. Remarks This function does not increase the reference count on the asset. IsLoaded(string, bool) Gets whether an asset with the given URL is currently loaded. bool IsLoaded(string url, bool loadedManuallyOnly = false) Parameters url string The URL to check. loadedManuallyOnly bool If true, this method will return true only if an asset with the given URL has been manually loaded via Load<T>(string, ContentManagerLoaderSettings?), and not if the asset has been only loaded indirectly from another asset. Returns bool True if an asset with the given URL is currently loaded, false otherwise. LoadAsync<T>(string, ContentManagerLoaderSettings?) Loads content from the specified URL asynchronously. Task<T> LoadAsync<T>(string url, ContentManagerLoaderSettings? settings = null) where T : class Parameters url string The URL to load from. settings ContentManagerLoaderSettings The settings. If null, fallback to Default. Returns Task<T> Type Parameters T The content type. Load<T>(string, ContentManagerLoaderSettings?) Loads content from the specified URL. T Load<T>(string url, ContentManagerLoaderSettings? settings = null) where T : class Parameters url string The URL to load from. settings ContentManagerLoaderSettings The settings. If null, fallback to Default. Returns T Type Parameters T The content type. OpenAsStream(string, StreamFlags) Opens the specified URL as a stream used for custom raw asset loading. Stream OpenAsStream(string url, StreamFlags streamFlags = StreamFlags.None) Parameters url string The URL to the raw asset. streamFlags StreamFlags The type of stream needed Returns Stream A stream to the raw asset. Unload(object) Unloads the specified object. void Unload(object obj) Parameters obj object The object to unload. Unload(string) Unloads the asset at the specified URL. void Unload(string url) Parameters url string The URL."
  },
  "api/Stride.Core.Serialization.Contents.IContentSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Contents.IContentSerializer-1.html",
    "title": "Interface IContentSerializer<T> | Stride API",
    "summary": "Interface IContentSerializer<T> Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll A IContentSerializer with a specific runtime type. public interface IContentSerializer<in T> : IContentSerializer Type Parameters T Runtime type being serialized. Expected to match ActualType Inherited Members IContentSerializer.SerializationType IContentSerializer.ActualType IContentSerializer.Serialize(ContentSerializerContext, SerializationStream, object) IContentSerializer.Construct(ContentSerializerContext) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ContentSerializerContext, SerializationStream, T) void Serialize(ContentSerializerContext context, SerializationStream stream, T obj) Parameters context ContentSerializerContext stream SerializationStream obj T"
  },
  "api/Stride.Core.Serialization.Contents.IContentSerializer.html": {
    "href": "api/Stride.Core.Serialization.Contents.IContentSerializer.html",
    "title": "Interface IContentSerializer | Stride API",
    "summary": "Interface IContentSerializer Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll Serializer for high-level \"chunk\", used by ContentManager. public interface IContentSerializer Extension Methods UnsafeUtilities.As<T>(object?) Properties ActualType Gets the actual runtime type of object being serialized by Serialize(ContentSerializerContext, SerializationStream, object). It could be different than SerializationType if a conversion happened. Type ActualType { get; } Property Value Type The actual type. SerializationType Gets the type stored on HDD. Usually matches ActualType, but sometimes it might be converted to a different format (i.e. a GPU Texture is saved as an Image). Type SerializationType { get; } Property Value Type The type stored on HDD. Methods Construct(ContentSerializerContext) Constructs the specified object. This is useful if there is any cycle in the object graph reference. object Construct(ContentSerializerContext context) Parameters context ContentSerializerContext The context. Returns object The newly built object. Serialize(ContentSerializerContext, SerializationStream, object) Serializes the specified object. void Serialize(ContentSerializerContext context, SerializationStream stream, object obj) Parameters context ContentSerializerContext The context. stream SerializationStream The stream. obj object The object."
  },
  "api/Stride.Core.Serialization.Contents.ILoadableReference.html": {
    "href": "api/Stride.Core.Serialization.Contents.ILoadableReference.html",
    "title": "Interface ILoadableReference | Stride API",
    "summary": "Interface ILoadableReference Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll public interface ILoadableReference Extension Methods UnsafeUtilities.As<T>(object?) Properties Location string Location { get; } Property Value string Type Type Type { get; } Property Value Type"
  },
  "api/Stride.Core.Serialization.Contents.IReference.html": {
    "href": "api/Stride.Core.Serialization.Contents.IReference.html",
    "title": "Interface IReference | Stride API",
    "summary": "Interface IReference Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll An interface that provides a reference to an object identified by a Guid and a location. public interface IReference Extension Methods UnsafeUtilities.As<T>(object?) Properties Id Gets the asset unique identifier. AssetId Id { get; } Property Value AssetId The identifier. Location Gets the location. string Location { get; } Property Value string The location."
  },
  "api/Stride.Core.Serialization.Contents.ITypedReference.html": {
    "href": "api/Stride.Core.Serialization.Contents.ITypedReference.html",
    "title": "Interface ITypedReference | Stride API",
    "summary": "Interface ITypedReference Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll A typed IReference public interface ITypedReference : IReference Inherited Members IReference.Id IReference.Location Extension Methods UnsafeUtilities.As<T>(object?) Properties Type Gets the type of this content reference. Type Type { get; } Property Value Type The type."
  },
  "api/Stride.Core.Serialization.Contents.ObjectUrl.html": {
    "href": "api/Stride.Core.Serialization.Contents.ObjectUrl.html",
    "title": "Struct ObjectUrl | Stride API",
    "summary": "Struct ObjectUrl Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll [DataContract] [Serializable] [DataSerializer(typeof(ObjectUrl.Serializer))] public readonly struct ObjectUrl : IEquatable<ObjectUrl> Implements IEquatable<ObjectUrl> Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ObjectUrl(UrlType, string) public ObjectUrl(UrlType type, string path) Parameters type UrlType path string Fields Empty public static readonly ObjectUrl Empty Field Value ObjectUrl Path public readonly string Path Field Value string Type public readonly UrlType Type Field Value UrlType Methods Equals(ObjectUrl) Indicates whether the current object is equal to another object of the same type. public bool Equals(ObjectUrl other) Parameters other ObjectUrl An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(ObjectUrl, ObjectUrl) public static bool operator ==(ObjectUrl left, ObjectUrl right) Parameters left ObjectUrl right ObjectUrl Returns bool operator !=(ObjectUrl, ObjectUrl) public static bool operator !=(ObjectUrl left, ObjectUrl right) Parameters left ObjectUrl right ObjectUrl Returns bool"
  },
  "api/Stride.Core.Serialization.Contents.ReferenceSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Contents.ReferenceSerializer-1.html",
    "title": "Class ReferenceSerializer<T> | Stride API",
    "summary": "Class ReferenceSerializer<T> Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll Serialize object with its underlying Id and Location, and use ContentManager to generate a separate chunk. public sealed class ReferenceSerializer<T> : DataSerializer<T> where T : class Type Parameters T Inheritance object DataSerializer DataSerializer<T> ReferenceSerializer<T> Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Contents.ReferenceSerializer.html": {
    "href": "api/Stride.Core.Serialization.Contents.ReferenceSerializer.html",
    "title": "Class ReferenceSerializer | Stride API",
    "summary": "Class ReferenceSerializer Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll public static class ReferenceSerializer Inheritance object ReferenceSerializer Fields CloneReferences public static readonly PropertyKey<List<object>> CloneReferences Field Value PropertyKey<List<object>>"
  },
  "api/Stride.Core.Serialization.Contents.ReferenceSerializerAttribute.html": {
    "href": "api/Stride.Core.Serialization.Contents.ReferenceSerializerAttribute.html",
    "title": "Class ReferenceSerializerAttribute | Stride API",
    "summary": "Class ReferenceSerializerAttribute Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll Used to detect whether a type is using ReferenceSerializer. [AttributeUsage(AttributeTargets.Class)] public class ReferenceSerializerAttribute : Attribute Inheritance object Attribute ReferenceSerializerAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Serialization.Contents.UrlType.html": {
    "href": "api/Stride.Core.Serialization.Contents.UrlType.html",
    "title": "Enum UrlType | Stride API",
    "summary": "Enum UrlType Namespace Stride.Core.Serialization.Contents Assembly Stride.Core.Serialization.dll An enum representing the type of an url. [DataContract] public enum UrlType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Content = 2 The location is a content url. File = 1 The location is a file on the disk. None = 0 The location is not valid."
  },
  "api/Stride.Core.Serialization.Contents.html": {
    "href": "api/Stride.Core.Serialization.Contents.html",
    "title": "Namespace Stride.Core.Serialization.Contents | Stride API",
    "summary": "Namespace Stride.Core.Serialization.Contents Classes ChunkHeader This class describes the header of an asset serialized in a blob file. Its (serialized) size has to remain constant ContentData ContentIndexMap ContentManager Loads and saves assets. ContentManagerLoaderSettings Specifies settings for Load<T>(string, ContentManagerLoaderSettings?) operations. ContentManagerStats A class representing stats computed for an instance of ContentManager at a given time. This class is intended to be used for debug purpose only. ContentManagerStats.LoadedAsset A class representing information on a single loaded asset. This class is intended to be used for debug purpose only. ContentProfilingKeys Keys used for profiling the game class. ContentSerializer ContentSerializerAttribute Allows customization of IContentSerializer through an attribute. ContentSerializerBase<T> Base class for Content Serializer with empty virtual implementation. ContentSerializerContext ContentSerializerExtensionAttribute DataContentSerializerHelper<T> DataContentSerializerWithReuse<T> ContentSerializer that simply defers serialization to low level serialization, with ReuseReferences set to true. DataContentSerializer<T> ContentSerializer that simply defers serialization to low level serialization. ReferenceSerializer ReferenceSerializerAttribute Used to detect whether a type is using ReferenceSerializer. ReferenceSerializer<T> Serialize object with its underlying Id and Location, and use ContentManager to generate a separate chunk. Structs ChunkReference Describe a reference between an object and another. ObjectUrl Interfaces IContentData A content data storing its own Location. IContentIndexMap IContentManager Interface of the asset manager. IContentSerializer Serializer for high-level \"chunk\", used by ContentManager. IContentSerializer<T> A IContentSerializer with a specific runtime type. ILoadableReference IReference An interface that provides a reference to an object identified by a Guid and a location. ITypedReference A typed IReference Enums ContentReferenceState ContentSerializerContext.AttachedReferenceSerialization UrlType An enum representing the type of an url. Delegates ContentManagerLoaderSettings.ContentFilterDelegate"
  },
  "api/Stride.Core.Serialization.DataSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.DataSerializer-1.html",
    "title": "Class DataSerializer<T> | Stride API",
    "summary": "Class DataSerializer<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll Describes how to serialize and deserialize an object of a given type. public abstract class DataSerializer<T> : DataSerializer Type Parameters T The type of object to serialize or deserialize. Inheritance object DataSerializer DataSerializer<T> Derived AnimationKeyValuePairArraySerializer<T> AssetPartCollectionSerializer<TAssetPartDesign, TAssetPart> AssetReferenceDataSerializer BasePartDataSerializer InvariantObjectCloneSerializer<T> ClassDataSerializer<T> ReferenceSerializer<T> EmptyDataSerializer<T> MemberSerializer<T> NullSerializer<T> ArraySerializer<T> BoolSerializer ByteArraySerializer ByteSerializer CharSerializer DateTimeSerializer DictionaryAllSerializer<TDictionary, TKey, TValue> DictionaryInterfaceSerializer<TKey, TValue> DictionarySerializer<TKey, TValue> DoubleSerializer EnumSerializer EnumSerializer<T> GuidSerializer HashSetSerializer<T> Int16Serializer Int32Serializer Int64Serializer KeyValuePairSerializer<TKey, TValue> KeyedSortedListSerializer<TKeyedList, TKey, T> ListAllSerializer<TList, T> ListInterfaceSerializer<T> ListSerializer<T> NullableSerializer<T> PropertyInfoSerializer PropertyKeySerializer<T> SByteSerializer ServiceWireSerializer SingleSerializer SortedListSerializer<TKey, TValue> StringSerializer TimeSpanSerializer TupleSerializer<T1> TupleSerializer<T1, T2> TupleSerializer<T1, T2, T3> TupleSerializer<T1, T2, T3, T4> TypeSerializer UInt16Serializer UInt32Serializer UInt64Serializer UriSerializer UrlReferenceDataSerializerBase<T> ValueTupleSerializer<T1> ValueTupleSerializer<T1, T2> ValueTupleSerializer<T1, T2, T3> ValueTupleSerializer<T1, T2, T3, T4> CloneEntityComponentSerializer<T> CloneSerializer<T> BufferSerializer TextureSerializer SamplerStateSerializer SceneCameraSlotId.SceneCameraSlotIdDataSerializer BowyerWatsonTetrahedralization.Face.Serializer BowyerWatsonTetrahedralization.Tetrahedron.Serializer ObjectParameterKeySerializer<T> PermutationParameterKeySerializer<T> ValueParameterKeySerializer<T> Inherited Members DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool SerializationType The type of the object that can be serialized or deserialized. public override Type SerializationType { get; } Property Value Type Methods PreSerialize(ref object, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref object obj, ArchiveMode mode, SerializationStream stream) Parameters obj object The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. PreSerialize(ref T, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public virtual void PreSerialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref object, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref object obj, ArchiveMode mode, SerializationStream stream) Parameters obj object The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Serialize(T, SerializationStream) Serializes the given object obj. public void Serialize(T obj, SerializationStream stream) Parameters obj T The object to serialize or deserialize. stream SerializationStream The stream to serialize or deserialize to. Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public abstract void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.DataSerializer.html": {
    "href": "api/Stride.Core.Serialization.DataSerializer.html",
    "title": "Class DataSerializer | Stride API",
    "summary": "Class DataSerializer Namespace Stride.Core.Serialization Assembly Stride.Core.dll Describes how to serialize and deserialize an object without knowing its type. Used as a common base class for all data serializers. public abstract class DataSerializer Inheritance object DataSerializer Derived DataSerializer<T> Extension Methods UnsafeUtilities.As<T>(object?) Fields BinaryFormatVersion public const int BinaryFormatVersion = 4000001 Field Value int SerializationTypeId The type id of SerializationType. Used internally to avoid dealing with strings. public ObjectId SerializationTypeId Field Value ObjectId Properties IsBlittable public abstract bool IsBlittable { get; } Property Value bool SerializationType The type of the object that can be serialized or deserialized. public abstract Type SerializationType { get; } Property Value Type Methods Initialize(SerializerSelector) Initializes the specified serializer. public virtual void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref object, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public abstract void PreSerialize(ref object obj, ArchiveMode mode, SerializationStream stream) Parameters obj object The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref object, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public abstract void Serialize(ref object obj, ArchiveMode mode, SerializationStream stream) Parameters obj object The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.DataSerializerAttribute.html": {
    "href": "api/Stride.Core.Serialization.DataSerializerAttribute.html",
    "title": "Class DataSerializerAttribute | Stride API",
    "summary": "Class DataSerializerAttribute Namespace Stride.Core.Serialization Assembly Stride.Core.dll Use this attribute on a class to specify its data serializer type. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct)] public class DataSerializerAttribute : Attribute Inheritance object Attribute DataSerializerAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DataSerializerAttribute(Type) Initializes a new instance of the DataSerializerAttribute class. public DataSerializerAttribute(Type dataSerializerType) Parameters dataSerializerType Type Type of the data serializer. Fields DataSerializerType Gets the type of the data serializer. public Type DataSerializerType Field Value Type The type of the data serializer. Mode public DataSerializerGenericMode Mode Field Value DataSerializerGenericMode"
  },
  "api/Stride.Core.Serialization.DataSerializerFactory.html": {
    "href": "api/Stride.Core.Serialization.DataSerializerFactory.html",
    "title": "Class DataSerializerFactory | Stride API",
    "summary": "Class DataSerializerFactory Namespace Stride.Core.Serialization Assembly Stride.Core.dll public static class DataSerializerFactory Inheritance object DataSerializerFactory Methods GetAssemblySerializers(Assembly) public static AssemblySerializers? GetAssemblySerializers(Assembly assembly) Parameters assembly Assembly Returns AssemblySerializers GetSerializer(string, Type) public static AssemblySerializerEntry GetSerializer(string profile, Type type) Parameters profile string type Type Returns AssemblySerializerEntry RegisterSerializationAssembly(AssemblySerializers) public static void RegisterSerializationAssembly(AssemblySerializers assemblySerializers) Parameters assemblySerializers AssemblySerializers RegisterSerializationAssembly(Assembly) public static void RegisterSerializationAssembly(Assembly assembly) Parameters assembly Assembly RegisterSerializerSelector(SerializerSelector) public static void RegisterSerializerSelector(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector UnregisterSerializationAssembly(Assembly) public static void UnregisterSerializationAssembly(Assembly assembly) Parameters assembly Assembly"
  },
  "api/Stride.Core.Serialization.DataSerializerGenericMode.html": {
    "href": "api/Stride.Core.Serialization.DataSerializerGenericMode.html",
    "title": "Enum DataSerializerGenericMode | Stride API",
    "summary": "Enum DataSerializerGenericMode Namespace Stride.Core.Serialization Assembly Stride.Core.dll Defines what generic parameters to pass to the serializer. public enum DataSerializerGenericMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields GenericArguments = 2 The generic arguments of the serialized type will be passed as a generic arguments of the serializer. Example: serializer of A{T1, T2} becomes instantiated as Serializer{T1, T2}. None = 0 Type = 1 The type of the serialized type will be passed as a generic arguments of the serializer. Example: serializer of A becomes instantiated as Serializer{A}. TypeAndGenericArguments = 3 Combinations of both Type and GenericArguments. Example: serializer of A{T1, T2} becomes instantiated as Serializer{A, T1, T2}."
  },
  "api/Stride.Core.Serialization.DataSerializerGlobalAttribute.html": {
    "href": "api/Stride.Core.Serialization.DataSerializerGlobalAttribute.html",
    "title": "Class DataSerializerGlobalAttribute | Stride API",
    "summary": "Class DataSerializerGlobalAttribute Namespace Stride.Core.Serialization Assembly Stride.Core.dll Declares a serializer like DataSerializerAttribute or DataContractAttribute, but externally. [AttributeUsage(AttributeTargets.Assembly|AttributeTargets.Class|AttributeTargets.Struct, AllowMultiple = true)] public class DataSerializerGlobalAttribute : Attribute Inheritance object Attribute DataSerializerGlobalAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DataSerializerGlobalAttribute(Type?, Type?, DataSerializerGenericMode, bool, bool) Initializes a new instance of the DataSerializerGlobalAttribute class, either by its serializer type (it will act like DataSerializerAttribute and guess data type from the generic type of DataSerializer<T>) or the data type (it will act just like if DataContractAttribute was set on the data type). public DataSerializerGlobalAttribute(Type? serializerType = null, Type? dataType = null, DataSerializerGenericMode mode = DataSerializerGenericMode.None, bool inherited = false, bool complexSerializer = false) Parameters serializerType Type The serializer type. Can be null if dataType if set. dataType Type The data type. Can be null if serializerType is set. mode DataSerializerGenericMode Defines how generic type are added to serializerType. inherited bool Similar to Inherited complexSerializer bool True if it should use the auto-generated serializer. Properties Profile public string Profile { get; set; } Property Value string"
  },
  "api/Stride.Core.Serialization.EmptyDataSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.EmptyDataSerializer-1.html",
    "title": "Class EmptyDataSerializer<T> | Stride API",
    "summary": "Class EmptyDataSerializer<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class EmptyDataSerializer<T> : DataSerializer<T> Type Parameters T Inheritance object DataSerializer DataSerializer<T> EmptyDataSerializer<T> Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.GenericSerializerFactory.html": {
    "href": "api/Stride.Core.Serialization.GenericSerializerFactory.html",
    "title": "Class GenericSerializerFactory | Stride API",
    "summary": "Class GenericSerializerFactory Namespace Stride.Core.Serialization Assembly Stride.Core.dll Simple serializer that will matches specific type using base type and create a data serializer with matched type. public class GenericSerializerFactory : SerializerFactory Inheritance object SerializerFactory GenericSerializerFactory Extension Methods UnsafeUtilities.As<T>(object?) Constructors GenericSerializerFactory(Type, Type) Initializes a new instance of the GenericSerializerFactory class. public GenericSerializerFactory(Type baseType, Type serializerGenericType) Parameters baseType Type The type to match. serializerGenericType Type The generic type that will be used to instantiate serializers. Methods GetSerializer(SerializerSelector, ref ObjectId) public override DataSerializer? GetSerializer(SerializerSelector selector, ref ObjectId typeId) Parameters selector SerializerSelector typeId ObjectId Returns DataSerializer GetSerializer(SerializerSelector, Type) public override DataSerializer? GetSerializer(SerializerSelector selector, Type type) Parameters selector SerializerSelector type Type Returns DataSerializer"
  },
  "api/Stride.Core.Serialization.HashSerializationWriter.html": {
    "href": "api/Stride.Core.Serialization.HashSerializationWriter.html",
    "title": "Class HashSerializationWriter | Stride API",
    "summary": "Class HashSerializationWriter Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class HashSerializationWriter : BinarySerializationWriter Inheritance object SerializationStream BinarySerializationWriter HashSerializationWriter Inherited Members BinarySerializationWriter.Serialize(ref bool) BinarySerializationWriter.Serialize(ref float) BinarySerializationWriter.Serialize(ref double) BinarySerializationWriter.Serialize(ref short) BinarySerializationWriter.Serialize(ref int) BinarySerializationWriter.Serialize(ref long) BinarySerializationWriter.Serialize(ref ushort) BinarySerializationWriter.Serialize(ref uint) BinarySerializationWriter.Serialize(ref ulong) BinarySerializationWriter.Serialize(ref char) BinarySerializationWriter.Serialize(ref byte) BinarySerializationWriter.Serialize(ref sbyte) BinarySerializationWriter.Serialize(byte[], int, int) BinarySerializationWriter.Serialize(Span<byte>) BinarySerializationWriter.Flush() SerializationStream.BufferTLSSize SerializationStream.UnderlyingStream SerializationStream.Context Extension Methods SerializerExtensions.ReadBoolean(SerializationStream) SerializerExtensions.ReadByte(SerializationStream) SerializerExtensions.ReadBytes(SerializationStream, int) SerializerExtensions.ReadChar(SerializationStream) SerializerExtensions.ReadDouble(SerializationStream) SerializerExtensions.ReadInt16(SerializationStream) SerializerExtensions.ReadInt32(SerializationStream) SerializerExtensions.ReadInt64(SerializationStream) SerializerExtensions.ReadSByte(SerializationStream) SerializerExtensions.ReadSingle(SerializationStream) SerializerExtensions.ReadString(SerializationStream) SerializerExtensions.ReadUInt16(SerializationStream) SerializerExtensions.ReadUInt32(SerializationStream) SerializerExtensions.ReadUInt64(SerializationStream) SerializerExtensions.Read<T>(SerializationStream) SerializerExtensions.SerializeExtended<T>(SerializationStream, T, ArchiveMode, DataSerializer<T>?) SerializerExtensions.SerializeExtended<T>(SerializationStream, ref T, ArchiveMode, DataSerializer<T>?) SerializerExtensions.Serialize<T>(SerializationStream, ref T) SerializerExtensions.Serialize<T>(SerializationStream, ref T, ArchiveMode) SerializerExtensions.Write(SerializationStream, bool) SerializerExtensions.Write(SerializationStream, byte) SerializerExtensions.Write(SerializationStream, byte[], int, int) SerializerExtensions.Write(SerializationStream, char) SerializerExtensions.Write(SerializationStream, double) SerializerExtensions.Write(SerializationStream, short) SerializerExtensions.Write(SerializationStream, int) SerializerExtensions.Write(SerializationStream, long) SerializerExtensions.Write(SerializationStream, sbyte) SerializerExtensions.Write(SerializationStream, float) SerializerExtensions.Write(SerializationStream, string) SerializerExtensions.Write(SerializationStream, ushort) SerializerExtensions.Write(SerializationStream, uint) SerializerExtensions.Write(SerializationStream, ulong) SerializerExtensions.Write<T>(SerializationStream, T) UnsafeUtilities.As<T>(object?) Constructors HashSerializationWriter(Stream) public HashSerializationWriter(Stream outputStream) Parameters outputStream Stream Methods Serialize(ref string) Serializes the specified string value. public override void Serialize(ref string value) Parameters value string The value to serialize"
  },
  "api/Stride.Core.Serialization.IDataSerializerGenericInstantiation.html": {
    "href": "api/Stride.Core.Serialization.IDataSerializerGenericInstantiation.html",
    "title": "Interface IDataSerializerGenericInstantiation | Stride API",
    "summary": "Interface IDataSerializerGenericInstantiation Namespace Stride.Core.Serialization Assembly Stride.Core.dll Allows enumeration of required data serializers. public interface IDataSerializerGenericInstantiation Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now)."
  },
  "api/Stride.Core.Serialization.IUrlReference.html": {
    "href": "api/Stride.Core.Serialization.IUrlReference.html",
    "title": "Interface IUrlReference | Stride API",
    "summary": "Interface IUrlReference Namespace Stride.Core.Serialization Assembly Stride.Core.Serialization.dll Represents a Url to an asset. public interface IUrlReference Extension Methods UnsafeUtilities.As<T>(object?) Properties IsEmpty Gets whether the is null or empty. bool IsEmpty { get; } Property Value bool Url Gets the Url of the referenced asset. string Url { get; } Property Value string"
  },
  "api/Stride.Core.Serialization.MemberNonSealedSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.MemberNonSealedSerializer-1.html",
    "title": "Class MemberNonSealedSerializer<T> | Stride API",
    "summary": "Class MemberNonSealedSerializer<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class MemberNonSealedSerializer<T> : MemberSerializer<T> Type Parameters T Inheritance object DataSerializer DataSerializer<T> MemberSerializer<T> MemberNonSealedSerializer<T> Inherited Members MemberSerializer<T>.isValueType MemberSerializer<T>.isSealed MemberSerializer<T>.dataSerializer MemberSerializer<T>.Create(SerializerSelector, bool) DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Constructors MemberNonSealedSerializer(DataSerializer<T>) public MemberNonSealedSerializer(DataSerializer<T> dataSerializer) Parameters dataSerializer DataSerializer<T> Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.MemberNonSealedSerializer.html": {
    "href": "api/Stride.Core.Serialization.MemberNonSealedSerializer.html",
    "title": "Class MemberNonSealedSerializer | Stride API",
    "summary": "Class MemberNonSealedSerializer Namespace Stride.Core.Serialization Assembly Stride.Core.dll public static class MemberNonSealedSerializer Inheritance object MemberNonSealedSerializer Methods SerializeExtended(SerializationStream, Type, ref object, ArchiveMode, DataSerializer) public static void SerializeExtended(SerializationStream stream, Type objType, ref object obj, ArchiveMode mode, DataSerializer dataSerializer = null) Parameters stream SerializationStream objType Type obj object mode ArchiveMode dataSerializer DataSerializer"
  },
  "api/Stride.Core.Serialization.MemberNonSealedSerializerObject-1.html": {
    "href": "api/Stride.Core.Serialization.MemberNonSealedSerializerObject-1.html",
    "title": "Class MemberNonSealedSerializerObject<T> | Stride API",
    "summary": "Class MemberNonSealedSerializerObject<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class MemberNonSealedSerializerObject<T> : MemberSerializer<T> Type Parameters T Inheritance object DataSerializer DataSerializer<T> MemberSerializer<T> MemberNonSealedSerializerObject<T> Inherited Members MemberSerializer<T>.isValueType MemberSerializer<T>.isSealed MemberSerializer<T>.dataSerializer MemberSerializer<T>.Create(SerializerSelector, bool) DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Constructors MemberNonSealedSerializerObject(DataSerializer<T>) public MemberNonSealedSerializerObject(DataSerializer<T> dataSerializer) Parameters dataSerializer DataSerializer<T> Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.MemberNullableSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.MemberNullableSerializer-1.html",
    "title": "Class MemberNullableSerializer<T> | Stride API",
    "summary": "Class MemberNullableSerializer<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class MemberNullableSerializer<T> : MemberSerializer<T> Type Parameters T Inheritance object DataSerializer DataSerializer<T> MemberSerializer<T> MemberNullableSerializer<T> Inherited Members MemberSerializer<T>.isValueType MemberSerializer<T>.isSealed MemberSerializer<T>.dataSerializer MemberSerializer<T>.Create(SerializerSelector, bool) DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Constructors MemberNullableSerializer(DataSerializer<T>) public MemberNullableSerializer(DataSerializer<T> dataSerializer) Parameters dataSerializer DataSerializer<T> Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.MemberNullableSerializer.html": {
    "href": "api/Stride.Core.Serialization.MemberNullableSerializer.html",
    "title": "Class MemberNullableSerializer | Stride API",
    "summary": "Class MemberNullableSerializer Namespace Stride.Core.Serialization Assembly Stride.Core.dll public static class MemberNullableSerializer Inheritance object MemberNullableSerializer Methods SerializeExtended(SerializationStream, Type, ref object, ArchiveMode, DataSerializer) public static void SerializeExtended(SerializationStream stream, Type objType, ref object obj, ArchiveMode mode, DataSerializer dataSerializer = null) Parameters stream SerializationStream objType Type obj object mode ArchiveMode dataSerializer DataSerializer"
  },
  "api/Stride.Core.Serialization.MemberNullableSerializerObject-1.html": {
    "href": "api/Stride.Core.Serialization.MemberNullableSerializerObject-1.html",
    "title": "Class MemberNullableSerializerObject<T> | Stride API",
    "summary": "Class MemberNullableSerializerObject<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class MemberNullableSerializerObject<T> : MemberSerializer<T> Type Parameters T Inheritance object DataSerializer DataSerializer<T> MemberSerializer<T> MemberNullableSerializerObject<T> Inherited Members MemberSerializer<T>.isValueType MemberSerializer<T>.isSealed MemberSerializer<T>.dataSerializer MemberSerializer<T>.Create(SerializerSelector, bool) DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Constructors MemberNullableSerializerObject(DataSerializer<T>) public MemberNullableSerializerObject(DataSerializer<T> dataSerializer) Parameters dataSerializer DataSerializer<T> Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.MemberReuseSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.MemberReuseSerializer-1.html",
    "title": "Class MemberReuseSerializer<T> | Stride API",
    "summary": "Class MemberReuseSerializer<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class MemberReuseSerializer<T> : MemberSerializer<T> Type Parameters T Inheritance object DataSerializer DataSerializer<T> MemberSerializer<T> MemberReuseSerializer<T> Inherited Members MemberSerializer<T>.isValueType MemberSerializer<T>.isSealed MemberSerializer<T>.dataSerializer MemberSerializer<T>.Create(SerializerSelector, bool) DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Constructors MemberReuseSerializer(DataSerializer<T>) public MemberReuseSerializer(DataSerializer<T> dataSerializer) Parameters dataSerializer DataSerializer<T> Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.MemberReuseSerializer.html": {
    "href": "api/Stride.Core.Serialization.MemberReuseSerializer.html",
    "title": "Class MemberReuseSerializer | Stride API",
    "summary": "Class MemberReuseSerializer Namespace Stride.Core.Serialization Assembly Stride.Core.dll public static class MemberReuseSerializer Inheritance object MemberReuseSerializer Methods SerializeExtended(SerializationStream, Type, ref object, ArchiveMode, DataSerializer) public static void SerializeExtended(SerializationStream stream, Type objType, ref object obj, ArchiveMode mode, DataSerializer dataSerializer = null) Parameters stream SerializationStream objType Type obj object mode ArchiveMode dataSerializer DataSerializer"
  },
  "api/Stride.Core.Serialization.MemberReuseSerializerObject-1.html": {
    "href": "api/Stride.Core.Serialization.MemberReuseSerializerObject-1.html",
    "title": "Class MemberReuseSerializerObject<T> | Stride API",
    "summary": "Class MemberReuseSerializerObject<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class MemberReuseSerializerObject<T> : MemberSerializer<T> Type Parameters T Inheritance object DataSerializer DataSerializer<T> MemberSerializer<T> MemberReuseSerializerObject<T> Inherited Members MemberSerializer<T>.isValueType MemberSerializer<T>.isSealed MemberSerializer<T>.dataSerializer MemberSerializer<T>.Create(SerializerSelector, bool) DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Constructors MemberReuseSerializerObject(DataSerializer<T>) public MemberReuseSerializerObject(DataSerializer<T> dataSerializer) Parameters dataSerializer DataSerializer<T> Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.MemberSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.MemberSerializer-1.html",
    "title": "Class MemberSerializer<T> | Stride API",
    "summary": "Class MemberSerializer<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll Helper for serializing members of a class. public abstract class MemberSerializer<T> : DataSerializer<T> Type Parameters T The type of member to serialize. Inheritance object DataSerializer DataSerializer<T> MemberSerializer<T> Derived MemberNonSealedSerializerObject<T> MemberNonSealedSerializer<T> MemberNullableSerializerObject<T> MemberNullableSerializer<T> MemberReuseSerializerObject<T> MemberReuseSerializer<T> Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Constructors MemberSerializer(DataSerializer<T>) protected MemberSerializer(DataSerializer<T> dataSerializer) Parameters dataSerializer DataSerializer<T> Fields dataSerializer protected DataSerializer<T> dataSerializer Field Value DataSerializer<T> isSealed protected static bool isSealed Field Value bool isValueType protected static bool isValueType Field Value bool Methods Create(SerializerSelector, bool) public static DataSerializer<T> Create(SerializerSelector serializerSelector, bool nullable = true) Parameters serializerSelector SerializerSelector nullable bool Returns DataSerializer<T>"
  },
  "api/Stride.Core.Serialization.MemberSerializer.ObjectReferenceEqualityComparer.html": {
    "href": "api/Stride.Core.Serialization.MemberSerializer.ObjectReferenceEqualityComparer.html",
    "title": "Class MemberSerializer.ObjectReferenceEqualityComparer | Stride API",
    "summary": "Class MemberSerializer.ObjectReferenceEqualityComparer Namespace Stride.Core.Serialization Assembly Stride.Core.dll Implements an equality comparer based on object reference instead of object.Equals(object). public class MemberSerializer.ObjectReferenceEqualityComparer : EqualityComparer<object>, IEqualityComparer<object>, IEqualityComparer Inheritance object EqualityComparer<object> MemberSerializer.ObjectReferenceEqualityComparer Implements IEqualityComparer<object> IEqualityComparer Inherited Members EqualityComparer<object>.Create(Func<object, object, bool>, Func<object, int>) Extension Methods UnsafeUtilities.As<T>(object?) Properties Default public static IEqualityComparer<object> Default { get; } Property Value IEqualityComparer<object> Methods Equals(object?, object?) When overridden in a derived class, determines whether two objects of type object are equal. public override bool Equals(object? x, object? y) Parameters x object The first object to compare. y object The second object to compare. Returns bool true if the specified objects are equal; otherwise, false. GetHashCode(object) When overridden in a derived class, serves as a hash function for the specified object for hashing algorithms and data structures, such as a hash table. public override int GetHashCode(object obj) Parameters obj object The object for which to get a hash code. Returns int A hash code for the specified object. Exceptions ArgumentNullException The type of obj is a reference type and obj is null."
  },
  "api/Stride.Core.Serialization.MemberSerializer.html": {
    "href": "api/Stride.Core.Serialization.MemberSerializer.html",
    "title": "Class MemberSerializer | Stride API",
    "summary": "Class MemberSerializer Namespace Stride.Core.Serialization Assembly Stride.Core.dll public static class MemberSerializer Inheritance object MemberSerializer Fields CachedTypes public static readonly Dictionary<string, Type> CachedTypes Field Value Dictionary<string, Type> ExternalIdentifiables public static PropertyKey<Dictionary<Guid, IIdentifiable>> ExternalIdentifiables Field Value PropertyKey<Dictionary<Guid, IIdentifiable>> ObjectDeserializeCallback public static PropertyKey<Action<int, object>> ObjectDeserializeCallback Field Value PropertyKey<Action<int, object>> ObjectDeserializeReferences public static PropertyKey<List<object>> ObjectDeserializeReferences Field Value PropertyKey<List<object>> ObjectSerializeReferences public static PropertyKey<Dictionary<object, int>> ObjectSerializeReferences Field Value PropertyKey<Dictionary<object, int>> ReverseCachedTypes public static readonly Dictionary<Type, string> ReverseCachedTypes Field Value Dictionary<Type, string>"
  },
  "api/Stride.Core.Serialization.NullSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.NullSerializer-1.html",
    "title": "Class NullSerializer<T> | Stride API",
    "summary": "Class NullSerializer<T> Namespace Stride.Core.Serialization Assembly Stride.Core.dll A null serializer that can be used to add dummy serialization attributes. public class NullSerializer<T> : DataSerializer<T> Type Parameters T Inheritance object DataSerializer DataSerializer<T> NullSerializer<T> Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.SerializationStream.html": {
    "href": "api/Stride.Core.Serialization.SerializationStream.html",
    "title": "Class SerializationStream | Stride API",
    "summary": "Class SerializationStream Namespace Stride.Core.Serialization Assembly Stride.Core.dll Base class for implementation of SerializationStream. public abstract class SerializationStream Inheritance object SerializationStream Derived BinarySerializationReader BinarySerializationWriter Extension Methods SerializerExtensions.ReadBoolean(SerializationStream) SerializerExtensions.ReadByte(SerializationStream) SerializerExtensions.ReadBytes(SerializationStream, int) SerializerExtensions.ReadChar(SerializationStream) SerializerExtensions.ReadDouble(SerializationStream) SerializerExtensions.ReadInt16(SerializationStream) SerializerExtensions.ReadInt32(SerializationStream) SerializerExtensions.ReadInt64(SerializationStream) SerializerExtensions.ReadSByte(SerializationStream) SerializerExtensions.ReadSingle(SerializationStream) SerializerExtensions.ReadString(SerializationStream) SerializerExtensions.ReadUInt16(SerializationStream) SerializerExtensions.ReadUInt32(SerializationStream) SerializerExtensions.ReadUInt64(SerializationStream) SerializerExtensions.Read<T>(SerializationStream) SerializerExtensions.SerializeExtended<T>(SerializationStream, T, ArchiveMode, DataSerializer<T>?) SerializerExtensions.SerializeExtended<T>(SerializationStream, ref T, ArchiveMode, DataSerializer<T>?) SerializerExtensions.Serialize<T>(SerializationStream, ref T) SerializerExtensions.Serialize<T>(SerializationStream, ref T, ArchiveMode) SerializerExtensions.Write(SerializationStream, bool) SerializerExtensions.Write(SerializationStream, byte) SerializerExtensions.Write(SerializationStream, byte[], int, int) SerializerExtensions.Write(SerializationStream, char) SerializerExtensions.Write(SerializationStream, double) SerializerExtensions.Write(SerializationStream, short) SerializerExtensions.Write(SerializationStream, int) SerializerExtensions.Write(SerializationStream, long) SerializerExtensions.Write(SerializationStream, sbyte) SerializerExtensions.Write(SerializationStream, float) SerializerExtensions.Write(SerializationStream, string) SerializerExtensions.Write(SerializationStream, ushort) SerializerExtensions.Write(SerializationStream, uint) SerializerExtensions.Write(SerializationStream, ulong) SerializerExtensions.Write<T>(SerializationStream, T) UnsafeUtilities.As<T>(object?) Constructors SerializationStream() Initializes a new instance of the SerializationStream class. protected SerializationStream() Fields BufferTLSSize protected const int BufferTLSSize = 1024 Field Value int Properties Context The serializer context. public SerializerContext Context { get; set; } Property Value SerializerContext UnderlyingStream The Stream from which this serializer reads or to which it writes. public Stream UnderlyingStream { get; protected init; } Property Value Stream Methods Flush() Flushes all recent writes (for better batching). Please note that if only Serialize has been used (no PopTag()), Flush() should be called manually. public abstract void Flush() Serialize(ref bool) Serializes the specified boolean value. public abstract void Serialize(ref bool value) Parameters value bool The value to serialize Serialize(ref byte) Serializes the specified byte value. public abstract void Serialize(ref byte value) Parameters value byte The value to serialize Serialize(byte[], int, int) Serializes the specified byte array. public abstract void Serialize(byte[] values, int offset, int count) Parameters values byte[] The buffer to serialize. offset int The starting offset in the buffer to begin serializing. count int The size, in bytes, to serialize. Serialize(ref char) Serializes the specified char value. public abstract void Serialize(ref char value) Parameters value char The value to serialize Serialize(ref double) Serializes the specified double value. public abstract void Serialize(ref double value) Parameters value double The value to serialize Serialize(ref short) Serializes the specified short value. public abstract void Serialize(ref short value) Parameters value short The value to serialize Serialize(ref int) Serializes the specified integer value. public abstract void Serialize(ref int value) Parameters value int The value to serialize Serialize(ref long) Serializes the specified long value. public abstract void Serialize(ref long value) Parameters value long The value to serialize Serialize(ref sbyte) Serializes the specified signed byte value. public abstract void Serialize(ref sbyte value) Parameters value sbyte The value to serialize Serialize(ref float) Serializes the specified float value. public abstract void Serialize(ref float value) Parameters value float The value to serialize Serialize(Span<byte>) Serializes the specified memory area. public abstract void Serialize(Span<byte> memory) Parameters memory Span<byte> The memory area to serialize. Serialize(ref string) Serializes the specified string value. public abstract void Serialize(ref string value) Parameters value string The value to serialize Serialize(ref ushort) Serializes the specified ushort value. public abstract void Serialize(ref ushort value) Parameters value ushort The value to serialize Serialize(ref uint) Serializes the specified unsigned integer value. public abstract void Serialize(ref uint value) Parameters value uint The value to serialize Serialize(ref ulong) Serializes the specified unsigned long value. public abstract void Serialize(ref ulong value) Parameters value ulong The value to serialize"
  },
  "api/Stride.Core.Serialization.SerializationTagType.html": {
    "href": "api/Stride.Core.Serialization.SerializationTagType.html",
    "title": "Class SerializationTagType | Stride API",
    "summary": "Class SerializationTagType Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class SerializationTagType Inheritance object SerializationTagType Extension Methods UnsafeUtilities.As<T>(object?) Fields EndElement public static readonly SerializationTagType EndElement Field Value SerializationTagType Identifier public static readonly SerializationTagType Identifier Field Value SerializationTagType StartElement public static readonly SerializationTagType StartElement Field Value SerializationTagType"
  },
  "api/Stride.Core.Serialization.SerializeClassFlags.html": {
    "href": "api/Stride.Core.Serialization.SerializeClassFlags.html",
    "title": "Enum SerializeClassFlags | Stride API",
    "summary": "Enum SerializeClassFlags Namespace Stride.Core.Serialization Assembly Stride.Core.dll Specifies flags used when serializing reference types. [Flags] public enum SerializeClassFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields IsExternalIdentifiable = 8 Specifies that the object is an IIdentifiable instance has not been serialized, and only its Id has been stored. IsNull = 1 Specifies that the object is null. IsReference = 4 Specifies that the object has already been serialized previously in the stream, and is only stored as an index. IsTypeInfo = 2 Specifies that additional type info is necessary and is stored in the stream. None = 0 Default value."
  },
  "api/Stride.Core.Serialization.SerializeObjectDelegate.html": {
    "href": "api/Stride.Core.Serialization.SerializeObjectDelegate.html",
    "title": "Delegate SerializeObjectDelegate | Stride API",
    "summary": "Delegate SerializeObjectDelegate Namespace Stride.Core.Serialization Assembly Stride.Core.dll public delegate void SerializeObjectDelegate(SerializationStream stream, ref object obj, ArchiveMode archiveMode) Parameters stream SerializationStream obj object archiveMode ArchiveMode Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Serialization.SerializerContext.html": {
    "href": "api/Stride.Core.Serialization.SerializerContext.html",
    "title": "Class SerializerContext | Stride API",
    "summary": "Class SerializerContext Namespace Stride.Core.Serialization Assembly Stride.Core.dll public class SerializerContext Inheritance object SerializerContext Extension Methods UnsafeUtilities.As<T>(object?) Constructors SerializerContext() public SerializerContext() Fields Tags public PropertyContainer Tags Field Value PropertyContainer Properties SerializerSelector Gets or sets the serializer. public SerializerSelector SerializerSelector { get; set; } Property Value SerializerSelector The serializer. Methods Get<T>(PropertyKey<T>) public T? Get<T>(PropertyKey<T> key) Parameters key PropertyKey<T> Returns T Type Parameters T Set<T>(PropertyKey<T>, T) public void Set<T>(PropertyKey<T> key, T value) Parameters key PropertyKey<T> value T Type Parameters T"
  },
  "api/Stride.Core.Serialization.SerializerExtensions.html": {
    "href": "api/Stride.Core.Serialization.SerializerExtensions.html",
    "title": "Class SerializerExtensions | Stride API",
    "summary": "Class SerializerExtensions Namespace Stride.Core.Serialization Assembly Stride.Core.dll Various useful extension methods on top of SerializationStream for serialization/deserialization of common types. public static class SerializerExtensions Inheritance object SerializerExtensions Methods Clone<T>(T) public static T Clone<T>(T obj) Parameters obj T Returns T Type Parameters T ReadBoolean(SerializationStream) Reads a boolean value from the stream. public static bool ReadBoolean(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns bool A boolean value read from the stream. ReadByte(SerializationStream) Reads a unsigned byte integer from the stream. public static byte ReadByte(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns byte An unsigned byte read from the stream. ReadBytes(SerializationStream, int) Reads the specified number of bytes. [Obsolete(\"Allocates. Read into the destination.\")] public static byte[] ReadBytes(this SerializationStream stream, int count) Parameters stream SerializationStream The stream. count int Returns byte[] A byte array containing the data read from the stream. ReadChar(SerializationStream) Reads a unicode character from the stream. public static char ReadChar(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns char A unicode character read from the stream. ReadDouble(SerializationStream) Reads a 8-byte floating point value from the stream. public static double ReadDouble(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns double A 8-byte floating point value read from the stream. ReadInt16(SerializationStream) Reads a 2-byte signed integer from the stream. public static short ReadInt16(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns short A 2-byte signed integer read from the stream. ReadInt32(SerializationStream) Reads a 4-byte signed integer from the stream. public static int ReadInt32(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns int A 4-byte signed integer read from the stream. ReadInt64(SerializationStream) Reads a 8-byte signed integer from the stream. public static long ReadInt64(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns long A 8-byte signed integer read from the stream. ReadSByte(SerializationStream) Reads a signed byte from the stream. public static sbyte ReadSByte(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns sbyte A signed byte read from the stream. ReadSingle(SerializationStream) Reads a 4-byte floating point value from the stream. public static float ReadSingle(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns float A 4-byte floating point value read from the stream. ReadString(SerializationStream) Reads a string. public static string ReadString(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns string A string read from the stream. ReadUInt16(SerializationStream) Reads a 2-byte unsigned integer from the stream. public static ushort ReadUInt16(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns ushort A 2-byte unsigned integer read from the stream. ReadUInt32(SerializationStream) Reads a 4-byte unsigned integer from the stream. public static uint ReadUInt32(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns uint A 4-byte unsigned integer read from the stream. ReadUInt64(SerializationStream) Reads a 8-byte unsigned integer from the stream. public static ulong ReadUInt64(this SerializationStream stream) Parameters stream SerializationStream The stream. Returns ulong A 8-byte unsigned integer read from the stream. Read<T>(SerializationStream) Reads the specified object from the stream. public static T Read<T>(this SerializationStream stream) Parameters stream SerializationStream The stream to read the object from. Returns T The object that has just been read. Type Parameters T The type of the object to read. SerializeExtended<T>(SerializationStream, T, ArchiveMode, DataSerializer<T>?) Serializes the specified object. public static void SerializeExtended<T>(this SerializationStream stream, T obj, ArchiveMode mode, DataSerializer<T>? dataSerializer = null) Parameters stream SerializationStream The stream to serialize to. obj T The object to serialize. mode ArchiveMode The serialization mode. dataSerializer DataSerializer<T> The data serializer (can be null). Type Parameters T The object type to serialize. SerializeExtended<T>(SerializationStream, ref T, ArchiveMode, DataSerializer<T>?) Serializes the specified object. public static void SerializeExtended<T>(this SerializationStream stream, ref T obj, ArchiveMode mode, DataSerializer<T>? dataSerializer = null) Parameters stream SerializationStream The stream to serialize to. obj T The object to serialize. mode ArchiveMode The serialization mode. dataSerializer DataSerializer<T> The data serializer (can be null). Type Parameters T The object type to serialize. Serialize<T>(SerializationStream, ref T) Serializes or deserializes the value using Serialize(Span<byte>). public static void Serialize<T>(this SerializationStream serializer, ref T value) Parameters serializer SerializationStream value T Type Parameters T Serialize<T>(SerializationStream, ref T, ArchiveMode) Serializes the specified object. public static void Serialize<T>(this SerializationStream stream, ref T obj, ArchiveMode mode) Parameters stream SerializationStream The stream to serialize to. obj T The object to serialize. mode ArchiveMode The serialization mode. Type Parameters T Write(SerializationStream, bool) Writes a boolean value to the specified stream. public static SerializationStream Write(this SerializationStream stream, bool value) Parameters stream SerializationStream The stream. value bool The boolean value to write. Returns SerializationStream The stream. Write(SerializationStream, byte) Writes an unsigned byte to the specified stream. public static SerializationStream Write(this SerializationStream stream, byte value) Parameters stream SerializationStream The stream. value byte The unsigned byte to write. Returns SerializationStream The stream. Write(SerializationStream, byte[], int, int) Writes a byte array region to the specified stream. public static SerializationStream Write(this SerializationStream stream, byte[] values, int offset, int count) Parameters stream SerializationStream The stream. values byte[] The byte array to write. offset int The starting offset in values to write. count int The number of bytes to write. Returns SerializationStream The stream. Write(SerializationStream, char) Writes a unicode character to the specified stream. public static SerializationStream Write(this SerializationStream stream, char value) Parameters stream SerializationStream The stream. value char The unicode character to write. Returns SerializationStream The stream. Write(SerializationStream, double) Writes a 8-byte floating point value to the specified stream. public static SerializationStream Write(this SerializationStream stream, double value) Parameters stream SerializationStream The stream. value double The 8-byte floating point value to write. Returns SerializationStream The stream. Write(SerializationStream, short) Writes a 2-byte signed integer to the specified stream. public static SerializationStream Write(this SerializationStream stream, short value) Parameters stream SerializationStream The stream. value short The 2-byte signed integer to write. Returns SerializationStream The stream. Write(SerializationStream, int) Writes a 4-byte signed integer to the specified stream. public static SerializationStream Write(this SerializationStream stream, int value) Parameters stream SerializationStream The stream. value int The 4-byte signed integer to write. Returns SerializationStream The stream. Write(SerializationStream, long) Writes a 8-byte signed integer to the specified stream. public static SerializationStream Write(this SerializationStream stream, long value) Parameters stream SerializationStream The stream. value long The 8-byte signed integer to write. Returns SerializationStream The stream. Write(SerializationStream, sbyte) Writes a signed byte to the specified stream. public static SerializationStream Write(this SerializationStream stream, sbyte value) Parameters stream SerializationStream The stream. value sbyte The signed byte to write. Returns SerializationStream The stream. Write(SerializationStream, float) Writes a 4-byte floating point value to the specified stream. public static SerializationStream Write(this SerializationStream stream, float value) Parameters stream SerializationStream The stream. value float The 4-byte floating point value to write. Returns SerializationStream The stream. Write(SerializationStream, string) Writes a string to the specified stream. public static SerializationStream Write(this SerializationStream stream, string value) Parameters stream SerializationStream The stream. value string The string to write. Returns SerializationStream The stream. Write(SerializationStream, ushort) Writes a 2-byte unsigned integer to the specified stream. public static SerializationStream Write(this SerializationStream stream, ushort value) Parameters stream SerializationStream The stream. value ushort The 2-byte unsigned integer to write. Returns SerializationStream The stream. Write(SerializationStream, uint) Writes a 4-byte unsigned integer to the specified stream. public static SerializationStream Write(this SerializationStream stream, uint value) Parameters stream SerializationStream The stream. value uint The 4-byte unsigned integer to write. Returns SerializationStream The stream. Write(SerializationStream, ulong) Writes a 8-byte unsigned integer to the specified stream. public static SerializationStream Write(this SerializationStream stream, ulong value) Parameters stream SerializationStream The stream. value ulong The 8-byte unsigned integer to write. Returns SerializationStream The stream. Write<T>(SerializationStream, T) Writes the specified object to the stream. public static void Write<T>(this SerializationStream stream, T obj) Parameters stream SerializationStream The stream to write the object to. obj T The object to write. Type Parameters T The type of the object to write."
  },
  "api/Stride.Core.Serialization.SerializerFactory.html": {
    "href": "api/Stride.Core.Serialization.SerializerFactory.html",
    "title": "Class SerializerFactory | Stride API",
    "summary": "Class SerializerFactory Namespace Stride.Core.Serialization Assembly Stride.Core.dll Used as a fallback when GetSerializer(ref ObjectId) didn't find anything. public abstract class SerializerFactory Inheritance object SerializerFactory Derived GenericSerializerFactory Extension Methods UnsafeUtilities.As<T>(object?) Methods GetSerializer(SerializerSelector, ref ObjectId) public abstract DataSerializer? GetSerializer(SerializerSelector selector, ref ObjectId typeId) Parameters selector SerializerSelector typeId ObjectId Returns DataSerializer GetSerializer(SerializerSelector, Type) public abstract DataSerializer? GetSerializer(SerializerSelector selector, Type type) Parameters selector SerializerSelector type Type Returns DataSerializer"
  },
  "api/Stride.Core.Serialization.SerializerSelector.html": {
    "href": "api/Stride.Core.Serialization.SerializerSelector.html",
    "title": "Class SerializerSelector | Stride API",
    "summary": "Class SerializerSelector Namespace Stride.Core.Serialization Assembly Stride.Core.dll Serializer context. It holds DataSerializer{T} objects and their factories. public class SerializerSelector Inheritance object SerializerSelector Extension Methods UnsafeUtilities.As<T>(object?) Constructors SerializerSelector(bool, bool, params string[]) Initializes a new instance of the SerializerSelector class. public SerializerSelector(bool reuseReferences, bool externalIdentifiableAsGuid, params string[] profiles) Parameters reuseReferences bool if set to true reuse references (allow cycles in the object graph). externalIdentifiableAsGuid bool profiles string[] The profiles. SerializerSelector(params string[]) public SerializerSelector(params string[] profiles) Parameters profiles string[] Fields SelectorOverride public SerializerSelector? SelectorOverride Field Value SerializerSelector Properties Asset public static SerializerSelector Asset { get; } Property Value SerializerSelector AssetWithReuse public static SerializerSelector AssetWithReuse { get; } Property Value SerializerSelector Default Gets the default instance of Serializer. public static SerializerSelector Default { get; } Property Value SerializerSelector The default instance. ExternalIdentifiableAsGuid Gets whether IIdentifiable instances marked as external will have only their Guid stored. public bool ExternalIdentifiableAsGuid { get; } Property Value bool Profiles public IEnumerable<string> Profiles { get; } Property Value IEnumerable<string> ReuseReferences Gets whether serialization reuses references, where each reference gets assigned an ID and if it is serialized again, same instance will be reused). public bool ReuseReferences { get; } Property Value bool SerializerFactories public List<SerializerFactory> SerializerFactories { get; } Property Value List<SerializerFactory> Methods EnsureInitialized(DataSerializer) Internal function, for use by SerializerFactory. public void EnsureInitialized(DataSerializer dataSerializer) Parameters dataSerializer DataSerializer The data serializer to initialize if not done yet GetSerializer(ref ObjectId) public DataSerializer? GetSerializer(ref ObjectId typeId) Parameters typeId ObjectId Returns DataSerializer GetSerializer(Type) Gets the serializer. public DataSerializer? GetSerializer(Type type) Parameters type Type The type that you want to (de)serialize. Returns DataSerializer The DataSerializer<T> for this type if it exists or can be created, otherwise null. GetSerializer<T>() Gets the serializer. public DataSerializer<T>? GetSerializer<T>() Returns DataSerializer<T> The DataSerializer<T> for this type if it exists or can be created, otherwise null. Type Parameters T The type that you want to (de)serialize. HasProfile(string) Checks if this instance supports the specified serialization profile. public bool HasProfile(string profile) Parameters profile string Name of the profile Returns bool true if this instance supports the specified serialization profile"
  },
  "api/Stride.Core.Serialization.Serializers.ArraySerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ArraySerializer-1.html",
    "title": "Class ArraySerializer<T> | Stride API",
    "summary": "Class ArraySerializer<T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for T[]. public class ArraySerializer<T> : DataSerializer<T[]>, IDataSerializerGenericInstantiation Type Parameters T Generics type of T[]. Inheritance object DataSerializer DataSerializer<T[]> ArraySerializer<T> Implements IDataSerializerGenericInstantiation Derived BlittableArraySerializer<T> Inherited Members DataSerializer<T[]>.SerializationType DataSerializer<T[]>.IsBlittable DataSerializer<T[]>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T[]>.Serialize(T[], SerializationStream) DataSerializer<T[]>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T[]>.PreSerialize(ref T[], ArchiveMode, SerializationStream) DataSerializer<T[]>.Serialize(ref T[], ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref T[], ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref T[] obj, ArchiveMode mode, SerializationStream stream) Parameters obj T[] The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref T[], ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T[] obj, ArchiveMode mode, SerializationStream stream) Parameters obj T[] The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.BlittableArraySerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.BlittableArraySerializer-1.html",
    "title": "Class BlittableArraySerializer<T> | Stride API",
    "summary": "Class BlittableArraySerializer<T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for blittable T[]. public class BlittableArraySerializer<T> : ArraySerializer<T>, IDataSerializerGenericInstantiation where T : unmanaged Type Parameters T Generics type of T[]. Inheritance object DataSerializer DataSerializer<T[]> ArraySerializer<T> BlittableArraySerializer<T> Implements IDataSerializerGenericInstantiation Inherited Members ArraySerializer<T>.PreSerialize(ref T[], ArchiveMode, SerializationStream) ArraySerializer<T>.EnumerateGenericInstantiations(SerializerSelector, IList<Type>) DataSerializer<T[]>.SerializationType DataSerializer<T[]>.IsBlittable DataSerializer<T[]>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T[]>.Serialize(T[], SerializationStream) DataSerializer<T[]>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T[]>.PreSerialize(ref T[], ArchiveMode, SerializationStream) DataSerializer<T[]>.Serialize(ref T[], ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref T[], ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T[] array, ArchiveMode mode, SerializationStream stream) Parameters array T[] mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.BoolSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.BoolSerializer.html",
    "title": "Class BoolSerializer | Stride API",
    "summary": "Class BoolSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for bool. [DataSerializerGlobal(typeof(BoolSerializer), null, DataSerializerGenericMode.None, false, false)] public class BoolSerializer : DataSerializer<bool> Inheritance object DataSerializer DataSerializer<bool> BoolSerializer Inherited Members DataSerializer<bool>.SerializationType DataSerializer<bool>.IsBlittable DataSerializer<bool>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<bool>.Serialize(bool, SerializationStream) DataSerializer<bool>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<bool>.PreSerialize(ref bool, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref bool, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref bool obj, ArchiveMode mode, SerializationStream stream) Parameters obj bool The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ByteArraySerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ByteArraySerializer.html",
    "title": "Class ByteArraySerializer | Stride API",
    "summary": "Class ByteArraySerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Implements DataSerializer<T> for a byte array. [DataSerializerGlobal(typeof(ByteArraySerializer), null, DataSerializerGenericMode.None, false, false)] public class ByteArraySerializer : DataSerializer<byte[]> Inheritance object DataSerializer DataSerializer<byte[]> ByteArraySerializer Inherited Members DataSerializer<byte[]>.SerializationType DataSerializer<byte[]>.IsBlittable DataSerializer<byte[]>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<byte[]>.Serialize(byte[], SerializationStream) DataSerializer<byte[]>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<byte[]>.PreSerialize(ref byte[], ArchiveMode, SerializationStream) DataSerializer<byte[]>.Serialize(ref byte[], ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Initialize(SerializerSelector) DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods PreSerialize(ref byte[], ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref byte[] obj, ArchiveMode mode, SerializationStream stream) Parameters obj byte[] The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref byte[], ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref byte[] obj, ArchiveMode mode, SerializationStream stream) Parameters obj byte[] The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ByteSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ByteSerializer.html",
    "title": "Class ByteSerializer | Stride API",
    "summary": "Class ByteSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for byte. [DataSerializerGlobal(typeof(ByteSerializer), null, DataSerializerGenericMode.None, false, false)] public class ByteSerializer : DataSerializer<byte> Inheritance object DataSerializer DataSerializer<byte> ByteSerializer Inherited Members DataSerializer<byte>.SerializationType DataSerializer<byte>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<byte>.Serialize(byte, SerializationStream) DataSerializer<byte>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<byte>.PreSerialize(ref byte, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref byte, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref byte obj, ArchiveMode mode, SerializationStream stream) Parameters obj byte The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.CharSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.CharSerializer.html",
    "title": "Class CharSerializer | Stride API",
    "summary": "Class CharSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for char. [DataSerializerGlobal(typeof(CharSerializer), null, DataSerializerGenericMode.None, false, false)] public class CharSerializer : DataSerializer<char> Inheritance object DataSerializer DataSerializer<char> CharSerializer Inherited Members DataSerializer<char>.SerializationType DataSerializer<char>.IsBlittable DataSerializer<char>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<char>.Serialize(char, SerializationStream) DataSerializer<char>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<char>.PreSerialize(ref char, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref char, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref char obj, ArchiveMode mode, SerializationStream stream) Parameters obj char The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ComplexTypeSerializerFlags.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ComplexTypeSerializerFlags.html",
    "title": "Enum ComplexTypeSerializerFlags | Stride API",
    "summary": "Enum ComplexTypeSerializerFlags Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll [Flags] public enum ComplexTypeSerializerFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields None = 0 SerializeFields = SerializePublicFields | SerializeNonPublicFields SerializeNonPublicFields = 2 SerializePublicFields = 1 SerializePublicProperties = 4"
  },
  "api/Stride.Core.Serialization.Serializers.DateTimeSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.DateTimeSerializer.html",
    "title": "Class DateTimeSerializer | Stride API",
    "summary": "Class DateTimeSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll [DataSerializerGlobal(typeof(DateTimeSerializer), null, DataSerializerGenericMode.None, false, false)] public class DateTimeSerializer : DataSerializer<DateTime> Inheritance object DataSerializer DataSerializer<DateTime> DateTimeSerializer Inherited Members DataSerializer<DateTime>.SerializationType DataSerializer<DateTime>.IsBlittable DataSerializer<DateTime>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<DateTime>.Serialize(DateTime, SerializationStream) DataSerializer<DateTime>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<DateTime>.PreSerialize(ref DateTime, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref DateTime, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref DateTime dateTime, ArchiveMode mode, SerializationStream stream) Parameters dateTime DateTime mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.DictionaryAllSerializer-3.html": {
    "href": "api/Stride.Core.Serialization.Serializers.DictionaryAllSerializer-3.html",
    "title": "Class DictionaryAllSerializer<TDictionary, TKey, TValue> | Stride API",
    "summary": "Class DictionaryAllSerializer<TDictionary, TKey, TValue> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll public class DictionaryAllSerializer<TDictionary, TKey, TValue> : DataSerializer<TDictionary>, IDataSerializerGenericInstantiation where TDictionary : IDictionary<TKey, TValue> where TKey : notnull Type Parameters TDictionary TKey TValue Inheritance object DataSerializer DataSerializer<TDictionary> DictionaryAllSerializer<TDictionary, TKey, TValue> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<TDictionary>.SerializationType DataSerializer<TDictionary>.IsBlittable DataSerializer<TDictionary>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<TDictionary>.Serialize(TDictionary, SerializationStream) DataSerializer<TDictionary>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref TDictionary, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref TDictionary obj, ArchiveMode mode, SerializationStream stream) Parameters obj TDictionary The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref TDictionary, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref TDictionary obj, ArchiveMode mode, SerializationStream stream) Parameters obj TDictionary The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.DictionaryInterfaceSerializer-2.html": {
    "href": "api/Stride.Core.Serialization.Serializers.DictionaryInterfaceSerializer-2.html",
    "title": "Class DictionaryInterfaceSerializer<TKey, TValue> | Stride API",
    "summary": "Class DictionaryInterfaceSerializer<TKey, TValue> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for IDictionary{TKey, TValue}. [DataSerializerGlobal(typeof(DictionaryInterfaceSerializer<,>), typeof(IDictionary<,>), DataSerializerGenericMode.GenericArguments, false, false)] public class DictionaryInterfaceSerializer<TKey, TValue> : DataSerializer<IDictionary<TKey, TValue>>, IDataSerializerGenericInstantiation where TKey : notnull Type Parameters TKey The type of the key in IDictionary{TKey, TValue}. TValue The type of the value in IDictionary{TKey, TValue}. Inheritance object DataSerializer DataSerializer<IDictionary<TKey, TValue>> DictionaryInterfaceSerializer<TKey, TValue> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<IDictionary<TKey, TValue>>.SerializationType DataSerializer<IDictionary<TKey, TValue>>.IsBlittable DataSerializer<IDictionary<TKey, TValue>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<IDictionary<TKey, TValue>>.Serialize(IDictionary<TKey, TValue>, SerializationStream) DataSerializer<IDictionary<TKey, TValue>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<IDictionary<TKey, TValue>>.PreSerialize(ref IDictionary<TKey, TValue>, ArchiveMode, SerializationStream) DataSerializer<IDictionary<TKey, TValue>>.Serialize(ref IDictionary<TKey, TValue>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref IDictionary<TKey, TValue>, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref IDictionary<TKey, TValue> obj, ArchiveMode mode, SerializationStream stream) Parameters obj IDictionary<TKey, TValue> The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref IDictionary<TKey, TValue>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref IDictionary<TKey, TValue> obj, ArchiveMode mode, SerializationStream stream) Parameters obj IDictionary<TKey, TValue> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.DictionarySerializer-2.html": {
    "href": "api/Stride.Core.Serialization.Serializers.DictionarySerializer-2.html",
    "title": "Class DictionarySerializer<TKey, TValue> | Stride API",
    "summary": "Class DictionarySerializer<TKey, TValue> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for Dictionary{TKey, TValue}. [DataSerializerGlobal(typeof(DictionarySerializer<,>), typeof(Dictionary<,>), DataSerializerGenericMode.GenericArguments, false, false)] public class DictionarySerializer<TKey, TValue> : DataSerializer<Dictionary<TKey, TValue>>, IDataSerializerGenericInstantiation where TKey : notnull Type Parameters TKey The type of the key in Dictionary{TKey, TValue}. TValue The type of the value in Dictionary{TKey, TValue}. Inheritance object DataSerializer DataSerializer<Dictionary<TKey, TValue>> DictionarySerializer<TKey, TValue> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<Dictionary<TKey, TValue>>.SerializationType DataSerializer<Dictionary<TKey, TValue>>.IsBlittable DataSerializer<Dictionary<TKey, TValue>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Dictionary<TKey, TValue>>.Serialize(Dictionary<TKey, TValue>, SerializationStream) DataSerializer<Dictionary<TKey, TValue>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Dictionary<TKey, TValue>>.PreSerialize(ref Dictionary<TKey, TValue>, ArchiveMode, SerializationStream) DataSerializer<Dictionary<TKey, TValue>>.Serialize(ref Dictionary<TKey, TValue>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref Dictionary<TKey, TValue>, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref Dictionary<TKey, TValue> obj, ArchiveMode mode, SerializationStream stream) Parameters obj Dictionary<TKey, TValue> The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref Dictionary<TKey, TValue>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Dictionary<TKey, TValue> obj, ArchiveMode mode, SerializationStream stream) Parameters obj Dictionary<TKey, TValue> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.DoubleSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.DoubleSerializer.html",
    "title": "Class DoubleSerializer | Stride API",
    "summary": "Class DoubleSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for double. [DataSerializerGlobal(typeof(DoubleSerializer), null, DataSerializerGenericMode.None, false, false)] public class DoubleSerializer : DataSerializer<double> Inheritance object DataSerializer DataSerializer<double> DoubleSerializer Inherited Members DataSerializer<double>.SerializationType DataSerializer<double>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<double>.Serialize(double, SerializationStream) DataSerializer<double>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<double>.PreSerialize(ref double, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref double, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref double obj, ArchiveMode mode, SerializationStream stream) Parameters obj double The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.EnumSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.EnumSerializer-1.html",
    "title": "Class EnumSerializer<T> | Stride API",
    "summary": "Class EnumSerializer<T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for typed enum. public class EnumSerializer<T> : DataSerializer<T> where T : struct Type Parameters T Inheritance object DataSerializer DataSerializer<T> EnumSerializer<T> Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.EnumSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.EnumSerializer.html",
    "title": "Class EnumSerializer | Stride API",
    "summary": "Class EnumSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for Enum. public class EnumSerializer : DataSerializer<Enum> Inheritance object DataSerializer DataSerializer<Enum> EnumSerializer Inherited Members DataSerializer<Enum>.SerializationType DataSerializer<Enum>.IsBlittable DataSerializer<Enum>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Enum>.Serialize(Enum, SerializationStream) DataSerializer<Enum>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Enum>.PreSerialize(ref Enum, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref Enum, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Enum obj, ArchiveMode mode, SerializationStream stream) Parameters obj Enum The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.GuidSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.GuidSerializer.html",
    "title": "Class GuidSerializer | Stride API",
    "summary": "Class GuidSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for Guid. [DataSerializerGlobal(typeof(GuidSerializer), null, DataSerializerGenericMode.None, false, false)] public class GuidSerializer : DataSerializer<Guid> Inheritance object DataSerializer DataSerializer<Guid> GuidSerializer Inherited Members DataSerializer<Guid>.SerializationType DataSerializer<Guid>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Guid>.Serialize(Guid, SerializationStream) DataSerializer<Guid>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Guid>.PreSerialize(ref Guid, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref Guid, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Guid obj, ArchiveMode mode, SerializationStream stream) Parameters obj Guid The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.HashSetSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.HashSetSerializer-1.html",
    "title": "Class HashSetSerializer<T> | Stride API",
    "summary": "Class HashSetSerializer<T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for HashSet{T}. [DataSerializerGlobal(typeof(HashSetSerializer<>), typeof(HashSet<>), DataSerializerGenericMode.GenericArguments, false, false)] public class HashSetSerializer<T> : DataSerializer<HashSet<T>>, IDataSerializerGenericInstantiation Type Parameters T Generics type of HashSet{T}. Inheritance object DataSerializer DataSerializer<HashSet<T>> HashSetSerializer<T> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<HashSet<T>>.SerializationType DataSerializer<HashSet<T>>.IsBlittable DataSerializer<HashSet<T>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<HashSet<T>>.Serialize(HashSet<T>, SerializationStream) DataSerializer<HashSet<T>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref HashSet<T>, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref HashSet<T> obj, ArchiveMode mode, SerializationStream stream) Parameters obj HashSet<T> The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref HashSet<T>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref HashSet<T> obj, ArchiveMode mode, SerializationStream stream) Parameters obj HashSet<T> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.Int16Serializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.Int16Serializer.html",
    "title": "Class Int16Serializer | Stride API",
    "summary": "Class Int16Serializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for short. [DataSerializerGlobal(typeof(Int16Serializer), null, DataSerializerGenericMode.None, false, false)] public class Int16Serializer : DataSerializer<short> Inheritance object DataSerializer DataSerializer<short> Int16Serializer Inherited Members DataSerializer<short>.SerializationType DataSerializer<short>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<short>.Serialize(short, SerializationStream) DataSerializer<short>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<short>.PreSerialize(ref short, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref short, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref short obj, ArchiveMode mode, SerializationStream stream) Parameters obj short The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.Int32Serializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.Int32Serializer.html",
    "title": "Class Int32Serializer | Stride API",
    "summary": "Class Int32Serializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for int. [DataSerializerGlobal(typeof(Int32Serializer), null, DataSerializerGenericMode.None, false, false)] public class Int32Serializer : DataSerializer<int> Inheritance object DataSerializer DataSerializer<int> Int32Serializer Inherited Members DataSerializer<int>.SerializationType DataSerializer<int>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<int>.Serialize(int, SerializationStream) DataSerializer<int>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<int>.PreSerialize(ref int, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref int, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref int obj, ArchiveMode mode, SerializationStream stream) Parameters obj int The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.Int64Serializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.Int64Serializer.html",
    "title": "Class Int64Serializer | Stride API",
    "summary": "Class Int64Serializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for long. [DataSerializerGlobal(typeof(Int64Serializer), null, DataSerializerGenericMode.None, false, false)] public class Int64Serializer : DataSerializer<long> Inheritance object DataSerializer DataSerializer<long> Int64Serializer Inherited Members DataSerializer<long>.SerializationType DataSerializer<long>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<long>.Serialize(long, SerializationStream) DataSerializer<long>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<long>.PreSerialize(ref long, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref long, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref long obj, ArchiveMode mode, SerializationStream stream) Parameters obj long The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.KeyValuePairSerializer-2.html": {
    "href": "api/Stride.Core.Serialization.Serializers.KeyValuePairSerializer-2.html",
    "title": "Class KeyValuePairSerializer<TKey, TValue> | Stride API",
    "summary": "Class KeyValuePairSerializer<TKey, TValue> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for KeyValuePair{TKey, TValue}. [DataSerializerGlobal(typeof(KeyValuePairSerializer<,>), typeof(KeyValuePair<,>), DataSerializerGenericMode.GenericArguments, false, false)] public class KeyValuePairSerializer<TKey, TValue> : DataSerializer<KeyValuePair<TKey, TValue>>, IDataSerializerGenericInstantiation Type Parameters TKey The type of the key in KeyValuePair{TKey, TValue}. TValue The type of the value in KeyValuePair{TKey, TValue}. Inheritance object DataSerializer DataSerializer<KeyValuePair<TKey, TValue>> KeyValuePairSerializer<TKey, TValue> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<KeyValuePair<TKey, TValue>>.SerializationType DataSerializer<KeyValuePair<TKey, TValue>>.IsBlittable DataSerializer<KeyValuePair<TKey, TValue>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<KeyValuePair<TKey, TValue>>.Serialize(KeyValuePair<TKey, TValue>, SerializationStream) DataSerializer<KeyValuePair<TKey, TValue>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<KeyValuePair<TKey, TValue>>.PreSerialize(ref KeyValuePair<TKey, TValue>, ArchiveMode, SerializationStream) DataSerializer<KeyValuePair<TKey, TValue>>.Serialize(ref KeyValuePair<TKey, TValue>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref KeyValuePair<TKey, TValue>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref KeyValuePair<TKey, TValue> obj, ArchiveMode mode, SerializationStream stream) Parameters obj KeyValuePair<TKey, TValue> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.KeyedSortedListSerializer-3.html": {
    "href": "api/Stride.Core.Serialization.Serializers.KeyedSortedListSerializer-3.html",
    "title": "Class KeyedSortedListSerializer<TKeyedList, TKey, T> | Stride API",
    "summary": "Class KeyedSortedListSerializer<TKeyedList, TKey, T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll public class KeyedSortedListSerializer<TKeyedList, TKey, T> : DataSerializer<TKeyedList>, IDataSerializerGenericInstantiation where TKeyedList : KeyedSortedList<TKey, T> where TKey : notnull Type Parameters TKeyedList TKey T Inheritance object DataSerializer DataSerializer<TKeyedList> KeyedSortedListSerializer<TKeyedList, TKey, T> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<TKeyedList>.SerializationType DataSerializer<TKeyedList>.IsBlittable DataSerializer<TKeyedList>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<TKeyedList>.Serialize(TKeyedList, SerializationStream) DataSerializer<TKeyedList>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref TKeyedList, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref TKeyedList obj, ArchiveMode mode, SerializationStream stream) Parameters obj TKeyedList The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref TKeyedList, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref TKeyedList obj, ArchiveMode mode, SerializationStream stream) Parameters obj TKeyedList The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ListAllSerializer-2.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ListAllSerializer-2.html",
    "title": "Class ListAllSerializer<TList, T> | Stride API",
    "summary": "Class ListAllSerializer<TList, T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for IList{T}. public class ListAllSerializer<TList, T> : DataSerializer<TList>, IDataSerializerGenericInstantiation where TList : class, IList<T> Type Parameters TList Type of IList{T}. T Generics type of IList{T}. Inheritance object DataSerializer DataSerializer<TList> ListAllSerializer<TList, T> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<TList>.SerializationType DataSerializer<TList>.IsBlittable DataSerializer<TList>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<TList>.Serialize(TList, SerializationStream) DataSerializer<TList>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref TList, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref TList obj, ArchiveMode mode, SerializationStream stream) Parameters obj TList The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref TList, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref TList obj, ArchiveMode mode, SerializationStream stream) Parameters obj TList The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ListInterfaceSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ListInterfaceSerializer-1.html",
    "title": "Class ListInterfaceSerializer<T> | Stride API",
    "summary": "Class ListInterfaceSerializer<T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for IList{T}. [DataSerializerGlobal(typeof(ListInterfaceSerializer<>), typeof(IList<>), DataSerializerGenericMode.GenericArguments, false, false)] public class ListInterfaceSerializer<T> : DataSerializer<IList<T>>, IDataSerializerGenericInstantiation Type Parameters T Generics type of IList{T}. Inheritance object DataSerializer DataSerializer<IList<T>> ListInterfaceSerializer<T> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<IList<T>>.SerializationType DataSerializer<IList<T>>.IsBlittable DataSerializer<IList<T>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<IList<T>>.Serialize(IList<T>, SerializationStream) DataSerializer<IList<T>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref IList<T>, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref IList<T> obj, ArchiveMode mode, SerializationStream stream) Parameters obj IList<T> The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref IList<T>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref IList<T> obj, ArchiveMode mode, SerializationStream stream) Parameters obj IList<T> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ListSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ListSerializer-1.html",
    "title": "Class ListSerializer<T> | Stride API",
    "summary": "Class ListSerializer<T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for List{T}. [DataSerializerGlobal(typeof(ListSerializer<>), typeof(List<>), DataSerializerGenericMode.GenericArguments, false, false)] public class ListSerializer<T> : DataSerializer<List<T>>, IDataSerializerGenericInstantiation Type Parameters T Generics type of List{T}. Inheritance object DataSerializer DataSerializer<List<T>> ListSerializer<T> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<List<T>>.SerializationType DataSerializer<List<T>>.IsBlittable DataSerializer<List<T>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<List<T>>.Serialize(List<T>, SerializationStream) DataSerializer<List<T>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref List<T>, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref List<T> obj, ArchiveMode mode, SerializationStream stream) Parameters obj List<T> The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref List<T>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref List<T> obj, ArchiveMode mode, SerializationStream stream) Parameters obj List<T> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.NullableSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.NullableSerializer-1.html",
    "title": "Class NullableSerializer<T> | Stride API",
    "summary": "Class NullableSerializer<T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for Nullable{T}. [DataSerializerGlobal(typeof(NullableSerializer<>), typeof(T?), DataSerializerGenericMode.GenericArguments, false, false)] public class NullableSerializer<T> : DataSerializer<T?> where T : struct Type Parameters T The generic type in Nullable{T}. Inheritance object DataSerializer DataSerializer<T?> NullableSerializer<T> Inherited Members DataSerializer<T?>.SerializationType DataSerializer<T?>.IsBlittable DataSerializer<T?>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T?>.Serialize(T?, SerializationStream) DataSerializer<T?>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T?>.PreSerialize(ref T?, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref T?, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T? obj, ArchiveMode mode, SerializationStream stream) Parameters obj T? The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.PropertyInfoSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.PropertyInfoSerializer.html",
    "title": "Class PropertyInfoSerializer | Stride API",
    "summary": "Class PropertyInfoSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll public class PropertyInfoSerializer : DataSerializer<PropertyInfo> Inheritance object DataSerializer DataSerializer<PropertyInfo> PropertyInfoSerializer Inherited Members DataSerializer<PropertyInfo>.SerializationType DataSerializer<PropertyInfo>.IsBlittable DataSerializer<PropertyInfo>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<PropertyInfo>.Serialize(PropertyInfo, SerializationStream) DataSerializer<PropertyInfo>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<PropertyInfo>.PreSerialize(ref PropertyInfo, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref PropertyInfo, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref PropertyInfo propertyInfo, ArchiveMode mode, SerializationStream stream) Parameters propertyInfo PropertyInfo mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.PropertyKeySerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.PropertyKeySerializer-1.html",
    "title": "Class PropertyKeySerializer<T> | Stride API",
    "summary": "Class PropertyKeySerializer<T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll public class PropertyKeySerializer<T> : DataSerializer<T> where T : PropertyKey Type Parameters T Inheritance object DataSerializer DataSerializer<T> PropertyKeySerializer<T> Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.SByteSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.SByteSerializer.html",
    "title": "Class SByteSerializer | Stride API",
    "summary": "Class SByteSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for sbyte. [DataSerializerGlobal(typeof(SByteSerializer), null, DataSerializerGenericMode.None, false, false)] public class SByteSerializer : DataSerializer<sbyte> Inheritance object DataSerializer DataSerializer<sbyte> SByteSerializer Inherited Members DataSerializer<sbyte>.SerializationType DataSerializer<sbyte>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<sbyte>.Serialize(sbyte, SerializationStream) DataSerializer<sbyte>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<sbyte>.PreSerialize(ref sbyte, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref sbyte, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref sbyte obj, ArchiveMode mode, SerializationStream stream) Parameters obj sbyte The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ServiceWireSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ServiceWireSerializer.html",
    "title": "Class ServiceWireSerializer | Stride API",
    "summary": "Class ServiceWireSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll [DataSerializerGlobal(typeof(ServiceWireSerializer), null, DataSerializerGenericMode.None, false, false)] public class ServiceWireSerializer : DataSerializer<ServiceSyncInfo> Inheritance object DataSerializer DataSerializer<ServiceSyncInfo> ServiceWireSerializer Inherited Members DataSerializer<ServiceSyncInfo>.SerializationType DataSerializer<ServiceSyncInfo>.IsBlittable DataSerializer<ServiceSyncInfo>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<ServiceSyncInfo>.Serialize(ServiceSyncInfo, SerializationStream) DataSerializer<ServiceSyncInfo>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods PreSerialize(ref ServiceSyncInfo, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref ServiceSyncInfo obj, ArchiveMode mode, SerializationStream stream) Parameters obj ServiceSyncInfo The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref ServiceSyncInfo, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref ServiceSyncInfo info, ArchiveMode mode, SerializationStream stream) Parameters info ServiceSyncInfo mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.SingleSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.SingleSerializer.html",
    "title": "Class SingleSerializer | Stride API",
    "summary": "Class SingleSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for float. [DataSerializerGlobal(typeof(SingleSerializer), null, DataSerializerGenericMode.None, false, false)] public class SingleSerializer : DataSerializer<float> Inheritance object DataSerializer DataSerializer<float> SingleSerializer Inherited Members DataSerializer<float>.SerializationType DataSerializer<float>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<float>.Serialize(float, SerializationStream) DataSerializer<float>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<float>.PreSerialize(ref float, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref float, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref float obj, ArchiveMode mode, SerializationStream stream) Parameters obj float The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.SortedListSerializer-2.html": {
    "href": "api/Stride.Core.Serialization.Serializers.SortedListSerializer-2.html",
    "title": "Class SortedListSerializer<TKey, TValue> | Stride API",
    "summary": "Class SortedListSerializer<TKey, TValue> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for SortedList{TKey, TValue}. [DataSerializerGlobal(typeof(SortedListSerializer<,>), typeof(SortedList<,>), DataSerializerGenericMode.GenericArguments, false, false)] public class SortedListSerializer<TKey, TValue> : DataSerializer<SortedList<TKey, TValue>>, IDataSerializerGenericInstantiation Type Parameters TKey The type of the key in SortedList{TKey, TValue}. TValue The type of the value in SortedList{TKey, TValue}. Inheritance object DataSerializer DataSerializer<SortedList<TKey, TValue>> SortedListSerializer<TKey, TValue> Implements IDataSerializerGenericInstantiation Inherited Members DataSerializer<SortedList<TKey, TValue>>.SerializationType DataSerializer<SortedList<TKey, TValue>>.IsBlittable DataSerializer<SortedList<TKey, TValue>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<SortedList<TKey, TValue>>.Serialize(SortedList<TKey, TValue>, SerializationStream) DataSerializer<SortedList<TKey, TValue>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<SortedList<TKey, TValue>>.PreSerialize(ref SortedList<TKey, TValue>, ArchiveMode, SerializationStream) DataSerializer<SortedList<TKey, TValue>>.Serialize(ref SortedList<TKey, TValue>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods EnumerateGenericInstantiations(SerializerSelector, IList<Type>) Enumerates required DataSerializer required by this instance of DataSerializer. public void EnumerateGenericInstantiations(SerializerSelector serializerSelector, IList<Type> genericInstantiations) Parameters serializerSelector SerializerSelector genericInstantiations IList<Type> Remarks The code won't be executed, it will only be scanned for typeof() operands by the assembly processor. Null is authorized in enumeration (for now). Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. PreSerialize(ref SortedList<TKey, TValue>, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref SortedList<TKey, TValue> obj, ArchiveMode mode, SerializationStream stream) Parameters obj SortedList<TKey, TValue> The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref SortedList<TKey, TValue>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref SortedList<TKey, TValue> obj, ArchiveMode mode, SerializationStream stream) Parameters obj SortedList<TKey, TValue> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.StringSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.StringSerializer.html",
    "title": "Class StringSerializer | Stride API",
    "summary": "Class StringSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for string. [DataSerializerGlobal(typeof(StringSerializer), null, DataSerializerGenericMode.None, false, false)] public class StringSerializer : DataSerializer<string> Inheritance object DataSerializer DataSerializer<string> StringSerializer Inherited Members DataSerializer<string>.SerializationType DataSerializer<string>.IsBlittable DataSerializer<string>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<string>.Serialize(string, SerializationStream) DataSerializer<string>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<string>.PreSerialize(ref string, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref string, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref string obj, ArchiveMode mode, SerializationStream stream) Parameters obj string The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.TimeSpanSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.TimeSpanSerializer.html",
    "title": "Class TimeSpanSerializer | Stride API",
    "summary": "Class TimeSpanSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for TimeSpan. [DataSerializerGlobal(typeof(TimeSpanSerializer), null, DataSerializerGenericMode.None, false, false)] public class TimeSpanSerializer : DataSerializer<TimeSpan> Inheritance object DataSerializer DataSerializer<TimeSpan> TimeSpanSerializer Inherited Members DataSerializer<TimeSpan>.SerializationType DataSerializer<TimeSpan>.IsBlittable DataSerializer<TimeSpan>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<TimeSpan>.Serialize(TimeSpan, SerializationStream) DataSerializer<TimeSpan>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<TimeSpan>.PreSerialize(ref TimeSpan, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref TimeSpan, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref TimeSpan timeSpan, ArchiveMode mode, SerializationStream stream) Parameters timeSpan TimeSpan mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.TupleSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.TupleSerializer-1.html",
    "title": "Class TupleSerializer<T1> | Stride API",
    "summary": "Class TupleSerializer<T1> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Serializer for a 1-tuple. [DataSerializerGlobal(typeof(TupleSerializer<>), typeof(Tuple<>), DataSerializerGenericMode.GenericArguments, false, false)] public class TupleSerializer<T1> : DataSerializer<Tuple<T1>> Type Parameters T1 The type of the tuple's component 1. Inheritance object DataSerializer DataSerializer<Tuple<T1>> TupleSerializer<T1> Inherited Members DataSerializer<Tuple<T1>>.SerializationType DataSerializer<Tuple<T1>>.IsBlittable DataSerializer<Tuple<T1>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1>>.Serialize(Tuple<T1>, SerializationStream) DataSerializer<Tuple<T1>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1>>.PreSerialize(ref Tuple<T1>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref Tuple<T1>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Tuple<T1> obj, ArchiveMode mode, SerializationStream stream) Parameters obj Tuple<T1> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.TupleSerializer-2.html": {
    "href": "api/Stride.Core.Serialization.Serializers.TupleSerializer-2.html",
    "title": "Class TupleSerializer<T1, T2> | Stride API",
    "summary": "Class TupleSerializer<T1, T2> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Serializer for a 2-tuple. [DataSerializerGlobal(typeof(TupleSerializer<,>), typeof(Tuple<,>), DataSerializerGenericMode.GenericArguments, false, false)] public class TupleSerializer<T1, T2> : DataSerializer<Tuple<T1, T2>> Type Parameters T1 The type of the tuple's component 1. T2 The type of the tuple's component 2. Inheritance object DataSerializer DataSerializer<Tuple<T1, T2>> TupleSerializer<T1, T2> Inherited Members DataSerializer<Tuple<T1, T2>>.SerializationType DataSerializer<Tuple<T1, T2>>.IsBlittable DataSerializer<Tuple<T1, T2>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1, T2>>.Serialize(Tuple<T1, T2>, SerializationStream) DataSerializer<Tuple<T1, T2>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1, T2>>.PreSerialize(ref Tuple<T1, T2>, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1, T2>>.Serialize(ref Tuple<T1, T2>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref Tuple<T1, T2>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Tuple<T1, T2> obj, ArchiveMode mode, SerializationStream stream) Parameters obj Tuple<T1, T2> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.TupleSerializer-3.html": {
    "href": "api/Stride.Core.Serialization.Serializers.TupleSerializer-3.html",
    "title": "Class TupleSerializer<T1, T2, T3> | Stride API",
    "summary": "Class TupleSerializer<T1, T2, T3> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Serializer for a 3-tuple. [DataSerializerGlobal(typeof(TupleSerializer<,,>), typeof(Tuple<,,>), DataSerializerGenericMode.GenericArguments, false, false)] public class TupleSerializer<T1, T2, T3> : DataSerializer<Tuple<T1, T2, T3>> Type Parameters T1 The type of the tuple's component 1. T2 The type of the tuple's component 2. T3 The type of the tuple's component 3. Inheritance object DataSerializer DataSerializer<Tuple<T1, T2, T3>> TupleSerializer<T1, T2, T3> Inherited Members DataSerializer<Tuple<T1, T2, T3>>.SerializationType DataSerializer<Tuple<T1, T2, T3>>.IsBlittable DataSerializer<Tuple<T1, T2, T3>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1, T2, T3>>.Serialize(Tuple<T1, T2, T3>, SerializationStream) DataSerializer<Tuple<T1, T2, T3>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1, T2, T3>>.PreSerialize(ref Tuple<T1, T2, T3>, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1, T2, T3>>.Serialize(ref Tuple<T1, T2, T3>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref Tuple<T1, T2, T3>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Tuple<T1, T2, T3> obj, ArchiveMode mode, SerializationStream stream) Parameters obj Tuple<T1, T2, T3> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.TupleSerializer-4.html": {
    "href": "api/Stride.Core.Serialization.Serializers.TupleSerializer-4.html",
    "title": "Class TupleSerializer<T1, T2, T3, T4> | Stride API",
    "summary": "Class TupleSerializer<T1, T2, T3, T4> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Serializer for a 4-tuple. [DataSerializerGlobal(typeof(TupleSerializer<,,,>), typeof(Tuple<,,,>), DataSerializerGenericMode.GenericArguments, false, false)] public class TupleSerializer<T1, T2, T3, T4> : DataSerializer<Tuple<T1, T2, T3, T4>> Type Parameters T1 The type of the tuple's component 1. T2 The type of the tuple's component 2. T3 The type of the tuple's component 3. T4 The type of the tuple's component 4. Inheritance object DataSerializer DataSerializer<Tuple<T1, T2, T3, T4>> TupleSerializer<T1, T2, T3, T4> Inherited Members DataSerializer<Tuple<T1, T2, T3, T4>>.SerializationType DataSerializer<Tuple<T1, T2, T3, T4>>.IsBlittable DataSerializer<Tuple<T1, T2, T3, T4>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1, T2, T3, T4>>.Serialize(Tuple<T1, T2, T3, T4>, SerializationStream) DataSerializer<Tuple<T1, T2, T3, T4>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1, T2, T3, T4>>.PreSerialize(ref Tuple<T1, T2, T3, T4>, ArchiveMode, SerializationStream) DataSerializer<Tuple<T1, T2, T3, T4>>.Serialize(ref Tuple<T1, T2, T3, T4>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref Tuple<T1, T2, T3, T4>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Tuple<T1, T2, T3, T4> obj, ArchiveMode mode, SerializationStream stream) Parameters obj Tuple<T1, T2, T3, T4> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.TypeSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.TypeSerializer.html",
    "title": "Class TypeSerializer | Stride API",
    "summary": "Class TypeSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll [DataSerializerGlobal(typeof(TypeSerializer), null, DataSerializerGenericMode.None, false, false)] public class TypeSerializer : DataSerializer<Type> Inheritance object DataSerializer DataSerializer<Type> TypeSerializer Inherited Members DataSerializer<Type>.SerializationType DataSerializer<Type>.IsBlittable DataSerializer<Type>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Type>.Serialize(Type, SerializationStream) DataSerializer<Type>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Type>.PreSerialize(ref Type, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref Type, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Type type, ArchiveMode mode, SerializationStream stream) Parameters type Type mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.UInt16Serializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.UInt16Serializer.html",
    "title": "Class UInt16Serializer | Stride API",
    "summary": "Class UInt16Serializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for ushort. [DataSerializerGlobal(typeof(UInt16Serializer), null, DataSerializerGenericMode.None, false, false)] public class UInt16Serializer : DataSerializer<ushort> Inheritance object DataSerializer DataSerializer<ushort> UInt16Serializer Inherited Members DataSerializer<ushort>.SerializationType DataSerializer<ushort>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<ushort>.Serialize(ushort, SerializationStream) DataSerializer<ushort>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<ushort>.PreSerialize(ref ushort, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref ushort, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref ushort obj, ArchiveMode mode, SerializationStream stream) Parameters obj ushort The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.UInt32Serializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.UInt32Serializer.html",
    "title": "Class UInt32Serializer | Stride API",
    "summary": "Class UInt32Serializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for uint. [DataSerializerGlobal(typeof(UInt32Serializer), null, DataSerializerGenericMode.None, false, false)] public class UInt32Serializer : DataSerializer<uint> Inheritance object DataSerializer DataSerializer<uint> UInt32Serializer Inherited Members DataSerializer<uint>.SerializationType DataSerializer<uint>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<uint>.Serialize(uint, SerializationStream) DataSerializer<uint>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<uint>.PreSerialize(ref uint, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref uint, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref uint obj, ArchiveMode mode, SerializationStream stream) Parameters obj uint The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.UInt64Serializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.UInt64Serializer.html",
    "title": "Class UInt64Serializer | Stride API",
    "summary": "Class UInt64Serializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for ulong. [DataSerializerGlobal(typeof(UInt64Serializer), null, DataSerializerGenericMode.None, false, false)] public class UInt64Serializer : DataSerializer<ulong> Inheritance object DataSerializer DataSerializer<ulong> UInt64Serializer Inherited Members DataSerializer<ulong>.SerializationType DataSerializer<ulong>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<ulong>.Serialize(ulong, SerializationStream) DataSerializer<ulong>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<ulong>.PreSerialize(ref ulong, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsBlittable public override bool IsBlittable { get; } Property Value bool Methods Serialize(ref ulong, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref ulong obj, ArchiveMode mode, SerializationStream stream) Parameters obj ulong The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.UriSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.UriSerializer.html",
    "title": "Class UriSerializer | Stride API",
    "summary": "Class UriSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Data serializer for string. [DataSerializerGlobal(typeof(UriSerializer), null, DataSerializerGenericMode.None, false, false)] public class UriSerializer : DataSerializer<Uri> Inheritance object DataSerializer DataSerializer<Uri> UriSerializer Inherited Members DataSerializer<Uri>.SerializationType DataSerializer<Uri>.IsBlittable DataSerializer<Uri>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Uri>.Serialize(Uri, SerializationStream) DataSerializer<Uri>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Uri>.PreSerialize(ref Uri, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref Uri, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Uri obj, ArchiveMode mode, SerializationStream stream) Parameters obj Uri The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.UrlReferenceDataSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.UrlReferenceDataSerializer-1.html",
    "title": "Class UrlReferenceDataSerializer<T> | Stride API",
    "summary": "Class UrlReferenceDataSerializer<T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.Serialization.dll Serializer for UrlReference<T>. public sealed class UrlReferenceDataSerializer<T> : UrlReferenceDataSerializerBase<UrlReference<T>> where T : class Type Parameters T The type of asset. Inheritance object DataSerializer DataSerializer<UrlReference<T>> UrlReferenceDataSerializerBase<UrlReference<T>> UrlReferenceDataSerializer<T> Inherited Members UrlReferenceDataSerializerBase<UrlReference<T>>.Serialize(ref UrlReference<T>, ArchiveMode, SerializationStream) DataSerializer<UrlReference<T>>.SerializationType DataSerializer<UrlReference<T>>.IsBlittable DataSerializer<UrlReference<T>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<UrlReference<T>>.Serialize(UrlReference<T>, SerializationStream) DataSerializer<UrlReference<T>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<UrlReference<T>>.PreSerialize(ref UrlReference<T>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Serialization.Serializers.UrlReferenceDataSerializer.html": {
    "href": "api/Stride.Core.Serialization.Serializers.UrlReferenceDataSerializer.html",
    "title": "Class UrlReferenceDataSerializer | Stride API",
    "summary": "Class UrlReferenceDataSerializer Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.Serialization.dll Serializer for UrlReference. public sealed class UrlReferenceDataSerializer : UrlReferenceDataSerializerBase<UrlReference> Inheritance object DataSerializer DataSerializer<UrlReference> UrlReferenceDataSerializerBase<UrlReference> UrlReferenceDataSerializer Inherited Members UrlReferenceDataSerializerBase<UrlReference>.Serialize(ref UrlReference, ArchiveMode, SerializationStream) DataSerializer<UrlReference>.SerializationType DataSerializer<UrlReference>.IsBlittable DataSerializer<UrlReference>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<UrlReference>.Serialize(UrlReference, SerializationStream) DataSerializer<UrlReference>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<UrlReference>.PreSerialize(ref UrlReference, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Serialization.Serializers.UrlReferenceDataSerializerBase-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.UrlReferenceDataSerializerBase-1.html",
    "title": "Class UrlReferenceDataSerializerBase<T> | Stride API",
    "summary": "Class UrlReferenceDataSerializerBase<T> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.Serialization.dll Serializer base class for UrlReference. public abstract class UrlReferenceDataSerializerBase<T> : DataSerializer<T> where T : UrlReferenceBase, new() Type Parameters T Inheritance object DataSerializer DataSerializer<T> UrlReferenceDataSerializerBase<T> Derived UrlReferenceDataSerializer UrlReferenceDataSerializer<T> Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.PreSerialize(ref T, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T urlReference, ArchiveMode mode, SerializationStream stream) Parameters urlReference T mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ValueTupleSerializer-1.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ValueTupleSerializer-1.html",
    "title": "Class ValueTupleSerializer<T1> | Stride API",
    "summary": "Class ValueTupleSerializer<T1> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Serializer for a 1-value tuple. [DataSerializerGlobal(typeof(ValueTupleSerializer<>), typeof(ValueTuple<>), DataSerializerGenericMode.GenericArguments, false, false)] public class ValueTupleSerializer<T1> : DataSerializer<ValueTuple<T1>> Type Parameters T1 The type of the tuple's component 1. Inheritance object DataSerializer DataSerializer<ValueTuple<T1>> ValueTupleSerializer<T1> Inherited Members DataSerializer<ValueTuple<T1>>.SerializationType DataSerializer<ValueTuple<T1>>.IsBlittable DataSerializer<ValueTuple<T1>>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<ValueTuple<T1>>.Serialize(ValueTuple<T1>, SerializationStream) DataSerializer<ValueTuple<T1>>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<ValueTuple<T1>>.PreSerialize(ref ValueTuple<T1>, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref ValueTuple<T1>, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref ValueTuple<T1> obj, ArchiveMode mode, SerializationStream stream) Parameters obj ValueTuple<T1> The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ValueTupleSerializer-2.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ValueTupleSerializer-2.html",
    "title": "Class ValueTupleSerializer<T1, T2> | Stride API",
    "summary": "Class ValueTupleSerializer<T1, T2> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Serializer for a 2-value tuple. [DataSerializerGlobal(typeof(ValueTupleSerializer<,>), typeof(ValueTuple<,>), DataSerializerGenericMode.GenericArguments, false, false)] public class ValueTupleSerializer<T1, T2> : DataSerializer<(T1, T2)> Type Parameters T1 The type of the tuple's component 1. T2 The type of the tuple's component 2. Inheritance object DataSerializer DataSerializer<(T1, T2)> ValueTupleSerializer<T1, T2> Inherited Members DataSerializer<(T1, T2)>.SerializationType DataSerializer<(T1, T2)>.IsBlittable DataSerializer<(T1, T2)>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<(T1, T2)>.Serialize((T1, T2), SerializationStream) DataSerializer<(T1, T2)>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<(T1, T2)>.PreSerialize(ref (T1, T2), ArchiveMode, SerializationStream) DataSerializer<(T1, T2)>.Serialize(ref (T1, T2), ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref (T1, T2), ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref (T1, T2) obj, ArchiveMode mode, SerializationStream stream) Parameters obj (T1, T2) The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ValueTupleSerializer-3.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ValueTupleSerializer-3.html",
    "title": "Class ValueTupleSerializer<T1, T2, T3> | Stride API",
    "summary": "Class ValueTupleSerializer<T1, T2, T3> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Serializer for a 3-value tuple. [DataSerializerGlobal(typeof(ValueTupleSerializer<,,>), typeof(ValueTuple<,,>), DataSerializerGenericMode.GenericArguments, false, false)] public class ValueTupleSerializer<T1, T2, T3> : DataSerializer<(T1, T2, T3)> Type Parameters T1 The type of the tuple's component 1. T2 The type of the tuple's component 2. T3 The type of the tuple's component 3. Inheritance object DataSerializer DataSerializer<(T1, T2, T3)> ValueTupleSerializer<T1, T2, T3> Inherited Members DataSerializer<(T1, T2, T3)>.SerializationType DataSerializer<(T1, T2, T3)>.IsBlittable DataSerializer<(T1, T2, T3)>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<(T1, T2, T3)>.Serialize((T1, T2, T3), SerializationStream) DataSerializer<(T1, T2, T3)>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<(T1, T2, T3)>.PreSerialize(ref (T1, T2, T3), ArchiveMode, SerializationStream) DataSerializer<(T1, T2, T3)>.Serialize(ref (T1, T2, T3), ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref (T1, T2, T3), ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref (T1, T2, T3) obj, ArchiveMode mode, SerializationStream stream) Parameters obj (T1, T2, T3) The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.ValueTupleSerializer-4.html": {
    "href": "api/Stride.Core.Serialization.Serializers.ValueTupleSerializer-4.html",
    "title": "Class ValueTupleSerializer<T1, T2, T3, T4> | Stride API",
    "summary": "Class ValueTupleSerializer<T1, T2, T3, T4> Namespace Stride.Core.Serialization.Serializers Assembly Stride.Core.dll Serializer for a 4-value tuple. [DataSerializerGlobal(typeof(ValueTupleSerializer<,,,>), typeof(ValueTuple<,,,>), DataSerializerGenericMode.GenericArguments, false, false)] public class ValueTupleSerializer<T1, T2, T3, T4> : DataSerializer<(T1, T2, T3, T4)> Type Parameters T1 The type of the tuple's component 1. T2 The type of the tuple's component 2. T3 The type of the tuple's component 3. T4 The type of the tuple's component 4. Inheritance object DataSerializer DataSerializer<(T1, T2, T3, T4)> ValueTupleSerializer<T1, T2, T3, T4> Inherited Members DataSerializer<(T1, T2, T3, T4)>.SerializationType DataSerializer<(T1, T2, T3, T4)>.IsBlittable DataSerializer<(T1, T2, T3, T4)>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<(T1, T2, T3, T4)>.Serialize((T1, T2, T3, T4), SerializationStream) DataSerializer<(T1, T2, T3, T4)>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<(T1, T2, T3, T4)>.PreSerialize(ref (T1, T2, T3, T4), ArchiveMode, SerializationStream) DataSerializer<(T1, T2, T3, T4)>.Serialize(ref (T1, T2, T3, T4), ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.SerializationType DataSerializer.IsBlittable DataSerializer.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer.PreSerialize(ref object, ArchiveMode, SerializationStream) Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref (T1, T2, T3, T4), ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref (T1, T2, T3, T4) obj, ArchiveMode mode, SerializationStream stream) Parameters obj (T1, T2, T3, T4) The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Core.Serialization.Serializers.html": {
    "href": "api/Stride.Core.Serialization.Serializers.html",
    "title": "Namespace Stride.Core.Serialization.Serializers | Stride API",
    "summary": "Namespace Stride.Core.Serialization.Serializers Classes ArraySerializer<T> Data serializer for T[]. BlittableArraySerializer<T> Data serializer for blittable T[]. BoolSerializer Data serializer for bool. ByteArraySerializer Implements DataSerializer<T> for a byte array. ByteSerializer Data serializer for byte. CharSerializer Data serializer for char. DateTimeSerializer DictionaryAllSerializer<TDictionary, TKey, TValue> DictionaryInterfaceSerializer<TKey, TValue> Data serializer for IDictionary{TKey, TValue}. DictionarySerializer<TKey, TValue> Data serializer for Dictionary{TKey, TValue}. DoubleSerializer Data serializer for double. EnumSerializer Data serializer for Enum. EnumSerializer<T> Data serializer for typed enum. GuidSerializer Data serializer for Guid. HashSetSerializer<T> Data serializer for HashSet{T}. Int16Serializer Data serializer for short. Int32Serializer Data serializer for int. Int64Serializer Data serializer for long. KeyValuePairSerializer<TKey, TValue> Data serializer for KeyValuePair{TKey, TValue}. KeyedSortedListSerializer<TKeyedList, TKey, T> ListAllSerializer<TList, T> Data serializer for IList{T}. ListInterfaceSerializer<T> Data serializer for IList{T}. ListSerializer<T> Data serializer for List{T}. NullableSerializer<T> Data serializer for Nullable{T}. PropertyInfoSerializer PropertyKeySerializer<T> SByteSerializer Data serializer for sbyte. ServiceWireSerializer SingleSerializer Data serializer for float. SortedListSerializer<TKey, TValue> Data serializer for SortedList{TKey, TValue}. StringSerializer Data serializer for string. TimeSpanSerializer Data serializer for TimeSpan. TupleSerializer<T1> Serializer for a 1-tuple. TupleSerializer<T1, T2> Serializer for a 2-tuple. TupleSerializer<T1, T2, T3> Serializer for a 3-tuple. TupleSerializer<T1, T2, T3, T4> Serializer for a 4-tuple. TypeSerializer UInt16Serializer Data serializer for ushort. UInt32Serializer Data serializer for uint. UInt64Serializer Data serializer for ulong. UriSerializer Data serializer for string. UrlReferenceDataSerializer Serializer for UrlReference. UrlReferenceDataSerializerBase<T> Serializer base class for UrlReference. UrlReferenceDataSerializer<T> Serializer for UrlReference<T>. ValueTupleSerializer<T1> Serializer for a 1-value tuple. ValueTupleSerializer<T1, T2> Serializer for a 2-value tuple. ValueTupleSerializer<T1, T2, T3> Serializer for a 3-value tuple. ValueTupleSerializer<T1, T2, T3, T4> Serializer for a 4-value tuple. Enums ComplexTypeSerializerFlags"
  },
  "api/Stride.Core.Serialization.TagMarkedDelegate.html": {
    "href": "api/Stride.Core.Serialization.TagMarkedDelegate.html",
    "title": "Delegate TagMarkedDelegate | Stride API",
    "summary": "Delegate TagMarkedDelegate Namespace Stride.Core.Serialization Assembly Stride.Core.dll public delegate void TagMarkedDelegate(SerializationStream stream, SerializationTagType tagType, object tagParam) Parameters stream SerializationStream tagType SerializationTagType tagParam object Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Serialization.UrlReference-1.html": {
    "href": "api/Stride.Core.Serialization.UrlReference-1.html",
    "title": "Class UrlReference<T> | Stride API",
    "summary": "Class UrlReference<T> Namespace Stride.Core.Serialization Assembly Stride.Core.Serialization.dll Represents a Url to an asset of type T. [DataSerializer(typeof(UrlReferenceDataSerializer<>), Mode = DataSerializerGenericMode.GenericArguments)] public sealed class UrlReference<T> : UrlReferenceBase, IReference, IUrlReference where T : class Type Parameters T The type off asset. Inheritance object UrlReferenceBase UrlReference<T> Implements IReference IUrlReference Inherited Members UrlReferenceBase.Url UrlReferenceBase.Id UrlReferenceBase.IsEmpty UrlReferenceBase.ToString() UrlReferenceBase.New(Type, AssetId, string) UrlReferenceBase.IsUrlReferenceType(Type) UrlReferenceBase.TryGetAssetType(Type, out Type) Extension Methods UnsafeUtilities.As<T>(object?) Constructors UrlReference() Create a new UrlReference<T> instance. public UrlReference() UrlReference(AssetId, string) Create a new UrlReference instance. public UrlReference(AssetId id, string url) Parameters id AssetId url string Exceptions ArgumentNullException If url is null or empty. UrlReference(string) Create a new UrlReference<T> instance. public UrlReference(string url) Parameters url string Exceptions ArgumentNullException If url is null or empty."
  },
  "api/Stride.Core.Serialization.UrlReference.html": {
    "href": "api/Stride.Core.Serialization.UrlReference.html",
    "title": "Class UrlReference | Stride API",
    "summary": "Class UrlReference Namespace Stride.Core.Serialization Assembly Stride.Core.Serialization.dll Represents a Url to an asset. [DataSerializer(typeof(UrlReferenceDataSerializer))] public sealed class UrlReference : UrlReferenceBase, IReference, IUrlReference Inheritance object UrlReferenceBase UrlReference Implements IReference IUrlReference Inherited Members UrlReferenceBase.Url UrlReferenceBase.Id UrlReferenceBase.IsEmpty UrlReferenceBase.ToString() UrlReferenceBase.New(Type, AssetId, string) UrlReferenceBase.IsUrlReferenceType(Type) UrlReferenceBase.TryGetAssetType(Type, out Type) Extension Methods UnsafeUtilities.As<T>(object?) Constructors UrlReference() Create a new UrlReference instance. public UrlReference() UrlReference(AssetId, string) Create a new UrlReference instance. public UrlReference(AssetId id, string url) Parameters id AssetId url string Exceptions ArgumentNullException If url is null or empty. UrlReference(string) Create a new UrlReference instance. public UrlReference(string url) Parameters url string Exceptions ArgumentNullException If url is null or empty."
  },
  "api/Stride.Core.Serialization.UrlReferenceBase.html": {
    "href": "api/Stride.Core.Serialization.UrlReferenceBase.html",
    "title": "Class UrlReferenceBase | Stride API",
    "summary": "Class UrlReferenceBase Namespace Stride.Core.Serialization Assembly Stride.Core.Serialization.dll Base class for IUrlReference implementations [DataContract(\"urlref\", Inherited = true)] [DataStyle(DataStyle.Compact)] public abstract class UrlReferenceBase : IReference, IUrlReference Inheritance object UrlReferenceBase Implements IReference IUrlReference Derived UrlReference UrlReference<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors UrlReferenceBase() Create a new UrlReferenceBase instance. protected UrlReferenceBase() UrlReferenceBase(AssetId, string) Create a new UrlReferenceBase instance. protected UrlReferenceBase(AssetId id, string url) Parameters id AssetId url string Exceptions ArgumentNullException If url is null or empty. UrlReferenceBase(string) Create a new UrlReferenceBase instance. protected UrlReferenceBase(string url) Parameters url string Exceptions ArgumentNullException If url is null or empty. Properties Id Gets the Id of the referenced asset. [DataMember(20)] public AssetId Id { get; init; } Property Value AssetId IsEmpty Gets whether the url is null or empty. public bool IsEmpty { get; } Property Value bool Url Gets the Url of the referenced asset. [DataMember(10)] public string Url { get; init; } Property Value string Methods IsUrlReferenceType(Type?) public static bool IsUrlReferenceType(Type? type) Parameters type Type Returns bool New(Type, AssetId, string) public static UrlReferenceBase New(Type urlReferenceType, AssetId id, string url) Parameters urlReferenceType Type id AssetId url string Returns UrlReferenceBase ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. TryGetAssetType(Type, out Type) public static bool TryGetAssetType(Type type, out Type assetType) Parameters type Type assetType Type Returns bool"
  },
  "api/Stride.Core.Serialization.UrlReferenceContentManagerExtenstions.html": {
    "href": "api/Stride.Core.Serialization.UrlReferenceContentManagerExtenstions.html",
    "title": "Class UrlReferenceContentManagerExtenstions | Stride API",
    "summary": "Class UrlReferenceContentManagerExtenstions Namespace Stride.Core.Serialization Assembly Stride.Core.Serialization.dll Extension methods of IContentManager to allow usage of UrlReference and UrlReference<T>. public static class UrlReferenceContentManagerExtenstions Inheritance object UrlReferenceContentManagerExtenstions Methods Exists(IContentManager, IUrlReference) Check if the specified asset url exists. public static bool Exists(this IContentManager content, IUrlReference urlReference) Parameters content IContentManager The IContentManager. urlReference IUrlReference The URL. Returns bool true if the specified asset url exists, false otherwise. Exceptions ArgumentNullException If urlReference is null or empty. Or content is null. Get<T>(IContentManager, UrlReference<T>) Gets a previously loaded asset from its URL. public static T? Get<T>(this IContentManager content, UrlReference<T> urlReference) where T : class Parameters content IContentManager urlReference UrlReference<T> The URL of the asset to retrieve. Returns T The loaded asset, or null if the asset has not been loaded. Type Parameters T The type of asset to retrieve. Remarks This function does not increase the reference count on the asset. Exceptions ArgumentNullException If urlReference is null or empty. Or content is null. IsLoaded(IContentManager, IUrlReference, bool) Gets whether an asset with the given URL is currently loaded. public static bool IsLoaded(this IContentManager content, IUrlReference urlReference, bool loadedManuallyOnly = false) Parameters content IContentManager urlReference IUrlReference The URL to check. loadedManuallyOnly bool If true, this method will return true only if an asset with the given URL has been manually loaded via Load<T>(IContentManager, UrlReference<T>, ContentManagerLoaderSettings?), and not if the asset has been only loaded indirectly from another asset. Returns bool True if an asset with the given URL is currently loaded, false otherwise. Exceptions ArgumentNullException If urlReference is null or empty. Or content is null. LoadAsync<T>(IContentManager, UrlReference<T>, ContentManagerLoaderSettings?) Loads content from the specified URL asynchronously. public static Task<T> LoadAsync<T>(this IContentManager content, UrlReference<T> urlReference, ContentManagerLoaderSettings? settings = null) where T : class Parameters content IContentManager The IContentManager. urlReference UrlReference<T> The URL to load from. settings ContentManagerLoaderSettings The settings. If null, fallback to Default. Returns Task<T> The loaded content. Type Parameters T The content type. Exceptions ArgumentNullException If urlReference is null or empty. Or content is null. Load<T>(IContentManager, UrlReference<T>, ContentManagerLoaderSettings?) Loads content from the specified URL. public static T Load<T>(this IContentManager content, UrlReference<T> urlReference, ContentManagerLoaderSettings? settings = null) where T : class Parameters content IContentManager The IContentManager. urlReference UrlReference<T> The URL to load from. settings ContentManagerLoaderSettings The settings. If null, fallback to Default. Returns T The loaded content. Type Parameters T The content type. Exceptions ArgumentNullException If urlReference is null or empty. Or content is null. OpenAsStream(IContentManager, UrlReference, StreamFlags) Opens the specified URL as a stream used for custom raw asset loading. public static Stream OpenAsStream(this IContentManager content, UrlReference urlReference, StreamFlags streamFlags = StreamFlags.None) Parameters content IContentManager The IContentManager. urlReference UrlReference The URL to the raw asset. streamFlags StreamFlags The type of stream needed Returns Stream A stream to the raw asset. Exceptions ArgumentNullException If urlReference is null or empty. Or content is null. Unload(IContentManager, IUrlReference) Unloads the asset at the specified URL. public static void Unload(this IContentManager content, IUrlReference urlReference) Parameters content IContentManager urlReference IUrlReference The URL. Exceptions ArgumentNullException If urlReference is null or empty. Or content is null."
  },
  "api/Stride.Core.Serialization.VirtualFileStream.html": {
    "href": "api/Stride.Core.Serialization.VirtualFileStream.html",
    "title": "Class VirtualFileStream | Stride API",
    "summary": "Class VirtualFileStream Namespace Stride.Core.Serialization Assembly Stride.Core.IO.dll A multithreaded wrapper over a Stream, used by the VirtualFileSystem. It also allows restricted access to subparts of the Stream (useful for serialization and data streaming). public class VirtualFileStream : Stream, IAsyncDisposable, IDisposable Inheritance object MarshalByRefObject Stream VirtualFileStream Implements IAsyncDisposable IDisposable Inherited Members Stream.Null Stream.BeginRead(byte[], int, int, AsyncCallback, object) Stream.BeginWrite(byte[], int, int, AsyncCallback, object) Stream.Close() Stream.CopyTo(Stream) Stream.CopyTo(Stream, int) Stream.CopyToAsync(Stream) Stream.CopyToAsync(Stream, int) Stream.CopyToAsync(Stream, int, CancellationToken) Stream.CopyToAsync(Stream, CancellationToken) Stream.CreateWaitHandle() Stream.Dispose() Stream.DisposeAsync() Stream.EndRead(IAsyncResult) Stream.EndWrite(IAsyncResult) Stream.FlushAsync() Stream.FlushAsync(CancellationToken) Stream.ObjectInvariant() Stream.ReadAsync(byte[], int, int) Stream.ReadAsync(byte[], int, int, CancellationToken) Stream.ReadAsync(Memory<byte>, CancellationToken) Stream.ReadAtLeast(Span<byte>, int, bool) Stream.ReadAtLeastAsync(Memory<byte>, int, bool, CancellationToken) Stream.ReadExactly(byte[], int, int) Stream.ReadExactly(Span<byte>) Stream.ReadExactlyAsync(byte[], int, int, CancellationToken) Stream.ReadExactlyAsync(Memory<byte>, CancellationToken) Stream.Synchronized(Stream) Stream.ValidateBufferArguments(byte[], int, int) Stream.ValidateCopyToArguments(Stream, int) Stream.WriteAsync(byte[], int, int) Stream.WriteAsync(byte[], int, int, CancellationToken) Stream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken) Stream.CanTimeout Stream.ReadTimeout Stream.WriteTimeout MarshalByRefObject.GetLifetimeService() MarshalByRefObject.InitializeLifetimeService() MarshalByRefObject.MemberwiseClone(bool) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) SocketExtensions.Read7BitEncodedInt(Stream) SocketExtensions.ReadAllAsync(Stream, byte[], int, int) SocketExtensions.ReadGuidAsync(Stream) SocketExtensions.ReadInt16Async(Stream) SocketExtensions.ReadInt32Async(Stream) SocketExtensions.ReadStringAsync(Stream) SocketExtensions.Write7BitEncodedInt(Stream, int) SocketExtensions.WriteGuidAsync(Stream, Guid) SocketExtensions.WriteInt16Async(Stream, short) SocketExtensions.WriteInt32Async(Stream, int) SocketExtensions.WriteStringAsync(Stream, string) UnsafeUtilities.As<T>(object?) Constructors VirtualFileStream(Stream, long, long, bool, bool) Initializes a new instance of the VirtualFileStream class. public VirtualFileStream(Stream internalStream, long startPosition = 0, long endPosition = -1, bool disposeInternalStream = true, bool seekToBeginning = true) Parameters internalStream Stream The internal stream. startPosition long The start position. endPosition long The end position. disposeInternalStream bool if set to true this instance has ownership of the internal stream and will dispose it]. seekToBeginning bool Exceptions ArgumentOutOfRangeException startPosition and endPosition doesn't fit inside current bounds NotSupportedException Attempted to create a VirtualFileStream from a Stream which doesn't support seeking. Fields endPosition protected readonly long endPosition Field Value long startPosition protected readonly long startPosition Field Value long virtualFileStream protected VirtualFileStream virtualFileStream Field Value VirtualFileStream Properties CanRead When overridden in a derived class, gets a value indicating whether the current stream supports reading. public override bool CanRead { get; } Property Value bool true if the stream supports reading; otherwise, false. CanSeek When overridden in a derived class, gets a value indicating whether the current stream supports seeking. public override bool CanSeek { get; } Property Value bool true if the stream supports seeking; otherwise, false. CanWrite When overridden in a derived class, gets a value indicating whether the current stream supports writing. public override bool CanWrite { get; } Property Value bool true if the stream supports writing; otherwise, false. EndPosition public long EndPosition { get; } Property Value long InternalStream public Stream InternalStream { get; protected set; } Property Value Stream Length When overridden in a derived class, gets the length in bytes of the stream. public override long Length { get; } Property Value long A long value representing the length of the stream in bytes. Exceptions NotSupportedException A class derived from Stream does not support seeking and the length is unknown. ObjectDisposedException Methods were called after the stream was closed. Position When overridden in a derived class, gets or sets the position within the current stream. public override long Position { get; set; } Property Value long The current position within the stream. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support seeking. ObjectDisposedException Methods were called after the stream was closed. StartPosition public long StartPosition { get; } Property Value long Methods Dispose(bool) Releases the unmanaged resources used by the Stream and optionally releases the managed resources. protected override void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. Flush() When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. public override void Flush() Exceptions IOException An I/O error occurs. Read(byte[], int, int) When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. public override int Read(byte[] buffer, int offset, int count) Parameters buffer byte[] An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. offset int The zero-based byte offset in buffer at which to begin storing the data read from the current stream. count int The maximum number of bytes to be read from the current stream. Returns int The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if count is 0 or the end of the stream has been reached. Exceptions ArgumentException The sum of offset and count is larger than the buffer length. ArgumentNullException buffer is null. ArgumentOutOfRangeException offset or count is negative. IOException An I/O error occurs. NotSupportedException The stream does not support reading. ObjectDisposedException Methods were called after the stream was closed. Read(Span<byte>) When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. public override int Read(Span<byte> buffer) Parameters buffer Span<byte> A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source. Returns int The total number of bytes read into the buffer. This can be less than the size of the buffer if that many bytes are not currently available, or zero (0) if the buffer's length is zero or the end of the stream has been reached. ReadByte() Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. public override int ReadByte() Returns int The unsigned byte cast to an int, or -1 if at the end of the stream. Exceptions NotSupportedException The stream does not support reading. ObjectDisposedException Methods were called after the stream was closed. Seek(long, SeekOrigin) When overridden in a derived class, sets the position within the current stream. public override long Seek(long offset, SeekOrigin origin) Parameters offset long A byte offset relative to the origin parameter. origin SeekOrigin A value of type SeekOrigin indicating the reference point used to obtain the new position. Returns long The new position within the current stream. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support seeking, such as if the stream is constructed from a pipe or console output. ObjectDisposedException Methods were called after the stream was closed. IOException The offset and origin would seek to a position before the start of the stream or after the end. SetLength(long) When overridden in a derived class, sets the length of the current stream. public override void SetLength(long value) Parameters value long The desired length of the current stream in bytes. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. ObjectDisposedException Methods were called after the stream was closed. Write(byte[], int, int) When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. public override void Write(byte[] buffer, int offset, int count) Parameters buffer byte[] An array of bytes. This method copies count bytes from buffer to the current stream. offset int The zero-based byte offset in buffer at which to begin copying bytes to the current stream. count int The number of bytes to be written to the current stream. Exceptions ArgumentException The sum of offset and count is greater than the buffer length. ArgumentNullException buffer is null. ArgumentOutOfRangeException offset or count is negative. IOException An I/O error occurred, such as the specified file cannot be found. NotSupportedException The stream does not support writing. ObjectDisposedException Write(byte[], int, int) was called after the stream was closed. IOException The remaining capacity in the stream is not large enough to write the specified buffer. Write(ReadOnlySpan<byte>) When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. public override void Write(ReadOnlySpan<byte> buffer) Parameters buffer ReadOnlySpan<byte> A region of memory. This method copies the contents of this region to the current stream. Exceptions IOException The remaining capacity in the stream is not large enough to write the specified buffer. WriteByte(byte) Writes a byte to the current position in the stream and advances the position within the stream by one byte. public override void WriteByte(byte value) Parameters value byte The byte to write to the stream. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support writing, or the stream is already closed. ObjectDisposedException Methods were called after the stream was closed. IOException The remaining capacity in the stream is not large enough to write the specified buffer."
  },
  "api/Stride.Core.Serialization.html": {
    "href": "api/Stride.Core.Serialization.html",
    "title": "Namespace Stride.Core.Serialization | Stride API",
    "summary": "Namespace Stride.Core.Serialization Classes AssemblySerializerFactoryAttribute Used internally by assembly processor when generating serializer factories. AssemblySerializers AssemblySerializersPerProfile AttachedReference Stores the object reference information, so that it is easy to work on partially loaded or CPU version of assets with ContentManager. AttachedReferenceManager Manage object reference information externally, not stored in the object but in a separate AttachedReference object. BinarySerializationReader Implements SerializationStream as a binary reader. BinarySerializationWriter Implements SerializationStream as a binary writer. ClassDataSerializer<T> ContentRefOutOfSyncException DataSerializer Describes how to serialize and deserialize an object without knowing its type. Used as a common base class for all data serializers. DataSerializerAttribute Use this attribute on a class to specify its data serializer type. DataSerializerFactory DataSerializerGlobalAttribute Declares a serializer like DataSerializerAttribute or DataContractAttribute, but externally. DataSerializer<T> Describes how to serialize and deserialize an object of a given type. EmptyDataSerializer<T> GenericSerializerFactory Simple serializer that will matches specific type using base type and create a data serializer with matched type. HashSerializationWriter MemberNonSealedSerializer MemberNonSealedSerializerObject<T> MemberNonSealedSerializer<T> MemberNullableSerializer MemberNullableSerializerObject<T> MemberNullableSerializer<T> MemberReuseSerializer MemberReuseSerializerObject<T> MemberReuseSerializer<T> MemberSerializer MemberSerializer.ObjectReferenceEqualityComparer Implements an equality comparer based on object reference instead of object.Equals(object). MemberSerializer<T> Helper for serializing members of a class. NullSerializer<T> A null serializer that can be used to add dummy serialization attributes. SerializationStream Base class for implementation of SerializationStream. SerializationTagType SerializerContext SerializerExtensions Various useful extension methods on top of SerializationStream for serialization/deserialization of common types. SerializerFactory Used as a fallback when GetSerializer(ref ObjectId) didn't find anything. SerializerSelector Serializer context. It holds DataSerializer{T} objects and their factories. UrlReference Represents a Url to an asset. UrlReferenceBase Base class for IUrlReference implementations UrlReferenceContentManagerExtenstions Extension methods of IContentManager to allow usage of UrlReference and UrlReference<T>. UrlReference<T> Represents a Url to an asset of type T. VirtualFileStream A multithreaded wrapper over a Stream, used by the VirtualFileSystem. It also allows restricted access to subparts of the Stream (useful for serialization and data streaming). Structs AssemblySerializerEntry An entry to a serialized object. AssemblySerializers.DataContractAlias Interfaces IDataSerializerGenericInstantiation Allows enumeration of required data serializers. IUrlReference Represents a Url to an asset. Enums ArchiveMode Enumerates the different mode of serialization (either serialization or deserialization). DataSerializerGenericMode Defines what generic parameters to pass to the serializer. SerializeClassFlags Specifies flags used when serializing reference types. Delegates SerializeObjectDelegate TagMarkedDelegate"
  },
  "api/Stride.Core.ServiceEventArgs.html": {
    "href": "api/Stride.Core.ServiceEventArgs.html",
    "title": "Class ServiceEventArgs | Stride API",
    "summary": "Class ServiceEventArgs Namespace Stride.Core Assembly Stride.Core.dll public class ServiceEventArgs : EventArgs Inheritance object EventArgs ServiceEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors ServiceEventArgs(Type, object) public ServiceEventArgs(Type serviceType, object serviceInstance) Parameters serviceType Type serviceInstance object Properties Instance public object Instance { get; } Property Value object ServiceType public Type ServiceType { get; } Property Value Type"
  },
  "api/Stride.Core.ServiceNotFoundException.html": {
    "href": "api/Stride.Core.ServiceNotFoundException.html",
    "title": "Class ServiceNotFoundException | Stride API",
    "summary": "Class ServiceNotFoundException Namespace Stride.Core Assembly Stride.Core.dll public class ServiceNotFoundException : Exception, ISerializable Inheritance object Exception ServiceNotFoundException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState Extension Methods UnsafeUtilities.As<T>(object?) Constructors ServiceNotFoundException() public ServiceNotFoundException() ServiceNotFoundException(Type) public ServiceNotFoundException(Type serviceType) Parameters serviceType Type ServiceNotFoundException(Type, Exception) public ServiceNotFoundException(Type serviceType, Exception innerException) Parameters serviceType Type innerException Exception Properties ServiceType public Type ServiceType { get; } Property Value Type"
  },
  "api/Stride.Core.ServiceRegistry.html": {
    "href": "api/Stride.Core.ServiceRegistry.html",
    "title": "Class ServiceRegistry | Stride API",
    "summary": "Class ServiceRegistry Namespace Stride.Core Assembly Stride.Core.dll Provides a base implementation for managing services within an application. Implements the IServiceRegistry interface. public class ServiceRegistry : IServiceRegistry Inheritance object ServiceRegistry Implements IServiceRegistry Extension Methods ServiceRegistryExtensions.GetSafeServiceAs<T>(IServiceRegistry) ServiceRegistryExtensions.GetServiceLate<T>(IServiceRegistry, Action<T>) UnsafeUtilities.As<T>(object?) Remarks This class uses a dictionary to store services by their types. It is thread-safe. Fields ServiceRegistryKey The key used to identify the ServiceRegistry instance. public static readonly PropertyKey<IServiceRegistry> ServiceRegistryKey Field Value PropertyKey<IServiceRegistry> Methods AddService<T>(T) Adds a service to this ServiceRegistry. public void AddService<T>(T service) where T : class Parameters service T The service to add. Type Parameters T The type of service to add. Remarks This implementation triggers the ServiceAdded event after a service is successfully added. Exceptions ArgumentNullException Thrown when the provided service is null. ArgumentException Thrown when a service of the same type is already registered. GetOrCreate<T>() Gets the service object of the specified type, create one if it didn't exist before. public T GetOrCreate<T>() where T : class, IService Returns T Type Parameters T The type of the service to retrieve. GetService<T>() Gets the service object of the specified type. public T? GetService<T>() where T : class Returns T A service of the requested type, or [null] if not found. Type Parameters T The type of the service to retrieve. Remarks The generic type provided must match the generic type of your initial call to AddService<T>(T) RemoveService<T>() Removes the object providing a specified service. public void RemoveService<T>() where T : class Type Parameters T The type of the service to remove. Remarks The generic type provided must match the generic type of your initial call to AddService<T>(T) RemoveService<T>(T) Removes the following object from services if it was registered as one. public bool RemoveService<T>(T serviceObject) where T : class Parameters serviceObject T Returns bool True if the argument was a service, false otherwise Type Parameters T The type of the service to remove. Remarks The generic type provided must match the generic type of your initial call to AddService<T>(T) Events ServiceAdded Occurs when a new service is added to the registry. public event EventHandler<ServiceEventArgs>? ServiceAdded Event Type EventHandler<ServiceEventArgs> ServiceRemoved Occurs when a service is removed from the registry. public event EventHandler<ServiceEventArgs>? ServiceRemoved Event Type EventHandler<ServiceEventArgs>"
  },
  "api/Stride.Core.ServiceRegistryExtensions.html": {
    "href": "api/Stride.Core.ServiceRegistryExtensions.html",
    "title": "Class ServiceRegistryExtensions | Stride API",
    "summary": "Class ServiceRegistryExtensions Namespace Stride.Core Assembly Stride.Core.dll public static class ServiceRegistryExtensions Inheritance object ServiceRegistryExtensions Methods GetSafeServiceAs<T>(IServiceRegistry) Gets a service instance from a specified interface contract. public static T GetSafeServiceAs<T>(this IServiceRegistry registry) where T : class Parameters registry IServiceRegistry The registry. Returns T An instance of the requested service registered to this registry. Type Parameters T Type of the interface contract of the service Exceptions ServiceNotFoundException If the service was not found GetServiceLate<T>(IServiceRegistry, Action<T>) Gets a service instance from a specified interface contract. public static void GetServiceLate<T>(this IServiceRegistry registry, Action<T> serviceReady) where T : class Parameters registry IServiceRegistry The registry. serviceReady Action<T> The service ready. Type Parameters T Type of the interface contract of the service Exceptions ServiceNotFoundException If the service was not found"
  },
  "api/Stride.Core.Settings.AppSettings.html": {
    "href": "api/Stride.Core.Settings.AppSettings.html",
    "title": "Class AppSettings | Stride API",
    "summary": "Class AppSettings Namespace Stride.Core.Settings Assembly Stride.Core.dll Collection of runtime loaded application settings. See also AppSettingsManager. [DataContract(\"AppSettings\")] public sealed class AppSettings : IEnumerable<object>, IEnumerable Inheritance object AppSettings Implements IEnumerable<object> IEnumerable Extension Methods EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors AppSettings() Default constructor, used for deserialization. public AppSettings() AppSettings(IEnumerable<object>) Creates a new AppSettings instance with a settings collection. public AppSettings(IEnumerable<object> settings) Parameters settings IEnumerable<object> Settings collection. Properties Settings Application specific settings. public FastCollection<object> Settings { get; } Property Value FastCollection<object> Methods GetEnumerator() Inline Enumerator used by foreach. public FastCollection<object>.Enumerator GetEnumerator() Returns FastCollection<object>.Enumerator Enumerator of the underlying settings collection. GetSettings<T>() Finds a settings object of the specified type in the settings collection. public T? GetSettings<T>() where T : class Returns T Found object, or null if not found. Type Parameters T"
  },
  "api/Stride.Core.Settings.AppSettingsManager.html": {
    "href": "api/Stride.Core.Settings.AppSettingsManager.html",
    "title": "Class AppSettingsManager | Stride API",
    "summary": "Class AppSettingsManager Namespace Stride.Core.Settings Assembly Stride.Core.dll Manages the loading of application settings with IAppSettingsProvider. public static class AppSettingsManager Inheritance object AppSettingsManager Properties Settings Gets AppSettings instance for the application. public static AppSettings Settings { get; } Property Value AppSettings Remarks Loaded with an IAppSettingsProvider. If no provider implementation is found, returns empty AppSettings instance. SettingsProvider Gets or sets an IAppSettingsProvider for the application. public static IAppSettingsProvider? SettingsProvider { get; set; } Property Value IAppSettingsProvider Remarks If provider is not set, getter of this property will attempt to find an implementation among the registered assemblies and cache it. Methods ReloadSettings() Clears cached settings value and calls LoadAppSettings() on the SettingsProvider. public static void ReloadSettings()"
  },
  "api/Stride.Core.Settings.IAppSettingsProvider.html": {
    "href": "api/Stride.Core.Settings.IAppSettingsProvider.html",
    "title": "Interface IAppSettingsProvider | Stride API",
    "summary": "Interface IAppSettingsProvider Namespace Stride.Core.Settings Assembly Stride.Core.dll A custom loader of the application settings. Implementation is required to have a parameterless constructor. public interface IAppSettingsProvider Extension Methods UnsafeUtilities.As<T>(object?) Methods LoadAppSettings() Loads AppSettings for the application. AppSettings LoadAppSettings() Returns AppSettings"
  },
  "api/Stride.Core.Settings.html": {
    "href": "api/Stride.Core.Settings.html",
    "title": "Namespace Stride.Core.Settings | Stride API",
    "summary": "Namespace Stride.Core.Settings Classes AppSettings Collection of runtime loaded application settings. See also AppSettingsManager. AppSettingsManager Manages the loading of application settings with IAppSettingsProvider. Interfaces IAppSettingsProvider A custom loader of the application settings. Implementation is required to have a parameterless constructor."
  },
  "api/Stride.Core.StaticDefaultValueMetadata-1.html": {
    "href": "api/Stride.Core.StaticDefaultValueMetadata-1.html",
    "title": "Class StaticDefaultValueMetadata<T> | Stride API",
    "summary": "Class StaticDefaultValueMetadata<T> Namespace Stride.Core Assembly Stride.Core.dll Defines default value of a specific PropertyKey as a parameter value. public class StaticDefaultValueMetadata<T> : DefaultValueMetadata<T> Type Parameters T Inheritance object PropertyKeyMetadata DefaultValueMetadata DefaultValueMetadata<T> StaticDefaultValueMetadata<T> Inherited Members DefaultValueMetadata<T>.GetDefaultValue(ref PropertyContainer) DefaultValueMetadata.PropertyUpdateCallback DefaultValueMetadata.Static<T>(T, bool) DefaultValueMetadata.Delegate<T>(DelegateDefaultValueMetadata<T>.DefaultValueCallback) Extension Methods UnsafeUtilities.As<T>(object?) Constructors StaticDefaultValueMetadata(T, bool) Initializes a new instance of the StaticDefaultValueMetadata<T> class. public StaticDefaultValueMetadata(T defaultValue, bool keepDefaultValue = false) Parameters defaultValue T The default value. keepDefaultValue bool if set to true [keep default value]. Properties KeepValue Gets a value indicating whether this value is kept. public override bool KeepValue { get; } Property Value bool true if this value is kept; otherwise, false. Methods GetDefaultValueT(ref PropertyContainer) Gets the default value of an external property, and specify if this default value should be kept. It could be usefull with properties with default values depending of its container, especially if they are long to generate. An example would be collision data, which should be generated only once. public override T GetDefaultValueT(ref PropertyContainer obj) Parameters obj PropertyContainer The property container. Returns T The default value."
  },
  "api/Stride.Core.Storage.Blob.html": {
    "href": "api/Stride.Core.Storage.Blob.html",
    "title": "Class Blob | Stride API",
    "summary": "Class Blob Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll Stores immutable binary content. public class Blob : ReferenceBase, IReferencable Inheritance object ReferenceBase Blob Implements IReferencable Inherited Members ReferenceBase.ReferenceCount ReferenceBase.AddReference() ReferenceBase.Release() Extension Methods ComponentBaseExtensions.KeepReference<T>(T) ComponentBaseExtensions.ReleaseBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveReleaseBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors Blob(ObjectDatabase, ObjectId) protected Blob(ObjectDatabase objectDatabase, ObjectId objectId) Parameters objectDatabase ObjectDatabase objectId ObjectId Properties Content Gets the content. public nint Content { get; } Property Value nint The content. ObjectId Gets the ObjectId. public ObjectId ObjectId { get; } Property Value ObjectId The ObjectId. Size Gets the size. public int Size { get; } Property Value int The size. Methods Destroy() Releases unmanaged and - optionally - managed resources protected override void Destroy() GetContentStream() Gets a Stream over the Content. public Stream GetContentStream() Returns Stream A Stream over the Content."
  },
  "api/Stride.Core.Storage.BundleDescription.html": {
    "href": "api/Stride.Core.Storage.BundleDescription.html",
    "title": "Class BundleDescription | Stride API",
    "summary": "Class BundleDescription Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll Description of a bundle: header, dependencies, objects and assets. public class BundleDescription Inheritance object BundleDescription Extension Methods UnsafeUtilities.As<T>(object?) Constructors BundleDescription() public BundleDescription() Properties Assets public List<KeyValuePair<string, ObjectId>> Assets { get; } Property Value List<KeyValuePair<string, ObjectId>> Dependencies public List<string> Dependencies { get; } Property Value List<string> Header public BundleOdbBackend.Header Header { get; set; } Property Value BundleOdbBackend.Header IncrementalBundles public List<ObjectId> IncrementalBundles { get; } Property Value List<ObjectId> Objects public List<KeyValuePair<ObjectId, BundleOdbBackend.ObjectInfo>> Objects { get; } Property Value List<KeyValuePair<ObjectId, BundleOdbBackend.ObjectInfo>>"
  },
  "api/Stride.Core.Storage.BundleOdbBackend.BundleResolveDelegate.html": {
    "href": "api/Stride.Core.Storage.BundleOdbBackend.BundleResolveDelegate.html",
    "title": "Delegate BundleOdbBackend.BundleResolveDelegate | Stride API",
    "summary": "Delegate BundleOdbBackend.BundleResolveDelegate Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll public delegate Task<string> BundleOdbBackend.BundleResolveDelegate(string bundleName) Parameters bundleName string Returns Task<string> Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Storage.BundleOdbBackend.Header.html": {
    "href": "api/Stride.Core.Storage.BundleOdbBackend.Header.html",
    "title": "Struct BundleOdbBackend.Header | Stride API",
    "summary": "Struct BundleOdbBackend.Header Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll [DataContract] [DataSerializer(typeof(BundleOdbBackend.Header.Serializer))] public struct BundleOdbBackend.Header Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Crc public uint Crc Field Value uint MagicHeader public uint MagicHeader Field Value uint MagicHeaderValid public const uint MagicHeaderValid = 826428248 Field Value uint Size public long Size Field Value long"
  },
  "api/Stride.Core.Storage.BundleOdbBackend.ObjectInfo.html": {
    "href": "api/Stride.Core.Storage.BundleOdbBackend.ObjectInfo.html",
    "title": "Struct BundleOdbBackend.ObjectInfo | Stride API",
    "summary": "Struct BundleOdbBackend.ObjectInfo Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll [DataContract] [DataSerializer(typeof(BundleOdbBackend.ObjectInfo.Serializer))] public struct BundleOdbBackend.ObjectInfo Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields EndOffset public long EndOffset Field Value long IncrementalBundleIndex public int IncrementalBundleIndex Field Value int IsCompressed public bool IsCompressed Field Value bool SizeNotCompressed public long SizeNotCompressed Field Value long StartOffset public long StartOffset Field Value long"
  },
  "api/Stride.Core.Storage.BundleOdbBackend.html": {
    "href": "api/Stride.Core.Storage.BundleOdbBackend.html",
    "title": "Class BundleOdbBackend | Stride API",
    "summary": "Class BundleOdbBackend Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll Object Database Backend (ODB) implementation that bundles multiple chunks into a .bundle files, optionally compressed with LZ4. [DataSerializerGlobal(null, typeof(List<string>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(List<ObjectId>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(List<KeyValuePair<ObjectId, BundleOdbBackend.ObjectInfo>>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(List<KeyValuePair<string, ObjectId>>), DataSerializerGenericMode.None, false, false)] public class BundleOdbBackend : IOdbBackend, IDisposable Inheritance object BundleOdbBackend Implements IOdbBackend IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors BundleOdbBackend(string) public BundleOdbBackend(string vfsRootUrl) Parameters vfsRootUrl string Fields BundleExtension The bundle file extension. public const string BundleExtension = \".bundle\" Field Value string Properties BundleDirectory The default directory where bundle are stored. public string BundleDirectory { get; } Property Value string BundleResolve Bundle resolve event asynchronous handler. public BundleOdbBackend.BundleResolveDelegate BundleResolve { get; set; } Property Value BundleOdbBackend.BundleResolveDelegate ContentIndexMap Gets the asset index map. public IContentIndexMap ContentIndexMap { get; } Property Value IContentIndexMap The asset index map. Methods CreateBundle(string, IOdbBackend, ObjectId[], ISet<ObjectId>, Dictionary<string, ObjectId>, IList<string>, bool) public static void CreateBundle(string bundleUrl, IOdbBackend backend, ObjectId[] objectIds, ISet<ObjectId> disableCompressionIds, Dictionary<string, ObjectId> indexMap, IList<string> dependencies, bool useIncrementalBundle) Parameters bundleUrl string backend IOdbBackend objectIds ObjectId[] disableCompressionIds ISet<ObjectId> indexMap Dictionary<string, ObjectId> dependencies IList<string> useIncrementalBundle bool CreateStream() Creates a stream that will be saved to database when closed and/or disposed. public OdbStreamWriter CreateStream() Returns OdbStreamWriter a stream writer that should be passed to Write(ObjectId, Stream, int, bool) in order to be stored in the database Delete(ObjectId) Deletes the specified ObjectId. public void Delete(ObjectId objectId) Parameters objectId ObjectId The object id. DeleteBundles(Func<string, bool>) public void DeleteBundles(Func<string, bool> bundleFileDeletePredicate) Parameters bundleFileDeletePredicate Func<string, bool> Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() EnumerateObjects() Enumerates the object stored in this backend. public IEnumerable<ObjectId> EnumerateObjects() Returns IEnumerable<ObjectId> Exists(ObjectId) Determines if the object with the specified ObjectId exists. public bool Exists(ObjectId objectId) Parameters objectId ObjectId The ObjectId to check existence for. Returns bool true if an object with the specified ObjectId exists; otherwise, false. GetFilePath(ObjectId) Returns the file path corresponding to the given id (in the VFS domain), if appliable. public string GetFilePath(ObjectId objectId) Parameters objectId ObjectId The ObjectId. Returns string The file path. GetObjectInfos() public Dictionary<ObjectId, BundleOdbBackend.ObjectInfo> GetObjectInfos() Returns Dictionary<ObjectId, BundleOdbBackend.ObjectInfo> GetSize(ObjectId) Requests that this backend read an object's length (but not its contents). public int GetSize(ObjectId objectId) Parameters objectId ObjectId The ObjectId. Returns int The object size. LoadBundle(string, ObjectDatabaseContentIndexMap) Loads the specified bundle. public Task LoadBundle(string bundleName, ObjectDatabaseContentIndexMap objectDatabaseContentIndexMap) Parameters bundleName string Name of the bundle. objectDatabaseContentIndexMap ObjectDatabaseContentIndexMap The object database asset index map, where newly loaded assets will be merged (ignored if null). Returns Task Task that will complete when bundle is loaded. LoadBundleFromUrl(string, ObjectDatabaseContentIndexMap, string, bool) public Task LoadBundleFromUrl(string bundleName, ObjectDatabaseContentIndexMap objectDatabaseContentIndexMap, string bundleUrl, bool ignoreDependencies = false) Parameters bundleName string objectDatabaseContentIndexMap ObjectDatabaseContentIndexMap bundleUrl string ignoreDependencies bool Returns Task OpenStream(ObjectId, VirtualFileMode, VirtualFileAccess, VirtualFileShare) Opens a Stream of the object with the specified ObjectId. public Stream OpenStream(ObjectId objectId, VirtualFileMode mode = VirtualFileMode.Open, VirtualFileAccess access = VirtualFileAccess.Read, VirtualFileShare share = VirtualFileShare.Read) Parameters objectId ObjectId The ObjectId. mode VirtualFileMode The mode. access VirtualFileAccess The access. share VirtualFileShare The process share mode. Returns Stream A Stream opened from the specified ObjectId. ReadBundleDescription(Stream) Reads the bundle description. public static BundleDescription ReadBundleDescription(Stream stream) Parameters stream Stream The stream. Returns BundleDescription The bundle description. Exceptions InvalidOperationException Invalid bundle header or Bundle has not been properly written ReadBundleHeader(string, out List<string>) public static BundleDescription ReadBundleHeader(string bundleUrl, out List<string> bundleUrls) Parameters bundleUrl string bundleUrls List<string> Returns BundleDescription TryGetObjectLocation(ObjectId, out string, out long, out long) public bool TryGetObjectLocation(ObjectId objectId, out string filePath, out long start, out long end) Parameters objectId ObjectId filePath string start long end long Returns bool UnloadBundle(string, ObjectDatabaseContentIndexMap) Unload the specified bundle. public void UnloadBundle(string bundleName, ObjectDatabaseContentIndexMap objectDatabaseContentIndexMap) Parameters bundleName string Name of the bundle. objectDatabaseContentIndexMap ObjectDatabaseContentIndexMap The object database asset index map, where newly loaded assets will be merged (ignored if null). Write(ObjectId, Stream, int, bool) Writes an object to the backing store. The backend may need to compute the object ID and return it to the caller. public ObjectId Write(ObjectId objectId, Stream dataStream, int length, bool forceWrite) Parameters objectId ObjectId The ObjectId if already computed, or Empty if not determined yet. dataStream Stream The data stream. length int The data length. forceWrite bool Set to true to force writing the datastream even if a content is already stored with the same id. Default is false. Returns ObjectId The generated ObjectId."
  },
  "api/Stride.Core.Storage.DigestStream.html": {
    "href": "api/Stride.Core.Storage.DigestStream.html",
    "title": "Class DigestStream | Stride API",
    "summary": "Class DigestStream Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll public class DigestStream : OdbStreamWriter, IAsyncDisposable, IDisposable Inheritance object MarshalByRefObject Stream OdbStreamWriter DigestStream Implements IAsyncDisposable IDisposable Inherited Members OdbStreamWriter.stream OdbStreamWriter.Disposed OdbStreamWriter.TemporaryName OdbStreamWriter.CanRead OdbStreamWriter.CanSeek OdbStreamWriter.CanWrite OdbStreamWriter.Flush() OdbStreamWriter.Dispose(bool) OdbStreamWriter.Length OdbStreamWriter.Position OdbStreamWriter.Read(byte[], int, int) OdbStreamWriter.Seek(long, SeekOrigin) OdbStreamWriter.SetLength(long) Stream.Null Stream.BeginRead(byte[], int, int, AsyncCallback, object) Stream.BeginWrite(byte[], int, int, AsyncCallback, object) Stream.Close() Stream.CopyTo(Stream) Stream.CopyTo(Stream, int) Stream.CopyToAsync(Stream) Stream.CopyToAsync(Stream, int) Stream.CopyToAsync(Stream, int, CancellationToken) Stream.CopyToAsync(Stream, CancellationToken) Stream.CreateWaitHandle() Stream.Dispose() Stream.DisposeAsync() Stream.EndRead(IAsyncResult) Stream.EndWrite(IAsyncResult) Stream.FlushAsync() Stream.FlushAsync(CancellationToken) Stream.ObjectInvariant() Stream.Read(Span<byte>) Stream.ReadAsync(byte[], int, int) Stream.ReadAsync(byte[], int, int, CancellationToken) Stream.ReadAsync(Memory<byte>, CancellationToken) Stream.ReadAtLeast(Span<byte>, int, bool) Stream.ReadAtLeastAsync(Memory<byte>, int, bool, CancellationToken) Stream.ReadByte() Stream.ReadExactly(byte[], int, int) Stream.ReadExactly(Span<byte>) Stream.ReadExactlyAsync(byte[], int, int, CancellationToken) Stream.ReadExactlyAsync(Memory<byte>, CancellationToken) Stream.Synchronized(Stream) Stream.ValidateBufferArguments(byte[], int, int) Stream.ValidateCopyToArguments(Stream, int) Stream.WriteAsync(byte[], int, int) Stream.WriteAsync(byte[], int, int, CancellationToken) Stream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken) Stream.CanTimeout Stream.ReadTimeout Stream.WriteTimeout MarshalByRefObject.GetLifetimeService() MarshalByRefObject.InitializeLifetimeService() MarshalByRefObject.MemberwiseClone(bool) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) SocketExtensions.Read7BitEncodedInt(Stream) SocketExtensions.ReadAllAsync(Stream, byte[], int, int) SocketExtensions.ReadGuidAsync(Stream) SocketExtensions.ReadInt16Async(Stream) SocketExtensions.ReadInt32Async(Stream) SocketExtensions.ReadStringAsync(Stream) SocketExtensions.Write7BitEncodedInt(Stream, int) SocketExtensions.WriteGuidAsync(Stream, Guid) SocketExtensions.WriteInt16Async(Stream, short) SocketExtensions.WriteInt32Async(Stream, int) SocketExtensions.WriteStringAsync(Stream, string) UnsafeUtilities.As<T>(object?) Constructors DigestStream(Stream) public DigestStream(Stream stream) Parameters stream Stream Properties CurrentHash public override ObjectId CurrentHash { get; } Property Value ObjectId Methods Reset() public void Reset() Write(byte[], int, int) When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. public override void Write(byte[] buffer, int offset, int count) Parameters buffer byte[] An array of bytes. This method copies count bytes from buffer to the current stream. offset int The zero-based byte offset in buffer at which to begin copying bytes to the current stream. count int The number of bytes to be written to the current stream. Exceptions ArgumentException The sum of offset and count is greater than the buffer length. ArgumentNullException buffer is null. ArgumentOutOfRangeException offset or count is negative. IOException An I/O error occurred, such as the specified file cannot be found. NotSupportedException The stream does not support writing. ObjectDisposedException Write(byte[], int, int) was called after the stream was closed. Write(ReadOnlySpan<byte>) When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. public override void Write(ReadOnlySpan<byte> buffer) Parameters buffer ReadOnlySpan<byte> A region of memory. This method copies the contents of this region to the current stream. WriteByte(byte) Writes a byte to the current position in the stream and advances the position within the stream by one byte. public override void WriteByte(byte value) Parameters value byte The byte to write to the stream. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support writing, or the stream is already closed. ObjectDisposedException Methods were called after the stream was closed."
  },
  "api/Stride.Core.Storage.FileOdbBackend.html": {
    "href": "api/Stride.Core.Storage.FileOdbBackend.html",
    "title": "Class FileOdbBackend | Stride API",
    "summary": "Class FileOdbBackend Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll Object Database Backend (ODB) implementation using VirtualFileSystem public class FileOdbBackend : IOdbBackend, IDisposable Inheritance object FileOdbBackend Implements IOdbBackend IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors FileOdbBackend(string, string, bool) public FileOdbBackend(string vfsRootUrl, string indexName, bool isReadOnly) Parameters vfsRootUrl string indexName string isReadOnly bool Properties ContentIndexMap Gets the asset index map. public IContentIndexMap ContentIndexMap { get; } Property Value IContentIndexMap The asset index map. IsReadOnly public bool IsReadOnly { get; } Property Value bool Methods BuildUrl(string, ObjectId) public static string BuildUrl(string vfsRootUrl, ObjectId objectId) Parameters vfsRootUrl string objectId ObjectId Returns string CreateStream() Creates a stream that will be saved to database when closed and/or disposed. public OdbStreamWriter CreateStream() Returns OdbStreamWriter a stream writer that should be passed to Write(ObjectId, Stream, int, bool) in order to be stored in the database Delete(ObjectId) Deletes the specified ObjectId. public void Delete(ObjectId objectId) Parameters objectId ObjectId The object id. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() EnumerateObjects() Enumerates the object stored in this backend. public IEnumerable<ObjectId> EnumerateObjects() Returns IEnumerable<ObjectId> Exists(ObjectId) Determines if the object with the specified ObjectId exists. public virtual bool Exists(ObjectId objectId) Parameters objectId ObjectId The ObjectId to check existence for. Returns bool true if an object with the specified ObjectId exists; otherwise, false. GetFilePath(ObjectId) Returns the file path corresponding to the given id (in the VFS domain), if appliable. public string GetFilePath(ObjectId objectId) Parameters objectId ObjectId The ObjectId. Returns string The file path. GetSize(ObjectId) Requests that this backend read an object's length (but not its contents). public virtual int GetSize(ObjectId objectId) Parameters objectId ObjectId The ObjectId. Returns int The object size. OpenStream(ObjectId, VirtualFileMode, VirtualFileAccess, VirtualFileShare) Opens a Stream of the object with the specified ObjectId. public virtual Stream OpenStream(ObjectId objectId, VirtualFileMode mode = VirtualFileMode.Open, VirtualFileAccess access = VirtualFileAccess.Read, VirtualFileShare share = VirtualFileShare.Read) Parameters objectId ObjectId The ObjectId. mode VirtualFileMode The mode. access VirtualFileAccess The access. share VirtualFileShare The process share mode. Returns Stream A Stream opened from the specified ObjectId. Write(ObjectId, Stream, int, bool) Writes an object to the backing store. The backend may need to compute the object ID and return it to the caller. public virtual ObjectId Write(ObjectId objectId, Stream dataStream, int length, bool forceWrite = false) Parameters objectId ObjectId The ObjectId if already computed, or Empty if not determined yet. dataStream Stream The data stream. length int The data length. forceWrite bool Set to true to force writing the datastream even if a content is already stored with the same id. Default is false. Returns ObjectId The generated ObjectId."
  },
  "api/Stride.Core.Storage.IOdbBackend.html": {
    "href": "api/Stride.Core.Storage.IOdbBackend.html",
    "title": "Interface IOdbBackend | Stride API",
    "summary": "Interface IOdbBackend Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll Base class for custom object database backends (ODB). public interface IOdbBackend : IDisposable Inherited Members IDisposable.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties ContentIndexMap Gets the asset index map. IContentIndexMap ContentIndexMap { get; } Property Value IContentIndexMap The asset index map. Methods CreateStream() Creates a stream that will be saved to database when closed and/or disposed. OdbStreamWriter CreateStream() Returns OdbStreamWriter a stream writer that should be passed to Write(ObjectId, Stream, int, bool) in order to be stored in the database Delete(ObjectId) Deletes the specified ObjectId. void Delete(ObjectId objectId) Parameters objectId ObjectId The object id. EnumerateObjects() Enumerates the object stored in this backend. IEnumerable<ObjectId> EnumerateObjects() Returns IEnumerable<ObjectId> Exists(ObjectId) Determines if the object with the specified ObjectId exists. bool Exists(ObjectId objectId) Parameters objectId ObjectId The ObjectId to check existence for. Returns bool true if an object with the specified ObjectId exists; otherwise, false. GetFilePath(ObjectId) Returns the file path corresponding to the given id (in the VFS domain), if appliable. string GetFilePath(ObjectId objectId) Parameters objectId ObjectId The ObjectId. Returns string The file path. GetSize(ObjectId) Requests that this backend read an object's length (but not its contents). int GetSize(ObjectId objectId) Parameters objectId ObjectId The ObjectId. Returns int The object size. OpenStream(ObjectId, VirtualFileMode, VirtualFileAccess, VirtualFileShare) Opens a Stream of the object with the specified ObjectId. Stream OpenStream(ObjectId objectId, VirtualFileMode mode = VirtualFileMode.Open, VirtualFileAccess access = VirtualFileAccess.Read, VirtualFileShare share = VirtualFileShare.Read) Parameters objectId ObjectId The ObjectId. mode VirtualFileMode The mode. access VirtualFileAccess The access. share VirtualFileShare The process share mode. Returns Stream A Stream opened from the specified ObjectId. Write(ObjectId, Stream, int, bool) Writes an object to the backing store. The backend may need to compute the object ID and return it to the caller. ObjectId Write(ObjectId objectId, Stream dataStream, int length, bool forceWrite = false) Parameters objectId ObjectId The ObjectId if already computed, or Empty if not determined yet. dataStream Stream The data stream. length int The data length. forceWrite bool Set to true to force writing the datastream even if a content is already stored with the same id. Default is false. Returns ObjectId The generated ObjectId."
  },
  "api/Stride.Core.Storage.ObjectDatabase.html": {
    "href": "api/Stride.Core.Storage.ObjectDatabase.html",
    "title": "Class ObjectDatabase | Stride API",
    "summary": "Class ObjectDatabase Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll Gives access to the object database. public class ObjectDatabase : IDisposable Inheritance object ObjectDatabase Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ObjectDatabase(string, string, string?, bool) Initializes a new instance of the ObjectDatabase class. public ObjectDatabase(string vfsMainUrl, string indexName, string? vfsAdditionalUrl = null, bool loadDefaultBundle = true) Parameters vfsMainUrl string The VFS main URL. indexName string Name of the index file. vfsAdditionalUrl string The VFS additional URL. It will be used only if vfsMainUrl is read-only. loadDefaultBundle bool Properties BundleBackend public BundleOdbBackend BundleBackend { get; } Property Value BundleOdbBackend ContentIndexMap public ObjectDatabaseContentIndexMap ContentIndexMap { get; } Property Value ObjectDatabaseContentIndexMap Methods CreateBlob(nint, int) Creates a in-memory binary blob as a Blob that will also be stored using the active IOdbBackend. Even if Blob is new (not in the ODB), memory will be copied. public Blob CreateBlob(nint data, int size) Parameters data nint The data. size int The size. Returns Blob The Blob containing given data, with its reference count incremented. CreateBundle(ObjectId[], string, BundleOdbBackend, ISet<ObjectId>, Dictionary<string, ObjectId>, IList<string>, bool) public string? CreateBundle(ObjectId[] objectIds, string bundleName, BundleOdbBackend bundleBackend, ISet<ObjectId> disableCompressionIds, Dictionary<string, ObjectId> indexMap, IList<string> dependencies, bool useIncrementalBundle) Parameters objectIds ObjectId[] bundleName string bundleBackend BundleOdbBackend disableCompressionIds ISet<ObjectId> indexMap Dictionary<string, ObjectId> dependencies IList<string> useIncrementalBundle bool Returns string CreateDefaultDatabase() Creates a new instance of the ObjectDatabase class using default database path, index name, and local database path, and loading default bundle. public static ObjectDatabase CreateDefaultDatabase() Returns ObjectDatabase A new instance of the ObjectDatabase class. CreateStream() Creates a stream that can then be saved directly in the database using Write(nint, int, bool). public OdbStreamWriter CreateStream() Returns OdbStreamWriter a stream writer that should be passed to Write(nint, int, bool) in order to be stored in the database Delete(ObjectId) public void Delete(ObjectId objectId) Parameters objectId ObjectId Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() EnumerateLooseObjects() public IEnumerable<ObjectId> EnumerateLooseObjects() Returns IEnumerable<ObjectId> EnumerateObjects() public IEnumerable<ObjectId> EnumerateObjects() Returns IEnumerable<ObjectId> Exists(ObjectId) public bool Exists(ObjectId objectId) Parameters objectId ObjectId Returns bool GetFilePath(ObjectId) public string GetFilePath(ObjectId objectId) Parameters objectId ObjectId Returns string GetSize(ObjectId) public int GetSize(ObjectId objectId) Parameters objectId ObjectId Returns int LoadBundle(string) Loads the specified bundle. public Task LoadBundle(string bundleName) Parameters bundleName string Name of the bundle. Returns Task Task that will complete when bundle is loaded. Lookup(ObjectId) Lookups the Blob with the specified ObjectId. Any object returned will have its reference count incremented. public Blob? Lookup(ObjectId objectId) Parameters objectId ObjectId The object id. Returns Blob The Blob matching this ObjectId with an incremented reference count if it exists; [null] otherwise. OpenStream(ObjectId, VirtualFileMode, VirtualFileAccess, VirtualFileShare) Opens a stream for the specified ObjectId. public Stream OpenStream(ObjectId objectId, VirtualFileMode mode = VirtualFileMode.Open, VirtualFileAccess access = VirtualFileAccess.Read, VirtualFileShare share = VirtualFileShare.Read) Parameters objectId ObjectId The object identifier. mode VirtualFileMode The mode. access VirtualFileAccess The access. share VirtualFileShare The share. Returns Stream A Stream. Exceptions InvalidOperationException Read-only object database. Read(ObjectId, bool) Returns a data stream of the data specified ObjectId. public Stream Read(ObjectId objectId, bool checkCache = false) Parameters objectId ObjectId The ObjectId. checkCache bool if set to true [check cache for existing blobs]. Returns Stream A Stream of the requested data. TryGetObjectLocation(ObjectId, out string?, out long, out long) public bool TryGetObjectLocation(ObjectId objectId, out string? filePath, out long start, out long end) Parameters objectId ObjectId filePath string start long end long Returns bool UnloadBundle(string) Unloads the specified bundle. public void UnloadBundle(string bundleName) Parameters bundleName string Name of the bundle. Write(Stream) Writes the specified data using the active IOdbBackend. public ObjectId Write(Stream stream) Parameters stream Stream The data stream. Returns ObjectId The ObjectId of the given data. Write(Stream, ObjectId, bool) Writes the specified data using the active IOdbBackend and a precomputer ObjectId. public ObjectId Write(Stream stream, ObjectId objectId, bool forceWrite = false) Parameters stream Stream The data stream. objectId ObjectId The precomputed objectId. forceWrite bool Set to true to force writing the datastream even if a content is already stored with the same id. Default is false. Returns ObjectId The ObjectId of the given data, which is the same that the passed one. Write(nint, int, bool) Writes the specified data using the active IOdbBackend. public ObjectId Write(nint data, int size, bool forceWrite = false) Parameters data nint The data. size int The size. forceWrite bool Set to true to force writing the datastream even if a content is already stored with the same id. Default is false. Returns ObjectId The ObjectId of the given data."
  },
  "api/Stride.Core.Storage.ObjectDatabaseContentIndexMap.html": {
    "href": "api/Stride.Core.Storage.ObjectDatabaseContentIndexMap.html",
    "title": "Class ObjectDatabaseContentIndexMap | Stride API",
    "summary": "Class ObjectDatabaseContentIndexMap Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll Content Index Map implementation which regroups all the asset index maps of every loaded file backend and asset bundle backends. public class ObjectDatabaseContentIndexMap : IContentIndexMap, IDisposable Inheritance object ObjectDatabaseContentIndexMap Implements IContentIndexMap IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties this[string] public ObjectId this[string url] { get; set; } Parameters url string Property Value ObjectId WriteableContentIndexMap public IContentIndexMap WriteableContentIndexMap { get; set; } Property Value IContentIndexMap Methods Contains(string) public bool Contains(string url) Parameters url string Returns bool Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() GetMergedIdMap() public IEnumerable<KeyValuePair<string, ObjectId>> GetMergedIdMap() Returns IEnumerable<KeyValuePair<string, ObjectId>> Merge(IContentIndexMap) Merges the values from the given asset index map. public void Merge(IContentIndexMap contentIndexMap) Parameters contentIndexMap IContentIndexMap The asset index map to merge. Merge(IEnumerable<KeyValuePair<string, ObjectId>>) Merges the values from the given assets. public void Merge(IEnumerable<KeyValuePair<string, ObjectId>> assets) Parameters assets IEnumerable<KeyValuePair<string, ObjectId>> The assets to merge. SearchValues(Func<KeyValuePair<string, ObjectId>, bool>) public IEnumerable<KeyValuePair<string, ObjectId>> SearchValues(Func<KeyValuePair<string, ObjectId>, bool> predicate) Parameters predicate Func<KeyValuePair<string, ObjectId>, bool> Returns IEnumerable<KeyValuePair<string, ObjectId>> TryGetValue(string, out ObjectId) public bool TryGetValue(string url, out ObjectId objectId) Parameters url string objectId ObjectId Returns bool Unmerge(IEnumerable<KeyValuePair<string, ObjectId>>) Unmerges the values from the given assets. public void Unmerge(IEnumerable<KeyValuePair<string, ObjectId>> assets) Parameters assets IEnumerable<KeyValuePair<string, ObjectId>> The assets to merge."
  },
  "api/Stride.Core.Storage.ObjectId.html": {
    "href": "api/Stride.Core.Storage.ObjectId.html",
    "title": "Struct ObjectId | Stride API",
    "summary": "Struct ObjectId Namespace Stride.Core.Storage Assembly Stride.Core.dll A hash to uniquely identify data. [DataContract(\"ObjectId\")] [Serializable] [DataSerializer(typeof(ObjectId.Serializer))] public struct ObjectId : IEquatable<ObjectId>, IComparable<ObjectId> Implements IEquatable<ObjectId> IComparable<ObjectId> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ObjectId(byte[]) Initializes a new instance of the ObjectId struct. public ObjectId(byte[] hash) Parameters hash byte[] The hash. Exceptions ArgumentNullException hash InvalidOperationException ObjectId value doesn't match expected size. ObjectId(uint, uint, uint, uint) public ObjectId(uint hash1, uint hash2, uint hash3, uint hash4) Parameters hash1 uint hash2 uint hash3 uint hash4 uint Fields Empty public static readonly ObjectId Empty Field Value ObjectId HashSize public const int HashSize = 16 Field Value int HashStringLength public const int HashStringLength = 32 Field Value int Methods Combine(ObjectId, ObjectId) public static ObjectId Combine(ObjectId left, ObjectId right) Parameters left ObjectId right ObjectId Returns ObjectId Combine(ref ObjectId, ref ObjectId, out ObjectId) public static void Combine(ref ObjectId left, ref ObjectId right, out ObjectId result) Parameters left ObjectId right ObjectId result ObjectId CompareTo(ObjectId) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. public int CompareTo(ObjectId other) Parameters other ObjectId An object to compare with this instance. Returns int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order. Equals(ObjectId) Indicates whether the current object is equal to another object of the same type. public bool Equals(ObjectId other) Parameters other ObjectId An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Indicates whether this instance and a specified object are equal. public override bool Equals(object? obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FromBytes(byte[]) Computes a hash from a byte buffer. public static ObjectId FromBytes(byte[] buffer) Parameters buffer byte[] The byte buffer. Returns ObjectId The hash of the object. Exceptions ArgumentNullException buffer FromBytes(byte[], int, int) Computes a hash from a byte buffer. public static ObjectId FromBytes(byte[] buffer, int offset, int count) Parameters buffer byte[] The byte buffer. offset int The offset into the buffer. count int The number of bytes to read from the buffer starting at offset position. Returns ObjectId The hash of the object. Exceptions ArgumentNullException buffer FromBytes(ReadOnlySpan<byte>) Computes a hash from a byte buffer. public static ObjectId FromBytes(ReadOnlySpan<byte> buffer) Parameters buffer ReadOnlySpan<byte> The byte buffer. Returns ObjectId The hash of the object. Exceptions ArgumentNullException buffer FromObject<T>(T) Computes a hash from an object using BinarySerializationWriter. public static ObjectId FromObject<T>(T obj) Parameters obj T The object. Returns ObjectId The hash of the object. Type Parameters T FromObject<T>(T, out byte[]) Computes a hash from an object using BinarySerializationWriter. public static ObjectId FromObject<T>(T obj, out byte[] buffer) Parameters obj T The object. buffer byte[] The buffer containing the serialized object. Returns ObjectId The hash of the object. Type Parameters T The type of the object to serialize GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. New() News this instance. public static ObjectId New() Returns ObjectId ObjectId. ToGuid() Gets a Guid from this object identifier. public Guid ToGuid() Returns Guid Guid. ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. TryParse(string, out ObjectId) Tries to parse an ObjectId from a string. public static bool TryParse(string input, out ObjectId result) Parameters input string The input hexa string. result ObjectId The result ObjectId. Returns bool true if parsing was successfull, false otherwise Operators operator ==(ObjectId, ObjectId) Implements the ==. public static bool operator ==(ObjectId left, ObjectId right) Parameters left ObjectId The left. right ObjectId The right. Returns bool The result of the operator. explicit operator byte[](ObjectId) Performs an explicit conversion from ObjectId to byte[]. public static explicit operator byte[](ObjectId objectId) Parameters objectId ObjectId The object id. Returns byte[] The result of the conversion. explicit operator ObjectId(Guid) public static explicit operator ObjectId(Guid guid) Parameters guid Guid Returns ObjectId operator !=(ObjectId, ObjectId) Implements the !=. public static bool operator !=(ObjectId left, ObjectId right) Parameters left ObjectId The left. right ObjectId The right. Returns bool The result of the operator."
  },
  "api/Stride.Core.Storage.ObjectIdBuilder.html": {
    "href": "api/Stride.Core.Storage.ObjectIdBuilder.html",
    "title": "Struct ObjectIdBuilder | Stride API",
    "summary": "Struct ObjectIdBuilder Namespace Stride.Core.Storage Assembly Stride.Core.dll A builder for ObjectId using Murmurshash3 128 bits public struct ObjectIdBuilder Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ObjectIdBuilder(uint) public ObjectIdBuilder(uint seed = 0) Parameters seed uint Properties Length public int Length { get; } Property Value int Seed public uint Seed { get; } Property Value uint Methods ComputeHash() Gets the current calculated hash. public ObjectId ComputeHash() Returns ObjectId The current hash. ComputeHash(out ObjectId) Gets the current calculated hash. public void ComputeHash(out ObjectId result) Parameters result ObjectId Reset() public void Reset() Write(byte*, int) Writes a buffer of byte to this builder. [Obsolete(\"Use Write(ReadOnlySpan<byte>)\")] public void Write(byte* buffer, int length) Parameters buffer byte* The buffer. length int The lenght. Exceptions ArgumentNullException buffer ArgumentOutOfRangeException count;Offset + Count is out of range Write(byte[]) Writes a buffer of byte to this builder. public void Write(byte[] buffer) Parameters buffer byte[] The buffer. Exceptions ArgumentNullException buffer ArgumentOutOfRangeException buffer Write(byte[], int, int) Writes a buffer of byte to this builder. public void Write(byte[] buffer, int offset, int count) Parameters buffer byte[] The buffer. offset int The offset. count int The count. Exceptions ArgumentNullException buffer ArgumentOutOfRangeException count;Offset + Count is out of range Write(ReadOnlySpan<byte>) Writes a buffer of byte to this builder. public void Write(ReadOnlySpan<byte> span) Parameters span ReadOnlySpan<byte> The readonly span. Exceptions ArgumentNullException buffer ArgumentOutOfRangeException count;Offset + Count is out of range Write(string) public void Write(string str) Parameters str string WriteByte(byte) Writes a byte to the builder. public void WriteByte(byte value) Parameters value byte The value. Write<T>(ReadOnlySpan<T>) Writes the specified buffer to this instance. public void Write<T>(ReadOnlySpan<T> buffer) where T : unmanaged Parameters buffer ReadOnlySpan<T> The buffer. Type Parameters T Type must be a struct Write<T>(T) Writes the specified buffer to this instance. public void Write<T>(T data) where T : unmanaged Parameters data T The data. Type Parameters T Type must be a struct Write<T>(T[], int, int) Writes the specified buffer to this instance. public void Write<T>(T[] buffer, int offset, int count) where T : unmanaged Parameters buffer T[] The buffer. offset int The offset. count int The count. Type Parameters T Type must be a struct"
  },
  "api/Stride.Core.Storage.ObjectIdSimpleBuilder.html": {
    "href": "api/Stride.Core.Storage.ObjectIdSimpleBuilder.html",
    "title": "Struct ObjectIdSimpleBuilder | Stride API",
    "summary": "Struct ObjectIdSimpleBuilder Namespace Stride.Core.Storage Assembly Stride.Core.dll An optimized version of ObjectIdBuilder to output a ObjectId expecting data to hash be 32bits integers only. See remarks. public struct ObjectIdSimpleBuilder Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks This implementation is suited when it can be feeded with 32bits values. The resulting value must be identical to ObjectIdBuilder if the length size of the data is a multiple of 16 bytes. Constructors ObjectIdSimpleBuilder(uint) public ObjectIdSimpleBuilder(uint seed = 0) Parameters seed uint Properties Length public uint Length { get; } Property Value uint Seed public uint Seed { get; } Property Value uint Methods ComputeHash() Gets the current calculated hash. public ObjectId ComputeHash() Returns ObjectId The current hash. ComputeHash(out ObjectId) Gets the current calculated hash. public void ComputeHash(out ObjectId result) Parameters result ObjectId Reset() public void Reset() Write(int) public void Write(int data) Parameters data int Write(uint) public void Write(uint data) Parameters data uint Write<T>(T) Writes the specified data to this builder. Size of data must be multiple of 4 bytes. public void Write<T>(T data) where T : struct Parameters data T The data to add to this builder Type Parameters T Struct type with a size multiple of 4 bytes"
  },
  "api/Stride.Core.Storage.ObjectType.html": {
    "href": "api/Stride.Core.Storage.ObjectType.html",
    "title": "Enum ObjectType | Stride API",
    "summary": "Enum ObjectType Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll public enum ObjectType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Blob = 0 Chunk = 1"
  },
  "api/Stride.Core.Storage.OdbStreamWriter.html": {
    "href": "api/Stride.Core.Storage.OdbStreamWriter.html",
    "title": "Class OdbStreamWriter | Stride API",
    "summary": "Class OdbStreamWriter Namespace Stride.Core.Storage Assembly Stride.Core.Serialization.dll public abstract class OdbStreamWriter : Stream, IAsyncDisposable, IDisposable Inheritance object MarshalByRefObject Stream OdbStreamWriter Implements IAsyncDisposable IDisposable Derived DigestStream Inherited Members Stream.Null Stream.BeginRead(byte[], int, int, AsyncCallback, object) Stream.BeginWrite(byte[], int, int, AsyncCallback, object) Stream.Close() Stream.CopyTo(Stream) Stream.CopyTo(Stream, int) Stream.CopyToAsync(Stream) Stream.CopyToAsync(Stream, int) Stream.CopyToAsync(Stream, int, CancellationToken) Stream.CopyToAsync(Stream, CancellationToken) Stream.CreateWaitHandle() Stream.Dispose() Stream.DisposeAsync() Stream.EndRead(IAsyncResult) Stream.EndWrite(IAsyncResult) Stream.FlushAsync() Stream.FlushAsync(CancellationToken) Stream.ObjectInvariant() Stream.Read(Span<byte>) Stream.ReadAsync(byte[], int, int) Stream.ReadAsync(byte[], int, int, CancellationToken) Stream.ReadAsync(Memory<byte>, CancellationToken) Stream.ReadAtLeast(Span<byte>, int, bool) Stream.ReadAtLeastAsync(Memory<byte>, int, bool, CancellationToken) Stream.ReadByte() Stream.ReadExactly(byte[], int, int) Stream.ReadExactly(Span<byte>) Stream.ReadExactlyAsync(byte[], int, int, CancellationToken) Stream.ReadExactlyAsync(Memory<byte>, CancellationToken) Stream.Synchronized(Stream) Stream.ValidateBufferArguments(byte[], int, int) Stream.ValidateCopyToArguments(Stream, int) Stream.Write(byte[], int, int) Stream.Write(ReadOnlySpan<byte>) Stream.WriteAsync(byte[], int, int) Stream.WriteAsync(byte[], int, int, CancellationToken) Stream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken) Stream.WriteByte(byte) Stream.CanTimeout Stream.ReadTimeout Stream.WriteTimeout MarshalByRefObject.GetLifetimeService() MarshalByRefObject.InitializeLifetimeService() MarshalByRefObject.MemberwiseClone(bool) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) SocketExtensions.Read7BitEncodedInt(Stream) SocketExtensions.ReadAllAsync(Stream, byte[], int, int) SocketExtensions.ReadGuidAsync(Stream) SocketExtensions.ReadInt16Async(Stream) SocketExtensions.ReadInt32Async(Stream) SocketExtensions.ReadStringAsync(Stream) SocketExtensions.Write7BitEncodedInt(Stream, int) SocketExtensions.WriteGuidAsync(Stream, Guid) SocketExtensions.WriteInt16Async(Stream, short) SocketExtensions.WriteInt32Async(Stream, int) SocketExtensions.WriteStringAsync(Stream, string) UnsafeUtilities.As<T>(object?) Constructors OdbStreamWriter(Stream, string) protected OdbStreamWriter(Stream stream, string temporaryName) Parameters stream Stream temporaryName string Fields Disposed public Action<OdbStreamWriter> Disposed Field Value Action<OdbStreamWriter> TemporaryName public string TemporaryName Field Value string stream protected readonly Stream stream Field Value Stream Properties CanRead When overridden in a derived class, gets a value indicating whether the current stream supports reading. public override bool CanRead { get; } Property Value bool true if the stream supports reading; otherwise, false. CanSeek When overridden in a derived class, gets a value indicating whether the current stream supports seeking. public override bool CanSeek { get; } Property Value bool true if the stream supports seeking; otherwise, false. CanWrite When overridden in a derived class, gets a value indicating whether the current stream supports writing. public override bool CanWrite { get; } Property Value bool true if the stream supports writing; otherwise, false. CurrentHash public abstract ObjectId CurrentHash { get; } Property Value ObjectId Length When overridden in a derived class, gets the length in bytes of the stream. public override long Length { get; } Property Value long A long value representing the length of the stream in bytes. Exceptions NotSupportedException A class derived from Stream does not support seeking and the length is unknown. ObjectDisposedException Methods were called after the stream was closed. Position When overridden in a derived class, gets or sets the position within the current stream. public override long Position { get; set; } Property Value long The current position within the stream. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support seeking. ObjectDisposedException Methods were called after the stream was closed. Methods Dispose(bool) Releases the unmanaged resources used by the Stream and optionally releases the managed resources. protected override void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. Flush() When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. public override void Flush() Exceptions IOException An I/O error occurs. Read(byte[], int, int) When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. public override int Read(byte[] buffer, int offset, int count) Parameters buffer byte[] An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. offset int The zero-based byte offset in buffer at which to begin storing the data read from the current stream. count int The maximum number of bytes to be read from the current stream. Returns int The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if count is 0 or the end of the stream has been reached. Exceptions ArgumentException The sum of offset and count is larger than the buffer length. ArgumentNullException buffer is null. ArgumentOutOfRangeException offset or count is negative. IOException An I/O error occurs. NotSupportedException The stream does not support reading. ObjectDisposedException Methods were called after the stream was closed. Seek(long, SeekOrigin) When overridden in a derived class, sets the position within the current stream. public override long Seek(long offset, SeekOrigin origin) Parameters offset long A byte offset relative to the origin parameter. origin SeekOrigin A value of type SeekOrigin indicating the reference point used to obtain the new position. Returns long The new position within the current stream. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support seeking, such as if the stream is constructed from a pipe or console output. ObjectDisposedException Methods were called after the stream was closed. SetLength(long) When overridden in a derived class, sets the length of the current stream. public override void SetLength(long value) Parameters value long The desired length of the current stream in bytes. Exceptions IOException An I/O error occurs. NotSupportedException The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. ObjectDisposedException Methods were called after the stream was closed."
  },
  "api/Stride.Core.Storage.html": {
    "href": "api/Stride.Core.Storage.html",
    "title": "Namespace Stride.Core.Storage | Stride API",
    "summary": "Namespace Stride.Core.Storage Classes Blob Stores immutable binary content. BundleDescription Description of a bundle: header, dependencies, objects and assets. BundleOdbBackend Object Database Backend (ODB) implementation that bundles multiple chunks into a .bundle files, optionally compressed with LZ4. DigestStream FileOdbBackend Object Database Backend (ODB) implementation using VirtualFileSystem ObjectDatabase Gives access to the object database. ObjectDatabaseContentIndexMap Content Index Map implementation which regroups all the asset index maps of every loaded file backend and asset bundle backends. OdbStreamWriter Structs BundleOdbBackend.Header BundleOdbBackend.ObjectInfo ObjectId A hash to uniquely identify data. ObjectIdBuilder A builder for ObjectId using Murmurshash3 128 bits ObjectIdSimpleBuilder An optimized version of ObjectIdBuilder to output a ObjectId expecting data to hash be 32bits integers only. See remarks. Interfaces IOdbBackend Base class for custom object database backends (ODB). Enums ObjectType Delegates BundleOdbBackend.BundleResolveDelegate"
  },
  "api/Stride.Core.Streaming.ContentChunk.html": {
    "href": "api/Stride.Core.Streaming.ContentChunk.html",
    "title": "Class ContentChunk | Stride API",
    "summary": "Class ContentChunk Namespace Stride.Core.Streaming Assembly Stride.Core.Serialization.dll Content storage data chunk. public sealed class ContentChunk Inheritance object ContentChunk Extension Methods UnsafeUtilities.As<T>(object?) Properties ExistsInFile Gets a value indicating whether this exists in file. public bool ExistsInFile { get; } Property Value bool IsLoaded Gets a value indicating whether this chunk is loaded. public bool IsLoaded { get; } Property Value bool IsMissing Gets a value indicating whether this chunk is not loaded. public bool IsMissing { get; } Property Value bool LastAccessTime Gets the last access time. public DateTime LastAccessTime { get; } Property Value DateTime Location Gets the chunk location in file (adress of the first byte). public int Location { get; } Property Value int Size Gets the chunk size in file (in bytes). public int Size { get; } Property Value int Storage Gets the parent storage container. public ContentStorage Storage { get; } Property Value ContentStorage Methods GetData(DatabaseFileProvider) Loads chunk data from the storage container. public nint GetData(DatabaseFileProvider fileProvider) Parameters fileProvider DatabaseFileProvider Database file provider. Returns nint RegisterUsage() Registers the usage operation of chunk data. public void RegisterUsage()"
  },
  "api/Stride.Core.Streaming.ContentStorage.html": {
    "href": "api/Stride.Core.Streaming.ContentStorage.html",
    "title": "Class ContentStorage | Stride API",
    "summary": "Class ContentStorage Namespace Stride.Core.Streaming Assembly Stride.Core.Serialization.dll Streamable resources content storage containter. public class ContentStorage : DisposeBase, IDisposable, IReferencable Inheritance object DisposeBase ContentStorage Implements IDisposable IReferencable Inherited Members DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.KeepReference<T>(T) ComponentBaseExtensions.ReleaseBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveReleaseBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties ChunksCount Gets the amount of chunks located inside the storage container. public int ChunksCount { get; } Property Value int LastAccessTime Gets the last access time. public DateTime LastAccessTime { get; } Property Value DateTime LoadedChunksCount Gets the amount of loaded chunks. public int LoadedChunksCount { get; } Property Value int PackageTime Gets the time when container has been created (in UTC). public DateTime PackageTime { get; } Property Value DateTime Service The content streaming service which manages this storage container. public ContentStreamingService Service { get; } Property Value ContentStreamingService Url Gets the storage URL path. public string Url { get; } Property Value string Methods Create(ContentManager, string, List<byte[]>, out ContentStorageHeader) Creates the new storage container at the specified location and generates header for that. public static void Create(ContentManager contentManager, string dataUrl, List<byte[]> chunksData, out ContentStorageHeader header) Parameters contentManager ContentManager The content manager. dataUrl string The file url. chunksData List<byte[]> The chunks data. header ContentStorageHeader The header data. Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. GetChunk(int) Gets the chunk. public ContentChunk GetChunk(int index) Parameters index int The index. Returns ContentChunk Chunk GetHashCode() Serves as the default hash function. public override sealed int GetHashCode() Returns int A hash code for the current object. LockChunks() Locks the chunks. public void LockChunks() UnlockChunks() Unlocks the chunks. public void UnlockChunks()"
  },
  "api/Stride.Core.Streaming.ContentStorageHeader.ChunkEntry.html": {
    "href": "api/Stride.Core.Streaming.ContentStorageHeader.ChunkEntry.html",
    "title": "Struct ContentStorageHeader.ChunkEntry | Stride API",
    "summary": "Struct ContentStorageHeader.ChunkEntry Namespace Stride.Core.Streaming Assembly Stride.Core.Serialization.dll Describies single data chunk storage information. public struct ContentStorageHeader.ChunkEntry Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Location The location (adress in file). public int Location Field Value int Size The size in bytes. public int Size Field Value int"
  },
  "api/Stride.Core.Streaming.ContentStorageHeader.html": {
    "href": "api/Stride.Core.Streaming.ContentStorageHeader.html",
    "title": "Struct ContentStorageHeader | Stride API",
    "summary": "Struct ContentStorageHeader Namespace Stride.Core.Streaming Assembly Stride.Core.Serialization.dll Header with description of streamable resource data storage. public struct ContentStorageHeader Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Chunks The data chunks. public ContentStorageHeader.ChunkEntry[] Chunks Field Value ChunkEntry[] DataUrl The data container url. public string DataUrl Field Value string HashCode The hash code for the package header. Used to ensure data consistency. public int HashCode Field Value int InitialImage True if data is followed by initial low resolution image. public bool InitialImage Field Value bool PackageTime Time when package has been created (in UTC). public DateTime PackageTime Field Value DateTime Properties ChunksCount Gets the amount of data chunks. public readonly int ChunksCount { get; } Property Value int Methods Read(SerializationStream, out ContentStorageHeader) Reads header instance from a stream. public static void Read(SerializationStream stream, out ContentStorageHeader result) Parameters stream SerializationStream The source stream. result ContentStorageHeader Result data Write(SerializationStream) Writes this instance to a stream. public readonly void Write(SerializationStream stream) Parameters stream SerializationStream The destination stream."
  },
  "api/Stride.Core.Streaming.ContentStreamingException.html": {
    "href": "api/Stride.Core.Streaming.ContentStreamingException.html",
    "title": "Class ContentStreamingException | Stride API",
    "summary": "Class ContentStreamingException Namespace Stride.Core.Streaming Assembly Stride.Core.Serialization.dll The exception that is thrown when an internal error happened in the Audio System. That is an error that is not due to the user behavior. public sealed class ContentStreamingException : Exception, ISerializable Inheritance object Exception ContentStreamingException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Extension Methods UnsafeUtilities.As<T>(object?) Constructors ContentStreamingException(string, ContentStorage) Initializes a new instance of the ContentStreamingException class. public ContentStreamingException(string msg, ContentStorage storage = null) Parameters msg string The message. storage ContentStorage The storage container. Properties Storage Gets the storage container that causes this exception. public ContentStorage Storage { get; } Property Value ContentStorage See Also Exception"
  },
  "api/Stride.Core.Streaming.ContentStreamingService.html": {
    "href": "api/Stride.Core.Streaming.ContentStreamingService.html",
    "title": "Class ContentStreamingService | Stride API",
    "summary": "Class ContentStreamingService Namespace Stride.Core.Streaming Assembly Stride.Core.Serialization.dll Streamable resources content management service. public class ContentStreamingService : IDisposable Inheritance object ContentStreamingService Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields UnusedDataChunksLifetime The unused data chunks lifetime. public TimeSpan UnusedDataChunksLifetime Field Value TimeSpan Methods Dispose() Performs resources disposing. public void Dispose() GetStorage(ref ContentStorageHeader) Gets the storage container. public ContentStorage GetStorage(ref ContentStorageHeader storageHeader) Parameters storageHeader ContentStorageHeader The storage header. Returns ContentStorage Content Storage container. Update() Updates this service. public void Update()"
  },
  "api/Stride.Core.Streaming.IStreamingManager.html": {
    "href": "api/Stride.Core.Streaming.IStreamingManager.html",
    "title": "Interface IStreamingManager | Stride API",
    "summary": "Interface IStreamingManager Namespace Stride.Core.Streaming Assembly Stride.Core.Serialization.dll Interface for Streaming Manager service. public interface IStreamingManager Extension Methods UnsafeUtilities.As<T>(object?) Methods FullyLoadResource(object) Puts request to load given resource up to the maximum residency level. void FullyLoadResource(object obj) Parameters obj object The streamable resource object."
  },
  "api/Stride.Core.Streaming.html": {
    "href": "api/Stride.Core.Streaming.html",
    "title": "Namespace Stride.Core.Streaming | Stride API",
    "summary": "Namespace Stride.Core.Streaming Classes ContentChunk Content storage data chunk. ContentStorage Streamable resources content storage containter. ContentStreamingException The exception that is thrown when an internal error happened in the Audio System. That is an error that is not due to the user behavior. ContentStreamingService Streamable resources content management service. Structs ContentStorageHeader Header with description of streamable resource data storage. ContentStorageHeader.ChunkEntry Describies single data chunk storage information. Interfaces IStreamingManager Interface for Streaming Manager service."
  },
  "api/Stride.Core.StringExtensions.html": {
    "href": "api/Stride.Core.StringExtensions.html",
    "title": "Class StringExtensions | Stride API",
    "summary": "Class StringExtensions Namespace Stride.Core Assembly Stride.Core.dll Extensions for string class. public static class StringExtensions Inheritance object StringExtensions Methods Contains(string, char) Indicate if the string contains a character. public static bool Contains(this string text, char value) Parameters text string The text value char The character to look for. Returns bool A boolean indicating if at least one instance of value is present in text EndsWith(string, char) Determines whether the end of this string ends by the specified character. public static bool EndsWith(this string stringToTest, char endChar) Parameters stringToTest string The string automatic test. endChar char The end character. Returns bool true if the end of this string ends by the specified character, false otherwise. EndsWith(string, params char[]) Determines whether the end of this string ends by the specified characters. public static bool EndsWith(this string stringToTest, params char[] endChars) Parameters stringToTest string The string automatic test. endChars char[] The end characters. Returns bool true if the end of this string ends by the specified character, false otherwise. IndexOf(StringBuilder, char) Calculates the index of a char inside the following StringBuilder, equivalent of IndexOf(char) for a StringBuilder. public static int IndexOf(this StringBuilder builder, char testChar) Parameters builder StringBuilder The builder. testChar char The test character. Returns int A position to the character found, or -1 if not found. Exceptions ArgumentNullException builder IndexOfReverse(string, char, int) Reports the index number, or character position, of the first occurrence of the specified Unicode character in the current String object. The search starts at a specified character position starting from the end and examines a specified number of character positions. public static int IndexOfReverse(this string text, char charToFind, int matchCount = 1) Parameters text string The text. charToFind char The character automatic find. matchCount int The number of match before stopping. Default is 1 Returns int The character position of the value parameter for the specified character if it is found, or -1 if it is not found. Exceptions ArgumentNullException text ArgumentOutOfRangeException matchCount;matchCount must be >= 1 IndexOfReverse(string, char, int, int, int) Reports the index number, or character position, of the first occurrence of the specified Unicode character in the current String object. The search starts at a specified character position starting from the end and examines a specified number of character positions. public static int IndexOfReverse(this string text, char charToFind, int startIndexFromEnd, int count, int matchCount = 1) Parameters text string The text. charToFind char The character automatic find. startIndexFromEnd int The starting index number for the search relative to the end of the string. count int The number of character positions to be examined. matchCount int The number of match before stopping. Default is 1 Returns int The character position of the value parameter for the specified character if it is found, or -1 if it is not found. Exceptions ArgumentNullException text ArgumentOutOfRangeException count;Count must be a positive value or startIndexFromEnd;StartIndexFromEnd must be a positive value or startIndexFromEnd;StartIndexFromEnd must be within the range of the string length or count;Count must be in the range of the string length minus the startIndexFromEnd LastIndexOf(StringBuilder, char, int) Calculates the last index of a char inside the following StringBuilder, equivalent of LastIndexOf(char) for a StringBuilder. public static int LastIndexOf(this StringBuilder builder, char testChar, int startIndex = 0) Parameters builder StringBuilder The builder. testChar char The test character. startIndex int The start index. Returns int A position to the character found, or -1 if not found. Exceptions ArgumentNullException builder SafeTrim(string?) Safely trim a string. public static string? SafeTrim(this string? value) Parameters value string The string value. can be null Returns string The string trimmed.May be null if string was null Substring(StringBuilder, int) public static string Substring(this StringBuilder builder, int startIndex) Parameters builder StringBuilder startIndex int Returns string Substring(StringBuilder, int, int) public static string Substring(this StringBuilder builder, int startIndex, int length) Parameters builder StringBuilder startIndex int length int Returns string ToFormat(string, params object?[]) Extension to format a string using Format(string, object) method by allowing to use it directly on a string. public static string ToFormat(this string stringToFormat, params object?[] argumentsToFormat) Parameters stringToFormat string The string automatic format. argumentsToFormat object[] The arguments automatic format. Returns string A formatted string. See Format(string, object)"
  },
  "api/Stride.Core.ThreadThrottler.ThrottlerType.html": {
    "href": "api/Stride.Core.ThreadThrottler.ThrottlerType.html",
    "title": "Enum ThreadThrottler.ThrottlerType | Stride API",
    "summary": "Enum ThreadThrottler.ThrottlerType Namespace Stride.Core Assembly Stride.Core.dll public enum ThreadThrottler.ThrottlerType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields PreciseAuto = 2 PreciseManual = 1 Standard = 0"
  },
  "api/Stride.Core.ThreadThrottler.html": {
    "href": "api/Stride.Core.ThreadThrottler.html",
    "title": "Class ThreadThrottler | Stride API",
    "summary": "Class ThreadThrottler Namespace Stride.Core Assembly Stride.Core.dll public class ThreadThrottler : IThreadThrottler Inheritance object ThreadThrottler Implements IThreadThrottler Extension Methods UnsafeUtilities.As<T>(object?) Constructors ThreadThrottler() Create an instance of this class without throttling and defaulting to Standard mode. See SetToPreciseAuto() and SetToPreciseManual(long) to set it to other modes. public ThreadThrottler() ThreadThrottler(int) Create an instance of this class set to Standard mode. See SetToPreciseAuto() and SetToPreciseManual(long) to set it to other modes. public ThreadThrottler(int frequencyMax) Parameters frequencyMax int The maximum frequency this object allows ThreadThrottler(TimeSpan) Create an instance of this class set to Standard mode. See SetToPreciseAuto() and SetToPreciseManual(long) to set it to other modes. public ThreadThrottler(TimeSpan minimumElapsedTimeParam) Parameters minimumElapsedTimeParam TimeSpan Minimum time allowed between each call Properties MinimumElapsedTime Set this to zero to disable throttling. Minimum amount of time allowed between each 'update'. Conversion is lossy, getting this value back might not return the same value you set it to. public TimeSpan MinimumElapsedTime { get; set; } Property Value TimeSpan Remarks See Throttle(out long)'s summary for an idea of how this property is used. Type The type of throttler used public ThreadThrottler.ThrottlerType Type { get; } Property Value ThreadThrottler.ThrottlerType Methods SetMaxFrequency(int) Thread will be blocked to stay within the given amount of 'updates' per second. public void SetMaxFrequency(int frequencyMax) Parameters frequencyMax int Remarks It effectively transforms the given parameter from frame per second to the internal closest second per frame equivalent for it. SetToPreciseAuto() Most of the timings will be perfectly precise to the system timer at the cost of higher CPU usage. If you aren't sure, use SetToStandard() instead. public void SetToPreciseAuto() Remarks This mode uses and automatically scales a spinwait window based on system responsiveness to find the right balance between Thread.Sleep calls and spinwaiting. SetToPreciseManual(long) Depending on the provided value, timings will be perfectly precise to the system timer at the cost of higher CPU usage. If you aren't sure, use SetToStandard() instead. public void SetToPreciseManual(long spinwaitWindowParam) Parameters spinwaitWindowParam long Remarks This mode uses the given value as the duration of the spinwait window. The format of this value is based on Stopwatch.Frequency SetToStandard() Saves CPU cycles while waiting, this one is the least precise mode but the lightest. If you aren't sure, use this one ! public void SetToStandard() Throttle(out double) Forces the thread to sleep when the time elapsed since last call is lower than MinimumElapsedTime, it will sleep for the time remaining to reach MinimumElapsedTime. Use this function inside a loop when you want to lock it to a specific rate. public bool Throttle(out double elapsedInSeconds) Parameters elapsedInSeconds double The time since the last call in seconds, returns a value close to MinimumElapsedTime, use this value as your delta time. Returns bool True if this class had to throttle, false otherwise Throttle(out long) Forces the thread to sleep when the time elapsed since last call is lower than MinimumElapsedTime, it will sleep for the time remaining to reach that value. Use this function inside a loop when you want to lock it to a specific rate. public bool Throttle(out long elapsedInSwFreq) Parameters elapsedInSwFreq long The time since the last call in Stopwatch.Frequency returns a value close to MinimumElapsedTime, use this value as your delta time. Returns bool True if this class had to throttle, false otherwise Throttle(out TimeSpan) Forces the thread to sleep when the time elapsed since last call is lower than MinimumElapsedTime, it will sleep for the time remaining to reach MinimumElapsedTime. Use this function inside a loop when you want to lock it to a specific rate. public bool Throttle(out TimeSpan elapsedTimeSpan) Parameters elapsedTimeSpan TimeSpan The time since the last call, returns a value close to MinimumElapsedTime, use this value as your delta time. Returns bool True if this class had to throttle, false otherwise"
  },
  "api/Stride.Core.Threading.ConcurrentCollector-1.Enumerator.html": {
    "href": "api/Stride.Core.Threading.ConcurrentCollector-1.Enumerator.html",
    "title": "Struct ConcurrentCollector<T>.Enumerator | Stride API",
    "summary": "Struct ConcurrentCollector<T>.Enumerator Namespace Stride.Core.Threading Assembly Stride.Core.dll public struct ConcurrentCollector<T>.Enumerator : IEnumerator<T>, IEnumerator, IDisposable Implements IEnumerator<T> IEnumerator IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Current Gets the element in the collection at the current position of the enumerator. public readonly T Current { get; } Property Value T The element in the collection at the current position of the enumerator. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public readonly void Dispose() MoveNext() Advances the enumerator to the next element of the collection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created."
  },
  "api/Stride.Core.Threading.ConcurrentCollector-1.html": {
    "href": "api/Stride.Core.Threading.ConcurrentCollector-1.html",
    "title": "Class ConcurrentCollector<T> | Stride API",
    "summary": "Class ConcurrentCollector<T> Namespace Stride.Core.Threading Assembly Stride.Core.dll A collector that allows for concurrent adding of items, as well as non-thread-safe clearing and accessing of the underlying collection. public class ConcurrentCollector<T> : IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable Type Parameters T The element type in the collection. Inheritance object ConcurrentCollector<T> Implements IReadOnlyList<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable Extension Methods ConcurrentCollectorExtensions.Add<T>(ConcurrentCollector<T>, T, ConcurrentCollectorCache<T>) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors ConcurrentCollector(int) public ConcurrentCollector(int capacity = 16) Parameters capacity int Properties Count Gets the number of elements in the collection. public int Count { get; } Property Value int The number of elements in the collection. this[int] Gets the element at the specified index in the read-only list. public T this[int index] { get; set; } Parameters index int The zero-based index of the element to get. Property Value T The element at the specified index in the read-only list. Items Gets the underlying array. It is an error to access Items after adding elements, but before closing. public T[] Items { get; } Property Value T[] Methods Add(T) public int Add(T item) Parameters item T Returns int AddRange(IReadOnlyList<T>) public void AddRange(IReadOnlyList<T> collection) Parameters collection IReadOnlyList<T> Clear(bool) Clears the collection. If fastClear is true, the underlying array is not cleared. public void Clear(bool fastClear) Parameters fastClear bool Close() Consolidates all added items into a single consecutive array. It is an error to access Items after adding elements, but before closing. public void Close() GetEnumerator() public ConcurrentCollector<T>.Enumerator GetEnumerator() Returns ConcurrentCollector<T>.Enumerator"
  },
  "api/Stride.Core.Threading.ConcurrentCollectorCache-1.html": {
    "href": "api/Stride.Core.Threading.ConcurrentCollectorCache-1.html",
    "title": "Class ConcurrentCollectorCache<T> | Stride API",
    "summary": "Class ConcurrentCollectorCache<T> Namespace Stride.Core.Threading Assembly Stride.Core.dll public class ConcurrentCollectorCache<T> Type Parameters T Inheritance object ConcurrentCollectorCache<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors ConcurrentCollectorCache(int) public ConcurrentCollectorCache(int capacity) Parameters capacity int Methods Add(ConcurrentCollector<T>, T) public void Add(ConcurrentCollector<T> collection, T item) Parameters collection ConcurrentCollector<T> item T Flush() public void Flush()"
  },
  "api/Stride.Core.Threading.ConcurrentCollectorExtensions.html": {
    "href": "api/Stride.Core.Threading.ConcurrentCollectorExtensions.html",
    "title": "Class ConcurrentCollectorExtensions | Stride API",
    "summary": "Class ConcurrentCollectorExtensions Namespace Stride.Core.Threading Assembly Stride.Core.dll public static class ConcurrentCollectorExtensions Inheritance object ConcurrentCollectorExtensions Methods Add<T>(ConcurrentCollector<T>, T, ConcurrentCollectorCache<T>) public static void Add<T>(this ConcurrentCollector<T> collection, T item, ConcurrentCollectorCache<T> cache) Parameters collection ConcurrentCollector<T> item T cache ConcurrentCollectorCache<T> Type Parameters T"
  },
  "api/Stride.Core.Threading.ConcurrentPool-1.html": {
    "href": "api/Stride.Core.Threading.ConcurrentPool-1.html",
    "title": "Class ConcurrentPool<T> | Stride API",
    "summary": "Class ConcurrentPool<T> Namespace Stride.Core.Threading Assembly Stride.Core.dll A concurrent object pool. public class ConcurrentPool<T> where T : class Type Parameters T The pooled item type Inheritance object ConcurrentPool<T> Extension Methods UnsafeUtilities.As<T>(object?) Remarks Circular buffer segments are used as storage. When full, new segments are added as tail. Items are only appended to the tail segment. When the head segment is empty, it will be discarded. After stabilizing, only a single segment exists at a time, causing no further segment allocations or locking. Constructors ConcurrentPool(Func<T>) Initializes a new instance of the ConcurrentPool<T> class. public ConcurrentPool(Func<T> factory) Parameters factory Func<T> The factory method for creating new items, should the pool be empty. Methods Acquire() Draws an item from the pool. public T Acquire() Returns T Release(T) Releases an item back to the pool. public void Release(T item) Parameters item T The item to release to the pool."
  },
  "api/Stride.Core.Threading.Dispatcher.IBatchJob.html": {
    "href": "api/Stride.Core.Threading.Dispatcher.IBatchJob.html",
    "title": "Interface Dispatcher.IBatchJob | Stride API",
    "summary": "Interface Dispatcher.IBatchJob Namespace Stride.Core.Threading Assembly Stride.Core.dll An implementation of a job running in batches. Implementing this as a struct improves performance as the JIT would have an easier time inlining the call. Implementing this as a class would provide more utility as this object would be shared across all threads, allowing for interlocked operations and other communication between threads. public interface Dispatcher.IBatchJob Extension Methods UnsafeUtilities.As<T>(object?) Methods Process(int, int) Execute this job over a range of items void Process(int start, int endExclusive) Parameters start int the start of the range endExclusive int the end of the range, iterate as long as i < endExclusive"
  },
  "api/Stride.Core.Threading.Dispatcher.ValueAction-1.html": {
    "href": "api/Stride.Core.Threading.Dispatcher.ValueAction-1.html",
    "title": "Delegate Dispatcher.ValueAction<T> | Stride API",
    "summary": "Delegate Dispatcher.ValueAction<T> Namespace Stride.Core.Threading Assembly Stride.Core.dll public delegate void Dispatcher.ValueAction<T>(ref T obj) Parameters obj T Type Parameters T Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Threading.Dispatcher.html": {
    "href": "api/Stride.Core.Threading.Dispatcher.html",
    "title": "Class Dispatcher | Stride API",
    "summary": "Class Dispatcher Namespace Stride.Core.Threading Assembly Stride.Core.dll public static class Dispatcher Inheritance object Dispatcher Properties MaxDegreeOfParallelism public static int MaxDegreeOfParallelism { get; set; } Property Value int Methods For(int, int, Action<int>) public static void For(int fromInclusive, int toExclusive, Action<int> action) Parameters fromInclusive int toExclusive int action Action<int> ForBatched(int, Action<int, int>) public static void ForBatched(int items, Action<int, int> executeBatch) Parameters items int executeBatch Action<int, int> ForBatched<TJob>(int, TJob) The call producing the least amount of overhead, other methods are built on top of this one. public static void ForBatched<TJob>(int items, TJob batchJob) where TJob : Dispatcher.IBatchJob Parameters items int The amount of items to process, this total will be split into multiple batches, each batch runs TJob.Process(int, int) with the range of items for that batch batchJob TJob An object shared across all threads running this job, if TJob is a struct each threads will work off of a unique copy of it Type Parameters TJob Exceptions Exception If any of the threads executing this job threw an exception, it will be re-thrown in the caller's scope ForBatched<T>(int, ref T, delegate*<ref T, int, int, void>) public static void ForBatched<T>(int items, ref T parameter, delegate*<ref T, int, int, void> executeBatch) Parameters items int parameter T executeBatch delegate*<ref T, int, int, void> Type Parameters T ForBatched<T>(int, ref T, delegate*<ref T, int, int, void>) public static void ForBatched<T>(int items, ref T parameter, delegate*<ref T, int, int, void> executeBatch) Parameters items int parameter T executeBatch delegate*<ref T, int, int, void> Type Parameters T ForEach<T>(FastCollection<T>, Action<T>) public static void ForEach<T>(FastCollection<T> collection, Action<T> action) Parameters collection FastCollection<T> action Action<T> Type Parameters T ForEach<T>(ConcurrentCollector<T>, ValueAction<T>) public static void ForEach<T>(ConcurrentCollector<T> collection, Dispatcher.ValueAction<T> action) Parameters collection ConcurrentCollector<T> action Dispatcher.ValueAction<T> Type Parameters T ForEach<T>(ConcurrentCollector<T>, Action<T>) public static void ForEach<T>(ConcurrentCollector<T> collection, Action<T> action) Parameters collection ConcurrentCollector<T> action Action<T> Type Parameters T ForEach<T>(List<T>, Action<T>) public static void ForEach<T>(List<T> collection, Action<T> action) Parameters collection List<T> action Action<T> Type Parameters T ForEach<T>(T[], Action<T>) public static void ForEach<T>(T[] collection, Action<T> action) Parameters collection T[] action Action<T> Type Parameters T ForEach<T, TLocal>(ConcurrentCollector<T>, Func<TLocal>, Action<T, TLocal>, Action<TLocal>) public static void ForEach<T, TLocal>(ConcurrentCollector<T> collection, Func<TLocal> initializeLocal, Action<T, TLocal> action, Action<TLocal> finalizeLocal = null) Parameters collection ConcurrentCollector<T> initializeLocal Func<TLocal> action Action<T, TLocal> finalizeLocal Action<TLocal> Type Parameters T TLocal ForEach<TKey, TValue>(Dictionary<TKey, TValue>, Action<KeyValuePair<TKey, TValue>>) public static void ForEach<TKey, TValue>(Dictionary<TKey, TValue> collection, Action<KeyValuePair<TKey, TValue>> action) where TKey : notnull Parameters collection Dictionary<TKey, TValue> action Action<KeyValuePair<TKey, TValue>> Type Parameters TKey TValue ForEach<T, TList>(TList, Action<T>) public static void ForEach<T, TList>(TList collection, Action<T> action) where TList : IReadOnlyList<T> Parameters collection TList action Action<T> Type Parameters T TList ForEach<TKey, TValue, TLocal>(Dictionary<TKey, TValue>, Func<TLocal>, Action<KeyValuePair<TKey, TValue>, TLocal>, Action<TLocal>) public static void ForEach<TKey, TValue, TLocal>(Dictionary<TKey, TValue> collection, Func<TLocal> initializeLocal, Action<KeyValuePair<TKey, TValue>, TLocal> action, Action<TLocal> finalizeLocal = null) where TKey : notnull Parameters collection Dictionary<TKey, TValue> initializeLocal Func<TLocal> action Action<KeyValuePair<TKey, TValue>, TLocal> finalizeLocal Action<TLocal> Type Parameters TKey TValue TLocal ForEach<TItem, TLocal, TList>(TList, Func<TLocal>, Action<TItem, TLocal>, Action<TLocal>) public static void ForEach<TItem, TLocal, TList>(TList collection, Func<TLocal> initializeLocal, Action<TItem, TLocal> action, Action<TLocal> finalizeLocal = null) where TList : IReadOnlyList<TItem> Parameters collection TList initializeLocal Func<TLocal> action Action<TItem, TLocal> finalizeLocal Action<TLocal> Type Parameters TItem TLocal TList For<TLocal>(int, int, Func<TLocal>, Action<int, TLocal>, Action<TLocal>) public static void For<TLocal>(int fromInclusive, int toExclusive, Func<TLocal> initializeLocal, Action<int, TLocal> action, Action<TLocal> finalizeLocal = null) Parameters fromInclusive int toExclusive int initializeLocal Func<TLocal> action Action<int, TLocal> finalizeLocal Action<TLocal> Type Parameters TLocal Sort<T>(FastList<T>, IComparer<T>) [Obsolete(\"This method will be removed in the future alongside FastList. We will have an alternative using Span<T> which you will be able to fallback to.\")] public static void Sort<T>(FastList<T> collection, IComparer<T> comparer) Parameters collection FastList<T> comparer IComparer<T> Type Parameters T Sort<T>(ConcurrentCollector<T>, IComparer<T>) public static void Sort<T>(ConcurrentCollector<T> collection, IComparer<T> comparer) Parameters collection ConcurrentCollector<T> comparer IComparer<T> Type Parameters T Sort<T>(T[], int, int, IComparer<T>) public static void Sort<T>(T[] collection, int index, int length, IComparer<T> comparer) Parameters collection T[] index int length int comparer IComparer<T> Type Parameters T"
  },
  "api/Stride.Core.Threading.IPooledClosure.html": {
    "href": "api/Stride.Core.Threading.IPooledClosure.html",
    "title": "Interface IPooledClosure | Stride API",
    "summary": "Interface IPooledClosure Namespace Stride.Core.Threading Assembly Stride.Core.dll Interface implemented by pooled closure types through the AssemblyProcessor. Enables Stride.Core.Threading.PooledDelegateHelper to keep closures and delegates alive. public interface IPooledClosure Extension Methods UnsafeUtilities.As<T>(object?) Methods AddReference() void AddReference() Release() void Release()"
  },
  "api/Stride.Core.Threading.PooledAttribute.html": {
    "href": "api/Stride.Core.Threading.PooledAttribute.html",
    "title": "Class PooledAttribute | Stride API",
    "summary": "Class PooledAttribute Namespace Stride.Core.Threading Assembly Stride.Core.dll Allows delegates passed as parameters to be allocated from a pool and recycled after the method call. To prevent recycling, use AddReference(Delegate) and Release(Delegate) to hold onto references to the delegate. [AttributeUsage(AttributeTargets.Parameter)] public class PooledAttribute : Attribute Inheritance object Attribute PooledAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Threading.ThreadPool.html": {
    "href": "api/Stride.Core.Threading.ThreadPool.html",
    "title": "Class ThreadPool | Stride API",
    "summary": "Class ThreadPool Namespace Stride.Core.Threading Assembly Stride.Core.dll Thread pool for scheduling sub-millisecond actions, do not schedule long-running tasks. Can be instantiated and generates less garbage than dotnet's. public sealed class ThreadPool : IDisposable Inheritance object ThreadPool Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ThreadPool(int?) public ThreadPool(int? threadCount = null) Parameters threadCount int? Fields Instance The default instance that the whole process shares, use this one to avoid wasting process memory. public static ThreadPool Instance Field Value ThreadPool WorkerThreadsCount Amount of threads within this pool public readonly int WorkerThreadsCount Field Value int Properties CompletedWork Amount of work completed public ulong CompletedWork { get; } Property Value ulong IsWorkedThread Is the thread reading this property a worker thread public static bool IsWorkedThread { get; } Property Value bool ThreadsBusy Amount of threads currently executing work items public int ThreadsBusy { get; } Property Value int WorkScheduled Amount of work waiting to be taken care of public int WorkScheduled { get; } Property Value int Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() QueueUnsafeWorkItem(object, delegate*<object, void>, int) Queue some work item to run on one of the available threads, it is strongly recommended that the action takes less than a millisecond. Additionally, the parameter provided must be fixed from this call onward until the action has finished executing public void QueueUnsafeWorkItem(object parameter, delegate*<object, void> obj, int amount = 1) Parameters parameter object obj delegate*<object, void> amount int QueueWorkItem(Action, int) Queue an action to run on one of the available threads, it is strongly recommended that the action takes less than a millisecond. public void QueueWorkItem(Action workItem, int amount = 1) Parameters workItem Action amount int TryCooperate() Attempt to steal work from the threadpool to execute it from the calling thread. If you absolutely have to block inside one of the threadpool's thread for whatever reason do a busy loop over this function. public bool TryCooperate() Returns bool"
  },
  "api/Stride.Core.Threading.html": {
    "href": "api/Stride.Core.Threading.html",
    "title": "Namespace Stride.Core.Threading | Stride API",
    "summary": "Namespace Stride.Core.Threading Classes ConcurrentCollectorCache<T> ConcurrentCollectorExtensions ConcurrentCollector<T> A collector that allows for concurrent adding of items, as well as non-thread-safe clearing and accessing of the underlying collection. ConcurrentPool<T> A concurrent object pool. Dispatcher PooledAttribute Allows delegates passed as parameters to be allocated from a pool and recycled after the method call. To prevent recycling, use AddReference(Delegate) and Release(Delegate) to hold onto references to the delegate. ThreadPool Thread pool for scheduling sub-millisecond actions, do not schedule long-running tasks. Can be instantiated and generates less garbage than dotnet's. Structs ConcurrentCollector<T>.Enumerator Interfaces Dispatcher.IBatchJob An implementation of a job running in batches. Implementing this as a struct improves performance as the JIT would have an easier time inlining the call. Implementing this as a class would provide more utility as this object would be shared across all threads, allowing for interlocked operations and other communication between threads. IPooledClosure Interface implemented by pooled closure types through the AssemblyProcessor. Enables Stride.Core.Threading.PooledDelegateHelper to keep closures and delegates alive. Delegates Dispatcher.ValueAction<T>"
  },
  "api/Stride.Core.UnmanagedArray-1.html": {
    "href": "api/Stride.Core.UnmanagedArray-1.html",
    "title": "Class UnmanagedArray<T> | Stride API",
    "summary": "Class UnmanagedArray<T> Namespace Stride.Core Assembly Stride.Core.dll [Obsolete(\"Obtain Memory<T> using GC.Allocate*Array or a Stride-specific allocator mechanism.\")] public class UnmanagedArray<T> : IDisposable where T : struct Type Parameters T Inheritance object UnmanagedArray<T> Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors UnmanagedArray(int) [Obsolete(\"Obtain Memory<T> using GC.Allocate*Array or a Stride-specific allocator mechanism.\")] public UnmanagedArray(int length) Parameters length int Properties this[int] public T this[int index] { get; set; } Parameters index int Property Value T Length public int Length { get; } Property Value int Pointer public nint Pointer { get; } Property Value nint Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Read(T[], int) public void Read(T[] destination, int offset = 0) Parameters destination T[] offset int Read(T[], int, int, int) public void Read(T[] destination, int pointerByteOffset, int arrayOffset, int arrayLen) Parameters destination T[] pointerByteOffset int arrayOffset int arrayLen int Write(T[], int) public void Write(T[] source, int offset = 0) Parameters source T[] offset int Write(T[], int, int, int) public void Write(T[] source, int pointerByteOffset, int arrayOffset, int arrayLen) Parameters source T[] pointerByteOffset int arrayOffset int arrayLen int"
  },
  "api/Stride.Core.UnsafeExtensions.StringMarshal.html": {
    "href": "api/Stride.Core.UnsafeExtensions.StringMarshal.html",
    "title": "Class StringMarshal | Stride API",
    "summary": "Class StringMarshal Namespace Stride.Core.UnsafeExtensions Assembly Stride.Core.dll Provides a set of methods to supplement or replace Marshal when operating on strings and spans of characters. public static class StringMarshal Inheritance object StringMarshal Methods GetAsciiSpan(byte*, int) Gets a span for a null-terminated ASCII character sequence. public static ReadOnlySpan<byte> GetAsciiSpan(byte* source, int maxLength = -1) Parameters source byte* The pointer to a null-terminated ASCII character sequence. maxLength int The maxmimum length of source or -1 if the maximum length is unknown. Returns ReadOnlySpan<byte> A ReadOnlySpan<T> that starts at source and extends to maxLength or the first null character, whichever comes first. GetAsciiSpan(in byte, int) Gets a span for a null-terminated ASCII character sequence. public static ReadOnlySpan<byte> GetAsciiSpan(in byte source, int maxLength = -1) Parameters source byte The reference to a null-terminated ASCII character sequence. maxLength int The maxmimum length of source or -1 if the maximum length is unknown. Returns ReadOnlySpan<byte> A ReadOnlySpan<T> that starts at source and extends to maxLength or the first null character, whichever comes first. GetAsciiSpan(string) Gets a null-terminated sequence of ASCII characters for a string. public static ReadOnlySpan<byte> GetAsciiSpan(this string source) Parameters source string The string for which to marshal. Returns ReadOnlySpan<byte> A ReadOnlySpan<T> containing a null-terminated ASCII string that is equivalent to source. GetString(byte*) Gets a string for a pointer to a null-terminated string of bytes, assuming an UTF-8 encoding, the current system codepage, or ANSI. public static string? GetString(byte* ptr) Parameters ptr byte* A pointer to a null-terminated array of 8-bit integers. The integers are interpreted using the current system code page encoding on Windows (referred to as CP_ACP) and as UTF-8 encoding on non-Windows. Returns string A string created from ptr. GetString(char*) Gets a string for a pointer to a null-terminated string of characters, assuming an UTF-16 encoding. public static string? GetString(char* ptr) Parameters ptr char* A pointer to a null-terminated array of 16-bit characters. Returns string A string created from ptr. GetString(ReadOnlySpan<byte>) Gets a string for a given span of bytes, assuming an UTF-8 encoding. public static string? GetString(this ReadOnlySpan<byte> span) Parameters span ReadOnlySpan<byte> The span for which to create the string. Returns string A string created from span. GetString(ReadOnlySpan<char>) Gets a string for a given span, assuming an UTF-16 encoding. public static string? GetString(this ReadOnlySpan<char> span) Parameters span ReadOnlySpan<char> The span for which to create the string. Returns string A string created from span. GetString(ReadOnlySpan<ushort>) Gets a string for a given span, assuming an UTF-16 encoding. public static string? GetString(this ReadOnlySpan<ushort> span) Parameters span ReadOnlySpan<ushort> The span for which to create the string. Returns string A string created from span. GetUtf16Span(string) Gets a null-terminated sequence of UTF-16 characters for a string. public static ReadOnlySpan<ushort> GetUtf16Span(this string source) Parameters source string The string for which to get the null-terminated UTF-16 character sequence. Returns ReadOnlySpan<ushort> A ReadOnlySpan<T> containing a null-terminated UTF-16 string that is equivalent to source. GetUtf16Span(ushort*, int) Gets a span for a null-terminated UTF-16 character sequence. public static ReadOnlySpan<ushort> GetUtf16Span(ushort* source, int maxLength = -1) Parameters source ushort* The pointer to a null-terminated UTF-16 string. maxLength int The maxmimum length of source or -1 if the maximum length is unknown. Returns ReadOnlySpan<ushort> A ReadOnlySpan<T> that starts at source and extends to maxLength or the first null character, whichever comes first. GetUtf16Span(in ushort, int) Gets a span for a null-terminated UTF-16 character sequence. public static ReadOnlySpan<ushort> GetUtf16Span(in ushort source, int maxLength = -1) Parameters source ushort The reference to a null-terminated UTF-16 string. maxLength int The maxmimum length of source or -1 if the maximum length is unknown. Returns ReadOnlySpan<ushort> A ReadOnlySpan<T> that starts at source and extends to maxLength or the first null character, whichever comes first. GetUtf8Span(byte*, int) Gets a span for a null-terminated UTF-8 character sequence. public static ReadOnlySpan<byte> GetUtf8Span(byte* source, int maxLength = -1) Parameters source byte* The pointer to a null-terminated UTF-8 character sequence. maxLength int The maxmimum length of source or -1 if the maximum length is unknown. Returns ReadOnlySpan<byte> A ReadOnlySpan<T> that starts at source and extends to maxLength or the first null character, whichever comes first. GetUtf8Span(in byte, int) Gets a span for a null-terminated UTF-8 character sequence. public static ReadOnlySpan<byte> GetUtf8Span(in byte source, int maxLength = -1) Parameters source byte The reference to a null-terminated UTF-8 character sequence. maxLength int The maxmimum length of source or -1 if the maximum length is unknown. Returns ReadOnlySpan<byte> A ReadOnlySpan<T> that starts at source and extends to maxLength or the first null character, whichever comes first. GetUtf8Span(string) Gets a null-terminated sequence of UTF-8 characters for a string. public static ReadOnlySpan<byte> GetUtf8Span(this string source) Parameters source string The string for which to get the null-terminated UTF8 character sequence. Returns ReadOnlySpan<byte> A ReadOnlySpan<T> containing a null-terminated UTF-8 string that is equivalent to source."
  },
  "api/Stride.Core.UnsafeExtensions.UnsafeUtilities.html": {
    "href": "api/Stride.Core.UnsafeExtensions.UnsafeUtilities.html",
    "title": "Class UnsafeUtilities | Stride API",
    "summary": "Class UnsafeUtilities Namespace Stride.Core.UnsafeExtensions Assembly Stride.Core.dll Provides a set of methods to supplement or replace Unsafe and MemoryMarshal, mainly for working with structs and unmanaged types. public static class UnsafeUtilities Inheritance object UnsafeUtilities Methods AsBytes<T>(ReadOnlySpan<T>) Casts a ReadOnlySpan<T> of one primitive type, T, to a ReadOnlySpan<Byte>. public static ReadOnlySpan<byte> AsBytes<T>(this ReadOnlySpan<T> span) where T : struct Parameters span ReadOnlySpan<T> The source slice to convert. Returns ReadOnlySpan<byte> A read-only span of type byte. Type Parameters T The type of items in the read-only span. Exceptions ArgumentException T contains managed object references. OverflowException The Length property of the new ReadOnlySpan<T> would exceed Int32.MaxValue AsBytes<T>(Span<T>) Casts a Span<T> of one primitive type, T, to a Span<Byte>. public static Span<byte> AsBytes<T>(this Span<T> span) where T : struct Parameters span Span<T> The source slice to convert. Returns Span<byte> A span of type byte. Type Parameters T The type of items in the span. Exceptions ArgumentException T contains managed object references. OverflowException The Length property of the new ReadOnlySpan<T> would exceed Int32.MaxValue AsPointer<T>(ref T) public static T* AsPointer<T>(this ref T value) where T : unmanaged Parameters value T Returns T* Type Parameters T AsReadOnlySpan<T>(T[]?) Creates a new read-only span over the target array. public static ReadOnlySpan<T> AsReadOnlySpan<T>(this T[]? array) Parameters array T[] The array. Returns ReadOnlySpan<T> A read-only span over the provided array. Type Parameters T AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) Reinterprets a regular managed object as a read-only span of elements of another type. This can be useful if a managed object represents a \"fixed array\". public static ReadOnlySpan<TTo> AsReadOnlySpan<TFrom, TTo>(this scoped ref TFrom reference) where TFrom : unmanaged where TTo : unmanaged Parameters reference TFrom A reference to data. Returns ReadOnlySpan<TTo> A read-only span representing the specified reference as elements of type TTo. Type Parameters TFrom TTo Remarks This method should be used with caution. Even though the ref is annotated as scoped, it will be stored into the returned span, and the lifetime of the returned span will not be validated for safety, even by span-aware languages. AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) Reinterprets a regular managed object as an array of elements of another type and returns a read-only span over a portion of that array. This can be useful if a managed object represents a \"fixed array\". This is dangerous because the elementCount is not checked. public static ReadOnlySpan<TTo> AsReadOnlySpan<TFrom, TTo>(this scoped ref TFrom reference, int elementCount) where TFrom : unmanaged where TTo : unmanaged Parameters reference TFrom A reference to data. elementCount int The number of TTo elements the memory contains. Returns ReadOnlySpan<TTo> A read-only span representing the specified reference as elementCount elements of type TTo. Type Parameters TFrom TTo Remarks This method should be used with caution. It is dangerous because the elementCount argument is not checked. Even though the ref is annotated as scoped, it will be stored into the returned span, and the lifetime of the returned span will not be validated for safety, even by span-aware languages. AsReadOnlySpan<TFrom, TTo>(TFrom[]?) Reinterprets a regular array as a read-only span of elements of another type. This can be useful if the types are the same size and interchangeable. public static ReadOnlySpan<TTo> AsReadOnlySpan<TFrom, TTo>(this TFrom[]? array) where TFrom : unmanaged where TTo : unmanaged Parameters array TFrom[] An array of data. Returns ReadOnlySpan<TTo> A read-only span representing the data of array reinterpreted as elements of type TTo. If the array is null, returns an empty span. Type Parameters TFrom TTo AsReadonlyPointer<T>(ref readonly T) public static T* AsReadonlyPointer<T>(ref readonly T value) where T : unmanaged Parameters value T Returns T* Type Parameters T AsReadonly<TFrom, TTo>(ref readonly TFrom) Reinterprets the given managed pointer as a new managed pointer to a value of type TTo. public static ref readonly TTo AsReadonly<TFrom, TTo>(ref readonly TFrom source) Parameters source TFrom The managed pointer to reinterpret. Returns TTo A managed pointer to a value of type TTo. Type Parameters TFrom The type of managed pointer to reinterpret. TTo The desired type of the managed pointer. AsRef<T>(nint) Reinterprets the given native integer as a reference. public static ref T AsRef<T>(nint source) Parameters source nint The native integer to reinterpret. Returns T A reference to a value of type T. Type Parameters T The type of the reference. AsRef<T>(nuint) Reinterprets the given native unsigned integer as a reference. public static ref T AsRef<T>(nuint source) Parameters source nuint The native unsigned integer to reinterpret. Returns T A reference to a value of type T. Type Parameters T The type of the reference. AsRef<T>(void*) Converts an unmanaged pointer into a managed pointer to a value of type T. public static ref T AsRef<T>(void* source) Parameters source void* The unmanaged pointer to convert. Returns T A managed pointer to a value of type T. Type Parameters T The elemental type of the managed pointer. AsRef<T>(scoped ref readonly T) Reinterprets the given read-only reference as a mutable reference. public static ref T AsRef<T>(scoped ref readonly T source) Parameters source T The read-only reference to reinterpret. Returns T A mutable reference to a value of type T. Type Parameters T The underlying type of the reference. AsRef<TFrom, TTo>(scoped ref readonly TFrom) Reinterprets the given read-only reference as a mutable reference. public static ref TTo AsRef<TFrom, TTo>(scoped ref readonly TFrom source) Parameters source TFrom The read-only reference to reinterpret. Returns TTo A mutable reference to a value of type T. Type Parameters TFrom TTo AsSpan<T>(ReadOnlySpan<T>) Reinterprets the read-only span as a writeable span. public static Span<T> AsSpan<T>(this ReadOnlySpan<T> span) Parameters span ReadOnlySpan<T> The read-only span to reinterpret. Returns Span<T> A writeable span that points to the same items as span. Type Parameters T The type of items in span. AsSpan<TFrom, TTo>(scoped ref TFrom) Reinterprets a regular managed object as a span of elements of another type. This can be useful if a managed object represents a \"fixed array\". public static Span<TTo> AsSpan<TFrom, TTo>(this scoped ref TFrom reference) where TFrom : unmanaged where TTo : unmanaged Parameters reference TFrom A reference to data. Returns Span<TTo> A span representing the specified reference as elements of type TTo. Type Parameters TFrom TTo Remarks This method should be used with caution. Even though the ref is annotated as scoped, it will be stored into the returned span, and the lifetime of the returned span will not be validated for safety, even by span-aware languages. AsSpan<TFrom, TTo>(scoped ref TFrom, int) Reinterprets a regular managed object as an array of elements of another type and returns a span over a portion of that array. This can be useful if a managed object represents a \"fixed array\". This is dangerous because the elementCount is not checked. public static Span<TTo> AsSpan<TFrom, TTo>(this scoped ref TFrom reference, int elementCount) where TFrom : unmanaged where TTo : unmanaged Parameters reference TFrom A reference to data. elementCount int The number of TTo elements the memory contains. Returns Span<TTo> A span representing the specified reference as elementCount elements of type TTo. Type Parameters TFrom TTo Remarks This method should be used with caution. It is dangerous because the elementCount argument is not checked. Even though the ref is annotated as scoped, it will be stored into the returned span, and the lifetime of the returned span will not be validated for safety, even by span-aware languages. AsSpan<TFrom, TTo>(TFrom[]?) Reinterprets a regular array as a span of elements of another type. This can be useful if the types are the same size and interchangeable. public static Span<TTo> AsSpan<TFrom, TTo>(this TFrom[]? array) where TFrom : unmanaged where TTo : unmanaged Parameters array TFrom[] An array of data. Returns Span<TTo> A span representing the data of array reinterpreted as elements of type TTo. If the array is null, returns an empty span. Type Parameters TFrom TTo As<T>(object?) Casts the given object to the specified type. public static T? As<T>(this object? o) where T : class? Parameters o object The object to cast. Returns T The original object, cast to the given type. Type Parameters T The type which the object will be cast to. As<TFrom, TTo>(ReadOnlySpan<TFrom>) Reinterprets the given managed pointer as a new managed pointer to a value of type TTo. public static ReadOnlySpan<TTo> As<TFrom, TTo>(this ReadOnlySpan<TFrom> span) where TFrom : unmanaged where TTo : unmanaged Parameters span ReadOnlySpan<TFrom> The span to reinterpret. Returns ReadOnlySpan<TTo> A managed pointer to a value of type TTo. Type Parameters TFrom The type of managed pointer to reinterpret. TTo The desired type of the managed pointer. As<TFrom, TTo>(Span<TFrom>) Reinterprets the given managed pointer as a new managed pointer to a value of type TTo. public static Span<TTo> As<TFrom, TTo>(this Span<TFrom> span) where TFrom : unmanaged where TTo : unmanaged Parameters span Span<TFrom> The span to reinterpret. Returns Span<TTo> A managed pointer to a value of type TTo. Type Parameters TFrom The type of managed pointer to reinterpret. TTo The desired type of the managed pointer. As<TFrom, TTo>(ref TFrom) Reinterprets the given managed pointer as a new managed pointer to a value of type TTo. public static ref TTo As<TFrom, TTo>(this ref TFrom source) where TFrom : unmanaged where TTo : unmanaged Parameters source TFrom The managed pointer to reinterpret. Returns TTo A managed pointer to a value of type TTo. Type Parameters TFrom The type of managed pointer to reinterpret. TTo The desired type of the managed pointer. BitCast<TFrom, TTo>(TFrom) Reinterprets the given value of type TFrom as a value of type TTo. public static TTo BitCast<TFrom, TTo>(this TFrom source) where TFrom : struct where TTo : struct Parameters source TFrom Returns TTo A value of type TTo. Type Parameters TFrom TTo Exceptions NotSupportedException The size of TFrom and TTo are not the same. Cast<TFrom, TTo>(ReadOnlySpan<TFrom>) Casts a read-only span of one primitive type to a read-only span of another primitive type. public static ReadOnlySpan<TTo> Cast<TFrom, TTo>(this ReadOnlySpan<TFrom> span) where TFrom : struct where TTo : struct Parameters span ReadOnlySpan<TFrom> The source slice to convert. Returns ReadOnlySpan<TTo> The converted read-only span. Type Parameters TFrom The type of the source span. TTo The type of the target span. Exceptions ArgumentException TFrom or TTo contains managed object references. OverflowException The Length property of the new ReadOnlySpan<T> would exceed MaxValue. Cast<TFrom, TTo>(Span<TFrom>) Casts a span of one primitive type to a span of another primitive type. public static Span<TTo> Cast<TFrom, TTo>(this Span<TFrom> span) where TFrom : struct where TTo : struct Parameters span Span<TFrom> The source slice to convert. Returns Span<TTo> The converted span. Type Parameters TFrom The type of the source span. TTo The type of the target span. Exceptions ArgumentException TFrom or TTo contains managed object references. OverflowException The Length property of the new ReadOnlySpan<T> would exceed MaxValue. CopyBlockUnaligned<TDestination, TSource>(ref TDestination, ref readonly TSource, uint) Copies bytes from the source address to the destination address without assuming architecture dependent alignment of the addresses. public static void CopyBlockUnaligned<TDestination, TSource>(ref TDestination destination, ref readonly TSource source, uint byteCount) Parameters destination TDestination The managed pointer corresponding to the destination address to copy to. source TSource The managed pointer corresponding to the source address to copy from. byteCount uint The number of bytes to copy. Type Parameters TDestination TSource CopyBlock<TDestination, TSource>(ref TDestination, ref readonly TSource, uint) Copies bytes from the source address to the destination address. public static void CopyBlock<TDestination, TSource>(ref TDestination destination, ref readonly TSource source, uint byteCount) Parameters destination TDestination The managed pointer corresponding to the destination address to copy to. source TSource The managed pointer corresponding to the source address to copy from. byteCount uint The number of bytes to copy. Type Parameters TDestination TSource CreateReadOnlySpan<T>(scoped ref readonly T, int) Creates a new read-only span over a portion of a regular managed object. public static ReadOnlySpan<T> CreateReadOnlySpan<T>(scoped ref readonly T reference, int length) Parameters reference T A reference to data. length int The number of T elements that reference contains. Returns ReadOnlySpan<T> A read-only span. Type Parameters T The type of the data items. CreateSpan<T>(scoped ref T, int) Creates a new span over a portion of a regular managed object. public static Span<T> CreateSpan<T>(scoped ref T reference, int length) Parameters reference T A reference to data. length int The number of T elements that reference contains. Returns Span<T> A span. Type Parameters T The type of the data items. GetPointer<T>(ReadOnlySpan<T>) Returns a pointer to the element of the span at index zero. public static T* GetPointer<T>(this ReadOnlySpan<T> span) where T : unmanaged Parameters span ReadOnlySpan<T> The span from which the pointer is retrieved. Returns T* A pointer to the item at index zero of span. Type Parameters T The type of items in span. GetPointer<T>(Span<T>) Returns a pointer to the element of the span at index zero. public static T* GetPointer<T>(this Span<T> span) where T : unmanaged Parameters span Span<T> The span from which the pointer is retrieved. Returns T* A pointer to the item at index zero of span. Type Parameters T The type of items in span. GetReference<T>(ReadOnlySpan<T>) Returns a reference to the element of the read-only span at index 0. public static ref readonly T GetReference<T>(this ReadOnlySpan<T> span) Parameters span ReadOnlySpan<T> The read-only span from which the reference is retrieved. Returns T A reference to the element at index 0. Type Parameters T The type of items in the span. GetReference<T>(ReadOnlySpan<T>, int) Returns a reference to the element of the read-only span at index 0. public static ref readonly T GetReference<T>(this ReadOnlySpan<T> span, int index) Parameters span ReadOnlySpan<T> The read-only span from which the reference is retrieved. index int The index of the element of span for which to take a reference. Returns T A reference to the element at index 0. Type Parameters T The type of items in the span. GetReference<T>(ReadOnlySpan<T>, nuint) Returns a reference to the element of the read-only span at index 0. public static ref readonly T GetReference<T>(this ReadOnlySpan<T> span, nuint index) Parameters span ReadOnlySpan<T> The read-only span from which the reference is retrieved. index nuint The index of the element of span for which to take a reference. Returns T A reference to the element at index 0. Type Parameters T The type of items in the span. GetReference<T>(Span<T>) Returns a reference to the element of the span at index 0. public static ref T GetReference<T>(this Span<T> span) Parameters span Span<T> The span from which the reference is retrieved. Returns T A reference to the element at index 0. Type Parameters T The type of items in the span. GetReference<T>(Span<T>, int) Returns a reference to the element of the span at index 0. public static ref T GetReference<T>(this Span<T> span, int index) Parameters span Span<T> The span from which the reference is retrieved. index int The index of the element of span for which to take a reference. Returns T A reference to the element at index 0. Type Parameters T The type of items in the span. GetReference<T>(Span<T>, nuint) Returns a reference to the element of the span at index 0. public static ref T GetReference<T>(this Span<T> span, nuint index) Parameters span Span<T> The span from which the reference is retrieved. index nuint The index of the element of span for which to take a reference. Returns T A reference to the element at index 0. Type Parameters T The type of items in the span. GetReference<T>(T[]) Returns a reference to the 0th element of array. If the array is empty, returns a reference to where the 0th element would have been stored. Such a reference may be used for pinning but must never be dereferenced. public static ref T GetReference<T>(this T[] array) Parameters array T[] The array to analyze. Returns T Reference to the 0th element in array. Type Parameters T The type of the array elements. Exceptions NullReferenceException array is null. GetReference<T>(T[], int) Returns a reference to the 0th element of array. If the array is empty, returns a reference to where the 0th element would have been stored. Such a reference may be used for pinning but must never be dereferenced. public static ref T GetReference<T>(this T[] array, int index) Parameters array T[] The array to analyze. index int The index of the element of array for which to take a reference. Returns T Reference to the 0th element in array. Type Parameters T The type of the array elements. Exceptions NullReferenceException array is null. GetReference<T>(T[], nuint) Returns a reference to the 0th element of array. If the array is empty, returns a reference to where the 0th element would have been stored. Such a reference may be used for pinning but must never be dereferenced. public static ref T GetReference<T>(this T[] array, nuint index) Parameters array T[] The array to analyze. index nuint The index of the element of array for which to take a reference. Returns T Reference to the 0th element in array. Type Parameters T The type of the array elements. Exceptions NullReferenceException array is null. IsNotNullRef<T>(ref readonly T) Determines if a given reference to a value of type T is not a null reference. public static bool IsNotNullRef<T>(ref readonly T source) Parameters source T The reference to check. Returns bool true if source is not a null reference; otherwise, false. Type Parameters T The type of the reference. IsNullRef<T>(ref readonly T) Determines if a given managed pointer to a value of type T is a null reference. public static bool IsNullRef<T>(ref readonly T source) Parameters source T The managed pointer to check. Returns bool true if source is a null reference; otherwise, false. Type Parameters T The elemental type of the managed pointer. NullRef<T>() Returns a null managed pointer to a value of type T. public static ref T NullRef<T>() Returns T A null managed pointer to a value of type T. Type Parameters T The elemental type of the managed pointer. ReadUnaligned<T>(void*) Reads a value of type T from the given location without assuming architecture dependent alignment of the source address. public static T ReadUnaligned<T>(void* source) where T : unmanaged Parameters source void* An unmanaged pointer containing the address to read from. Returns T A value of type T read from the given location. Type Parameters T The type of the value to read. ReadUnaligned<T>(void*, nuint) Reads a value of type T from the given location without assuming architecture dependent alignment of the source address. public static T ReadUnaligned<T>(void* source, nuint offset) where T : unmanaged Parameters source void* An unmanaged pointer containing the address to read from. offset nuint The offset in bytes from the location pointed to by source. Returns T A value of type T read from the given location. Type Parameters T The type of the value to read. SizeOf<T>() Returns the size of a value of the given type parameter. public static uint SizeOf<T>() Returns uint The size, in bytes, of a value of type T. Type Parameters T The type whose size is to be retrieved. WriteUnaligned<T>(void*, nuint, T) Writes a value of type T to the given location without assuming architecture dependent alignment of the destination address. public static void WriteUnaligned<T>(void* destination, nuint offset, T value) where T : unmanaged Parameters destination void* A managed pointer containing the address to write to. offset nuint The offset in bytes from the location pointed to by destination. value T The value to write. Type Parameters T The type of the value to write. WriteUnaligned<T>(void*, T) Writes a value of type T to the given location without assuming architecture dependent alignment of the destination address. public static void WriteUnaligned<T>(void* destination, T value) where T : unmanaged Parameters destination void* A managed pointer containing the address to write to. value T The value to write. Type Parameters T The type of the value to write."
  },
  "api/Stride.Core.UnsafeExtensions.html": {
    "href": "api/Stride.Core.UnsafeExtensions.html",
    "title": "Namespace Stride.Core.UnsafeExtensions | Stride API",
    "summary": "Namespace Stride.Core.UnsafeExtensions Classes StringMarshal Provides a set of methods to supplement or replace Marshal when operating on strings and spans of characters. UnsafeUtilities Provides a set of methods to supplement or replace Unsafe and MemoryMarshal, mainly for working with structs and unmanaged types."
  },
  "api/Stride.Core.Utilities.html": {
    "href": "api/Stride.Core.Utilities.html",
    "title": "Class Utilities | Stride API",
    "summary": "Class Utilities Namespace Stride.Core Assembly Stride.Core.dll Provides a set of static utility methods for collection operations, and general-purpose helpers. public static class Utilities Inheritance object Utilities Methods Compare<TKey, TValue>(SortedList<TKey, TValue>, SortedList<TKey, TValue>) Compares two collection, element by elements. public static bool Compare<TKey, TValue>(SortedList<TKey, TValue> first, SortedList<TKey, TValue> second) Parameters first SortedList<TKey, TValue> The collection to compare from. second SortedList<TKey, TValue> The colllection to compare to. Returns bool True if lists are identical (but not necessarily in the same order). False otherwise. Type Parameters TKey TValue Remarks Concrete SortedList is favored over interface to avoid enumerator object allocation. Compare<TKey, TValue>(IDictionary<TKey, TValue>, IDictionary<TKey, TValue>) Compares two collection, element by elements. public static bool Compare<TKey, TValue>(IDictionary<TKey, TValue> first, IDictionary<TKey, TValue> second) Parameters first IDictionary<TKey, TValue> The collection to compare from. second IDictionary<TKey, TValue> The colllection to compare to. Returns bool True if lists are identical (but no necessarely of the same time). False otherwise. Type Parameters TKey TValue ConvertRawToTimestamp(long) Converts a Stopwatch raw time to a TimeSpan. public static TimeSpan ConvertRawToTimestamp(long delta) Parameters delta long The delta. Returns TimeSpan The TimeSpan. Dispose<T>(ref T?) Disposes an IDisposable object if not null, and sets it to null. public static void Dispose<T>(ref T? disposable) where T : class, IDisposable Parameters disposable T The disposable object to dispose. Type Parameters T GetHashCode(IDictionary) Computes a hashcode for a dictionary. public static int GetHashCode(IDictionary dict) Parameters dict IDictionary Returns int Hashcode for the list. GetHashCode(IEnumerable) Computes a hashcode for an enumeration public static int GetHashCode(IEnumerable it) Parameters it IEnumerable An enumerator. Returns int Hashcode for the list. GetHashCode(IEnumerator) Computes a hashcode for an enumeration public static int GetHashCode(IEnumerator it) Parameters it IEnumerator An enumerator. Returns int Hashcode for the list. IterateTree<T>(T, Func<T, IEnumerable<T>>) Linq assisted full tree iteration and collection in a single line. Warning, could be slow. public static IEnumerable<T> IterateTree<T>(T root, Func<T, IEnumerable<T>> childrenF) Parameters root T The root item childrenF Func<T, IEnumerable<T>> The function to retrieve a child Returns IEnumerable<T> Type Parameters T The type to iterate. ReadStream(Stream) Read stream to a byte[] buffer [Obsolete(\"Allocates. Read into the destination.\")] public static byte[] ReadStream(Stream stream) Parameters stream Stream input stream Returns byte[] a byte[] buffer"
  },
  "api/Stride.Core.ValidateValueCallback-1.html": {
    "href": "api/Stride.Core.ValidateValueCallback-1.html",
    "title": "Delegate ValidateValueCallback<T> | Stride API",
    "summary": "Delegate ValidateValueCallback<T> Namespace Stride.Core Assembly Stride.Core.dll Delegate ValidateValueCallback used by ValidateValueMetadata. public delegate void ValidateValueCallback<T>(ref T? value) Parameters value T The value to validate and coerce. Type Parameters T Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.ValidateValueMetadata-1.html": {
    "href": "api/Stride.Core.ValidateValueMetadata-1.html",
    "title": "Class ValidateValueMetadata<T> | Stride API",
    "summary": "Class ValidateValueMetadata<T> Namespace Stride.Core Assembly Stride.Core.dll A metadata to allow validation/coercision of a value before storing the value into the PropertyContainer. public class ValidateValueMetadata<T> : ValidateValueMetadata Type Parameters T Inheritance object PropertyKeyMetadata ValidateValueMetadata ValidateValueMetadata<T> Inherited Members ValidateValueMetadata.New<T>(ValidateValueCallback<T>) Extension Methods UnsafeUtilities.As<T>(object?) Constructors ValidateValueMetadata(ValidateValueCallback<T>) Initializes a new instance of the ValidateValueMetadata<T> class. public ValidateValueMetadata(ValidateValueCallback<T> validateValueCallback) Parameters validateValueCallback ValidateValueCallback<T> The validate value callback. Exceptions ArgumentNullException validateValueCallback Properties ValidateValueCallback Gets the validate value callback. public ValidateValueCallback<T> ValidateValueCallback { get; } Property Value ValidateValueCallback<T> The validate value callback. Methods Validate(ref object?) public override void Validate(ref object? obj) Parameters obj object"
  },
  "api/Stride.Core.ValidateValueMetadata.html": {
    "href": "api/Stride.Core.ValidateValueMetadata.html",
    "title": "Class ValidateValueMetadata | Stride API",
    "summary": "Class ValidateValueMetadata Namespace Stride.Core Assembly Stride.Core.dll public abstract class ValidateValueMetadata : PropertyKeyMetadata Inheritance object PropertyKeyMetadata ValidateValueMetadata Derived ValidateValueMetadata<T> Extension Methods UnsafeUtilities.As<T>(object?) Methods New<T>(ValidateValueCallback<T>) public static ValidateValueMetadata<T> New<T>(ValidateValueCallback<T> invalidationCallback) Parameters invalidationCallback ValidateValueCallback<T> Returns ValidateValueMetadata<T> Type Parameters T Validate(ref object?) public abstract void Validate(ref object? obj) Parameters obj object"
  },
  "api/Stride.Core.Yaml.AssetObjectSerializerBackend.html": {
    "href": "api/Stride.Core.Yaml.AssetObjectSerializerBackend.html",
    "title": "Class AssetObjectSerializerBackend | Stride API",
    "summary": "Class AssetObjectSerializerBackend Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll Internal class used when serializing/deserializing an object. public class AssetObjectSerializerBackend : DefaultObjectSerializerBackend, IObjectSerializerBackend Inheritance object DefaultObjectSerializerBackend AssetObjectSerializerBackend Implements IObjectSerializerBackend Inherited Members DefaultObjectSerializerBackend.GetStyle(ref ObjectContext) DefaultObjectSerializerBackend.ReadYaml(ref ObjectContext) DefaultObjectSerializerBackend.WriteYaml(ref ObjectContext) Extension Methods UnsafeUtilities.As<T>(object?) Constructors AssetObjectSerializerBackend(ITypeDescriptorFactory) public AssetObjectSerializerBackend(ITypeDescriptorFactory typeDescriptorFactory) Parameters typeDescriptorFactory ITypeDescriptorFactory Fields ObjectReferencesKey public static readonly PropertyKey<YamlAssetMetadata<Guid>> ObjectReferencesKey Field Value PropertyKey<YamlAssetMetadata<Guid>> OverrideDictionaryKey public static readonly PropertyKey<YamlAssetMetadata<OverrideType>> OverrideDictionaryKey Field Value PropertyKey<YamlAssetMetadata<OverrideType>> Methods GetCurrentPath(ref ObjectContext, bool) public static YamlAssetPath GetCurrentPath(ref ObjectContext objectContext, bool clone) Parameters objectContext ObjectContext clone bool Returns YamlAssetPath ReadCollectionItem(ref ObjectContext, object, Type, int) Reads the collection item from the current YAML stream. public override object ReadCollectionItem(ref ObjectContext objectContext, object value, Type itemType, int index) Parameters objectContext ObjectContext The object context. value object The value. itemType Type Type of the item. index int Returns object The collection item read from YAML stream. ReadDictionaryKey(ref ObjectContext, Type) Reads the key of the dictionary item from the current YAML stream. public override object ReadDictionaryKey(ref ObjectContext objectContext, Type keyType) Parameters objectContext ObjectContext The object context. keyType Type Type of the key. Returns object The key of the dictionary item read from YAML stream. ReadDictionaryValue(ref ObjectContext, Type, object) Reads the value of the dictionary item from the current YAML stream. public override object ReadDictionaryValue(ref ObjectContext objectContext, Type valueType, object key) Parameters objectContext ObjectContext The object context. valueType Type Type of the value. key object The key corresponding to the value. Returns object The value of the dictionary item read from YAML stream. ReadMemberName(ref ObjectContext, string, out bool) Allows to transform the name of the member while reading for the specified object context. public override string ReadMemberName(ref ObjectContext objectContext, string memberName, out bool skipMember) Parameters objectContext ObjectContext The object context to which the member name. memberName string Name of the member read from the current yaml stream. skipMember bool Returns string The name that will be used to get the Stride.Core.Reflection.IMemberDescriptor from the current object context. ReadMemberValue(ref ObjectContext, IMemberDescriptor, object, Type) Reads the value for the specified member from the current YAML stream. public override object ReadMemberValue(ref ObjectContext objectContext, IMemberDescriptor memberDescriptor, object memberValue, Type memberType) Parameters objectContext ObjectContext The object context. memberDescriptor IMemberDescriptor memberValue object The member value. See remarks memberType Type Type of the member. Returns object The value read from YAML stream. Remarks TODO: Explain memberValue when can be not null ShouldSerialize(IMemberDescriptor, ref ObjectContext) Indicates if the given member should be serialized. public override bool ShouldSerialize(IMemberDescriptor member, ref ObjectContext objectContext) Parameters member IMemberDescriptor The member to evaluate. objectContext ObjectContext The object context. Returns bool True if the member should be serialized, False otherwise. WriteCollectionItem(ref ObjectContext, object, Type, int) Writes the collection item. public override void WriteCollectionItem(ref ObjectContext objectContext, object item, Type itemType, int index) Parameters objectContext ObjectContext The object context. item object The item. itemType Type Type of the item. index int WriteDictionaryKey(ref ObjectContext, object, Type) Writes the key of the dictionary item. public override void WriteDictionaryKey(ref ObjectContext objectContext, object key, Type keyType) Parameters objectContext ObjectContext The object context. key object The key of the dictionary item. keyType Type Type of the key. WriteDictionaryValue(ref ObjectContext, object, object, Type) Writes the value of the dictionary item. public override void WriteDictionaryValue(ref ObjectContext objectContext, object key, object value, Type valueType) Parameters objectContext ObjectContext The object context. key object value object The value of the dictionary item. valueType Type Type of the value. WriteMemberName(ref ObjectContext, IMemberDescriptor, string) Writes the name of the member. public override void WriteMemberName(ref ObjectContext objectContext, IMemberDescriptor member, string memberName) Parameters objectContext ObjectContext The object context. member IMemberDescriptor The member. memberName string Name of the member. WriteMemberValue(ref ObjectContext, IMemberDescriptor, object, Type) Writes the member value. public override void WriteMemberValue(ref ObjectContext objectContext, IMemberDescriptor memberDescriptor, object memberValue, Type memberType) Parameters objectContext ObjectContext The object context. memberDescriptor IMemberDescriptor memberValue object The member value. memberType Type Type of the member."
  },
  "api/Stride.Core.Yaml.AssetYamlSerializer.html": {
    "href": "api/Stride.Core.Yaml.AssetYamlSerializer.html",
    "title": "Class AssetYamlSerializer | Stride API",
    "summary": "Class AssetYamlSerializer Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll Default Yaml serializer used to serialize assets by default. public class AssetYamlSerializer : YamlSerializerBase, IDisposable Inheritance object YamlSerializerBase AssetYamlSerializer Implements IDisposable Inherited Members YamlSerializerBase.RegisteredAssemblies YamlSerializerBase.Lock YamlSerializerBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties Default public static AssetYamlSerializer Default { get; set; } Property Value AssetYamlSerializer Methods Deserialize(EventReader, object, Type, out PropertyContainer, SerializerContextSettings?) Deserializes an object from the specified stream (expecting a YAML string). public object Deserialize(EventReader eventReader, object value, Type expectedType, out PropertyContainer contextProperties, SerializerContextSettings? contextSettings = null) Parameters eventReader EventReader A YAML event reader. value object The value. expectedType Type The expected type. contextProperties PropertyContainer A dictionary or properties that were generated during deserialization. contextSettings SerializerContextSettings The context settings. Returns object An instance of the YAML data. Deserialize(Stream, Type?, SerializerContextSettings?) Deserializes an object from the specified stream (expecting a YAML string). public object Deserialize(Stream stream, Type? expectedType = null, SerializerContextSettings? contextSettings = null) Parameters stream Stream A YAML string from a stream. expectedType Type The expected type. contextSettings SerializerContextSettings The context settings. Returns object An instance of the YAML data. Deserialize(Stream, Type?, SerializerContextSettings?, out bool, out PropertyContainer) Deserializes an object from the specified stream (expecting a YAML string). public object Deserialize(Stream stream, Type? expectedType, SerializerContextSettings? contextSettings, out bool aliasOccurred, out PropertyContainer contextProperties) Parameters stream Stream A YAML string from a stream . expectedType Type The expected type. contextSettings SerializerContextSettings The context settings. aliasOccurred bool if set to true a class/field/property/enum name has been renamed during deserialization. contextProperties PropertyContainer A dictionary or properties that were generated during deserialization. Returns object An instance of the YAML data. DeserializeMultiple<T>(Stream) Deserializes an object from the specified stream (expecting a YAML string). public IEnumerable<T> DeserializeMultiple<T>(Stream stream) Parameters stream Stream A YAML string from a stream . Returns IEnumerable<T> An instance of the YAML data. Type Parameters T GetSerializerSettings() Gets the serializer settings. public SerializerSettings GetSerializerSettings() Returns SerializerSettings SerializerSettings. ResetCache() Reset the assembly cache used by this class. public override void ResetCache() Serialize(IEmitter, object, Type, SerializerContextSettings?) Serializes an object to specified stream in YAML format. public void Serialize(IEmitter emitter, object instance, Type type, SerializerContextSettings? contextSettings = null) Parameters emitter IEmitter The emitter. instance object The object to serialize. type Type The type. contextSettings SerializerContextSettings The context settings. Serialize(Stream, object, Type?, SerializerContextSettings?) Serializes an object to specified stream in YAML format. public void Serialize(Stream stream, object instance, Type? type = null, SerializerContextSettings? contextSettings = null) Parameters stream Stream The stream to receive the YAML representation of the object. instance object The instance. type Type The expected type. contextSettings SerializerContextSettings The context settings. Events PrepareMembers public event Action<ObjectDescriptor, List<IMemberDescriptor>> PrepareMembers Event Type Action<ObjectDescriptor, List<IMemberDescriptor>>"
  },
  "api/Stride.Core.Yaml.CollectionWithIdsSerializer.html": {
    "href": "api/Stride.Core.Yaml.CollectionWithIdsSerializer.html",
    "title": "Class CollectionWithIdsSerializer | Stride API",
    "summary": "Class CollectionWithIdsSerializer Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll An implementation of CollectionWithIdsSerializerBase for actual collections. [YamlSerializerFactory(new string[] { \"Assets\" })] public class CollectionWithIdsSerializer : CollectionWithIdsSerializerBase, IYamlSerializable, IYamlSerializableFactory Inheritance object ObjectSerializer DictionarySerializer CollectionWithIdsSerializerBase CollectionWithIdsSerializer Implements IYamlSerializable IYamlSerializableFactory Inherited Members CollectionWithIdsSerializerBase.YamlDeletedKey CollectionWithIdsSerializerBase.NonIdentifiableCollectionItemsKey CollectionWithIdsSerializerBase.InstanceInfoKey CollectionWithIdsSerializerBase.DeletedItemsKey CollectionWithIdsSerializerBase.ReadYaml(ref ObjectContext) CollectionWithIdsSerializerBase.WriteYaml(ref ObjectContext) CollectionWithIdsSerializerBase.CreateOrTransformObject(ref ObjectContext) CollectionWithIdsSerializerBase.ReadDictionaryItems(ref ObjectContext) CollectionWithIdsSerializerBase.WriteDictionaryItems(ref ObjectContext) CollectionWithIdsSerializerBase.ReadDictionaryItem(ref ObjectContext, KeyValuePair<Type, Type>) CollectionWithIdsSerializerBase.CheckIsSequence(ref ObjectContext) CollectionWithIdsSerializerBase.AreCollectionItemsIdentifiable(ref ObjectContext) DictionarySerializer.ReadMember(ref ObjectContext) DictionarySerializer.WriteMembers(ref ObjectContext) DictionarySerializer.WriteDictionaryItem(ref ObjectContext, KeyValuePair<object, object>, KeyValuePair<Type, Type>) ObjectSerializer.GetStyle(ref ObjectContext) ObjectSerializer.ReadMembers<TStart, TEnd>(ref ObjectContext) ObjectSerializer.TryReadMember(ref ObjectContext, out string) ObjectSerializer.TryReadMember(ref ObjectContext, out Scalar, out string) ObjectSerializer.ReadMemberName(ref ObjectContext, string, out bool) ObjectSerializer.ReadMemberValue(ref ObjectContext, IMemberDescriptor, object, Type) ObjectSerializer.WriteMember(ref ObjectContext, IMemberDescriptor) ObjectSerializer.WriteMemberName(ref ObjectContext, IMemberDescriptor, string) ObjectSerializer.WriteMemberValue(ref ObjectContext, IMemberDescriptor, object, Type) Extension Methods UnsafeUtilities.As<T>(object?) Methods CreatEmptyContainer(ITypeDescriptor) Creates an empty dictionary that can store the mapping of ids to items of the collection. protected override IDictionary CreatEmptyContainer(ITypeDescriptor descriptor) Parameters descriptor ITypeDescriptor The type descriptor of the collection for which to create the dictionary. Returns IDictionary An empty dictionary for mapping ids to elements. GetCollectionSerializerForNonTransformedObject() protected virtual CollectionSerializer GetCollectionSerializerForNonTransformedObject() Returns CollectionSerializer ReadDeletedDictionaryItem(ref ObjectContext, object) protected override KeyValuePair<object, object> ReadDeletedDictionaryItem(ref ObjectContext objectContext, object keyResult) Parameters objectContext ObjectContext keyResult object Returns KeyValuePair<object, object> ReadYamlAfterTransform(ref ObjectContext, bool) protected override void ReadYamlAfterTransform(ref ObjectContext objectContext, bool transformed) Parameters objectContext ObjectContext transformed bool TransformAfterDeserialization(IDictionary, ITypeDescriptor, object, ICollection<ItemId>?) Transforms a dictionary containing the mapping of ids to items into the actual collection, and store the ids in the Stride.Core.Reflection.ShadowObject. protected override void TransformAfterDeserialization(IDictionary container, ITypeDescriptor targetDescriptor, object targetCollection, ICollection<ItemId>? deletedItems = null) Parameters container IDictionary The dictionary mapping ids to item. targetDescriptor ITypeDescriptor The type descriptor of the actual collection to fill. targetCollection object The instance of the actual collection to fill. deletedItems ICollection<ItemId> A collection of items that are marked as deleted. Can be null. TransformForSerialization(ITypeDescriptor, object) Transforms the given collection or dictionary into a dictionary of (ids, items) or a dictionary of (ids & keys, items). protected override object TransformForSerialization(ITypeDescriptor descriptor, object collection) Parameters descriptor ITypeDescriptor The type descriptor of the collection. collection object The collection for which to create the mapping dictionary. Returns object A dictionary mapping the id to the element of the initial collection. TransformObjectAfterRead(ref ObjectContext) Transforms the object after it has been read. This method is called after an object has been read and before returning the object to the deserialization process. See remarks for usage. protected override void TransformObjectAfterRead(ref ObjectContext objectContext) Parameters objectContext ObjectContext Remarks This method is usefull in conjunction with Stride.Core.Yaml.Serialization.Serializers.ObjectSerializer.CreateOrTransformObject(ref Stride.Core.Yaml.Serialization.ObjectContext). For example, in the case of deserializing to an immutable member, where we need to call the constructor of a type instead of setting each of its member, we can instantiate a mutable object in Stride.Core.Yaml.Serialization.Serializers.ObjectSerializer.CreateOrTransformObject(ref Stride.Core.Yaml.Serialization.ObjectContext), receive the mutable object filled in Stride.Core.Yaml.Serialization.Serializers.ObjectSerializer.TransformObjectAfterRead(ref Stride.Core.Yaml.Serialization.ObjectContext) and transform it back to an immutable object. TryCreate(SerializerContext, ITypeDescriptor) Try to create a Stride.Core.Yaml.Serialization.IYamlSerializable or return null if not supported for a particular .NET typeDescriptor. public override IYamlSerializable? TryCreate(SerializerContext context, ITypeDescriptor typeDescriptor) Parameters context SerializerContext typeDescriptor ITypeDescriptor The typeDescriptor. Returns IYamlSerializable If supported, return an instance of Stride.Core.Yaml.Serialization.IYamlSerializable else return null. WriteDeletedItems(ref ObjectContext) protected override void WriteDeletedItems(ref ObjectContext objectContext) Parameters objectContext ObjectContext WriteYamlAfterTransform(ref ObjectContext, bool) protected override void WriteYamlAfterTransform(ref ObjectContext objectContext, bool transformed) Parameters objectContext ObjectContext transformed bool"
  },
  "api/Stride.Core.Yaml.CollectionWithIdsSerializerBase.InstanceInfo.html": {
    "href": "api/Stride.Core.Yaml.CollectionWithIdsSerializerBase.InstanceInfo.html",
    "title": "Class CollectionWithIdsSerializerBase.InstanceInfo | Stride API",
    "summary": "Class CollectionWithIdsSerializerBase.InstanceInfo Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll A structure containing the information about the instance that we need the store in the Stride.Core.Yaml.Serialization.ObjectContext.Properties dictionary. protected class CollectionWithIdsSerializerBase.InstanceInfo Inheritance object CollectionWithIdsSerializerBase.InstanceInfo Extension Methods UnsafeUtilities.As<T>(object?) Constructors InstanceInfo(object, ITypeDescriptor) public InstanceInfo(object instance, ITypeDescriptor typeDescriptor) Parameters instance object typeDescriptor ITypeDescriptor Fields Descriptor public readonly ITypeDescriptor Descriptor Field Value ITypeDescriptor Instance public readonly object Instance Field Value object"
  },
  "api/Stride.Core.Yaml.CollectionWithIdsSerializerBase.html": {
    "href": "api/Stride.Core.Yaml.CollectionWithIdsSerializerBase.html",
    "title": "Class CollectionWithIdsSerializerBase | Stride API",
    "summary": "Class CollectionWithIdsSerializerBase Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll A base class to serialize collections with unique identifiers for each item. [YamlSerializerFactory(new string[] { \"Assets\" })] public abstract class CollectionWithIdsSerializerBase : DictionarySerializer, IYamlSerializable, IYamlSerializableFactory Inheritance object ObjectSerializer DictionarySerializer CollectionWithIdsSerializerBase Implements IYamlSerializable IYamlSerializableFactory Derived CollectionWithIdsSerializer DictionaryWithIdsSerializer Inherited Members DictionarySerializer.TryCreate(SerializerContext, ITypeDescriptor) DictionarySerializer.ReadMember(ref ObjectContext) DictionarySerializer.WriteMembers(ref ObjectContext) DictionarySerializer.WriteDictionaryItem(ref ObjectContext, KeyValuePair<object, object>, KeyValuePair<Type, Type>) ObjectSerializer.GetStyle(ref ObjectContext) ObjectSerializer.TransformObjectAfterRead(ref ObjectContext) ObjectSerializer.ReadMembers<TStart, TEnd>(ref ObjectContext) ObjectSerializer.TryReadMember(ref ObjectContext, out string) ObjectSerializer.TryReadMember(ref ObjectContext, out Scalar, out string) ObjectSerializer.ReadMemberName(ref ObjectContext, string, out bool) ObjectSerializer.ReadMemberValue(ref ObjectContext, IMemberDescriptor, object, Type) ObjectSerializer.WriteMember(ref ObjectContext, IMemberDescriptor) ObjectSerializer.WriteMemberName(ref ObjectContext, IMemberDescriptor, string) ObjectSerializer.WriteMemberValue(ref ObjectContext, IMemberDescriptor, object, Type) Extension Methods UnsafeUtilities.As<T>(object?) Fields DeletedItemsKey A key that identifies deleted items during deserialization. protected static readonly PropertyKey<ICollection<ItemId>> DeletedItemsKey Field Value PropertyKey<ICollection<ItemId>> InstanceInfoKey A key that identifies the information about the instance that we need the store in the Stride.Core.Yaml.Serialization.ObjectContext.Properties dictionary. protected static readonly PropertyKey<CollectionWithIdsSerializerBase.InstanceInfo> InstanceInfoKey Field Value PropertyKey<CollectionWithIdsSerializerBase.InstanceInfo> NonIdentifiableCollectionItemsKey A property key to indicate whether a collection has non-identifiable items public static readonly PropertyKey<bool> NonIdentifiableCollectionItemsKey Field Value PropertyKey<bool> YamlDeletedKey A string token to identify deleted items in a collection. public const string YamlDeletedKey = \"~(Deleted)\" Field Value string Methods AreCollectionItemsIdentifiable(ref ObjectContext) protected static bool AreCollectionItemsIdentifiable(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns bool CheckIsSequence(ref ObjectContext) Checks if a type is a sequence. protected override bool CheckIsSequence(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns bool true if a type is a sequence, false otherwise. CreatEmptyContainer(ITypeDescriptor) Creates an empty dictionary that can store the mapping of ids to items of the collection. protected abstract IDictionary CreatEmptyContainer(ITypeDescriptor descriptor) Parameters descriptor ITypeDescriptor The type descriptor of the collection for which to create the dictionary. Returns IDictionary An empty dictionary for mapping ids to elements. CreateOrTransformObject(ref ObjectContext) Overrides this method when deserializing/serializing an object that needs a special instantiation or transformation. By default, this is calling Create(Type) if the Stride.Core.Yaml.Serialization.ObjectContext.Instance is null or returning Stride.Core.Yaml.Serialization.ObjectContext.Instance. protected override void CreateOrTransformObject(ref ObjectContext objectContext) Parameters objectContext ObjectContext The object context. ReadDeletedDictionaryItem(ref ObjectContext, object) protected abstract KeyValuePair<object, object> ReadDeletedDictionaryItem(ref ObjectContext objectContext, object keyResult) Parameters objectContext ObjectContext keyResult object Returns KeyValuePair<object, object> ReadDictionaryItem(ref ObjectContext, KeyValuePair<Type, Type>) Reads a dictionary item key-value. protected override KeyValuePair<object, object> ReadDictionaryItem(ref ObjectContext objectContext, KeyValuePair<Type, Type> keyValueTypes) Parameters objectContext ObjectContext The object context. keyValueTypes KeyValuePair<Type, Type> The types corresponding to the key and the value. Returns KeyValuePair<object, object> A KeyValuePair<TKey, TValue> representing the dictionary item. ReadDictionaryItems(ref ObjectContext) Reads the dictionary items key-values. protected override void ReadDictionaryItems(ref ObjectContext objectContext) Parameters objectContext ObjectContext ReadYaml(ref ObjectContext) Reads this object's state from a YAML parser. public override object ReadYaml(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns object A instance of the object deserialized from Yaml. ReadYamlAfterTransform(ref ObjectContext, bool) protected virtual void ReadYamlAfterTransform(ref ObjectContext objectContext, bool transformed) Parameters objectContext ObjectContext transformed bool TransformAfterDeserialization(IDictionary, ITypeDescriptor, object, ICollection<ItemId>?) Transforms a dictionary containing the mapping of ids to items into the actual collection, and store the ids in the Stride.Core.Reflection.ShadowObject. protected abstract void TransformAfterDeserialization(IDictionary container, ITypeDescriptor targetDescriptor, object targetCollection, ICollection<ItemId>? deletedItems = null) Parameters container IDictionary The dictionary mapping ids to item. targetDescriptor ITypeDescriptor The type descriptor of the actual collection to fill. targetCollection object The instance of the actual collection to fill. deletedItems ICollection<ItemId> A collection of items that are marked as deleted. Can be null. TransformForSerialization(ITypeDescriptor, object) Transforms the given collection or dictionary into a dictionary of (ids, items) or a dictionary of (ids & keys, items). protected abstract object TransformForSerialization(ITypeDescriptor descriptor, object collection) Parameters descriptor ITypeDescriptor The type descriptor of the collection. collection object The collection for which to create the mapping dictionary. Returns object A dictionary mapping the id to the element of the initial collection. WriteDeletedItems(ref ObjectContext) protected abstract void WriteDeletedItems(ref ObjectContext objectContext) Parameters objectContext ObjectContext WriteDictionaryItems(ref ObjectContext) Writes the dictionary items keys-values. protected override void WriteDictionaryItems(ref ObjectContext objectContext) Parameters objectContext ObjectContext The object context. WriteYaml(ref ObjectContext) Writes the specified object context to a YAML emitter. public override void WriteYaml(ref ObjectContext objectContext) Parameters objectContext ObjectContext The object context. WriteYamlAfterTransform(ref ObjectContext, bool) protected virtual void WriteYamlAfterTransform(ref ObjectContext objectContext, bool transformed) Parameters objectContext ObjectContext transformed bool"
  },
  "api/Stride.Core.Yaml.CollectionWithItemIds-1.html": {
    "href": "api/Stride.Core.Yaml.CollectionWithItemIds-1.html",
    "title": "Class CollectionWithItemIds<TItem> | Stride API",
    "summary": "Class CollectionWithItemIds<TItem> Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll A container used to serialize collection whose items have identifiers. [DataContract] public class CollectionWithItemIds<TItem> : OrderedDictionary<ItemId, TItem>, IOrderedDictionary<ItemId, TItem>, IDictionary<ItemId, TItem>, IList<KeyValuePair<ItemId, TItem>>, ICollection<KeyValuePair<ItemId, TItem>>, IEnumerable<KeyValuePair<ItemId, TItem>>, IDictionary, ICollection, IEnumerable Type Parameters TItem The type of item contained in the collection. Inheritance object OrderedDictionary<ItemId, TItem> CollectionWithItemIds<TItem> Implements IOrderedDictionary<ItemId, TItem> IDictionary<ItemId, TItem> IList<KeyValuePair<ItemId, TItem>> ICollection<KeyValuePair<ItemId, TItem>> IEnumerable<KeyValuePair<ItemId, TItem>> IDictionary ICollection IEnumerable Inherited Members OrderedDictionary<ItemId, TItem>.Count OrderedDictionary<ItemId, TItem>.IsReadOnly OrderedDictionary<ItemId, TItem>.GetEnumerator() OrderedDictionary<ItemId, TItem>.Add(KeyValuePair<ItemId, TItem>) OrderedDictionary<ItemId, TItem>.Clear() OrderedDictionary<ItemId, TItem>.Contains(KeyValuePair<ItemId, TItem>) OrderedDictionary<ItemId, TItem>.CopyTo(KeyValuePair<ItemId, TItem>[], int) OrderedDictionary<ItemId, TItem>.Remove(KeyValuePair<ItemId, TItem>) OrderedDictionary<ItemId, TItem>.Add(ItemId, TItem) OrderedDictionary<ItemId, TItem>.ContainsKey(ItemId) OrderedDictionary<ItemId, TItem>.Remove(ItemId) OrderedDictionary<ItemId, TItem>.TryGetValue(ItemId, out TItem) OrderedDictionary<ItemId, TItem>.Insert(int, ItemId, TItem) OrderedDictionary<ItemId, TItem>.RemoveAt(int) OrderedDictionary<ItemId, TItem>.IndexOf(KeyValuePair<ItemId, TItem>) OrderedDictionary<ItemId, TItem>.Insert(int, KeyValuePair<ItemId, TItem>) OrderedDictionary<ItemId, TItem>.IndexOf(ItemId) OrderedDictionary<ItemId, TItem>.this[int] OrderedDictionary<ItemId, TItem>.this[ItemId] OrderedDictionary<ItemId, TItem>.Keys OrderedDictionary<ItemId, TItem>.Values Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Yaml.DeletedKeyWithId-1.html": {
    "href": "api/Stride.Core.Yaml.DeletedKeyWithId-1.html",
    "title": "Struct DeletedKeyWithId<TKey> | Stride API",
    "summary": "Struct DeletedKeyWithId<TKey> Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll A generic structure that implements the IKeyWithId interface for keys that are deleted. public readonly struct DeletedKeyWithId<TKey> : IKeyWithId Type Parameters TKey The type of the key. Implements IKeyWithId Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors DeletedKeyWithId(ItemId) Initializes a new instance of the KeyWithId<TKey> structure. public DeletedKeyWithId(ItemId id) Parameters id ItemId The ItemId associated to the deleted key. Fields Id The ItemId associated to the key. public readonly ItemId Id Field Value ItemId"
  },
  "api/Stride.Core.Yaml.DictionaryWithIdsSerializer.html": {
    "href": "api/Stride.Core.Yaml.DictionaryWithIdsSerializer.html",
    "title": "Class DictionaryWithIdsSerializer | Stride API",
    "summary": "Class DictionaryWithIdsSerializer Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll An implementation of CollectionWithIdsSerializerBase for dictionaries. [YamlSerializerFactory(new string[] { \"Assets\" })] public class DictionaryWithIdsSerializer : CollectionWithIdsSerializerBase, IYamlSerializable, IYamlSerializableFactory Inheritance object ObjectSerializer DictionarySerializer CollectionWithIdsSerializerBase DictionaryWithIdsSerializer Implements IYamlSerializable IYamlSerializableFactory Inherited Members CollectionWithIdsSerializerBase.YamlDeletedKey CollectionWithIdsSerializerBase.NonIdentifiableCollectionItemsKey CollectionWithIdsSerializerBase.InstanceInfoKey CollectionWithIdsSerializerBase.DeletedItemsKey CollectionWithIdsSerializerBase.ReadYaml(ref ObjectContext) CollectionWithIdsSerializerBase.WriteYaml(ref ObjectContext) CollectionWithIdsSerializerBase.CreateOrTransformObject(ref ObjectContext) CollectionWithIdsSerializerBase.ReadDictionaryItems(ref ObjectContext) CollectionWithIdsSerializerBase.WriteDictionaryItems(ref ObjectContext) CollectionWithIdsSerializerBase.ReadDictionaryItem(ref ObjectContext, KeyValuePair<Type, Type>) CollectionWithIdsSerializerBase.CheckIsSequence(ref ObjectContext) CollectionWithIdsSerializerBase.ReadYamlAfterTransform(ref ObjectContext, bool) CollectionWithIdsSerializerBase.WriteYamlAfterTransform(ref ObjectContext, bool) CollectionWithIdsSerializerBase.AreCollectionItemsIdentifiable(ref ObjectContext) DictionarySerializer.ReadMember(ref ObjectContext) DictionarySerializer.WriteMembers(ref ObjectContext) DictionarySerializer.WriteDictionaryItem(ref ObjectContext, KeyValuePair<object, object>, KeyValuePair<Type, Type>) ObjectSerializer.GetStyle(ref ObjectContext) ObjectSerializer.ReadMembers<TStart, TEnd>(ref ObjectContext) ObjectSerializer.TryReadMember(ref ObjectContext, out string) ObjectSerializer.TryReadMember(ref ObjectContext, out Scalar, out string) ObjectSerializer.ReadMemberName(ref ObjectContext, string, out bool) ObjectSerializer.ReadMemberValue(ref ObjectContext, IMemberDescriptor, object, Type) ObjectSerializer.WriteMember(ref ObjectContext, IMemberDescriptor) ObjectSerializer.WriteMemberName(ref ObjectContext, IMemberDescriptor, string) ObjectSerializer.WriteMemberValue(ref ObjectContext, IMemberDescriptor, object, Type) Extension Methods UnsafeUtilities.As<T>(object?) Methods CreatEmptyContainer(ITypeDescriptor) Creates an empty dictionary that can store the mapping of ids to items of the collection. protected override IDictionary CreatEmptyContainer(ITypeDescriptor descriptor) Parameters descriptor ITypeDescriptor The type descriptor of the collection for which to create the dictionary. Returns IDictionary An empty dictionary for mapping ids to elements. ReadDeletedDictionaryItem(ref ObjectContext, object) protected override KeyValuePair<object, object> ReadDeletedDictionaryItem(ref ObjectContext objectContext, object keyResult) Parameters objectContext ObjectContext keyResult object Returns KeyValuePair<object, object> TransformAfterDeserialization(IDictionary, ITypeDescriptor, object, ICollection<ItemId>?) Transforms a dictionary containing the mapping of ids to items into the actual collection, and store the ids in the Stride.Core.Reflection.ShadowObject. protected override void TransformAfterDeserialization(IDictionary container, ITypeDescriptor targetDescriptor, object targetCollection, ICollection<ItemId>? deletedItems = null) Parameters container IDictionary The dictionary mapping ids to item. targetDescriptor ITypeDescriptor The type descriptor of the actual collection to fill. targetCollection object The instance of the actual collection to fill. deletedItems ICollection<ItemId> A collection of items that are marked as deleted. Can be null. TransformForSerialization(ITypeDescriptor, object) Transforms the given collection or dictionary into a dictionary of (ids, items) or a dictionary of (ids & keys, items). protected override object TransformForSerialization(ITypeDescriptor descriptor, object collection) Parameters descriptor ITypeDescriptor The type descriptor of the collection. collection object The collection for which to create the mapping dictionary. Returns object A dictionary mapping the id to the element of the initial collection. TransformObjectAfterRead(ref ObjectContext) Transforms the object after it has been read. This method is called after an object has been read and before returning the object to the deserialization process. See remarks for usage. protected override void TransformObjectAfterRead(ref ObjectContext objectContext) Parameters objectContext ObjectContext Remarks This method is usefull in conjunction with Stride.Core.Yaml.Serialization.Serializers.ObjectSerializer.CreateOrTransformObject(ref Stride.Core.Yaml.Serialization.ObjectContext). For example, in the case of deserializing to an immutable member, where we need to call the constructor of a type instead of setting each of its member, we can instantiate a mutable object in Stride.Core.Yaml.Serialization.Serializers.ObjectSerializer.CreateOrTransformObject(ref Stride.Core.Yaml.Serialization.ObjectContext), receive the mutable object filled in Stride.Core.Yaml.Serialization.Serializers.ObjectSerializer.TransformObjectAfterRead(ref Stride.Core.Yaml.Serialization.ObjectContext) and transform it back to an immutable object. TryCreate(SerializerContext, ITypeDescriptor) Try to create a Stride.Core.Yaml.Serialization.IYamlSerializable or return null if not supported for a particular .NET typeDescriptor. public override IYamlSerializable? TryCreate(SerializerContext context, ITypeDescriptor typeDescriptor) Parameters context SerializerContext typeDescriptor ITypeDescriptor The typeDescriptor. Returns IYamlSerializable If supported, return an instance of Stride.Core.Yaml.Serialization.IYamlSerializable else return null. WriteDeletedItems(ref ObjectContext) protected override void WriteDeletedItems(ref ObjectContext objectContext) Parameters objectContext ObjectContext"
  },
  "api/Stride.Core.Yaml.DictionaryWithItemIds-2.html": {
    "href": "api/Stride.Core.Yaml.DictionaryWithItemIds-2.html",
    "title": "Class DictionaryWithItemIds<TKey, TValue> | Stride API",
    "summary": "Class DictionaryWithItemIds<TKey, TValue> Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll A container used to serialize dictionary whose entries have identifiers. [DataContract] public class DictionaryWithItemIds<TKey, TValue> : OrderedDictionary<KeyWithId<TKey>, TValue>, IOrderedDictionary<KeyWithId<TKey>, TValue>, IDictionary<KeyWithId<TKey>, TValue>, IList<KeyValuePair<KeyWithId<TKey>, TValue>>, ICollection<KeyValuePair<KeyWithId<TKey>, TValue>>, IEnumerable<KeyValuePair<KeyWithId<TKey>, TValue>>, IDictionary, ICollection, IEnumerable Type Parameters TKey The type of key contained in the dictionary. TValue The type of value contained in the dictionary. Inheritance object OrderedDictionary<KeyWithId<TKey>, TValue> DictionaryWithItemIds<TKey, TValue> Implements IOrderedDictionary<KeyWithId<TKey>, TValue> IDictionary<KeyWithId<TKey>, TValue> IList<KeyValuePair<KeyWithId<TKey>, TValue>> ICollection<KeyValuePair<KeyWithId<TKey>, TValue>> IEnumerable<KeyValuePair<KeyWithId<TKey>, TValue>> IDictionary ICollection IEnumerable Inherited Members OrderedDictionary<KeyWithId<TKey>, TValue>.Count OrderedDictionary<KeyWithId<TKey>, TValue>.IsReadOnly OrderedDictionary<KeyWithId<TKey>, TValue>.GetEnumerator() OrderedDictionary<KeyWithId<TKey>, TValue>.Add(KeyValuePair<KeyWithId<TKey>, TValue>) OrderedDictionary<KeyWithId<TKey>, TValue>.Clear() OrderedDictionary<KeyWithId<TKey>, TValue>.Contains(KeyValuePair<KeyWithId<TKey>, TValue>) OrderedDictionary<KeyWithId<TKey>, TValue>.CopyTo(KeyValuePair<KeyWithId<TKey>, TValue>[], int) OrderedDictionary<KeyWithId<TKey>, TValue>.Remove(KeyValuePair<KeyWithId<TKey>, TValue>) OrderedDictionary<KeyWithId<TKey>, TValue>.Add(KeyWithId<TKey>, TValue) OrderedDictionary<KeyWithId<TKey>, TValue>.ContainsKey(KeyWithId<TKey>) OrderedDictionary<KeyWithId<TKey>, TValue>.Remove(KeyWithId<TKey>) OrderedDictionary<KeyWithId<TKey>, TValue>.TryGetValue(KeyWithId<TKey>, out TValue) OrderedDictionary<KeyWithId<TKey>, TValue>.Insert(int, KeyWithId<TKey>, TValue) OrderedDictionary<KeyWithId<TKey>, TValue>.RemoveAt(int) OrderedDictionary<KeyWithId<TKey>, TValue>.IndexOf(KeyValuePair<KeyWithId<TKey>, TValue>) OrderedDictionary<KeyWithId<TKey>, TValue>.Insert(int, KeyValuePair<KeyWithId<TKey>, TValue>) OrderedDictionary<KeyWithId<TKey>, TValue>.IndexOf(KeyWithId<TKey>) OrderedDictionary<KeyWithId<TKey>, TValue>.this[int] OrderedDictionary<KeyWithId<TKey>, TValue>.this[KeyWithId<TKey>] OrderedDictionary<KeyWithId<TKey>, TValue>.Keys OrderedDictionary<KeyWithId<TKey>, TValue>.Values Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Yaml.DynamicYaml.html": {
    "href": "api/Stride.Core.Yaml.DynamicYaml.html",
    "title": "Class DynamicYaml | Stride API",
    "summary": "Class DynamicYaml Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll Allows to manipulate dynamically a YAML content. public class DynamicYaml Inheritance object DynamicYaml Derived PackageLoadingAssetFile.YamlAsset Extension Methods UnsafeUtilities.As<T>(object?) Constructors DynamicYaml(Stream, bool) Initializes a new instance of DynamicYaml from the specified stream. public DynamicYaml(Stream stream, bool disposeStream = true) Parameters stream Stream A stream that contains a YAML content. The stream will be disposed disposeStream bool Dispose the stream when reading the YAML content is done. true by default DynamicYaml(string) Initializes a new instance of DynamicYaml from the specified stream. public DynamicYaml(string text) Parameters text string A text that contains a YAML content Properties DynamicRootNode Gets a dynamic YAML node around the RootNode. public dynamic DynamicRootNode { get; } Property Value dynamic RootNode Gets the root YAML node. public YamlMappingNode RootNode { get; } Property Value YamlMappingNode Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. WriteTo(Stream, SerializerSettings) Writes the content of this YAML node to the specified stream. public void WriteTo(Stream stream, SerializerSettings settings) Parameters stream Stream The stream to output YAML to. settings SerializerSettings The settings to use to generate YAML. If null, a default Stride.Core.Yaml.Serialization.SerializerSettings will be used. WriteTo(TextWriter, SerializerSettings) Writes the content of this YAML node to the specified writer. public void WriteTo(TextWriter writer, SerializerSettings settings) Parameters writer TextWriter The writer to output YAML to. settings SerializerSettings The settings to use to generate YAML. If null, a default Stride.Core.Yaml.Serialization.SerializerSettings will be used."
  },
  "api/Stride.Core.Yaml.DynamicYamlArray.html": {
    "href": "api/Stride.Core.Yaml.DynamicYamlArray.html",
    "title": "Class DynamicYamlArray | Stride API",
    "summary": "Class DynamicYamlArray Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll Dynamic version of Stride.Core.Yaml.Serialization.YamlSequenceNode. public class DynamicYamlArray : DynamicYamlObject, IDynamicMetaObjectProvider, IDynamicYamlNode, IEnumerable Inheritance object DynamicObject DynamicYamlObject DynamicYamlArray Implements IDynamicMetaObjectProvider IDynamicYamlNode IEnumerable Inherited Members DynamicYamlObject.ConvertFromDynamic(object) DynamicYamlObject.ConvertToDynamic(object) DynamicObject.GetDynamicMemberNames() DynamicObject.GetMetaObject(Expression) DynamicObject.TryBinaryOperation(BinaryOperationBinder, object, out object) DynamicObject.TryCreateInstance(CreateInstanceBinder, object[], out object) DynamicObject.TryDeleteIndex(DeleteIndexBinder, object[]) DynamicObject.TryDeleteMember(DeleteMemberBinder) DynamicObject.TryGetMember(GetMemberBinder, out object) DynamicObject.TryInvoke(InvokeBinder, object[], out object) DynamicObject.TryInvokeMember(InvokeMemberBinder, object[], out object) DynamicObject.TrySetMember(SetMemberBinder, object) DynamicObject.TryUnaryOperation(UnaryOperationBinder, out object) Extension Methods EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors DynamicYamlArray(YamlSequenceNode) public DynamicYamlArray(YamlSequenceNode node) Parameters node YamlSequenceNode Properties Count public int Count { get; } Property Value int Node public YamlSequenceNode Node { get; } Property Value YamlSequenceNode Methods Add(object) public void Add(object value) Parameters value object RemoveAt(int) public void RemoveAt(int index) Parameters index int TryConvert(ConvertBinder, out object) Provides implementation for type conversion operations. Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations that convert an object from one type to another. public override bool TryConvert(ConvertBinder binder, out object result) Parameters binder ConvertBinder Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the DynamicObject class, binder.Type returns the string type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion. result object The result of the type conversion operation. Returns bool true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.) TryGetIndex(GetIndexBinder, object[], out object) Provides the implementation for operations that get a value by index. Classes derived from the DynamicObject class can override this method to specify dynamic behavior for indexing operations. public override bool TryGetIndex(GetIndexBinder binder, object[] indexes, out object result) Parameters binder GetIndexBinder Provides information about the operation. indexes object[] The indexes that are used in the operation. For example, for the sampleObject[3] operation in C# (sampleObject(3) in Visual Basic), where sampleObject is derived from the DynamicObject class, indexes[0] is equal to 3. result object The result of the index operation. Returns bool true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a run-time exception is thrown.) TrySetIndex(SetIndexBinder, object[], object?) Provides the implementation for operations that set a value by index. Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations that access objects by a specified index. public override bool TrySetIndex(SetIndexBinder binder, object[] indexes, object? value) Parameters binder SetIndexBinder Provides information about the operation. indexes object[] The indexes that are used in the operation. For example, for the sampleObject[3] = 10 operation in C# (sampleObject(3) = 10 in Visual Basic), where sampleObject is derived from the DynamicObject class, indexes[0] is equal to 3. value object The value to set to the object that has the specified index. For example, for the sampleObject[3] = 10 operation in C# (sampleObject(3) = 10 in Visual Basic), where sampleObject is derived from the DynamicObject class, value is equal to 10. Returns bool true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown."
  },
  "api/Stride.Core.Yaml.DynamicYamlEmpty.html": {
    "href": "api/Stride.Core.Yaml.DynamicYamlEmpty.html",
    "title": "Class DynamicYamlEmpty | Stride API",
    "summary": "Class DynamicYamlEmpty Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll Placeholder value to remove keys from DynamicYamlMapping. public class DynamicYamlEmpty : DynamicYamlObject, IDynamicMetaObjectProvider Inheritance object DynamicObject DynamicYamlObject DynamicYamlEmpty Implements IDynamicMetaObjectProvider Inherited Members DynamicYamlObject.ConvertFromDynamic(object) DynamicYamlObject.ConvertToDynamic(object) DynamicObject.GetDynamicMemberNames() DynamicObject.GetMetaObject(Expression) DynamicObject.TryBinaryOperation(BinaryOperationBinder, object, out object) DynamicObject.TryConvert(ConvertBinder, out object) DynamicObject.TryCreateInstance(CreateInstanceBinder, object[], out object) DynamicObject.TryDeleteIndex(DeleteIndexBinder, object[]) DynamicObject.TryDeleteMember(DeleteMemberBinder) DynamicObject.TryGetIndex(GetIndexBinder, object[], out object) DynamicObject.TryGetMember(GetMemberBinder, out object) DynamicObject.TryInvoke(InvokeBinder, object[], out object) DynamicObject.TryInvokeMember(InvokeMemberBinder, object[], out object) DynamicObject.TrySetIndex(SetIndexBinder, object[], object) DynamicObject.TrySetMember(SetMemberBinder, object) DynamicObject.TryUnaryOperation(UnaryOperationBinder, out object) Extension Methods UnsafeUtilities.As<T>(object?) Fields Default public static readonly DynamicYamlEmpty Default Field Value DynamicYamlEmpty"
  },
  "api/Stride.Core.Yaml.DynamicYamlExtensions.html": {
    "href": "api/Stride.Core.Yaml.DynamicYamlExtensions.html",
    "title": "Class DynamicYamlExtensions | Stride API",
    "summary": "Class DynamicYamlExtensions Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll public static class DynamicYamlExtensions Inheritance object DynamicYamlExtensions Methods ConvertFrom<T>(T) public static IDynamicYamlNode ConvertFrom<T>(T dataObject) Parameters dataObject T Returns IDynamicYamlNode Type Parameters T ConvertTo<T>(IDynamicYamlNode) public static T ConvertTo<T>(IDynamicYamlNode yamObject) Parameters yamObject IDynamicYamlNode Returns T Type Parameters T"
  },
  "api/Stride.Core.Yaml.DynamicYamlMapping.html": {
    "href": "api/Stride.Core.Yaml.DynamicYamlMapping.html",
    "title": "Class DynamicYamlMapping | Stride API",
    "summary": "Class DynamicYamlMapping Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll Dynamic version of Stride.Core.Yaml.Serialization.YamlMappingNode. public class DynamicYamlMapping : DynamicYamlObject, IDynamicMetaObjectProvider, IDynamicYamlNode, IEnumerable Inheritance object DynamicObject DynamicYamlObject DynamicYamlMapping Implements IDynamicMetaObjectProvider IDynamicYamlNode IEnumerable Inherited Members DynamicYamlObject.ConvertFromDynamic(object) DynamicYamlObject.ConvertToDynamic(object) DynamicObject.GetDynamicMemberNames() DynamicObject.GetMetaObject(Expression) DynamicObject.TryBinaryOperation(BinaryOperationBinder, object, out object) DynamicObject.TryCreateInstance(CreateInstanceBinder, object[], out object) DynamicObject.TryDeleteIndex(DeleteIndexBinder, object[]) DynamicObject.TryDeleteMember(DeleteMemberBinder) DynamicObject.TryInvoke(InvokeBinder, object[], out object) DynamicObject.TryInvokeMember(InvokeMemberBinder, object[], out object) DynamicObject.TryUnaryOperation(UnaryOperationBinder, out object) Extension Methods EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors DynamicYamlMapping(YamlMappingNode) public DynamicYamlMapping(YamlMappingNode node) Parameters node YamlMappingNode Properties Node public YamlMappingNode Node { get; } Property Value YamlMappingNode Methods AddChild(object, object) public void AddChild(object key, object value) Parameters key object value object ContainsChild(object) public bool ContainsChild(object key) Parameters key object Returns bool GetOverride(string) Gets the override for the specified member. public OverrideType GetOverride(string key) Parameters key string The member name to get the override Returns OverrideType The type of override (if no override, return Base IndexOf(object) public int IndexOf(object key) Parameters key object Returns int MoveChild(object, int) public void MoveChild(object key, int movePosition) Parameters key object movePosition int RemoveChild(object) public void RemoveChild(object key) Parameters key object RemoveOverride(string) Removes an override information from the specified member. public void RemoveOverride(string key) Parameters key string The member name RenameChild(object, object) Renames a property to a new name while keeping all overrides and key mappings public void RenameChild(object oldKey, object newKey) Parameters oldKey object Old property name newKey object New property name SetOverride(string, OverrideType) Sets the override type for the specified member. public void SetOverride(string key, OverrideType type) Parameters key string The member name to setup an override type OverrideType Type of the override TransferChild(object, object, object) Transfers ownership of a property to another parent object and removes it from the current one public void TransferChild(object oldKey, object newParent, object newKey) Parameters oldKey object Old property name newParent object New owner for the property newKey object New property name TryConvert(ConvertBinder, out object) Provides implementation for type conversion operations. Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations that convert an object from one type to another. public override bool TryConvert(ConvertBinder binder, out object result) Parameters binder ConvertBinder Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the DynamicObject class, binder.Type returns the string type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion. result object The result of the type conversion operation. Returns bool true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.) TryGetIndex(GetIndexBinder, object[], out object?) Provides the implementation for operations that get a value by index. Classes derived from the DynamicObject class can override this method to specify dynamic behavior for indexing operations. public override bool TryGetIndex(GetIndexBinder binder, object[] indexes, out object? result) Parameters binder GetIndexBinder Provides information about the operation. indexes object[] The indexes that are used in the operation. For example, for the sampleObject[3] operation in C# (sampleObject(3) in Visual Basic), where sampleObject is derived from the DynamicObject class, indexes[0] is equal to 3. result object The result of the index operation. Returns bool true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a run-time exception is thrown.) TryGetMember(GetMemberBinder, out object?) Provides the implementation for operations that get member values. Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations such as getting a value for a property. public override bool TryGetMember(GetMemberBinder binder, out object? result) Parameters binder GetMemberBinder Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member on which the dynamic operation is performed. For example, for the Console.WriteLine(sampleObject.SampleProperty) statement, where sampleObject is an instance of the class derived from the DynamicObject class, binder.Name returns \"SampleProperty\". The binder.IgnoreCase property specifies whether the member name is case-sensitive. result object The result of the get operation. For example, if the method is called for a property, you can assign the property value to result. Returns bool true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a run-time exception is thrown.) TrySetIndex(SetIndexBinder, object[], object?) Provides the implementation for operations that set a value by index. Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations that access objects by a specified index. public override bool TrySetIndex(SetIndexBinder binder, object[] indexes, object? value) Parameters binder SetIndexBinder Provides information about the operation. indexes object[] The indexes that are used in the operation. For example, for the sampleObject[3] = 10 operation in C# (sampleObject(3) = 10 in Visual Basic), where sampleObject is derived from the DynamicObject class, indexes[0] is equal to 3. value object The value to set to the object that has the specified index. For example, for the sampleObject[3] = 10 operation in C# (sampleObject(3) = 10 in Visual Basic), where sampleObject is derived from the DynamicObject class, value is equal to 10. Returns bool true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown. TrySetMember(SetMemberBinder, object?) Provides the implementation for operations that set member values. Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations such as setting a value for a property. public override bool TrySetMember(SetMemberBinder binder, object? value) Parameters binder SetMemberBinder Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member to which the value is being assigned. For example, for the statement sampleObject.SampleProperty = \"Test\", where sampleObject is an instance of the class derived from the DynamicObject class, binder.Name returns \"SampleProperty\". The binder.IgnoreCase property specifies whether the member name is case-sensitive. value object The value to set to the member. For example, for sampleObject.SampleProperty = \"Test\", where sampleObject is an instance of the class derived from the DynamicObject class, the value is \"Test\". Returns bool true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.)"
  },
  "api/Stride.Core.Yaml.DynamicYamlObject.html": {
    "href": "api/Stride.Core.Yaml.DynamicYamlObject.html",
    "title": "Class DynamicYamlObject | Stride API",
    "summary": "Class DynamicYamlObject Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll public abstract class DynamicYamlObject : DynamicObject, IDynamicMetaObjectProvider Inheritance object DynamicObject DynamicYamlObject Implements IDynamicMetaObjectProvider Derived DynamicYamlArray DynamicYamlEmpty DynamicYamlMapping DynamicYamlScalar Inherited Members DynamicObject.GetDynamicMemberNames() DynamicObject.GetMetaObject(Expression) DynamicObject.TryBinaryOperation(BinaryOperationBinder, object, out object) DynamicObject.TryConvert(ConvertBinder, out object) DynamicObject.TryCreateInstance(CreateInstanceBinder, object[], out object) DynamicObject.TryDeleteIndex(DeleteIndexBinder, object[]) DynamicObject.TryDeleteMember(DeleteMemberBinder) DynamicObject.TryGetIndex(GetIndexBinder, object[], out object) DynamicObject.TryGetMember(GetMemberBinder, out object) DynamicObject.TryInvoke(InvokeBinder, object[], out object) DynamicObject.TryInvokeMember(InvokeMemberBinder, object[], out object) DynamicObject.TrySetIndex(SetIndexBinder, object[], object) DynamicObject.TrySetMember(SetMemberBinder, object) DynamicObject.TryUnaryOperation(UnaryOperationBinder, out object) Extension Methods UnsafeUtilities.As<T>(object?) Methods ConvertFromDynamic(object?) protected static YamlNode ConvertFromDynamic(object? obj) Parameters obj object Returns YamlNode ConvertToDynamic(object) public static object ConvertToDynamic(object obj) Parameters obj object Returns object"
  },
  "api/Stride.Core.Yaml.DynamicYamlScalar.html": {
    "href": "api/Stride.Core.Yaml.DynamicYamlScalar.html",
    "title": "Class DynamicYamlScalar | Stride API",
    "summary": "Class DynamicYamlScalar Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll Dynamic version of Stride.Core.Yaml.Serialization.YamlScalarNode. public class DynamicYamlScalar : DynamicYamlObject, IDynamicMetaObjectProvider, IDynamicYamlNode Inheritance object DynamicObject DynamicYamlObject DynamicYamlScalar Implements IDynamicMetaObjectProvider IDynamicYamlNode Inherited Members DynamicYamlObject.ConvertFromDynamic(object) DynamicYamlObject.ConvertToDynamic(object) DynamicObject.GetDynamicMemberNames() DynamicObject.GetMetaObject(Expression) DynamicObject.TryCreateInstance(CreateInstanceBinder, object[], out object) DynamicObject.TryDeleteIndex(DeleteIndexBinder, object[]) DynamicObject.TryDeleteMember(DeleteMemberBinder) DynamicObject.TryGetIndex(GetIndexBinder, object[], out object) DynamicObject.TryGetMember(GetMemberBinder, out object) DynamicObject.TryInvoke(InvokeBinder, object[], out object) DynamicObject.TryInvokeMember(InvokeMemberBinder, object[], out object) DynamicObject.TrySetIndex(SetIndexBinder, object[], object) DynamicObject.TrySetMember(SetMemberBinder, object) DynamicObject.TryUnaryOperation(UnaryOperationBinder, out object) Extension Methods UnsafeUtilities.As<T>(object?) Constructors DynamicYamlScalar(YamlScalarNode) public DynamicYamlScalar(YamlScalarNode node) Parameters node YamlScalarNode Properties Node public YamlScalarNode Node { get; } Property Value YamlScalarNode Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. TryBinaryOperation(BinaryOperationBinder, object, out object?) Provides implementation for binary operations. Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations such as addition and multiplication. public override bool TryBinaryOperation(BinaryOperationBinder binder, object arg, out object? result) Parameters binder BinaryOperationBinder Provides information about the binary operation. The binder.Operation property returns an ExpressionType object. For example, for the sum = first + second statement, where first and second are derived from the DynamicObject class, binder.Operation returns ExpressionType.Add. arg object The right operand for the binary operation. For example, for the sum = first + second statement, where first and second are derived from the DynamicObject class, arg is equal to second. result object The result of the binary operation. Returns bool true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.) TryConvert(ConvertBinder, out object) Provides implementation for type conversion operations. Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations that convert an object from one type to another. public override bool TryConvert(ConvertBinder binder, out object result) Parameters binder ConvertBinder Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the DynamicObject class, binder.Type returns the string type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion. result object The result of the type conversion operation. Returns bool true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.)"
  },
  "api/Stride.Core.Yaml.IDynamicYamlNode.html": {
    "href": "api/Stride.Core.Yaml.IDynamicYamlNode.html",
    "title": "Interface IDynamicYamlNode | Stride API",
    "summary": "Interface IDynamicYamlNode Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll public interface IDynamicYamlNode Extension Methods UnsafeUtilities.As<T>(object?) Properties Node YamlNode Node { get; } Property Value YamlNode"
  },
  "api/Stride.Core.Yaml.IKeyWithId.html": {
    "href": "api/Stride.Core.Yaml.IKeyWithId.html",
    "title": "Interface IKeyWithId | Stride API",
    "summary": "Interface IKeyWithId Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll An interface representing an association between an ItemId and the key of a dictionary. public interface IKeyWithId Extension Methods UnsafeUtilities.As<T>(object?) Properties Id The ItemId associated to the key. ItemId Id { get; } Property Value ItemId IsDeleted Indicates whether this key is considered to be deleted in the dictionary, and kept around for reconcilation purpose. bool IsDeleted { get; } Property Value bool Key The key of the dictionary. object Key { get; } Property Value object KeyType The type of the key. Type KeyType { get; } Property Value Type"
  },
  "api/Stride.Core.Yaml.IUnloadable.html": {
    "href": "api/Stride.Core.Yaml.IUnloadable.html",
    "title": "Interface IUnloadable | Stride API",
    "summary": "Interface IUnloadable Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll Objects that can't be loaded as valid Yaml will be converted to a proxy object implementing this interface by Stride.Core.Yaml.ErrorRecoverySerializer. public interface IUnloadable Extension Methods UnsafeUtilities.As<T>(object?) Properties AssemblyName string AssemblyName { get; } Property Value string Error string Error { get; } Property Value string ParsingEvents List<ParsingEvent> ParsingEvents { get; } Property Value List<ParsingEvent> TypeName string TypeName { get; } Property Value string"
  },
  "api/Stride.Core.Yaml.ItemIdSerializerBase.html": {
    "href": "api/Stride.Core.Yaml.ItemIdSerializerBase.html",
    "title": "Class ItemIdSerializerBase | Stride API",
    "summary": "Class ItemIdSerializerBase Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll A base class to serialize ItemId. public abstract class ItemIdSerializerBase : AssetScalarSerializerBase, IYamlSerializable, IYamlSerializableFactory, IDataCustomVisitor Inheritance object ScalarSerializerBase AssetScalarSerializerBase ItemIdSerializerBase Implements IYamlSerializable IYamlSerializableFactory IDataCustomVisitor Derived KeyWithIdSerializer Inherited Members AssetScalarSerializerBase.TryCreate(SerializerContext, ITypeDescriptor) AssetScalarSerializerBase.CanVisit(Type) AssetScalarSerializerBase.Visit(ref VisitorContext) ScalarSerializerBase.ReadYaml(ref ObjectContext) ScalarSerializerBase.ConvertFrom(ref ObjectContext, Scalar) ScalarSerializerBase.WriteYaml(ref ObjectContext) ScalarSerializerBase.WriteScalar(ref ObjectContext, ScalarEventInfo) Extension Methods UnsafeUtilities.As<T>(object?) Fields OverrideInfoKey A key used in properties of serialization contexts to notify whether an override flag should be appened when serializing the related ItemId. public static PropertyKey<string> OverrideInfoKey Field Value PropertyKey<string> Methods ConvertTo(ref ObjectContext) public override string ConvertTo(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns string"
  },
  "api/Stride.Core.Yaml.KeyWithId-1.html": {
    "href": "api/Stride.Core.Yaml.KeyWithId-1.html",
    "title": "Struct KeyWithId<TKey> | Stride API",
    "summary": "Struct KeyWithId<TKey> Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll A generic structure that implements the IKeyWithId interface for keys that are not deleted. public readonly struct KeyWithId<TKey> : IKeyWithId Type Parameters TKey The type of the key. Implements IKeyWithId Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors KeyWithId(ItemId, TKey) Initializes a new instance of the KeyWithId<TKey> structure. public KeyWithId(ItemId id, TKey key) Parameters id ItemId The ItemId associated to the key. key TKey The key of the dictionary. Fields Id The ItemId associated to the key. public readonly ItemId Id Field Value ItemId Key The key of the dictionary. public readonly TKey Key Field Value TKey"
  },
  "api/Stride.Core.Yaml.KeyWithIdSerializer.html": {
    "href": "api/Stride.Core.Yaml.KeyWithIdSerializer.html",
    "title": "Class KeyWithIdSerializer | Stride API",
    "summary": "Class KeyWithIdSerializer Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll A Yaml serializer for IKeyWithId. [YamlSerializerFactory(new string[] { \"Assets\" })] public class KeyWithIdSerializer : ItemIdSerializerBase, IYamlSerializable, IYamlSerializableFactory, IDataCustomVisitor Inheritance object ScalarSerializerBase AssetScalarSerializerBase ItemIdSerializerBase KeyWithIdSerializer Implements IYamlSerializable IYamlSerializableFactory IDataCustomVisitor Inherited Members ItemIdSerializerBase.OverrideInfoKey AssetScalarSerializerBase.TryCreate(SerializerContext, ITypeDescriptor) AssetScalarSerializerBase.Visit(ref VisitorContext) ScalarSerializerBase.ReadYaml(ref ObjectContext) ScalarSerializerBase.WriteYaml(ref ObjectContext) ScalarSerializerBase.WriteScalar(ref ObjectContext, ScalarEventInfo) Extension Methods UnsafeUtilities.As<T>(object?) Fields OverrideKeyInfoKey A key used in properties of serialization contexts to notify whether an override flag should be appened when serializing the key of the related ItemId. public static PropertyKey<string> OverrideKeyInfoKey Field Value PropertyKey<string> Methods CanVisit(Type) Determines whether this instance can visit the specified object. public override bool CanVisit(Type type) Parameters type Type Returns bool true if this instance can visit the specified object; otherwise, false. ConvertFrom(ref ObjectContext, Scalar) public override object? ConvertFrom(ref ObjectContext objectContext, Scalar fromScalar) Parameters objectContext ObjectContext fromScalar Scalar Returns object ConvertTo(ref ObjectContext) public override string ConvertTo(ref ObjectContext objectContext) Parameters objectContext ObjectContext Returns string"
  },
  "api/Stride.Core.Yaml.UnloadableObjectInstantiator.ProcessProxyTypeDelegate.html": {
    "href": "api/Stride.Core.Yaml.UnloadableObjectInstantiator.ProcessProxyTypeDelegate.html",
    "title": "Delegate UnloadableObjectInstantiator.ProcessProxyTypeDelegate | Stride API",
    "summary": "Delegate UnloadableObjectInstantiator.ProcessProxyTypeDelegate Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll public delegate void UnloadableObjectInstantiator.ProcessProxyTypeDelegate(Type baseType, TypeBuilder typeBuilder) Parameters baseType Type typeBuilder TypeBuilder Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Core.Yaml.UnloadableObjectInstantiator.html": {
    "href": "api/Stride.Core.Yaml.UnloadableObjectInstantiator.html",
    "title": "Class UnloadableObjectInstantiator | Stride API",
    "summary": "Class UnloadableObjectInstantiator Namespace Stride.Core.Yaml Assembly Stride.Core.Assets.dll public static class UnloadableObjectInstantiator Inheritance object UnloadableObjectInstantiator Fields ProcessProxyType Callback to perform additional changes to the generated proxy object. public static UnloadableObjectInstantiator.ProcessProxyTypeDelegate? ProcessProxyType Field Value UnloadableObjectInstantiator.ProcessProxyTypeDelegate Methods CreateUnloadableObject(Type, string, string, string, List<ParsingEvent>) Creates an object that implements the given baseType and IUnloadable. public static IUnloadable CreateUnloadableObject(Type baseType, string typeName, string assemblyName, string error, List<ParsingEvent> parsingEvents) Parameters baseType Type typeName string assemblyName string error string parsingEvents List<ParsingEvent> Returns IUnloadable"
  },
  "api/Stride.Core.Yaml.html": {
    "href": "api/Stride.Core.Yaml.html",
    "title": "Namespace Stride.Core.Yaml | Stride API",
    "summary": "Namespace Stride.Core.Yaml Classes AssetObjectSerializerBackend Internal class used when serializing/deserializing an object. AssetYamlSerializer Default Yaml serializer used to serialize assets by default. CollectionWithIdsSerializer An implementation of CollectionWithIdsSerializerBase for actual collections. CollectionWithIdsSerializerBase A base class to serialize collections with unique identifiers for each item. CollectionWithIdsSerializerBase.InstanceInfo A structure containing the information about the instance that we need the store in the Stride.Core.Yaml.Serialization.ObjectContext.Properties dictionary. CollectionWithItemIds<TItem> A container used to serialize collection whose items have identifiers. DictionaryWithIdsSerializer An implementation of CollectionWithIdsSerializerBase for dictionaries. DictionaryWithItemIds<TKey, TValue> A container used to serialize dictionary whose entries have identifiers. DynamicYaml Allows to manipulate dynamically a YAML content. DynamicYamlArray Dynamic version of Stride.Core.Yaml.Serialization.YamlSequenceNode. DynamicYamlEmpty Placeholder value to remove keys from DynamicYamlMapping. DynamicYamlExtensions DynamicYamlMapping Dynamic version of Stride.Core.Yaml.Serialization.YamlMappingNode. DynamicYamlObject DynamicYamlScalar Dynamic version of Stride.Core.Yaml.Serialization.YamlScalarNode. ItemIdSerializerBase A base class to serialize ItemId. KeyWithIdSerializer A Yaml serializer for IKeyWithId. UnloadableObjectInstantiator Structs DeletedKeyWithId<TKey> A generic structure that implements the IKeyWithId interface for keys that are deleted. KeyWithId<TKey> A generic structure that implements the IKeyWithId interface for keys that are not deleted. Interfaces IDynamicYamlNode IKeyWithId An interface representing an association between an ItemId and the key of a dictionary. IUnloadable Objects that can't be loaded as valid Yaml will be converted to a proxy object implementing this interface by Stride.Core.Yaml.ErrorRecoverySerializer. Delegates UnloadableObjectInstantiator.ProcessProxyTypeDelegate"
  },
  "api/Stride.Core.html": {
    "href": "api/Stride.Core.html",
    "title": "Namespace Stride.Core | Stride API",
    "summary": "Namespace Stride.Core Classes AccessorMetadata Metadata used for providing attached getter/setter to a PropertyKey. AnonymousDisposable This class allows implementation of IDisposable using anonymous functions. The anonymous function will be invoked only on the first call to the Dispose() method. ComponentBase Base class for a framework Component. ComponentBaseExtensions Extensions for IComponent. DataAliasAttribute Allows to re-map a previous class/field/property/enum name to the specified property/field/enum/class/struct. DataContractAttribute Indicates that a class can be serialized. DataContractIgnoreAttribute DataContractMetadataTypeAttribute Specifies the metadata class to associate with a serializable class. The main usage of this class is to allow a sub-class to override property attributes such as DefaultValueAttribute. DataMemberAttribute Specify the way to store a property or field of some class or structure. DataMemberCustomSerializerAttribute When specified on a property or field, a serializer won't be needed for this type (useful if serializer is dynamically or manually registered). DataMemberIgnoreAttribute When specified on a property or field, it will not be used when serializing/deserializing. DataStyleAttribute An attribute to modify the output style of a sequence or mapping. This attribute can be apply directly on a type or on a property/field. DefaultValueMetadata Abstract class that could be overloaded in order to define how to get default value of an PropertyKey. DefaultValueMetadata<T> DelegateDefaultValueMetadata<T> Specifies a delegate to fetch the default value of an PropertyKey. DisplayAttribute Portable DisplayAttribute equivalent to DisplayAttribute. DisposeBase Base class for a IDisposable interface implementation with reference-counting semantics. MemoryUtilities Provides a set of static utility methods for memory management. ModuleInitializerAttribute NativeLibraryHelper Provides helper methods for locating, preloading, registering, and unloading native libraries and executables across different platforms. ObjectInvalidationMetadata ObjectInvalidationMetadata<T> Metadata used to invalidate an object state after a property value modification. Platform Platform specific queries and functions. PlatformFolders Folders used for the running platform. PropertyContainerClass Class wrapper around PropertyContainer. PropertyKey A class that represents a tag propety. PropertyKeyMetadata Specifies metadata for an PropertyKey. PropertyKey<T> A class that represents a typed tag propety. ReferenceBase Base class for a IReferencable class. ReferenceEqualityComparer<T> A Comparator to use object.ReferenceEquals(object, object) method. RuntimeIdHelper Extension methods to get a runtime unique id from a live object. ServiceEventArgs ServiceNotFoundException ServiceRegistry Provides a base implementation for managing services within an application. Implements the IServiceRegistry interface. ServiceRegistryExtensions StaticDefaultValueMetadata<T> Defines default value of a specific PropertyKey as a parameter value. StringExtensions Extensions for string class. ThreadThrottler UnmanagedArray<T> Utilities Provides a set of static utility methods for collection operations, and general-purpose helpers. ValidateValueMetadata ValidateValueMetadata<T> A metadata to allow validation/coercision of a value before storing the value into the PropertyContainer. Structs ComponentBaseExtensions.PropertyTagRestore<T> A structure returned by PushTagAndRestore<T>(ComponentBase, PropertyKey<T?>, T) that saves the value of a tag property of an object and, once finished, can restore its value to the previous one. ObjectCollector A struct to collect objects implementing the IDisposable, or IReferencable interfaces, or pointers to memory allocated with Allocate(int, int), so they can be disposed in bulk at a later time. PropertyContainer Represents a container that can hold properties, lightweight to embed (lazy initialized). Interfaces ICollectorHolder Interface for objects that can collect other object instances that can be released / disposed in bulk. IComponent Base interface for all framework Components. IContentUrl Interface for serializable object having an url (so referenceable by other assets and saved into a single blob file) IIdentifiable Base interface for all identifiable instances. IReferencable Base interface for all objects that use reference-counting lifetime management. IService IServiceRegistry A service registry is a IServiceProvider that provides methods to register and unregister services. IThreadThrottler Enums DataMemberMode Specify the way to store a property or field of some class or structure. DataStyle Specifies the style used for textual serialization when an array/list or a dictionary/map must be serialized. ExpandRule PlatformType Defines the platform Stride is running on. ScalarStyle Specifies the style used for textual serialization of scalars. ThreadThrottler.ThrottlerType Delegates AccessorMetadata.GetterDelegate Getter delegate AccessorMetadata.SetterDelegate Setter delegate. DelegateDefaultValueMetadata<T>.DefaultValueCallback Callback used to initialiwe the tag value. ObjectInvalidationCallback<T> Delegate ObjectInvalidatorCallback used by ObjectInvalidationMetadata. ObjectInvalidationRefCallback<T> PropertyContainer.PropertyUpdatedDelegate Property changed delegate. ValidateValueCallback<T> Delegate ValidateValueCallback used by ValidateValueMetadata."
  },
  "api/Stride.Data.ConfigPlatforms.html": {
    "href": "api/Stride.Data.ConfigPlatforms.html",
    "title": "Enum ConfigPlatforms | Stride API",
    "summary": "Enum ConfigPlatforms Namespace Stride.Data Assembly Stride.dll Represents a set of platform configurations. [Flags] public enum ConfigPlatforms Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Android = 4 The Android operating system for mobile devices and tablets. Linux = 32 The Linux operating system, typically used for servers and desktops. None = 0 UWP = 16 The Universal Windows Platform (UWP) for applications that run on Windows 10 and later devices, and XBox gaming consoles. Windows = 2 The Windows operating system for desktop applications. iOS = 8 The iOS operating system for Apple mobile devices such as iPhone and iPad. macOS = 64 The macOS operating system for Apple desktop and laptop computers. Remarks This enumeration allows specifying one or more platforms by combining values using bitwise operations. For example, you can use Windows | Android to indicate both Windows and Android platforms. See Also PlatformType"
  },
  "api/Stride.Data.Configuration.html": {
    "href": "api/Stride.Data.Configuration.html",
    "title": "Class Configuration | Stride API",
    "summary": "Class Configuration Namespace Stride.Data Assembly Stride.dll [DataContract(Inherited = true)] public abstract class Configuration Inheritance object Configuration Derived AudioEngineSettings BepuConfiguration RenderingSettings NavigationSettings PhysicsSettings SubsurfaceScatteringSettings StreamingSettings Extension Methods UnsafeUtilities.As<T>(object?) Properties OfflineOnly public bool OfflineOnly { get; protected set; } Property Value bool"
  },
  "api/Stride.Data.ConfigurationOverride.html": {
    "href": "api/Stride.Data.ConfigurationOverride.html",
    "title": "Class ConfigurationOverride | Stride API",
    "summary": "Class ConfigurationOverride Namespace Stride.Data Assembly Stride.dll [DataContract] public class ConfigurationOverride Inheritance object ConfigurationOverride Extension Methods UnsafeUtilities.As<T>(object?) Fields Configuration [DataMember(30)] public Configuration Configuration Field Value Configuration Platforms [DataMember(10)] public ConfigPlatforms Platforms Field Value ConfigPlatforms SpecificFilter [DataMember(20)] public int SpecificFilter Field Value int"
  },
  "api/Stride.Data.PlatformConfigurations.html": {
    "href": "api/Stride.Data.PlatformConfigurations.html",
    "title": "Class PlatformConfigurations | Stride API",
    "summary": "Class PlatformConfigurations Namespace Stride.Data Assembly Stride.dll [DataContract] public class PlatformConfigurations Inheritance object PlatformConfigurations Extension Methods UnsafeUtilities.As<T>(object?) Fields Configurations [DataMember] public List<ConfigurationOverride> Configurations Field Value List<ConfigurationOverride> DeviceModel public static string DeviceModel Field Value string PlatformFilters [DataMember] public List<string> PlatformFilters Field Value List<string> RendererName public static string RendererName Field Value string Methods Get<T>() public T Get<T>() where T : Configuration, new() Returns T Type Parameters T"
  },
  "api/Stride.Data.html": {
    "href": "api/Stride.Data.html",
    "title": "Namespace Stride.Data | Stride API",
    "summary": "Namespace Stride.Data Classes Configuration ConfigurationOverride PlatformConfigurations Enums ConfigPlatforms Represents a set of platform configurations."
  },
  "api/Stride.Engine.ActivableEntityComponent.html": {
    "href": "api/Stride.Engine.ActivableEntityComponent.html",
    "title": "Class ActivableEntityComponent | Stride API",
    "summary": "Class ActivableEntityComponent Namespace Stride.Engine Assembly Stride.Engine.dll An EntityComponent that can be enabled and disabled. [DataContract] public abstract class ActivableEntityComponent : EntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent Implements IIdentifiable Derived AudioEmitterComponent AudioListenerComponent BackgroundComponent CameraComponent InstanceComponent InstancingComponent LightComponent LightShaftBoundingVolumeComponent LightShaftComponent ModelComponent PhysicsComponent SpriteComponent UIComponent ParticleSystemComponent PhysicsConstraintComponent Inherited Members EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties Enabled Gets or sets a value indicating whether this EntityComponent is enabled. [DataMember(-10)] public virtual bool Enabled { get; set; } Property Value bool true if enabled; otherwise, false."
  },
  "api/Stride.Engine.AllowMultipleComponentsAttribute.html": {
    "href": "api/Stride.Engine.AllowMultipleComponentsAttribute.html",
    "title": "Class AllowMultipleComponentsAttribute | Stride API",
    "summary": "Class AllowMultipleComponentsAttribute Namespace Stride.Engine Assembly Stride.Engine.dll Allows a component of the same type to be added multiple time to the same entity (default is false) [AttributeUsage(AttributeTargets.Class)] public class AllowMultipleComponentsAttribute : EntityComponentAttributeBase Inheritance object Attribute EntityComponentAttributeBase AllowMultipleComponentsAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Engine.AnimationComponent.html": {
    "href": "api/Stride.Engine.AnimationComponent.html",
    "title": "Class AnimationComponent | Stride API",
    "summary": "Class AnimationComponent Namespace Stride.Engine Assembly Stride.Engine.dll Add animation capabilities to an Entity. It will usually apply to Skeleton [DataContract(\"AnimationComponent\")] [DefaultEntityComponentProcessor(typeof(AnimationProcessor), ExecutionMode = ExecutionMode.Runtime|ExecutionMode.Thumbnail|ExecutionMode.Preview)] [Display(\"Animations\", null, Expand = ExpandRule.Once)] [ComponentOrder(2000)] [ComponentCategory(\"Animation\")] public sealed class AnimationComponent : EntityComponent, IIdentifiable Inheritance object EntityComponent AnimationComponent Implements IIdentifiable Inherited Members EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Remarks Data is stored as in http://altdevblogaday.com/2011/10/23/low-level-animation-part-2/. Constructors AnimationComponent() public AnimationComponent() Properties Animations Gets the animations associated to the component. public Dictionary<string, AnimationClip> Animations { get; } Property Value Dictionary<string, AnimationClip> BlendTreeBuilder public IBlendTreeBuilder BlendTreeBuilder { get; set; } Property Value IBlendTreeBuilder Blender public AnimationBlender Blender { get; } Property Value AnimationBlender PlayingAnimations Gets list of active animations. Use this to customize startup animations. public TrackingCollection<PlayingAnimation> PlayingAnimations { get; } Property Value TrackingCollection<PlayingAnimation> Methods Add(AnimationClip, double, AnimationBlendOperation, float, float, AnimationRepeatMode?) Adds a new playing animation at the end of the list. It doesn't alter currently playing animations. public PlayingAnimation Add(AnimationClip clip, double startTime = 0, AnimationBlendOperation blend = AnimationBlendOperation.LinearBlend, float timeScale = 1, float weight = 1, AnimationRepeatMode? repeatMode = null) Parameters clip AnimationClip Animation clip to add to the list of playing animations startTime double Time, in seconds, at which the animation starts playing blend AnimationBlendOperation Blend mode - linear or additive timeScale float Speed at which the animation should play weight float Weight of the animation, in regard to all other playing animations. repeatMode AnimationRepeatMode? Repeat mode - play once or loop indefinitely Returns PlayingAnimation The added playing animation Blend(string, float, TimeSpan) Blends progressively a new animation. public PlayingAnimation Blend(string name, float desiredWeight, TimeSpan fadeTimeSpan) Parameters name string The name. desiredWeight float The desired weight. fadeTimeSpan TimeSpan The fade time span. Returns PlayingAnimation Exceptions ArgumentException name Crossfade(string, TimeSpan) Crossfades to a new animation. public PlayingAnimation Crossfade(string name, TimeSpan fadeTimeSpan) Parameters name string The name. fadeTimeSpan TimeSpan The fade time span. Returns PlayingAnimation Exceptions ArgumentException name Ended(PlayingAnimation) Returns an awaitable object that will be completed when the animation is removed from the PlayingAnimation list. public Task Ended(PlayingAnimation animation) Parameters animation PlayingAnimation Returns Task Remarks This happens when: RepeatMode is PlayOnce and animation reached end Animation faded out completely (due to blend to 0.0 or crossfade out) Animation was manually removed from AnimationComponent.PlayingAnimations IsPlaying(string) Returns true if the specified animation is in the list of currently playing animations public bool IsPlaying(string name) Parameters name string The name of the animation to check Returns bool true if the animation is playing, false otherwise NewPlayingAnimation(string) public PlayingAnimation NewPlayingAnimation(string name) Parameters name string Returns PlayingAnimation Play(string) Plays right away the animation with the specified name, instantly removing all other blended animations. public PlayingAnimation Play(string name) Parameters name string The animation name. Returns PlayingAnimation"
  },
  "api/Stride.Engine.AsyncScript.html": {
    "href": "api/Stride.Engine.AsyncScript.html",
    "title": "Class AsyncScript | Stride API",
    "summary": "Class AsyncScript Namespace Stride.Engine Assembly Stride.Engine.dll A script which can be implemented as an async microthread. public abstract class AsyncScript : ScriptComponent, IIdentifiable, ICollectorHolder Inheritance object EntityComponent ScriptComponent AsyncScript Implements IIdentifiable ICollectorHolder Inherited Members ScriptComponent.LiveScriptingMask ScriptComponent.ScriptGlobalProfilingKey ScriptComponent.ProfilingKey ScriptComponent.Services ScriptComponent.Game ScriptComponent.GraphicsDevice ScriptComponent.Content ScriptComponent.GameProfiler ScriptComponent.Input ScriptComponent.Script ScriptComponent.SceneSystem ScriptComponent.EffectSystem ScriptComponent.DebugText ScriptComponent.Audio ScriptComponent.SpriteAnimation ScriptComponent.Streaming ScriptComponent.Log ScriptComponent.Priority ScriptComponent.IsLiveReloading ScriptComponent.Collector ScriptComponent.Cancel() EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods PhysicsScriptComponentExtensions.GetSimulation(ScriptComponent) UnsafeUtilities.As<T>(object?) Properties CancellationToken Gets a token indicating if the script execution was canceled. public CancellationToken CancellationToken { get; } Property Value CancellationToken Methods Execute() Called once, as a microthread public abstract Task Execute() Returns Task PriorityUpdated() Internal helper function called when Priority is changed. protected override void PriorityUpdated()"
  },
  "api/Stride.Engine.AudioEmitterComponent.html": {
    "href": "api/Stride.Engine.AudioEmitterComponent.html",
    "title": "Class AudioEmitterComponent | Stride API",
    "summary": "Class AudioEmitterComponent Namespace Stride.Engine Assembly Stride.Engine.dll Component representing an audio emitter. [Display(\"Audio emitter\", null, Expand = ExpandRule.Once)] [DataContract(\"AudioEmitterComponent\")] [DefaultEntityComponentProcessor(typeof(AudioEmitterProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentOrder(7000)] [ComponentCategory(\"Audio\")] public sealed class AudioEmitterComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent AudioEmitterComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Remarks Associate this component to an entity to simulate a 3D localized source of sound coming from the entity center. Several sounds can be associated to a single AudioEmitterComponent. Use the Sounds dictionary to associate or dissociate a SoundBase to the emitter component. Each SoundBase associated to the emitter component can be controlled (played, paused, stopped, ...) independently for the others. Once attached to the emitter component, a SoundBase is controlled using a AudioEmitterSoundController. To get the AudioEmitterSoundController associated to a SoundBase use the readonly this[string] indexer. Fields Sounds The sounds this audio emitter can play and use [DataMember(10)] public TrackingDictionary<string, Sound> Sounds Field Value TrackingDictionary<string, Sound> Properties DirectionalFactor If 0 the sound will be omnidirectional, 1 fully directional [DataMember(30)] [DataMemberRange(0, 1, 0.1, 0.2, 3)] public float DirectionalFactor { get; set; } Property Value float Environment The reverberation model that this emitter will use [DataMember(40)] public HrtfEnvironment Environment { get; set; } Property Value HrtfEnvironment this[string] The sound controllers associated with the sounds this audio emitter can play and use, use this to access and play sounds. public AudioEmitterSoundController this[string soundName] { get; } Parameters soundName string The name of the sound you want to access. Property Value AudioEmitterSoundController The sound controller. UseHRTF If possible use a more complex HRTF algorithm to perform 3D sound simulation [DataMember(20)] public bool UseHRTF { get; set; } Property Value bool Methods AttachSound(SoundBase) Attach a SoundBase to this emitter component. Once attached a AudioEmitterSoundController can be queried using readonly this[string] indexer to control the attached SoundBase. public AudioEmitterSoundController AttachSound(SoundBase sound) Parameters sound SoundBase The SoundBase to attach Returns AudioEmitterSoundController Remarks Attaching a SoundBase already attached has no effects. Exceptions ArgumentNullException The provided sound is null. InvalidOperationException The provided sound can not be localized (contains more than one channel). DetachSound(SoundBase) Detach a SoundBase from this emitter component. Once detach the controller previously associated to the SoundBase is invalid. public void DetachSound(SoundBase sound) Parameters sound SoundBase The SoundBase to detach. Exceptions ArgumentNullException The provided sound is null. ArgumentException The provided sound is not currently attached to the emitter component."
  },
  "api/Stride.Engine.AudioListenerComponent.html": {
    "href": "api/Stride.Engine.AudioListenerComponent.html",
    "title": "Class AudioListenerComponent | Stride API",
    "summary": "Class AudioListenerComponent Namespace Stride.Engine Assembly Stride.Engine.dll Component representing an audio listener. [Display(\"Audio listener\", null, Expand = ExpandRule.Once)] [DataContract(\"AudioListenerComponent\")] [DefaultEntityComponentProcessor(typeof(AudioListenerProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentOrder(6000)] [ComponentCategory(\"Audio\")] public sealed class AudioListenerComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent AudioListenerComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Remarks Associate this component to an Entity to simulate a physical listener listening to the AudioEmitterComponents of the scene, placed at the entity's center and oriented along the entity's Oz (forward) and Oy (up) vectors. Use the AudioSystem's `AudioSystem.AddListener` and `AudioSystem.RemoveListener` functions to activate/deactivate the listeners that are actually listening at a given time. The entity needs to be added to the Entity System so that the associated AudioListenerComponent can be processed."
  },
  "api/Stride.Engine.BackgroundComponent.html": {
    "href": "api/Stride.Engine.BackgroundComponent.html",
    "title": "Class BackgroundComponent | Stride API",
    "summary": "Class BackgroundComponent Namespace Stride.Engine Assembly Stride.Engine.dll Add a background to an Entity. [DataContract(\"BackgroundComponent\")] [Display(\"Background\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentRenderer(typeof(BackgroundRenderProcessor))] [ComponentOrder(9600)] public sealed class BackgroundComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent BackgroundComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors BackgroundComponent() Create an empty Background component. public BackgroundComponent() Properties Intensity Gets or sets the intensity. [DataMember(20)] [DataMemberRange(0, 100, 0.009999999776482582, 1, 2)] public float Intensity { get; set; } Property Value float The intensity. Is2D Indicate if the background should behave like a 2D image. [DataMember(40)] [Display(\"2D background\", null)] public bool Is2D { get; set; } Property Value bool RenderGroup The render group for this component. [DataMember(30)] [Display(\"Render group\", null)] public RenderGroup RenderGroup { get; set; } Property Value RenderGroup Texture Gets or sets the texture to use as background [DataMember(10)] [Display(\"Texture\", null)] public Texture Texture { get; set; } Property Value Texture"
  },
  "api/Stride.Engine.CameraComponent.html": {
    "href": "api/Stride.Engine.CameraComponent.html",
    "title": "Class CameraComponent | Stride API",
    "summary": "Class CameraComponent Namespace Stride.Engine Assembly Stride.Engine.dll Describes the camera projection and view. [DataContract(\"CameraComponent\")] [Display(\"Camera\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentProcessor(typeof(CameraProcessor))] [ComponentOrder(13000)] [ObjectFactory(typeof(CameraComponent.Factory))] public sealed class CameraComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent CameraComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors CameraComponent() Create a new CameraComponent instance. public CameraComponent() CameraComponent(float, float) Create a new CameraComponent instance with the provided target, near plane and far plane. public CameraComponent(float nearClipPlane, float farClipPlane) Parameters nearClipPlane float The near plane value farClipPlane float The far plane value Fields DefaultAspectRatio public const float DefaultAspectRatio = 1.7777778 Field Value float DefaultFarClipPlane public const float DefaultFarClipPlane = 1000 Field Value float DefaultNearClipPlane public const float DefaultNearClipPlane = 0.1 Field Value float DefaultOrthographicSize public const float DefaultOrthographicSize = 10 Field Value float DefaultVerticalFieldOfView public const float DefaultVerticalFieldOfView = 45 Field Value float Frustum The frustum extracted from the view projection matrix calculated automatically after calling Update() method. public BoundingFrustum Frustum Field Value BoundingFrustum ProjectionMatrix Gets or sets the local projection matrix. See remarks. public Matrix ProjectionMatrix Field Value Matrix The local projection matrix. Remarks This value is updated when calling Update() or is directly used when UseCustomViewMatrix is true. Slot [DataMember(50)] public SceneCameraSlotId Slot Field Value SceneCameraSlotId ViewMatrix Gets or sets the local view matrix. See remarks. public Matrix ViewMatrix Field Value Matrix The local view matrix. Remarks This value is updated when calling Update() or is directly used when UseCustomViewMatrix is true. ViewProjectionMatrix The view projection matrix calculated automatically after calling Update() method. public Matrix ViewProjectionMatrix Field Value Matrix Properties ActuallyUsedAspectRatio Gets the last used aspect ratio. public float ActuallyUsedAspectRatio { get; } Property Value float Remarks This value is updated when calling Update(). It either holds the aspect ratio of the window that called Update or the manually set aspect ratio AspectRatio if UseCustomAspectRatio is true. AspectRatio Gets or sets the custom aspect ratio. [DataMember(40)] public float AspectRatio { get; set; } Property Value float The custom aspect ratio. FarClipPlane Gets or sets the far plane distance. [DataMember(30)] public float FarClipPlane { get; set; } Property Value float The far plane distance. Name [DataMember(-5)] [Obsolete(\"This property is no longer used.\")] public string Name { get; set; } Property Value string NearClipPlane Gets or sets the near plane distance. [DataMember(20)] public float NearClipPlane { get; set; } Property Value float The near plane distance. OrthographicSize Gets or sets the height of the orthographic projection. [DataMember(10)] [Display(\"Orthographic size\", null)] public float OrthographicSize { get; set; } Property Value float The height of the orthographic projection. Projection Gets or sets the projection. [DataMember(0)] public CameraProjectionMode Projection { get; set; } Property Value CameraProjectionMode The projection. UseCustomAspectRatio Gets or sets a value indicating whether to use a custom AspectRatio. Default is false, meaning that the aspect ratio is calculated from the ratio of the current viewport when rendering. [DataMember(35)] [Display(\"Custom aspect ratio\", null)] public bool UseCustomAspectRatio { get; set; } Property Value bool The use custom aspect ratio. UseCustomProjectionMatrix Gets or sets a value indicating whether to use custom ProjectionMatrix. Default is false public bool UseCustomProjectionMatrix { get; set; } Property Value bool true if use custom ProjectionMatrix; otherwise, false. UseCustomViewMatrix Gets or sets a value indicating whether to use custom ViewMatrix. Default is false public bool UseCustomViewMatrix { get; set; } Property Value bool true if use custom ViewMatrix; otherwise, false. VerticalFieldOfView Gets or sets the vertical field of view in degrees. [DataMember(5)] [Display(\"Field of view\", null)] [DataMemberRange(1, 179, 1, 10, 0)] public float VerticalFieldOfView { get; set; } Property Value float The vertical field of view. Methods Update() Calculates the projection matrix and view matrix. public void Update() Update(float?) Calculates the projection matrix and view matrix. public void Update(float? screenAspectRatio) Parameters screenAspectRatio float? The current screen aspect ratio. If null, use the AspectRatio even if UseCustomAspectRatio is false."
  },
  "api/Stride.Engine.CollisionState.html": {
    "href": "api/Stride.Engine.CollisionState.html",
    "title": "Enum CollisionState | Stride API",
    "summary": "Enum CollisionState Namespace Stride.Engine Assembly Stride.Physics.dll public enum CollisionState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Detect = 1 Ignore = 0"
  },
  "api/Stride.Engine.ComponentCategoryAttribute.html": {
    "href": "api/Stride.Engine.ComponentCategoryAttribute.html",
    "title": "Class ComponentCategoryAttribute | Stride API",
    "summary": "Class ComponentCategoryAttribute Namespace Stride.Engine Assembly Stride.Engine.dll Defines the category of a component type. This information is used to group component types in Game Studio. [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)] public class ComponentCategoryAttribute : EntityComponentAttributeBase Inheritance object Attribute EntityComponentAttributeBase ComponentCategoryAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors ComponentCategoryAttribute(string) Initializes a new instance of the ComponentCategoryAttribute class. public ComponentCategoryAttribute(string category) Parameters category string The category of the associated component. Exceptions ArgumentNullException If category is null or empty. Properties Category Gets the category of the associated component public string Category { get; } Property Value string Methods GetCategory(Type) Gets the category for the component type. public static string GetCategory(Type type) Parameters type Type The type to get the attribute from Returns string The category."
  },
  "api/Stride.Engine.ComponentOrderAttribute.html": {
    "href": "api/Stride.Engine.ComponentOrderAttribute.html",
    "title": "Class ComponentOrderAttribute | Stride API",
    "summary": "Class ComponentOrderAttribute Namespace Stride.Engine Assembly Stride.Engine.dll Defines the order of a component type. This information is used to determine the most \"important\" component of a collection [AttributeUsage(AttributeTargets.Class)] public class ComponentOrderAttribute : EntityComponentAttributeBase Inheritance object Attribute EntityComponentAttributeBase ComponentOrderAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors ComponentOrderAttribute(int) Initializes a new instance of the ComponentOrderAttribute class. public ComponentOrderAttribute(int order) Parameters order int The order of the associated component. Properties Order Gets the order of the associated component. public int Order { get; } Property Value int"
  },
  "api/Stride.Engine.Design.CloneEntityComponentSerializer-1.html": {
    "href": "api/Stride.Engine.Design.CloneEntityComponentSerializer-1.html",
    "title": "Class CloneEntityComponentSerializer<T> | Stride API",
    "summary": "Class CloneEntityComponentSerializer<T> Namespace Stride.Engine.Design Assembly Stride.Engine.dll public class CloneEntityComponentSerializer<T> : DataSerializer<T> where T : EntityComponent, new() Type Parameters T Inheritance object DataSerializer DataSerializer<T> CloneEntityComponentSerializer<T> Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods PreSerialize(ref T, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref T entityComponent, ArchiveMode mode, SerializationStream stream) Parameters entityComponent T mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T entityComponent, ArchiveMode mode, SerializationStream stream) Parameters entityComponent T mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Engine.Design.CloneSerializer-1.html": {
    "href": "api/Stride.Engine.Design.CloneSerializer-1.html",
    "title": "Class CloneSerializer<T> | Stride API",
    "summary": "Class CloneSerializer<T> Namespace Stride.Engine.Design Assembly Stride.Engine.dll Serializer for helping cloning of Entity. public class CloneSerializer<T> : DataSerializer<T> where T : class Type Parameters T Inheritance object DataSerializer DataSerializer<T> CloneSerializer<T> Inherited Members DataSerializer<T>.SerializationType DataSerializer<T>.IsBlittable DataSerializer<T>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<T>.Serialize(T, SerializationStream) DataSerializer<T>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods PreSerialize(ref T, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to process. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref T, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref T obj, ArchiveMode mode, SerializationStream stream) Parameters obj T The object to serialize or deserialize. mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Engine.Design.DefaultEntityComponentProcessorAttribute.html": {
    "href": "api/Stride.Engine.Design.DefaultEntityComponentProcessorAttribute.html",
    "title": "Class DefaultEntityComponentProcessorAttribute | Stride API",
    "summary": "Class DefaultEntityComponentProcessorAttribute Namespace Stride.Engine.Design Assembly Stride.Engine.dll An attribute used to associate a default EntityProcessor to an entity component. [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] public class DefaultEntityComponentProcessorAttribute : DynamicTypeAttributeBase Inheritance object Attribute DynamicTypeAttributeBase DefaultEntityComponentProcessorAttribute Inherited Members DynamicTypeAttributeBase.TypeName Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DefaultEntityComponentProcessorAttribute(Type) Initializes a new instance of the DefaultEntityComponentProcessorAttribute class. public DefaultEntityComponentProcessorAttribute(Type type) Parameters type Type The type must derived from EntityProcessor. Properties ExecutionMode public ExecutionMode ExecutionMode { get; set; } Property Value ExecutionMode"
  },
  "api/Stride.Engine.Design.DefaultEntityComponentRendererAttribute.html": {
    "href": "api/Stride.Engine.Design.DefaultEntityComponentRendererAttribute.html",
    "title": "Class DefaultEntityComponentRendererAttribute | Stride API",
    "summary": "Class DefaultEntityComponentRendererAttribute Namespace Stride.Engine.Design Assembly Stride.Engine.dll An attribute used to associate a default IEntityComponentRenderProcessor to an entity component. public class DefaultEntityComponentRendererAttribute : DynamicTypeAttributeBase Inheritance object Attribute DynamicTypeAttributeBase DefaultEntityComponentRendererAttribute Inherited Members DynamicTypeAttributeBase.TypeName Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors DefaultEntityComponentRendererAttribute(Type) Initializes a new instance of the DefaultEntityComponentRendererAttribute class. public DefaultEntityComponentRendererAttribute(Type type) Parameters type Type The type must derived from IEntityComponentRenderProcessor. DefaultEntityComponentRendererAttribute(Type, int) Initializes a new instance of the DefaultEntityComponentRendererAttribute class. public DefaultEntityComponentRendererAttribute(Type type, int order) Parameters type Type The type must derived from IEntityComponentRenderProcessor. order int The order. Properties Order public int Order { get; } Property Value int"
  },
  "api/Stride.Engine.Design.EffectCompilationMode.html": {
    "href": "api/Stride.Engine.Design.EffectCompilationMode.html",
    "title": "Enum EffectCompilationMode | Stride API",
    "summary": "Enum EffectCompilationMode Namespace Stride.Engine.Design Assembly Stride.Engine.dll Defines how CreateEffectCompiler(IVirtualFileProvider, EffectSystem, string, EffectCompilationMode, bool, TaskSchedulerSelector, DatabaseFileProvider) tries to create compiler. [Flags] public enum EffectCompilationMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Local = 1 Effects can only be compiled in process (if possible). Stride.Shaders.Compiler.EffectCompiler will be used. LocalOrRemote = Local | Remote Effects can be compiled either in process (if possible) or over network otherwise. None = 0 Effects can't be compiled. NullEffectCompiler will be used. Remote = 2 Effects can only be compiled over network. Stride.Shaders.Compiler.RemoteEffectCompiler will be used."
  },
  "api/Stride.Engine.Design.EntityCloner.CloneContext.html": {
    "href": "api/Stride.Engine.Design.EntityCloner.CloneContext.html",
    "title": "Class EntityCloner.CloneContext | Stride API",
    "summary": "Class EntityCloner.CloneContext Namespace Stride.Engine.Design Assembly Stride.Engine.dll Helper class for cloning Entity. public class EntityCloner.CloneContext Inheritance object EntityCloner.CloneContext Extension Methods UnsafeUtilities.As<T>(object?) Fields ClonedObjects Lists objects that should be cloned. public HashSet<object> ClonedObjects Field Value HashSet<object> EntitySerializerSelector Special serializer that goes through EntitySerializerSelector and CloneEntityComponentSerializer<T>. public SerializerSelector EntitySerializerSelector Field Value SerializerSelector MappedObjects public EntityCloner.TryGetValueFunction<object, object> MappedObjects Field Value EntityCloner.TryGetValueFunction<object, object> MemoryStream public MemoryStream MemoryStream Field Value MemoryStream SerializedObjects public readonly HashSet<object> SerializedObjects Field Value HashSet<object> SharedObjects Stores objects that should be reused in the new cloned instance. public readonly List<object> SharedObjects Field Value List<object> Methods Cleanup() public void Cleanup()"
  },
  "api/Stride.Engine.Design.EntityCloner.TryGetValueFunction-2.html": {
    "href": "api/Stride.Engine.Design.EntityCloner.TryGetValueFunction-2.html",
    "title": "Delegate EntityCloner.TryGetValueFunction<TKey, TResult> | Stride API",
    "summary": "Delegate EntityCloner.TryGetValueFunction<TKey, TResult> Namespace Stride.Engine.Design Assembly Stride.Engine.dll public delegate bool EntityCloner.TryGetValueFunction<in TKey, TResult>(TKey key, out TResult result) Parameters key TKey result TResult Returns bool Type Parameters TKey TResult Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Engine.Design.EntityCloner.html": {
    "href": "api/Stride.Engine.Design.EntityCloner.html",
    "title": "Class EntityCloner | Stride API",
    "summary": "Class EntityCloner Namespace Stride.Engine.Design Assembly Stride.Engine.dll Provides method for deep cloning of en Entity. [DataSerializerGlobal(typeof(CloneSerializer<Effect>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<SpriteSheet>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<SamplerState>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<Texture>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<Mesh>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<Model>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<AnimationClip>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<Sound>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<string>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<OfflineRasterizedSpriteFont>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<RuntimeRasterizedSpriteFont>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<SignedDistanceFieldSpriteFont>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<Prefab>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(CloneSerializer<Entity>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] public class EntityCloner Inheritance object EntityCloner Extension Methods UnsafeUtilities.As<T>(object?) Fields CloneContextProperty public static readonly PropertyKey<EntityCloner.CloneContext> CloneContextProperty Field Value PropertyKey<EntityCloner.CloneContext> Methods Clone(Entity) Clones the specified entity. Entity, children Entity and their EntityComponent will be cloned. Other assets will be shared. public static Entity Clone(Entity entity) Parameters entity Entity The entity. Returns Entity A cloned entity Instantiate(Prefab) Instantiates the content of the prefab provided. Entities, children Entity and their EntityComponent will be cloned. Other assets will be shared. public static List<Entity> Instantiate(Prefab prefab) Parameters prefab Prefab The prefab to instantiate. Returns List<Entity> A clone of this prefab's Entities"
  },
  "api/Stride.Engine.Design.EntityComponentEventArgs.html": {
    "href": "api/Stride.Engine.Design.EntityComponentEventArgs.html",
    "title": "Struct EntityComponentEventArgs | Stride API",
    "summary": "Struct EntityComponentEventArgs Namespace Stride.Engine.Design Assembly Stride.Engine.dll An event when an EntityComponent changed in an Entity. public struct EntityComponentEventArgs Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors EntityComponentEventArgs(Entity, int, EntityComponent, EntityComponent) Initializes a new instance of the EntityComponentEventArgs struct. public EntityComponentEventArgs(Entity entity, int index, EntityComponent previousComponent, EntityComponent newComponent) Parameters entity Entity The entity. index int previousComponent EntityComponent The previous component. newComponent EntityComponent The new component. Fields Entity The entity public readonly Entity Entity Field Value Entity Index The index of the component in the entity public readonly int Index Field Value int NewComponent The new component public readonly EntityComponent NewComponent Field Value EntityComponent PreviousComponent The previous component public readonly EntityComponent PreviousComponent Field Value EntityComponent"
  },
  "api/Stride.Engine.Design.EntityComponentProperty.html": {
    "href": "api/Stride.Engine.Design.EntityComponentProperty.html",
    "title": "Class EntityComponentProperty | Stride API",
    "summary": "Class EntityComponentProperty Namespace Stride.Engine.Design Assembly Stride.Engine.dll [DataContract] public class EntityComponentProperty Inheritance object EntityComponentProperty Extension Methods UnsafeUtilities.As<T>(object?) Constructors EntityComponentProperty() public EntityComponentProperty() EntityComponentProperty(EntityComponentPropertyType, string, object) public EntityComponentProperty(EntityComponentPropertyType type, string name, object value) Parameters type EntityComponentPropertyType name string value object Properties Name public string Name { get; set; } Property Value string Type public EntityComponentPropertyType Type { get; set; } Property Value EntityComponentPropertyType Value public object Value { get; set; } Property Value object"
  },
  "api/Stride.Engine.Design.EntityComponentPropertyType.html": {
    "href": "api/Stride.Engine.Design.EntityComponentPropertyType.html",
    "title": "Enum EntityComponentPropertyType | Stride API",
    "summary": "Enum EntityComponentPropertyType Namespace Stride.Engine.Design Assembly Stride.Engine.dll [DataContract] public enum EntityComponentPropertyType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ExternalProperty = 2 Field = 0 Property = 1"
  },
  "api/Stride.Engine.Design.ExecutionMode.html": {
    "href": "api/Stride.Engine.Design.ExecutionMode.html",
    "title": "Enum ExecutionMode | Stride API",
    "summary": "Enum ExecutionMode Namespace Stride.Engine.Design Assembly Stride.Engine.dll Describes the different execution mode of the engine. [Flags] public enum ExecutionMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields All = Runtime | Editor | Thumbnail | Preview | EffectCompile Editor = 2 EffectCompile = 16 None = 0 Preview = 8 Runtime = 1 Thumbnail = 4"
  },
  "api/Stride.Engine.Design.GameSettings.html": {
    "href": "api/Stride.Engine.Design.GameSettings.html",
    "title": "Class GameSettings | Stride API",
    "summary": "Class GameSettings Namespace Stride.Engine.Design Assembly Stride.Engine.dll Stores some default parameters for the game. [DataContract(\"GameSettings\")] [ContentSerializer(typeof(DataContentSerializer<GameSettings>))] public sealed class GameSettings Inheritance object GameSettings Extension Methods UnsafeUtilities.As<T>(object?) Constructors GameSettings() public GameSettings() Fields AssetUrl public const string AssetUrl = \"GameSettings\" Field Value string Properties CompilationMode Gets or sets the compilation mode used. public CompilationMode CompilationMode { get; set; } Property Value CompilationMode Configurations Gets or sets configuration for the actual running platform as compiled during build public PlatformConfigurations Configurations { get; set; } Property Value PlatformConfigurations DefaultGraphicsCompositorUrl public string DefaultGraphicsCompositorUrl { get; set; } Property Value string DefaultSceneUrl public string DefaultSceneUrl { get; set; } Property Value string DoubleViewSplashScreen public bool DoubleViewSplashScreen { get; set; } Property Value bool EffectCompilation Gets or sets a value indicating whether effect compile should be allowed, and if yes, should it be done locally (if possible) or remotely? public EffectCompilationMode EffectCompilation { get; set; } Property Value EffectCompilationMode PackageName public string PackageName { get; set; } Property Value string RecordUsedEffects Gets or sets a value indicating whether effect compile (local or remote) should be recorded and sent to effect compile server for GameStudio notification. public bool RecordUsedEffects { get; set; } Property Value bool SplashScreenColor public Color4 SplashScreenColor { get; set; } Property Value Color4 SplashScreenUrl public string SplashScreenUrl { get; set; } Property Value string"
  },
  "api/Stride.Engine.Design.IGameSettingsService.html": {
    "href": "api/Stride.Engine.Design.IGameSettingsService.html",
    "title": "Interface IGameSettingsService | Stride API",
    "summary": "Interface IGameSettingsService Namespace Stride.Engine.Design Assembly Stride.Engine.dll public interface IGameSettingsService Extension Methods UnsafeUtilities.As<T>(object?) Properties Settings Gets the GameSettings GameSettings Settings { get; } Property Value GameSettings"
  },
  "api/Stride.Engine.Design.ParameterCollectionResolver.html": {
    "href": "api/Stride.Engine.Design.ParameterCollectionResolver.html",
    "title": "Class ParameterCollectionResolver | Stride API",
    "summary": "Class ParameterCollectionResolver Namespace Stride.Engine.Design Assembly Stride.Engine.dll public class ParameterCollectionResolver : UpdateMemberResolver Inheritance object UpdateMemberResolver ParameterCollectionResolver Inherited Members UpdateMemberResolver.ResolveProperty(string) Extension Methods UnsafeUtilities.As<T>(object?) Properties SupportedType Defines what type it does support. public override Type SupportedType { get; } Property Value Type Methods InstantiateValueAccessor<T>() public static void InstantiateValueAccessor<T>() where T : struct Type Parameters T ResolveIndexer(string) Defines how to resolve an indexer (between angle brackets). public override UpdatableMember ResolveIndexer(string indexerName) Parameters indexerName string The indexer name to resolve. Returns UpdatableMember The resolved indexer if found, otherwise null."
  },
  "api/Stride.Engine.Design.ParameterContainerExtensions.html": {
    "href": "api/Stride.Engine.Design.ParameterContainerExtensions.html",
    "title": "Class ParameterContainerExtensions | Stride API",
    "summary": "Class ParameterContainerExtensions Namespace Stride.Engine.Design Assembly Stride.Engine.dll public class ParameterContainerExtensions Inheritance object ParameterContainerExtensions Extension Methods UnsafeUtilities.As<T>(object?) Fields DefaultSceneSerializerSelector public static SerializerSelector DefaultSceneSerializerSelector Field Value SerializerSelector"
  },
  "api/Stride.Engine.Design.UICloner.html": {
    "href": "api/Stride.Engine.Design.UICloner.html",
    "title": "Class UICloner | Stride API",
    "summary": "Class UICloner Namespace Stride.Engine.Design Assembly Stride.UI.dll public class UICloner Inheritance object UICloner Extension Methods UnsafeUtilities.As<T>(object?) Methods Clone(UIElement) public static UIElement Clone(UIElement element) Parameters element UIElement Returns UIElement"
  },
  "api/Stride.Engine.Design.html": {
    "href": "api/Stride.Engine.Design.html",
    "title": "Namespace Stride.Engine.Design | Stride API",
    "summary": "Namespace Stride.Engine.Design Classes CloneEntityComponentSerializer<T> CloneSerializer<T> Serializer for helping cloning of Entity. DefaultEntityComponentProcessorAttribute An attribute used to associate a default EntityProcessor to an entity component. DefaultEntityComponentRendererAttribute An attribute used to associate a default IEntityComponentRenderProcessor to an entity component. EntityCloner Provides method for deep cloning of en Entity. EntityCloner.CloneContext Helper class for cloning Entity. EntityComponentProperty GameSettings Stores some default parameters for the game. ParameterCollectionResolver ParameterContainerExtensions UICloner Structs EntityComponentEventArgs An event when an EntityComponent changed in an Entity. Interfaces IGameSettingsService Enums EffectCompilationMode Defines how CreateEffectCompiler(IVirtualFileProvider, EffectSystem, string, EffectCompilationMode, bool, TaskSchedulerSelector, DatabaseFileProvider) tries to create compiler. EntityComponentPropertyType ExecutionMode Describes the different execution mode of the engine. Delegates EntityCloner.TryGetValueFunction<TKey, TResult>"
  },
  "api/Stride.Engine.Entity.html": {
    "href": "api/Stride.Engine.Entity.html",
    "title": "Class Entity | Stride API",
    "summary": "Class Entity Namespace Stride.Engine Assembly Stride.Engine.dll Represents a game entity that typically aggregates multiple EntityComponent instances. For more information about entities, see Adding entities and Managing entities. [ContentSerializer(typeof(Entity.EntityContentSerializer))] [DataSerializer(typeof(Entity.EntitySerializer))] [DataStyle(DataStyle.Normal)] [DataContract(\"Entity\")] public sealed class Entity : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder, IEnumerable<EntityComponent>, IEnumerable, IIdentifiable Inheritance object DisposeBase ComponentBase Entity Implements IDisposable IComponent IReferencable ICollectorHolder IEnumerable<EntityComponent> IEnumerable IIdentifiable Inherited Members ComponentBase.Tags DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods BepuSimulationExtensions.GetSimulation(Entity) ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) EntityExtensions.Clone(Entity) EntityExtensions.EnableAll(Entity, bool, bool) EntityExtensions.Enable<T>(Entity, bool, bool) EntityExtensions.GetChildren(Entity) EntityTransformExtensions.AddChild(Entity, Entity) EntityTransformExtensions.FindChild(Entity, string) EntityTransformExtensions.FindRoot(Entity) EntityTransformExtensions.GetChild(Entity, int) EntityTransformExtensions.GetParent(Entity) EntityTransformExtensions.RemoveChild(Entity, Entity) EntityTransformExtensions.RemoveChild(Entity, Guid) EntityTransformExtensions.SetParent(Entity, Entity) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors Entity() Create a new Entity instance. public Entity() Entity(string) Create a new Entity instance having the provided name. public Entity(string name) Parameters name string The name to give to the entity Entity(string, Vector3, Quaternion?, Vector3?) Create a new Entity instance having the provided name, initial position, rotation and scale. public Entity(string name = null, Vector3 position = default, Quaternion? rotation = null, Vector3? scale = null) Parameters name string The name to give to the entity position Vector3 The initial position of the entity rotation Quaternion? The initial rotation of the entity scale Vector3? The initial scale of the entity Properties Components The components stored in this entity. [DataMember(100, DataMemberMode.Content)] public EntityComponentCollection Components { get; } Property Value EntityComponentCollection EntityManager The entity manager which processes this entity. public EntityManager EntityManager { get; } Property Value EntityManager Id Gets the id of this instance [DataMember(-10)] [Display(null, null, Browsable = false)] public Guid Id { get; set; } Property Value Guid Name Gets or sets the name of the Component. [DataMember(0)] public override string Name { get; set; } Property Value string The name that identifies the Component. It can be null to denote it has no specific name. Scene The scene this entity is in. Setting this to null will remove the entity from the scene and detach it from its parent if it has one. public Scene Scene { get; set; } Property Value Scene Transform Gets or sets the Transform associated to this entity. Added for convenience over usual Get/Set method. public TransformComponent Transform { get; } Property Value TransformComponent Methods Add(EntityComponent) Adds the specified component to the entity. public void Add(EntityComponent component) Parameters component EntityComponent The component to add. Exceptions ArgumentNullException Thrown if the component is null. GetAll<T>() Gets all components of the specified type. public IEnumerable<T> GetAll<T>() where T : EntityComponent Returns IEnumerable<T> The component or null if does no exist Type Parameters T Type of the component GetEnumerator() Gets the enumerator of EntityComponent public FastCollection<EntityComponent>.Enumerator GetEnumerator() Returns FastCollection<EntityComponent>.Enumerator GetOrCreate<T>() Gets or create a component with the specified key. public T GetOrCreate<T>() where T : EntityComponent, new() Returns T A new or existing instance of {T} Type Parameters T Type of the entity component Get<T>() Gets the first component of the specified type. public T Get<T>() where T : EntityComponent Returns T The component or null if does no exist Type Parameters T Type of the component Get<T>(int) Gets the index'th component of the specified type. See remarks. public T Get<T>(int index) where T : EntityComponent Parameters index int The index'th component to select. Returns T The component or null if does no exist Type Parameters T Type of the component Remarks If index > 0, it will take the index'th component of the specified T. An index == 0 is equivalent to calling Get<T>() if index < 0, it will start from the end of the list to the beginning. A value of -1 means the first last component. Remove(EntityComponent) Removes the specified component. public void Remove(EntityComponent component) Parameters component EntityComponent RemoveAll<T>() Removes all components of the specified type or derived type. public void RemoveAll<T>() where T : EntityComponent Type Parameters T Type of the component Remove<T>() Removes the first component of the specified type or derived type. public void Remove<T>() where T : EntityComponent Type Parameters T Type of the component ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Engine.EntityComponent.html": {
    "href": "api/Stride.Engine.EntityComponent.html",
    "title": "Class EntityComponent | Stride API",
    "summary": "Class EntityComponent Namespace Stride.Engine Assembly Stride.Engine.dll Base class for Entity components. [DataSerializer(typeof(EntityComponent.Serializer))] [DataContract(Inherited = true)] [ComponentCategory(\"Miscellaneous\")] public abstract class EntityComponent : IIdentifiable Inheritance object EntityComponent Implements IIdentifiable Derived CollidableComponent ConstraintComponentBase ActivableEntityComponent AnimationComponent LightProbeComponent ModelNodeLinkComponent ScriptComponent TransformComponent UIElementLinkComponent NavigationBoundingBoxComponent NavigationComponent VideoComponent Extension Methods UnsafeUtilities.As<T>(object?) Properties EnsureEntity Gets the entity and throws an exception if the entity is null. protected Entity EnsureEntity { get; } Property Value Entity The entity. Exceptions InvalidOperationException Entity on this instance is null Entity Gets or sets the owner entity. public Entity Entity { get; } Property Value Entity The owner entity. Id The unique identifier of this component. [DataMember(-2147483648)] [Display(null, null, Browsable = false)] public Guid Id { get; set; } Property Value Guid"
  },
  "api/Stride.Engine.EntityComponentAttributeBase.html": {
    "href": "api/Stride.Engine.EntityComponentAttributeBase.html",
    "title": "Class EntityComponentAttributeBase | Stride API",
    "summary": "Class EntityComponentAttributeBase Namespace Stride.Engine Assembly Stride.Engine.dll Base class for attributes for EntityComponent [AttributeUsage(AttributeTargets.Class)] public abstract class EntityComponentAttributeBase : Attribute Inheritance object Attribute EntityComponentAttributeBase Derived AllowMultipleComponentsAttribute ComponentCategoryAttribute ComponentOrderAttribute RequireComponentAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) See Also Attribute"
  },
  "api/Stride.Engine.EntityComponentAttributes.html": {
    "href": "api/Stride.Engine.EntityComponentAttributes.html",
    "title": "Struct EntityComponentAttributes | Stride API",
    "summary": "Struct EntityComponentAttributes Namespace Stride.Engine Assembly Stride.Engine.dll Allow to query attributes used on an EntityComponent public struct EntityComponentAttributes Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AllowMultipleComponents Gets a boolean indicating whether the EntityComponent is supporting multiple components of the same type on an entity. public readonly bool AllowMultipleComponents Field Value bool Methods Get(Type) Gets the attributes for the specified type. public static EntityComponentAttributes Get(Type type) Parameters type Type The type of the component. Returns EntityComponentAttributes The attributes for the specified type. Exceptions ArgumentNullException ArgumentException The type must be of EntityComponent;type Get<T>() Gets the attributes for the specified type. public static EntityComponentAttributes Get<T>() where T : EntityComponent Returns EntityComponentAttributes The attributes for the specified type. Type Parameters T Type of the component"
  },
  "api/Stride.Engine.EntityComponentCollection.html": {
    "href": "api/Stride.Engine.EntityComponentCollection.html",
    "title": "Class EntityComponentCollection | Stride API",
    "summary": "Class EntityComponentCollection Namespace Stride.Engine Assembly Stride.Engine.dll A collection of EntityComponent managed exclusively by the Entity. [DataContract(\"EntityComponentCollection\")] public sealed class EntityComponentCollection : FastCollection<EntityComponent>, IList<EntityComponent>, ICollection<EntityComponent>, IReadOnlyList<EntityComponent>, IReadOnlyCollection<EntityComponent>, IEnumerable<EntityComponent>, IEnumerable Inheritance object FastCollection<EntityComponent> EntityComponentCollection Implements IList<EntityComponent> ICollection<EntityComponent> IReadOnlyList<EntityComponent> IReadOnlyCollection<EntityComponent> IEnumerable<EntityComponent> IEnumerable Inherited Members FastCollection<EntityComponent>.Capacity FastCollection<EntityComponent>.Count FastCollection<EntityComponent>.this[int] FastCollection<EntityComponent>.Add(EntityComponent) FastCollection<EntityComponent>.Clear() FastCollection<EntityComponent>.Contains(EntityComponent) FastCollection<EntityComponent>.CopyTo(EntityComponent[], int) FastCollection<EntityComponent>.IndexOf(EntityComponent) FastCollection<EntityComponent>.Insert(int, EntityComponent) FastCollection<EntityComponent>.Remove(EntityComponent) FastCollection<EntityComponent>.RemoveAt(int) FastCollection<EntityComponent>.AddRange<TE>(TE) FastCollection<EntityComponent>.GetEnumerator() FastCollection<EntityComponent>.Sort() FastCollection<EntityComponent>.Sort(IComparer<EntityComponent>) FastCollection<EntityComponent>.Sort(int, int, IComparer<EntityComponent>) FastCollection<EntityComponent>.IsReadOnly FastCollection<EntityComponent>.EnsureCapacity(int) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors EntityComponentCollection() public EntityComponentCollection() Methods ClearItems() protected override void ClearItems() GetAll<T>() Gets all the components of the specified type or derived type. public IEnumerable<T> GetAll<T>() where T : EntityComponent Returns IEnumerable<T> An iterator on the component matching the specified type Type Parameters T Type of the component Get<T>() Gets the first component of the specified type or derived type. public T Get<T>() where T : EntityComponent Returns T The first component or null if it was not found Type Parameters T Type of the component Get<T>(int) Gets the index'th component of the specified type or derived type. public T Get<T>(int index) where T : EntityComponent Parameters index int Index of the component of the same type Returns T The component or null if it was not found Type Parameters T Type of the component Remarks If index > 0, it will take the index'th component of the specified T. An index == 0 is equivalent to calling Get<T>() if index < 0, it will start from the end of the list to the beginning. A value of -1 means the first last component. InsertItem(int, EntityComponent) protected override void InsertItem(int index, EntityComponent item) Parameters index int item EntityComponent RemoveAll<T>() Removes all components of the specified type or derived type. public void RemoveAll<T>() where T : EntityComponent Type Parameters T Type of the component RemoveItem(int) protected override void RemoveItem(int index) Parameters index int Remove<T>() Removes the first component of the specified type or derived type. public void Remove<T>() where T : EntityComponent Type Parameters T Type of the component SetItem(int, EntityComponent) protected override void SetItem(int index, EntityComponent item) Parameters index int item EntityComponent"
  },
  "api/Stride.Engine.EntityExtensions.html": {
    "href": "api/Stride.Engine.EntityExtensions.html",
    "title": "Class EntityExtensions | Stride API",
    "summary": "Class EntityExtensions Namespace Stride.Engine Assembly Stride.Engine.dll Extensions for Entity public static class EntityExtensions Inheritance object EntityExtensions Methods Clone(Entity) Deep clone of this entity. public static Entity Clone(this Entity entity) Parameters entity Entity The entity to clone Returns Entity The cloned entity EnableAll(Entity, bool, bool) Enables or disables all ActivableEntityComponent. public static void EnableAll(this Entity entity, bool enabled = true, bool applyOnChildren = false) Parameters entity Entity The entity to apply this method. enabled bool If set to true, all ActivableEntityComponent will be enabled; otherwise they will be disabled applyOnChildren bool Recursively apply this method to the children of this entity Enable<T>(Entity, bool, bool) Enables or disables components of the specified type. public static void Enable<T>(this Entity entity, bool enabled = true, bool applyOnChildren = false) where T : ActivableEntityComponent Parameters entity Entity The entity to apply this method. enabled bool If set to true, all components of {T} will be enabled; otherwise they will be disabled applyOnChildren bool Recursively apply this method to the children of this entity Type Parameters T Type of the component GetChildren(Entity) Gets the children of this entity. public static IEnumerable<Entity> GetChildren(this Entity entity) Parameters entity Entity The entity Returns IEnumerable<Entity> An iteration on the child entity"
  },
  "api/Stride.Engine.EntityManager.html": {
    "href": "api/Stride.Engine.EntityManager.html",
    "title": "Class EntityManager | Stride API",
    "summary": "Class EntityManager Namespace Stride.Engine Assembly Stride.Engine.dll Manage a collection of entities. public abstract class EntityManager : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder, IReadOnlySet<Entity>, IReadOnlyCollection<Entity>, IEnumerable<Entity>, IEnumerable Inheritance object DisposeBase ComponentBase EntityManager Implements IDisposable IComponent IReferencable ICollectorHolder IReadOnlySet<Entity> IReadOnlyCollection<Entity> IEnumerable<Entity> IEnumerable Derived SceneInstance Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors EntityManager(IServiceRegistry) Initializes a new instance of the EntityManager class. protected EntityManager(IServiceRegistry registry) Parameters registry IServiceRegistry The registry. Exceptions ArgumentNullException registry Properties ComponentTypes Gets the list of component types from the entities.. public IEnumerable<TypeInfo> ComponentTypes { get; } Property Value IEnumerable<TypeInfo> The registered component types. Count Gets the number of elements in the collection. public int Count { get; } Property Value int The number of elements in the collection. ExecutionMode public ExecutionMode ExecutionMode { get; protected set; } Property Value ExecutionMode Processors Gets the entity Processors. public EntityProcessorCollection Processors { get; } Property Value EntityProcessorCollection Services Gets the services. public IServiceRegistry Services { get; } Property Value IServiceRegistry The services. Methods Contains(Entity) Determines whether this instance contains the specified entity. public bool Contains(Entity item) Parameters item Entity The item. Returns bool true if this instance contains the specified entity; otherwise, false. Draw(RenderContext) Calls Draw(RenderContext) on all enabled entity processors. public virtual void Draw(RenderContext context) Parameters context RenderContext The render context. GetEnumerator() Gets the Entity enumerator of this instance. public HashSet<Entity>.Enumerator GetEnumerator() Returns HashSet<Entity>.Enumerator The entity enumerator GetProcessor<TProcessor>() Gets the first processor of the type TProcessor. public TProcessor GetProcessor<TProcessor>() where TProcessor : EntityProcessor Returns TProcessor The first processor of type T or null if not found. Type Parameters TProcessor Type of the processor OnComponentChanged(Entity, int, EntityComponent, EntityComponent) protected virtual void OnComponentChanged(Entity entity, int index, EntityComponent previousComponent, EntityComponent newComponent) Parameters entity Entity index int previousComponent EntityComponent newComponent EntityComponent OnComponentTypeAdded(TypeInfo) protected virtual void OnComponentTypeAdded(TypeInfo obj) Parameters obj TypeInfo OnEntityAdded(Entity) protected virtual void OnEntityAdded(Entity e) Parameters e Entity OnEntityRemoved(Entity) protected virtual void OnEntityRemoved(Entity e) Parameters e Entity Remove(Entity) Removes the entity from the EntityManager. It works either entity has a parent or not. In conjonction with EntityProcessor, it will remove child entities as well. public void Remove(Entity entity) Parameters entity Entity The entity. Reset() Removes all entities from the EntityManager. protected virtual void Reset() Update(GameTime) public virtual void Update(GameTime gameTime) Parameters gameTime GameTime Events ComponentChanged Occurs when a component changed for an entity (Added or removed) public event EventHandler<EntityComponentEventArgs> ComponentChanged Event Type EventHandler<EntityComponentEventArgs> ComponentTypeAdded Occurs when a new component type is added. public event EventHandler<TypeInfo> ComponentTypeAdded Event Type EventHandler<TypeInfo> EntityAdded Occurs when an entity is added. public event EventHandler<Entity> EntityAdded Event Type EventHandler<Entity> EntityRemoved Occurs when an entity is removed. public event EventHandler<Entity> EntityRemoved Event Type EventHandler<Entity> HierarchyChanged Occurs when an entity is removed. public event EventHandler<Entity> HierarchyChanged Event Type EventHandler<Entity>"
  },
  "api/Stride.Engine.EntityProcessor-1.html": {
    "href": "api/Stride.Engine.EntityProcessor-1.html",
    "title": "Class EntityProcessor<TComponent> | Stride API",
    "summary": "Class EntityProcessor<TComponent> Namespace Stride.Engine Assembly Stride.Engine.dll Base implementation of EntityProcessor<TComponent, TData> when the TComponent and TData are the same public abstract class EntityProcessor<TComponent> : EntityProcessor<TComponent, TComponent> where TComponent : EntityComponent Type Parameters TComponent The main type of the component this processor is looking for. Inheritance object EntityProcessor EntityProcessor<TComponent, TComponent> EntityProcessor<TComponent> Derived AudioListenerProcessor CollidableProcessor ConstraintProcessor CameraProcessor InstanceProcessor LightShaftBoundingVolumeProcessor ModelNodeLinkProcessor ScriptProcessor TransformProcessor UIElementLinkProcessor PhysicsConstraintProcessor LightProbeProcessor UIProcessor Inherited Members EntityProcessor<TComponent, TComponent>.ComponentDatas EntityProcessor<TComponent, TComponent>.OnSystemAdd() EntityProcessor<TComponent, TComponent>.OnSystemRemove() EntityProcessor<TComponent, TComponent>.RemoveAllEntities() EntityProcessor<TComponent, TComponent>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<TComponent, TComponent>.GenerateComponentData(Entity, TComponent) EntityProcessor<TComponent, TComponent>.IsAssociatedDataValid(Entity, TComponent, TComponent) EntityProcessor<TComponent, TComponent>.OnEntityComponentAdding(Entity, TComponent, TComponent) EntityProcessor<TComponent, TComponent>.OnEntityComponentRemoved(Entity, TComponent, TComponent) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.Draw(RenderContext) EntityProcessor.OnSystemAdd() EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors EntityProcessor(params Type[]) protected EntityProcessor(params Type[] requiredAdditionalTypes) Parameters requiredAdditionalTypes Type[] Methods GenerateComponentData(Entity, TComponent) Generates associated data to the given entity. protected override TComponent GenerateComponentData(Entity entity, TComponent component) Parameters entity Entity The entity. component TComponent Returns TComponent The associated data. IsAssociatedDataValid(Entity, TComponent, TComponent) Checks if the current associated data is valid, or if readding the entity is required. protected override bool IsAssociatedDataValid(Entity entity, TComponent component, TComponent associatedData) Parameters entity Entity The entity. component TComponent associatedData TComponent The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise."
  },
  "api/Stride.Engine.EntityProcessor-2.html": {
    "href": "api/Stride.Engine.EntityProcessor-2.html",
    "title": "Class EntityProcessor<TComponent, TData> | Stride API",
    "summary": "Class EntityProcessor<TComponent, TData> Namespace Stride.Engine Assembly Stride.Engine.dll Helper class for EntityProcessor, that will keep track of Entity matching certain EntityComponent requirements. public abstract class EntityProcessor<TComponent, TData> : EntityProcessor where TComponent : EntityComponent where TData : class Type Parameters TComponent The main type of the component this processor is looking for. TData The type of the associated data. Inheritance object EntityProcessor EntityProcessor<TComponent, TData> Derived AnimationProcessor AudioEmitterProcessor EntityProcessor<TComponent> InstancingProcessor LightShaftProcessor ModelTransformProcessor NavigationProcessor ParticleSystemRenderProcessor PhysicsProcessor BackgroundRenderProcessor LightProcessor ModelRenderProcessor UIRenderProcessor VideoProcessor Inherited Members EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.Draw(RenderContext) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Remarks Additional precomputed data will be stored alongside the Entity to offer faster accesses and iterations. Constructors EntityProcessor(params Type[]) protected EntityProcessor(params Type[] requiredAdditionalTypes) Parameters requiredAdditionalTypes Type[] Fields ComponentDatas protected readonly Dictionary<TComponent, TData> ComponentDatas Field Value Dictionary<TComponent, TData> Methods GenerateComponentData(Entity, TComponent) Generates associated data to the given entity. protected abstract TData GenerateComponentData(Entity entity, TComponent component) Parameters entity Entity The entity. component TComponent Returns TData The associated data. IsAssociatedDataValid(Entity, TComponent, TData) Checks if the current associated data is valid, or if readding the entity is required. protected virtual bool IsAssociatedDataValid(Entity entity, TComponent component, TData associatedData) Parameters entity Entity The entity. component TComponent associatedData TData The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise. OnEntityComponentAdding(Entity, TComponent, TData) Run when a matching entity is added to this entity processor. protected virtual void OnEntityComponentAdding(Entity entity, TComponent component, TData data) Parameters entity Entity The entity. component TComponent data TData The associated data. OnEntityComponentRemoved(Entity, TComponent, TData) Run when a matching entity is removed from this entity processor. protected virtual void OnEntityComponentRemoved(Entity entity, TComponent component, TData data) Parameters entity Entity The entity. component TComponent data TData The associated data. OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd() OnSystemRemove() Run when this EntityProcessor is removed from an EntityManager. protected override void OnSystemRemove() ProcessEntityComponent(Entity, EntityComponent, bool) Checks if Entity needs to be either added or removed. protected override void ProcessEntityComponent(Entity entity, EntityComponent entityComponentArg, bool forceRemove) Parameters entity Entity The entity. entityComponentArg EntityComponent forceRemove bool RemoveAllEntities() Should be called prior removal, it will unregister all entities. protected override void RemoveAllEntities()"
  },
  "api/Stride.Engine.EntityProcessor.html": {
    "href": "api/Stride.Engine.EntityProcessor.html",
    "title": "Class EntityProcessor | Stride API",
    "summary": "Class EntityProcessor Namespace Stride.Engine Assembly Stride.Engine.dll Entity processor, triggered on various EntityManager events such as Entity and Component additions and removals. public abstract class EntityProcessor Inheritance object EntityProcessor Derived EntityProcessor<TComponent, TData> Extension Methods UnsafeUtilities.As<T>(object?) Constructors EntityProcessor(Type, Type[]) Initializes a new instance of the EntityProcessor class. protected EntityProcessor(Type mainComponentType, Type[] additionalTypes) Parameters mainComponentType Type Type of the main component. additionalTypes Type[] The additional types required by this processor. Exceptions ArgumentNullException If parameteters are null ArgumentException If a type does not inherit from EntityComponent Fields DrawProfilingState Draw Profiling state of this entity processor for the current frame. Pay attention this is a struct, use directly. Useful to add custom Mark events into processors public ProfilingState DrawProfilingState Field Value ProfilingState Tags Tags associated to this entity processor public PropertyContainer Tags Field Value PropertyContainer UpdateProfilingState Update Profiling state of this entity processor for the current frame. Pay attention this is a struct, use directly. Useful to add custom Mark events into processors public ProfilingState UpdateProfilingState Field Value ProfilingState Properties Enabled Gets or sets a value indicating whether this EntityProcessor is enabled. public bool Enabled { get; set; } Property Value bool EntityManager Gets the current entity manager. public EntityManager EntityManager { get; } Property Value EntityManager HasRequiredComponents Gets a value indicating whether this processor is requiring some components to be present in addition to the main component of MainComponentType. public bool HasRequiredComponents { get; } Property Value bool MainComponentType Gets the primary component type handled by this processor public Type MainComponentType { get; } Property Value Type Order Gets or sets the order of this processor. public int Order { get; protected set; } Property Value int RequiredTypes Gets the required components for an entity to be added to this entity processor. public TypeInfo[] RequiredTypes { get; } Property Value TypeInfo[] Services Gets the services. public IServiceRegistry Services { get; } Property Value IServiceRegistry Methods Draw(RenderContext) Performs work related to this processor. public virtual void Draw(RenderContext context) Parameters context RenderContext InternalAddEntity(Entity) Adds the entity to the internal list of the EntityManager. Exposed for inheriting class that has no access to SceneInstance as internal. protected void InternalAddEntity(Entity entity) Parameters entity Entity The entity. InternalRemoveEntity(Entity, bool) Removes the entity to the internal list of the EntityManager. Exposed for inheriting class that has no access to SceneInstance as internal. protected void InternalRemoveEntity(Entity entity, bool removeParent) Parameters entity Entity The entity. removeParent bool Indicate if entity should be removed from its parent OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected abstract void OnSystemAdd() OnSystemRemove() Run when this EntityProcessor is removed from an EntityManager. protected abstract void OnSystemRemove() ProcessEntityComponent(Entity, EntityComponent, bool) Checks if Entity needs to be either added or removed. protected abstract void ProcessEntityComponent(Entity entity, EntityComponent entityComponent, bool forceRemove) Parameters entity Entity The entity. entityComponent EntityComponent forceRemove bool RemoveAllEntities() Should be called prior removal, it will unregister all entities. protected abstract void RemoveAllEntities() Update(GameTime) Performs work related to this processor. public virtual void Update(GameTime time) Parameters time GameTime"
  },
  "api/Stride.Engine.EntityProcessorCollection.html": {
    "href": "api/Stride.Engine.EntityProcessorCollection.html",
    "title": "Class EntityProcessorCollection | Stride API",
    "summary": "Class EntityProcessorCollection Namespace Stride.Engine Assembly Stride.Engine.dll Ordered collection of EntityProcessor based on the Order property. public class EntityProcessorCollection : OrderedCollection<EntityProcessor>, ICollection<EntityProcessor>, IEnumerable<EntityProcessor>, IEnumerable Inheritance object OrderedCollection<EntityProcessor> EntityProcessorCollection Implements ICollection<EntityProcessor> IEnumerable<EntityProcessor> IEnumerable Inherited Members OrderedCollection<EntityProcessor>.Capacity OrderedCollection<EntityProcessor>.Count OrderedCollection<EntityProcessor>.this[int] OrderedCollection<EntityProcessor>.Add(EntityProcessor) OrderedCollection<EntityProcessor>.Clear() OrderedCollection<EntityProcessor>.Contains(EntityProcessor) OrderedCollection<EntityProcessor>.CopyTo(EntityProcessor[], int) OrderedCollection<EntityProcessor>.IndexOf(EntityProcessor) OrderedCollection<EntityProcessor>.Remove(EntityProcessor) OrderedCollection<EntityProcessor>.RemoveAt(int) OrderedCollection<EntityProcessor>.ClearItems() OrderedCollection<EntityProcessor>.AddItem(EntityProcessor) OrderedCollection<EntityProcessor>.RemoteItem(int) OrderedCollection<EntityProcessor>.AddRange<TE>(TE) OrderedCollection<EntityProcessor>.GetEnumerator() OrderedCollection<EntityProcessor>.IsReadOnly OrderedCollection<EntityProcessor>.EnsureCapacity(int) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors EntityProcessorCollection() Initializes a new instance of the EntityProcessorCollection class. public EntityProcessorCollection() EntityProcessorCollection(int) Initializes a new instance of the EntityProcessorCollection class. public EntityProcessorCollection(int capacity) Parameters capacity int The capacity. Methods Get<T>() Gets the first processor of the type T. public T Get<T>() where T : EntityProcessor Returns T The first processor of type T or null if not found. Type Parameters T Type of the processor See Also OrderedCollection<T>"
  },
  "api/Stride.Engine.EntityTransformExtensions.html": {
    "href": "api/Stride.Engine.EntityTransformExtensions.html",
    "title": "Class EntityTransformExtensions | Stride API",
    "summary": "Class EntityTransformExtensions Namespace Stride.Engine Assembly Stride.Engine.dll Extensions for Entity and the TransformComponent. public static class EntityTransformExtensions Inheritance object EntityTransformExtensions Methods AddChild(Entity, Entity) Adds a child Entity to the transform component of a parent Entity. public static void AddChild(this Entity parentEntity, Entity childEntity) Parameters parentEntity Entity The parent Entity. childEntity Entity The child parent Entity. Exceptions NullReferenceException childEntity is null NullReferenceException parentEntity is null FindChild(Entity, string) Returns the first child in the hierarchy with the provided name. This function can be slow, do not use every frame! public static Entity FindChild(this Entity parentEntity, string childName) Parameters parentEntity Entity The parent Entity. childName string The name of the child to look for. Returns Entity Null or the first child with the requested name. Exceptions ArgumentNullException parentEntity is null FindRoot(Entity) Returns the root of this Entity, or itself if it has no parent. public static Entity FindRoot(this Entity entity) Parameters entity Entity The entity. Returns Entity The root entity, or itself if it has no parent. Exceptions ArgumentNullException entity is null GetChild(Entity, int) Get the nth child of an Entity as stored in its TransformComponent. public static Entity GetChild(this Entity parentEntity, int index) Parameters parentEntity Entity The parent Entity. index int The child index. Returns Entity Exceptions NullReferenceException parentEntity is null GetParent(Entity) Returns the parent of this Entity as stored in its TransformComponent, or null if it has no parent. public static Entity GetParent(this Entity entity) Parameters entity Entity The entity. Returns Entity The parent entity, or null if it has no parent. Exceptions NullReferenceException entity is null GetWorldTransformation(TransformComponent, out Vector3, out Quaternion, out Vector3) Gets absolute world space position, rotation and scale of the given transform. public static void GetWorldTransformation(this TransformComponent transformComponent, out Vector3 position, out Quaternion rotation, out Vector3 scale) Parameters transformComponent TransformComponent The transform component. position Vector3 Output world space position. rotation Quaternion Output world space rotation. scale Vector3 Output world space scale. LocalToWorld(TransformComponent, Vector3) Performs transformation of the given point in local space to world space. public static Vector3 LocalToWorld(this TransformComponent transformComponent, Vector3 point) Parameters transformComponent TransformComponent The transform component. point Vector3 Local space point. Returns Vector3 World space point. LocalToWorld(TransformComponent, ref Vector3, ref Quaternion, ref Vector3) Performs transformation of the given transform in local space to world space. public static void LocalToWorld(this TransformComponent transformComponent, ref Vector3 position, ref Quaternion rotation, ref Vector3 scale) Parameters transformComponent TransformComponent The transform component. position Vector3 Input local space position transformed to world space. rotation Quaternion Input local space rotation transformed to world space. scale Vector3 Input local space scale transformed to world space. LocalToWorld(TransformComponent, ref Vector3, out Vector3) Performs transformation of the given point in local space to world space. public static void LocalToWorld(this TransformComponent transformComponent, ref Vector3 point, out Vector3 result) Parameters transformComponent TransformComponent The transform component. point Vector3 Local space point. result Vector3 World space point. RemoveChild(Entity, Entity) Removes a child Entity to the transform component of a parent Entity. Note that the child entity is still in the SceneInstance. In order to remove it from the scene instance, you should call Remove(myEntity) in Entities. public static void RemoveChild(this Entity parentEntity, Entity childEntity) Parameters parentEntity Entity The parent Entity. childEntity Entity The child Entity. Remarks Alternatively, you can remove an entity from the scene by setting myEntity.Scene = null. Exceptions NullReferenceException childEntity is null NullReferenceException parentEntity is null RemoveChild(Entity, Guid) Removes a child entity from the transform component of a parent Entity. public static void RemoveChild(this Entity parentEntity, Guid childId) Parameters parentEntity Entity The parent entity. childId Guid The child id of the child entity. Exceptions NullReferenceException parentEntity is null ArgumentException childId is Empty SetParent(Entity, Entity) Sets the parent of the TransformComponent of this Entity. If the parent is set to null, the enity gets removed from the scene graph. public static void SetParent(this Entity entity, Entity parent) Parameters entity Entity The entity. parent Entity The parent. Can be null SetWorld(TransformComponent, Quaternion) Set this Transform's world position and rotation based on the given parameters. public static void SetWorld(this TransformComponent transformComponent, Quaternion rotation) Parameters transformComponent TransformComponent The transform component. rotation Quaternion Input world space rotation. Remarks This conversion is lossy, getting the world position back won't match this input position. This method relies on this object's matrix which may be out of date if any of its parents moved since the last frame. If this is likely, you should call UpdateWorldMatrix() before calling this method. SetWorld(TransformComponent, Vector3) Set this Transform's world position and rotation based on the given parameters. public static void SetWorld(this TransformComponent transformComponent, Vector3 position) Parameters transformComponent TransformComponent The transform component. position Vector3 Input world space position. Remarks This conversion is lossy, getting the world position back won't match this input position. This method relies on this object's matrix which may be out of date if any of its parents moved since the last frame. If this is likely, you should call UpdateWorldMatrix() before calling this method. SetWorld(TransformComponent, Vector3, Quaternion) Set this Transform's world position and rotation based on the given parameters. public static void SetWorld(this TransformComponent transformComponent, Vector3 position, Quaternion rotation) Parameters transformComponent TransformComponent The transform component. position Vector3 Input world space position. rotation Quaternion Input world space rotation. Remarks This conversion is lossy, getting the world position back won't match this input position. This method relies on this object's matrix which may be out of date if any of its parents moved since the last frame. If this is likely, you should call UpdateWorldMatrix() before calling this method. WorldToLocal(TransformComponent, Vector3) Performs transformation of the given point in world space to local space. public static Vector3 WorldToLocal(this TransformComponent transformComponent, Vector3 point) Parameters transformComponent TransformComponent The transform component. point Vector3 World space point. Returns Vector3 Local space point. WorldToLocal(TransformComponent, ref Vector3, ref Quaternion, ref Vector3) Performs transformation of the given transform in world space to local space. public static void WorldToLocal(this TransformComponent transformComponent, ref Vector3 position, ref Quaternion rotation, ref Vector3 scale) Parameters transformComponent TransformComponent The transform component. position Vector3 Input world space position transformed to local space. rotation Quaternion Input world space rotation transformed to local space. scale Vector3 Input world space scale transformed to local space. WorldToLocal(TransformComponent, ref Vector3, out Vector3) Performs transformation of the given point in world space to local space. public static void WorldToLocal(this TransformComponent transformComponent, ref Vector3 point, out Vector3 result) Parameters transformComponent TransformComponent The transform component. point Vector3 World space point. result Vector3 Local space point."
  },
  "api/Stride.Engine.Events.EventData.html": {
    "href": "api/Stride.Engine.Events.EventData.html",
    "title": "Struct EventData | Stride API",
    "summary": "Struct EventData Namespace Stride.Engine.Events Assembly Stride.Engine.dll When using EventReceiver.ReceiveOne, this structure is used to contain the received data public struct EventData Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Data public readonly object Data { get; } Property Value object Receiver public readonly EventReceiverBase Receiver { get; } Property Value EventReceiverBase"
  },
  "api/Stride.Engine.Events.EventKey-1.html": {
    "href": "api/Stride.Engine.Events.EventKey-1.html",
    "title": "Class EventKey<T> | Stride API",
    "summary": "Class EventKey<T> Namespace Stride.Engine.Events Assembly Stride.Engine.dll public sealed class EventKey<T> : EventKeyBase<T>, IDisposable Type Parameters T Inheritance object EventKeyBase<T> EventKey<T> Implements IDisposable Inherited Members EventKeyBase<T>.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors EventKey(string, string) public EventKey(string category = \"General\", string eventName = \"Event\") Parameters category string eventName string Methods Broadcast(T) Broadcasts the event to all the receivers public void Broadcast(T data) Parameters data T"
  },
  "api/Stride.Engine.Events.EventKey.html": {
    "href": "api/Stride.Engine.Events.EventKey.html",
    "title": "Class EventKey | Stride API",
    "summary": "Class EventKey Namespace Stride.Engine.Events Assembly Stride.Engine.dll Creates a new EventKey used to broadcast events. public sealed class EventKey : EventKeyBase<bool>, IDisposable Inheritance object EventKeyBase<bool> EventKey Implements IDisposable Inherited Members EventKeyBase<bool>.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors EventKey(string, string) public EventKey(string category = \"General\", string eventName = \"Event\") Parameters category string eventName string Methods Broadcast() Broadcasts the event to all the receivers public void Broadcast()"
  },
  "api/Stride.Engine.Events.EventKeyBase-1.html": {
    "href": "api/Stride.Engine.Events.EventKeyBase-1.html",
    "title": "Class EventKeyBase<T> | Stride API",
    "summary": "Class EventKeyBase<T> Namespace Stride.Engine.Events Assembly Stride.Engine.dll Creates a new EventKey used to broadcast T type events. public class EventKeyBase<T> : IDisposable Type Parameters T The data type of the event you wish to send Inheritance object EventKeyBase<T> Implements IDisposable Derived EventKey EventKey<T> Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() ~EventKeyBase() protected ~EventKeyBase() InternalBroadcast(T) protected void InternalBroadcast(T data) Parameters data T"
  },
  "api/Stride.Engine.Events.EventReceiver-1.html": {
    "href": "api/Stride.Engine.Events.EventReceiver-1.html",
    "title": "Class EventReceiver<T> | Stride API",
    "summary": "Class EventReceiver<T> Namespace Stride.Engine.Events Assembly Stride.Engine.dll Creates an event receiver that is used to receive T type events from an EventKey public sealed class EventReceiver<T> : EventReceiverBase<T>, IDisposable Type Parameters T The type of data the EventKey will send Inheritance object EventReceiverBase EventReceiverBase<T> EventReceiver<T> Implements IDisposable Inherited Members EventReceiverBase<T>.Key EventReceiverBase<T>.GetAwaiter() EventReceiverBase<T>.Count EventReceiverBase<T>.Reset() EventReceiverBase<T>.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors EventReceiver(EventKey<T>, EventReceiverOptions) Creates an event receiver, ready to receive broadcasts from the key public EventReceiver(EventKey<T> key, EventReceiverOptions options = EventReceiverOptions.None) Parameters key EventKey<T> The event key to listen from options EventReceiverOptions Option flags Methods ReceiveAsync() Awaits a single event public Task<T> ReceiveAsync() Returns Task<T> TryReceive(out T) Receives one event from the buffer, useful specially in Sync scripts public bool TryReceive(out T data) Parameters data T Returns bool TryReceiveAll(ICollection<T>) Receives all the events from the queue (if buffered was true during creations), useful mostly only in Sync scripts public int TryReceiveAll(ICollection<T> collection) Parameters collection ICollection<T> Returns int"
  },
  "api/Stride.Engine.Events.EventReceiver.html": {
    "href": "api/Stride.Engine.Events.EventReceiver.html",
    "title": "Class EventReceiver | Stride API",
    "summary": "Class EventReceiver Namespace Stride.Engine.Events Assembly Stride.Engine.dll Creates an event receiver that is used to receive events from an EventKey public sealed class EventReceiver : EventReceiverBase<bool>, IDisposable Inheritance object EventReceiverBase EventReceiverBase<bool> EventReceiver Implements IDisposable Inherited Members EventReceiverBase<bool>.Key EventReceiverBase<bool>.GetAwaiter() EventReceiverBase<bool>.Count EventReceiverBase<bool>.Reset() EventReceiverBase<bool>.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors EventReceiver(EventKey, EventReceiverOptions) Initializes a new instance of the EventReceiver class. Creates an event receiver, ready to receive broadcasts from the key. public EventReceiver(EventKey key, EventReceiverOptions options = EventReceiverOptions.None) Parameters key EventKey The event key to listen from options EventReceiverOptions Option flags Methods ReceiveAsync() Awaits a single event public Task ReceiveAsync() Returns Task ReceiveOne(params EventReceiverBase[]) Combines multiple receivers in one call and tries to receive the first available events among all the passed receivers public static Task<EventData> ReceiveOne(params EventReceiverBase[] events) Parameters events EventReceiverBase[] The events you want to listen to Returns Task<EventData> TryReceive() Receives one event from the buffer, useful specially in Sync scripts public bool TryReceive() Returns bool TryReceiveAll() Receives all the events from the queue (if buffered was true during creations), useful mostly only in Sync scripts public int TryReceiveAll() Returns int"
  },
  "api/Stride.Engine.Events.EventReceiverAwaiter-1.html": {
    "href": "api/Stride.Engine.Events.EventReceiverAwaiter-1.html",
    "title": "Struct EventReceiverAwaiter<T> | Stride API",
    "summary": "Struct EventReceiverAwaiter<T> Namespace Stride.Engine.Events Assembly Stride.Engine.dll public struct EventReceiverAwaiter<T> : INotifyCompletion Type Parameters T Implements INotifyCompletion Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors EventReceiverAwaiter(TaskAwaiter<T>) public EventReceiverAwaiter(TaskAwaiter<T> task) Parameters task TaskAwaiter<T> Properties IsCompleted public bool IsCompleted { get; } Property Value bool Methods GetResult() public T GetResult() Returns T OnCompleted(Action) Schedules the continuation action that's invoked when the instance completes. public void OnCompleted(Action continuation) Parameters continuation Action The action to invoke when the operation completes. Exceptions ArgumentNullException The continuation argument is null (Nothing in Visual Basic)."
  },
  "api/Stride.Engine.Events.EventReceiverBase-1.html": {
    "href": "api/Stride.Engine.Events.EventReceiverBase-1.html",
    "title": "Class EventReceiverBase<T> | Stride API",
    "summary": "Class EventReceiverBase<T> Namespace Stride.Engine.Events Assembly Stride.Engine.dll Base type for EventReceiver. public class EventReceiverBase<T> : EventReceiverBase, IDisposable Type Parameters T The type of data the EventKey will send Inheritance object EventReceiverBase EventReceiverBase<T> Implements IDisposable Derived EventReceiver EventReceiver<T> Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties Count Returns the count of currently buffered events public int Count { get; } Property Value int Key public EventKeyBase<T> Key { get; } Property Value EventKeyBase<T> Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() ~EventReceiverBase() protected ~EventReceiverBase() GetAwaiter() public EventReceiverAwaiter<T> GetAwaiter() Returns EventReceiverAwaiter<T> InternalReceiveAsync() protected Task<T> InternalReceiveAsync() Returns Task<T> InternalTryReceive(out T) protected bool InternalTryReceive(out T data) Parameters data T Returns bool InternalTryReceiveAll(ICollection<T>) protected int InternalTryReceiveAll(ICollection<T> collection) Parameters collection ICollection<T> Returns int Reset() Clears all currently buffered events. public void Reset()"
  },
  "api/Stride.Engine.Events.EventReceiverBase.html": {
    "href": "api/Stride.Engine.Events.EventReceiverBase.html",
    "title": "Class EventReceiverBase | Stride API",
    "summary": "Class EventReceiverBase Namespace Stride.Engine.Events Assembly Stride.Engine.dll Base class for EventReceivers public abstract class EventReceiverBase Inheritance object EventReceiverBase Derived EventReceiverBase<T> Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Engine.Events.EventReceiverOptions.html": {
    "href": "api/Stride.Engine.Events.EventReceiverOptions.html",
    "title": "Enum EventReceiverOptions | Stride API",
    "summary": "Enum EventReceiverOptions Namespace Stride.Engine.Events Assembly Stride.Engine.dll Options related to EventReceiver might be extended in the future [Flags] public enum EventReceiverOptions Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Buffered = 1 If this flag is present the events will be buffered into a queue, receivers might decide to consume at any pace they wish as long as they consume them at some point None = 0 If no flags are present only the most recent event will be buffered"
  },
  "api/Stride.Engine.Events.html": {
    "href": "api/Stride.Engine.Events.html",
    "title": "Namespace Stride.Engine.Events | Stride API",
    "summary": "Namespace Stride.Engine.Events Classes EventKey Creates a new EventKey used to broadcast events. EventKeyBase<T> Creates a new EventKey used to broadcast T type events. EventKey<T> EventReceiver Creates an event receiver that is used to receive events from an EventKey EventReceiverBase Base class for EventReceivers EventReceiverBase<T> Base type for EventReceiver. EventReceiver<T> Creates an event receiver that is used to receive T type events from an EventKey Structs EventData When using EventReceiver.ReceiveOne, this structure is used to contain the received data EventReceiverAwaiter<T> Enums EventReceiverOptions Options related to EventReceiver might be extended in the future"
  },
  "api/Stride.Engine.FlexibleProcessing.IComponent-2.IProcessor.html": {
    "href": "api/Stride.Engine.FlexibleProcessing.IComponent-2.IProcessor.html",
    "title": "Interface IComponent<TProcessor, TThis>.IProcessor | Stride API",
    "summary": "Interface IComponent<TProcessor, TThis>.IProcessor Namespace Stride.Engine.FlexibleProcessing Assembly Stride.Engine.dll public interface IComponent<TProcessor, TThis>.IProcessor : IProcessorBase Inherited Members IProcessorBase.ExecutionMode IProcessorBase.SystemAdded(IServiceRegistry) IProcessorBase.SystemRemoved() IProcessorBase.OnComponentAdded(IMarkedComponent) IProcessorBase.OnComponentRemoved(IMarkedComponent) Extension Methods UnsafeUtilities.As<T>(object?) Methods OnComponentAdded(TThis) Occurs right after a component is added to the scene void OnComponentAdded(TThis item) Parameters item TThis OnComponentRemoved(TThis) Occurs right after a component is removed from the scene void OnComponentRemoved(TThis item) Parameters item TThis"
  },
  "api/Stride.Engine.FlexibleProcessing.IComponent-2.html": {
    "href": "api/Stride.Engine.FlexibleProcessing.IComponent-2.html",
    "title": "Interface IComponent<TProcessor, TThis> | Stride API",
    "summary": "Interface IComponent<TProcessor, TThis> Namespace Stride.Engine.FlexibleProcessing Assembly Stride.Engine.dll Defines a Processor/component or system/component relationship, EntityComponent implementing this interface will be sent to the TProcessor defined. Enabling component addition and removal tracking as well as batching operations over components. public interface IComponent<TProcessor, TThis> : IMarkedComponent where TProcessor : IComponent<TProcessor, TThis>.IProcessor, new() where TThis : IComponent<TProcessor, TThis> Type Parameters TProcessor The system which collects those components and iterates over them TThis The type name implementing this interface Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Engine.FlexibleProcessing.IDrawProcessor.html": {
    "href": "api/Stride.Engine.FlexibleProcessing.IDrawProcessor.html",
    "title": "Interface IDrawProcessor | Stride API",
    "summary": "Interface IDrawProcessor Namespace Stride.Engine.FlexibleProcessing Assembly Stride.Engine.dll public interface IDrawProcessor Extension Methods UnsafeUtilities.As<T>(object?) Properties Order The order of the processor, smaller values execute first int Order { get; } Property Value int Remarks Only evaluated once after instantiation Methods Draw(RenderContext) void Draw(RenderContext context) Parameters context RenderContext"
  },
  "api/Stride.Engine.FlexibleProcessing.IMarkedComponent.html": {
    "href": "api/Stride.Engine.FlexibleProcessing.IMarkedComponent.html",
    "title": "Interface IMarkedComponent | Stride API",
    "summary": "Interface IMarkedComponent Namespace Stride.Engine.FlexibleProcessing Assembly Stride.Engine.dll Dummy interface used to quickly filter out components that aren't marked for processing, do not use. public interface IMarkedComponent Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Engine.FlexibleProcessing.IProcessorBase.html": {
    "href": "api/Stride.Engine.FlexibleProcessing.IProcessorBase.html",
    "title": "Interface IProcessorBase | Stride API",
    "summary": "Interface IProcessorBase Namespace Stride.Engine.FlexibleProcessing Assembly Stride.Engine.dll public interface IProcessorBase Extension Methods UnsafeUtilities.As<T>(object?) Properties ExecutionMode The logic using this value expects it to be constant at runtime ExecutionMode ExecutionMode { get; } Property Value ExecutionMode Methods OnComponentAdded(IMarkedComponent) Occurs right after a component is added to the scene void OnComponentAdded(IMarkedComponent comp) Parameters comp IMarkedComponent OnComponentRemoved(IMarkedComponent) Occurs right after a component is removed from the scene void OnComponentRemoved(IMarkedComponent comp) Parameters comp IMarkedComponent SystemAdded(IServiceRegistry) Occurs right after the first component handled by this processor is added to the scene, but before OnComponentAdded(IMarkedComponent) void SystemAdded(IServiceRegistry registryParam) Parameters registryParam IServiceRegistry SystemRemoved() Occurs right after the last component handled by this processor is removed from the scene, after the call to OnComponentRemoved(IMarkedComponent) void SystemRemoved()"
  },
  "api/Stride.Engine.FlexibleProcessing.IUpdateProcessor.html": {
    "href": "api/Stride.Engine.FlexibleProcessing.IUpdateProcessor.html",
    "title": "Interface IUpdateProcessor | Stride API",
    "summary": "Interface IUpdateProcessor Namespace Stride.Engine.FlexibleProcessing Assembly Stride.Engine.dll public interface IUpdateProcessor Extension Methods UnsafeUtilities.As<T>(object?) Properties Order The order of the processor, smaller values execute first int Order { get; } Property Value int Remarks Only evaluated once after instantiation Methods Update(GameTime) void Update(GameTime gameTime) Parameters gameTime GameTime"
  },
  "api/Stride.Engine.FlexibleProcessing.ProcessorManager.html": {
    "href": "api/Stride.Engine.FlexibleProcessing.ProcessorManager.html",
    "title": "Class ProcessorManager | Stride API",
    "summary": "Class ProcessorManager Namespace Stride.Engine.FlexibleProcessing Assembly Stride.Engine.dll public class ProcessorManager Inheritance object ProcessorManager Extension Methods UnsafeUtilities.As<T>(object?) Constructors ProcessorManager(IServiceRegistry) public ProcessorManager(IServiceRegistry registryParam) Parameters registryParam IServiceRegistry Methods Draw(RenderContext) public void Draw(RenderContext context) Parameters context RenderContext IntroduceComponent(EntityComponent, ExecutionMode) public void IntroduceComponent(EntityComponent _component, ExecutionMode executionMode) Parameters _component EntityComponent executionMode ExecutionMode RemoveComponent(EntityComponent, ExecutionMode) public void RemoveComponent(EntityComponent _component, ExecutionMode executionMode) Parameters _component EntityComponent executionMode ExecutionMode Update(GameTime) public void Update(GameTime gameTime) Parameters gameTime GameTime"
  },
  "api/Stride.Engine.FlexibleProcessing.html": {
    "href": "api/Stride.Engine.FlexibleProcessing.html",
    "title": "Namespace Stride.Engine.FlexibleProcessing | Stride API",
    "summary": "Namespace Stride.Engine.FlexibleProcessing Classes ProcessorManager Interfaces IComponent<TProcessor, TThis> Defines a Processor/component or system/component relationship, EntityComponent implementing this interface will be sent to the TProcessor defined. Enabling component addition and removal tracking as well as batching operations over components. IComponent<TProcessor, TThis>.IProcessor IDrawProcessor IMarkedComponent Dummy interface used to quickly filter out components that aren't marked for processing, do not use. IProcessorBase IUpdateProcessor"
  },
  "api/Stride.Engine.Game.html": {
    "href": "api/Stride.Engine.Game.html",
    "title": "Class Game | Stride API",
    "summary": "Class Game Namespace Stride.Engine Assembly Stride.Engine.dll Main Game class system. public class Game : GameBase, IDisposable, IComponent, IReferencable, ICollectorHolder, IGame, ISceneRendererContext, IGameSettingsService Inheritance object DisposeBase ComponentBase GameBase Game Implements IDisposable IComponent IReferencable ICollectorHolder IGame ISceneRendererContext IGameSettingsService Inherited Members GameBase.graphicsDeviceManager GameBase.Log GameBase.Activated GameBase.Deactivated GameBase.Exiting GameBase.WindowCreated GameBase.UnhandledException GameBase.UpdateTime GameBase.DrawTime GameBase.DrawInterpolationFactor GameBase.Content GameBase.GameSystems GameBase.Context GameBase.GraphicsDevice GameBase.GraphicsContext GameBase.InactiveSleepTime GameBase.IsActive GameBase.IsExiting GameBase.IsFixedTimeStep GameBase.ForceOneUpdatePerDraw GameBase.MakeWindowVisibleOnRun GameBase.IsDrawDesynchronized GameBase.IsMouseVisible GameBase.LaunchParameters GameBase.IsRunning GameBase.Services GameBase.TargetElapsedTime GameBase.WindowMinimumUpdateRate GameBase.MinimizedMinimumUpdateRate GameBase.TreatNotFocusedLikeMinimized GameBase.DrawWhileMinimized GameBase.Window GameBase.FullPlatformName GameBase.Exit() GameBase.ResetElapsedTime() GameBase.Run(GameContext) GameBase.SuppressDraw() GameBase.Tick() GameBase.RawTickProducer() GameBase.RawTick(TimeSpan, int, float, bool) GameBase.BeginRun() GameBase.EndRun() GameBase.BeginDraw() GameBase.Draw(GameTime) GameBase.Update(GameTime) GameBase.OnActivated(object, EventArgs) GameBase.OnDeactivated(object, EventArgs) GameBase.OnExiting(object, EventArgs) GameBase.OnWindowCreated() GameBase.ShowMissingRequirementMessage(Exception) GameBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors Game() Initializes a new instance of the Game class. public Game() Properties Audio Gets the audio system. public AudioSystem Audio { get; } Property Value AudioSystem The audio. AutoLoadDefaultSettings Automatically initializes game settings like default scene, resolution, graphics profile. public bool AutoLoadDefaultSettings { get; set; } Property Value bool ConsoleLogLevel Gets or sets the default console log level. public LogMessageType ConsoleLogLevel { get; set; } Property Value LogMessageType The console log level. ConsoleLogMode Gets or sets the console log mode. See remarks. public ConsoleLogMode ConsoleLogMode { get; set; } Property Value ConsoleLogMode The console log mode. Remarks Defines how the console will be displayed when running the game. By default, on Windows, It will open only on debug if there are any messages logged. DebugTextSystem Gets the game profiler system. public DebugTextSystem DebugTextSystem { get; } Property Value DebugTextSystem EffectSystem Gets the effect system. public EffectSystem EffectSystem { get; } Property Value EffectSystem The effect system. Font Gets the font system. public IFontFactory Font { get; } Property Value IFontFactory The font system. Exceptions InvalidOperationException The font system is not initialized yet GraphicsDeviceManager Gets the graphics device manager. public GraphicsDeviceManager GraphicsDeviceManager { get; } Property Value GraphicsDeviceManager The graphics device manager. Input Gets the input manager. public InputManager Input { get; } Property Value InputManager The input. ProfilingSystem Gets the game profiler system. public GameProfilingSystem ProfilingSystem { get; } Property Value GameProfilingSystem SceneSystem Gets the scene system. public SceneSystem SceneSystem { get; } Property Value SceneSystem The scene system. Script Gets the script system. public ScriptSystem Script { get; } Property Value ScriptSystem The script. Settings Readonly game settings as defined in the GameSettings asset Please note that it will be populated during initialization It will be ok to read them after the GameStarted event or after initialization public GameSettings Settings { get; } Property Value GameSettings SpriteAnimation Gets the sprite animation system. public SpriteAnimationSystem SpriteAnimation { get; } Property Value SpriteAnimationSystem The sprite animation system. Streaming Gets the streaming system. public StreamingManager Streaming { get; } Property Value StreamingManager The streaming system. VRDeviceSystem Gets the VR Device System. public VRDeviceSystem VRDeviceSystem { get; } Property Value VRDeviceSystem Methods ConfirmRenderingSettings(bool) public override void ConfirmRenderingSettings(bool gameCreation) Parameters gameCreation bool Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. EndDraw(bool) Ends the drawing of a frame. This method will always be preceeded by calls to BeginDraw() and perhaps Draw(GameTime) depending on if we had to do so. protected override void EndDraw(bool present) Parameters present bool GetLogListener() protected virtual LogListener GetLogListener() Returns LogListener Initialize() Called after the Game is created, but before GraphicsDevice is available and before LoadContent(). Reference page contains code sample. protected override void Initialize() LoadContent() Loads the content. protected virtual Task LoadContent() Returns Task PrepareContext() Creates or updates Context before window and device are created. protected override void PrepareContext() Events GameDestroyed Static event that will be fired when a game is destroyed public static event EventHandler GameDestroyed Event Type EventHandler GameStarted Static event that will be fired when a game is initialized public static event EventHandler GameStarted Event Type EventHandler"
  },
  "api/Stride.Engine.GameSystem.html": {
    "href": "api/Stride.Engine.GameSystem.html",
    "title": "Class GameSystem | Stride API",
    "summary": "Class GameSystem Namespace Stride.Engine Assembly Stride.Engine.dll public abstract class GameSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase GameSystem Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Derived DynamicNavigationMeshSystem Bullet2PhysicsSystem PhysicsShapesRenderingService Inherited Members GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.Draw(GameTime) GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.Initialize() GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Update(GameTime) GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) GameSystemBase.LoadContent() GameSystemBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors GameSystem(IServiceRegistry) protected GameSystem(IServiceRegistry registry) Parameters registry IServiceRegistry Properties Game Gets the Game associated with this GameSystemBase. This value can be null in a mock environment. public Game Game { get; } Property Value Game The game. Remarks This value can be null"
  },
  "api/Stride.Engine.Gizmos.GizmoComponentAttribute.html": {
    "href": "api/Stride.Engine.Gizmos.GizmoComponentAttribute.html",
    "title": "Class GizmoComponentAttribute | Stride API",
    "summary": "Class GizmoComponentAttribute Namespace Stride.Engine.Gizmos Assembly Stride.Engine.dll Specifies for which component the associated gizmo class is. public class GizmoComponentAttribute : Attribute Inheritance object Attribute GizmoComponentAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors GizmoComponentAttribute(Type, bool) Initializes a new instance of the GizmoComponentAttribute class. public GizmoComponentAttribute(Type componentType, bool isMainGizmo) Parameters componentType Type The type of component the related gizmo class is associated with. isMainGizmo bool Indicates whether this gizmo is a main gizmo. Properties ComponentType Gets or sets the type of component the related gizmo class is associated with. public Type ComponentType { get; set; } Property Value Type IsMainGizmo Gets or sets whether this gizmo is a main gizmo. An entity will display only one of its main gizmo, corresponding to the component that has the highest priority set in its DisplayAttribute. public bool IsMainGizmo { get; set; } Property Value bool Remarks Main gizmos will be entirely disposed instead of disabled if disabled in the gizmo settings"
  },
  "api/Stride.Engine.Gizmos.IEntityGizmo.html": {
    "href": "api/Stride.Engine.Gizmos.IEntityGizmo.html",
    "title": "Interface IEntityGizmo | Stride API",
    "summary": "Interface IEntityGizmo Namespace Stride.Engine.Gizmos Assembly Stride.Engine.dll An interface creating and managing an editor gizmo for a particular EntityComponent public interface IEntityGizmo : IGizmo, IDisposable Inherited Members IGizmo.IsEnabled IGizmo.SizeFactor IGizmo.HandlesComponentId(OpaqueComponentId, out Entity) IGizmo.Initialize(IServiceRegistry, Scene) IDisposable.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks The implementer must have a GizmoComponentAttribute attach and the constructor of said class must have exactly one argument of the type of component specified in the attribute. Fields PickingRenderGroup Render group used for scene picking, set your model to use this render group when you want mouse selection to work on your models public const RenderGroup PickingRenderGroup = Group0 Field Value RenderGroup Remarks Your HandlesComponentId(OpaqueComponentId, out Entity) takes care of confirming to the engine that the picked component is yours Properties IsSelected Gets or sets the selected state of the gizmo. bool IsSelected { get; set; } Property Value bool Methods Update() Updates the gizmo state. void Update()"
  },
  "api/Stride.Engine.Gizmos.IGizmo.html": {
    "href": "api/Stride.Engine.Gizmos.IGizmo.html",
    "title": "Interface IGizmo | Stride API",
    "summary": "Interface IGizmo Namespace Stride.Engine.Gizmos Assembly Stride.Engine.dll The base interface for editor gizmos public interface IGizmo : IDisposable Inherited Members IDisposable.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties IsEnabled Gets or sets the enabled state of the gizmo. bool IsEnabled { get; set; } Property Value bool SizeFactor Gets or sets the size scale factor of the gizmo. float SizeFactor { get; set; } Property Value float Methods HandlesComponentId(OpaqueComponentId, out Entity) Used for picking gizmos on mouse down, returns true when that component was created by this gizmo bool HandlesComponentId(OpaqueComponentId pickedComponentId, out Entity selection) Parameters pickedComponentId OpaqueComponentId selection Entity Returns bool Initialize(IServiceRegistry, Scene) Initialize the gizmo. void Initialize(IServiceRegistry services, Scene editorScene) Parameters services IServiceRegistry editorScene Scene"
  },
  "api/Stride.Engine.Gizmos.html": {
    "href": "api/Stride.Engine.Gizmos.html",
    "title": "Namespace Stride.Engine.Gizmos | Stride API",
    "summary": "Namespace Stride.Engine.Gizmos Classes GizmoComponentAttribute Specifies for which component the associated gizmo class is. Interfaces IEntityGizmo An interface creating and managing an editor gizmo for a particular EntityComponent IGizmo The base interface for editor gizmos"
  },
  "api/Stride.Engine.IAnimatableSpriteProvider.html": {
    "href": "api/Stride.Engine.IAnimatableSpriteProvider.html",
    "title": "Interface IAnimatableSpriteProvider | Stride API",
    "summary": "Interface IAnimatableSpriteProvider Namespace Stride.Engine Assembly Stride.Rendering.dll The base interface for all classes providing animated sprites. public interface IAnimatableSpriteProvider : ISpriteProvider Inherited Members ISpriteProvider.SpritesCount ISpriteProvider.GetSprite() Extension Methods UnsafeUtilities.As<T>(object?) Properties CurrentFrame Gets or sets the current frame of the animation. int CurrentFrame { get; set; } Property Value int"
  },
  "api/Stride.Engine.IBlendTreeBuilder.html": {
    "href": "api/Stride.Engine.IBlendTreeBuilder.html",
    "title": "Interface IBlendTreeBuilder | Stride API",
    "summary": "Interface IBlendTreeBuilder Namespace Stride.Engine Assembly Stride.Engine.dll public interface IBlendTreeBuilder Extension Methods UnsafeUtilities.As<T>(object?) Methods BuildBlendTree(List<AnimationOperation>) void BuildBlendTree(List<AnimationOperation> animationList) Parameters animationList List<AnimationOperation>"
  },
  "api/Stride.Engine.IInstancing.html": {
    "href": "api/Stride.Engine.IInstancing.html",
    "title": "Interface IInstancing | Stride API",
    "summary": "Interface IInstancing Namespace Stride.Engine Assembly Stride.Engine.dll public interface IInstancing Extension Methods UnsafeUtilities.As<T>(object?) Properties BoundingBox BoundingBox BoundingBox { get; } Property Value BoundingBox InstanceCount int InstanceCount { get; } Property Value int ModelTransformUsage ModelTransformUsage ModelTransformUsage { get; } Property Value ModelTransformUsage Methods Update() void Update()"
  },
  "api/Stride.Engine.ISceneRendererContext.html": {
    "href": "api/Stride.Engine.ISceneRendererContext.html",
    "title": "Interface ISceneRendererContext | Stride API",
    "summary": "Interface ISceneRendererContext Namespace Stride.Engine Assembly Stride.Engine.dll public interface ISceneRendererContext Extension Methods UnsafeUtilities.As<T>(object?) Properties Content The content manager to load content. ContentManager Content { get; } Property Value ContentManager DrawTime GameTime DrawTime { get; } Property Value GameTime GameSystems The list of game systems. GameSystemCollection GameSystems { get; } Property Value GameSystemCollection GraphicsContext The graphics context used during draw. GraphicsContext GraphicsContext { get; } Property Value GraphicsContext GraphicsDevice The graphics device. GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice SceneSystem The current scene system. SceneSystem SceneSystem { get; } Property Value SceneSystem Services The service registry. ServiceRegistry Services { get; } Property Value ServiceRegistry"
  },
  "api/Stride.Engine.ISpriteProvider.html": {
    "href": "api/Stride.Engine.ISpriteProvider.html",
    "title": "Interface ISpriteProvider | Stride API",
    "summary": "Interface ISpriteProvider Namespace Stride.Engine Assembly Stride.Rendering.dll The base interface for all classes providing sprites. public interface ISpriteProvider Extension Methods UnsafeUtilities.As<T>(object?) Properties SpritesCount Gets the number of sprites available in the provider. int SpritesCount { get; } Property Value int Methods GetSprite() Get a sprite from the provider. Sprite GetSprite() Returns Sprite"
  },
  "api/Stride.Engine.InputSystem.html": {
    "href": "api/Stride.Engine.InputSystem.html",
    "title": "Class InputSystem | Stride API",
    "summary": "Class InputSystem Namespace Stride.Engine Assembly Stride.Engine.dll The input system updating the input manager exposed by Input. public sealed class InputSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase InputSystem Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Inherited Members GameSystemBase.Game GameSystemBase.Services GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.Draw(GameTime) GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Enabled GameSystemBase.UpdateOrder ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors InputSystem(IServiceRegistry) public InputSystem(IServiceRegistry registry) Parameters registry IServiceRegistry Fields DefaultUpdateOrder public const int DefaultUpdateOrder = -50 Field Value int Properties Manager public InputManager Manager { get; } Property Value InputManager Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. Initialize() Initializes the Game System. public override void Initialize() Remarks This method is called when the component is added to the Game. This can be used for tasks like querying for services the component needs and setting up non-graphics resources (as here the Graphics Device may have not been initialized yet). Update(GameTime) This method is called when this game component is updated. public override void Update(GameTime gameTime) Parameters gameTime GameTime The current timing."
  },
  "api/Stride.Engine.InstanceComponent.html": {
    "href": "api/Stride.Engine.InstanceComponent.html",
    "title": "Class InstanceComponent | Stride API",
    "summary": "Class InstanceComponent Namespace Stride.Engine Assembly Stride.Engine.dll Represents a single instance of a model instancing component. [DataContract(\"InstanceComponent\")] [Display(\"Instance\", null, Expand = ExpandRule.Once)] [ComponentCategory(\"Model\")] [DefaultEntityComponentProcessor(typeof(InstanceProcessor))] public sealed class InstanceComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent InstanceComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Properties Master Gets or sets the referenced InstancingComponent to instance. [DataMember(10)] [Display(\"Instancing\", null, Expand = ExpandRule.Always)] public InstancingComponent Master { get; set; } Property Value InstancingComponent The referenced InstancingComponent to instance. See Also ActivableEntityComponent"
  },
  "api/Stride.Engine.InstancingComponent.html": {
    "href": "api/Stride.Engine.InstancingComponent.html",
    "title": "Class InstancingComponent | Stride API",
    "summary": "Class InstancingComponent Namespace Stride.Engine Assembly Stride.Engine.dll [DataContract(\"InstancingComponent\")] [Display(\"Instancing\", null, Expand = ExpandRule.Once)] [ComponentCategory(\"Model\")] [DefaultEntityComponentRenderer(typeof(InstancingProcessor))] public sealed class InstancingComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent InstancingComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods InstancingExtensions.IsEntityTransform(InstancingComponent, out InstancingEntityTransform) UnsafeUtilities.As<T>(object?) Properties Type Gets or sets the type of the instancing. [DataMember(10)] [Display(\"Instancing Type\", null, Expand = ExpandRule.Always)] public IInstancing Type { get; set; } Property Value IInstancing The type of the instancing. Events InstancingChanged Occurs when the instancing changed. Used to notify instances to change their public event EventHandler<IInstancing> InstancingChanged Event Type EventHandler<IInstancing>"
  },
  "api/Stride.Engine.InstancingEntityTransform.html": {
    "href": "api/Stride.Engine.InstancingEntityTransform.html",
    "title": "Class InstancingEntityTransform | Stride API",
    "summary": "Class InstancingEntityTransform Namespace Stride.Engine Assembly Stride.Engine.dll [DataContract(\"InstancingEntityTransform\")] [Display(\"EntityTransform\", null)] public class InstancingEntityTransform : InstancingUserArray, IInstancing Inheritance object InstancingUserArray InstancingEntityTransform Implements IInstancing Inherited Members InstancingUserArray.InstanceCount InstancingUserArray.BoundingBox InstancingUserArray.WorldMatrices InstancingUserArray.WorldInverseMatrices InstancingUserArray.UpdateWorldMatrices(Matrix[], int) Extension Methods UnsafeUtilities.As<T>(object?) Properties ModelTransformUsage public override ModelTransformUsage ModelTransformUsage { get; } Property Value ModelTransformUsage Methods Update() public override void Update()"
  },
  "api/Stride.Engine.InstancingExtensions.html": {
    "href": "api/Stride.Engine.InstancingExtensions.html",
    "title": "Class InstancingExtensions | Stride API",
    "summary": "Class InstancingExtensions Namespace Stride.Engine Assembly Stride.Engine.dll public static class InstancingExtensions Inheritance object InstancingExtensions Methods IsEntityTransform(InstancingComponent, out InstancingEntityTransform) public static bool IsEntityTransform(this InstancingComponent component, out InstancingEntityTransform instancing) Parameters component InstancingComponent instancing InstancingEntityTransform Returns bool"
  },
  "api/Stride.Engine.InstancingUserArray.html": {
    "href": "api/Stride.Engine.InstancingUserArray.html",
    "title": "Class InstancingUserArray | Stride API",
    "summary": "Class InstancingUserArray Namespace Stride.Engine Assembly Stride.Engine.dll [DataContract(\"InstancingUserArray\")] [Display(\"UserArray\", null)] public class InstancingUserArray : IInstancing Inheritance object InstancingUserArray Implements IInstancing Derived InstancingEntityTransform Extension Methods UnsafeUtilities.As<T>(object?) Fields WorldInverseMatrices The inverse instance transformation matrices, updated automatically by the InstancingProcessor. public Matrix[] WorldInverseMatrices Field Value Matrix[] WorldMatrices The instance transformation matrices. public Matrix[] WorldMatrices Field Value Matrix[] Properties BoundingBox The bounding box of the world matrices, updated automatically by the InstancingProcessor. public virtual BoundingBox BoundingBox { get; } Property Value BoundingBox InstanceCount The instance count public virtual int InstanceCount { get; } Property Value int ModelTransformUsage [DataMember(10)] [Display(\"Model Transformation Usage\", null)] public virtual ModelTransformUsage ModelTransformUsage { get; set; } Property Value ModelTransformUsage Methods Update() public virtual void Update() UpdateWorldMatrices(Matrix[], int) Updates the world matrices. public void UpdateWorldMatrices(Matrix[] matrices, int instanceCount = -1) Parameters matrices Matrix[] The matrices. instanceCount int The instance count. When set to -1 the length if the matrices array is used"
  },
  "api/Stride.Engine.InstancingUserBuffer.html": {
    "href": "api/Stride.Engine.InstancingUserBuffer.html",
    "title": "Class InstancingUserBuffer | Stride API",
    "summary": "Class InstancingUserBuffer Namespace Stride.Engine Assembly Stride.Engine.dll [DataContract(\"InstancingUserBuffer\")] [Display(\"UserBuffer\", null)] public class InstancingUserBuffer : IInstancing Inheritance object InstancingUserBuffer Implements IInstancing Extension Methods UnsafeUtilities.As<T>(object?) Fields InstanceWorldBuffer public Buffer InstanceWorldBuffer Field Value Buffer InstanceWorldInverseBuffer public Buffer InstanceWorldInverseBuffer Field Value Buffer Properties BoundingBox The bounding box of the world matrices, updated automatically by the InstancingProcessor. public virtual BoundingBox BoundingBox { get; set; } Property Value BoundingBox InstanceCount The instance count public virtual int InstanceCount { get; set; } Property Value int ModelTransformUsage [DataMember(10)] [Display(\"Model Transformation Usage\", null)] public virtual ModelTransformUsage ModelTransformUsage { get; set; } Property Value ModelTransformUsage Methods Update() public void Update()"
  },
  "api/Stride.Engine.LightComponent.html": {
    "href": "api/Stride.Engine.LightComponent.html",
    "title": "Class LightComponent | Stride API",
    "summary": "Class LightComponent Namespace Stride.Engine Assembly Stride.Engine.dll Add a light to an Entity, that will be used during rendering. [DataContract(\"LightComponent\")] [Display(\"Light\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentRenderer(typeof(LightProcessor))] [ComponentOrder(12000)] [ComponentCategory(\"Lights\")] public sealed class LightComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent LightComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods LightComponentExtensions.GetColor(LightComponent) LightComponentExtensions.SetColor(LightComponent, Color3) UnsafeUtilities.As<T>(object?) Constructors LightComponent() Initializes a new instance of the LightComponent class. public LightComponent() Properties Intensity Gets or sets the light intensity. [DataMember(30)] public float Intensity { get; set; } Property Value float The light intensity. Type Gets or sets the type of the light. [DataMember(10)] [Display(\"Light\", null, Expand = ExpandRule.Always)] public ILight Type { get; set; } Property Value ILight The type of the light."
  },
  "api/Stride.Engine.LightComponentExtensions.html": {
    "href": "api/Stride.Engine.LightComponentExtensions.html",
    "title": "Class LightComponentExtensions | Stride API",
    "summary": "Class LightComponentExtensions Namespace Stride.Engine Assembly Stride.Engine.dll Extensions for the LightComponent class. public static class LightComponentExtensions Inheritance object LightComponentExtensions Methods GetColor(LightComponent) Gets the color from a LightComponent assuming that the Type is an instance of IColorLight public static Color3 GetColor(this LightComponent light) Parameters light LightComponent The light component. Returns Color3 The color of the light component Exceptions InvalidOperationException If the LightComponent doesn't contain a color light type IColorLight SetColor(LightComponent, Color3) Sets the color from a LightComponent assuming that the Type is an instance of IColorLight public static void SetColor(this LightComponent light, Color3 color) Parameters light LightComponent The light component. color Color3 The light color. Exceptions InvalidOperationException If the LightComponent doesn't contain a color light type IColorLight"
  },
  "api/Stride.Engine.LightProbeComponent.html": {
    "href": "api/Stride.Engine.LightProbeComponent.html",
    "title": "Class LightProbeComponent | Stride API",
    "summary": "Class LightProbeComponent Namespace Stride.Engine Assembly Stride.Engine.dll [DataContract(\"LightProbeComponent\")] [Display(\"Light probe\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentRenderer(typeof(LightProbeProcessor))] [ComponentOrder(15000)] [ComponentCategory(\"Lights\")] public class LightProbeComponent : EntityComponent, IIdentifiable Inheritance object EntityComponent LightProbeComponent Implements IIdentifiable Inherited Members EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties Coefficients [Display(null, null, Browsable = false)] public List<Color3> Coefficients { get; set; } Property Value List<Color3>"
  },
  "api/Stride.Engine.LightShaftBoundingVolumeComponent.html": {
    "href": "api/Stride.Engine.LightShaftBoundingVolumeComponent.html",
    "title": "Class LightShaftBoundingVolumeComponent | Stride API",
    "summary": "Class LightShaftBoundingVolumeComponent Namespace Stride.Engine Assembly Stride.Engine.dll A bounding volume for light shafts to be rendered in, can take any Model as a volume [Display(\"Light shaft bounding volume\", null, Expand = ExpandRule.Always)] [DataContract(\"LightShaftBoundingVolumeComponent\")] [DefaultEntityComponentProcessor(typeof(LightShaftBoundingVolumeProcessor))] [ComponentCategory(\"Lights\")] public class LightShaftBoundingVolumeComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent LightShaftBoundingVolumeComponent Implements IIdentifiable Inherited Members EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties Enabled Gets or sets a value indicating whether this EntityComponent is enabled. public override bool Enabled { get; set; } Property Value bool true if enabled; otherwise, false. LightShaft The light shaft to which the bounding volume applies public LightShaftComponent LightShaft { get; set; } Property Value LightShaftComponent Model The model used to define the bounding volume public Model Model { get; set; } Property Value Model Events EnabledChanged public event EventHandler EnabledChanged Event Type EventHandler LightShaftChanged public event EventHandler LightShaftChanged Event Type EventHandler ModelChanged public event EventHandler ModelChanged Event Type EventHandler"
  },
  "api/Stride.Engine.LightShaftComponent.html": {
    "href": "api/Stride.Engine.LightShaftComponent.html",
    "title": "Class LightShaftComponent | Stride API",
    "summary": "Class LightShaftComponent Namespace Stride.Engine Assembly Stride.Engine.dll The source for light shafts, should be placed on the same entity as the light component which will be used for light shafts [Display(\"Light shaft\", null, Expand = ExpandRule.Always)] [DataContract(\"LightShaftComponent\")] [DefaultEntityComponentRenderer(typeof(LightShaftProcessor))] [ComponentCategory(\"Lights\")] public class LightShaftComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent LightShaftComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties DensityFactor Density of the light shaft fog [Display(\"Density\", null)] public float DensityFactor { get; set; } Property Value float SampleCount Number of samples taken per pixel [DataMemberRange(1, 0)] public int SampleCount { get; set; } Property Value int SeparateBoundingVolumes If true, all bounding volumes will be drawn one by one. [Display(\"Process bounding volumes separately\", null)] public bool SeparateBoundingVolumes { get; set; } Property Value bool Remarks If this is off, the light shafts might be lower in quality if the bounding volumes overlap (in the same pixel). If this is on, and the bounding volumes overlap (in space), the light shafts inside the overlapping area will become twice as bright."
  },
  "api/Stride.Engine.ModelComponent.MeshInfo.html": {
    "href": "api/Stride.Engine.ModelComponent.MeshInfo.html",
    "title": "Class ModelComponent.MeshInfo | Stride API",
    "summary": "Class ModelComponent.MeshInfo Namespace Stride.Engine Assembly Stride.Engine.dll Per-entity state of each individual mesh of a model. public class ModelComponent.MeshInfo Inheritance object ModelComponent.MeshInfo Extension Methods UnsafeUtilities.As<T>(object?) Fields BlendMatrices The current blend matrices of a skinned meshes, transforming from mesh space to world space, for each bone. public Matrix[] BlendMatrices Field Value Matrix[] BoundingBox The meshes current bounding box in world space. public BoundingBox BoundingBox Field Value BoundingBox BoundingSphere The meshes current sphere box in world space. public BoundingSphere BoundingSphere Field Value BoundingSphere"
  },
  "api/Stride.Engine.ModelComponent.html": {
    "href": "api/Stride.Engine.ModelComponent.html",
    "title": "Class ModelComponent | Stride API",
    "summary": "Class ModelComponent Namespace Stride.Engine Assembly Stride.Engine.dll Add a Model to an Entity, that will be used during rendering. [DataContract(\"ModelComponent\")] [Display(\"Model\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentProcessor(typeof(ModelTransformProcessor))] [DefaultEntityComponentRenderer(typeof(ModelRenderProcessor))] [ComponentOrder(11000)] [ComponentCategory(\"Model\")] public sealed class ModelComponent : ActivableEntityComponent, IIdentifiable, IModelInstance Inheritance object EntityComponent ActivableEntityComponent ModelComponent Implements IIdentifiable IModelInstance Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors ModelComponent() Initializes a new instance of the ModelComponent class. public ModelComponent() ModelComponent(Model) Initializes a new instance of the ModelComponent class. public ModelComponent(Model model) Parameters model Model The model. Fields BoundingBox Gets the bounding box in world space. public BoundingBox BoundingBox Field Value BoundingBox The bounding box. BoundingSphere Gets the bounding sphere in world space. public BoundingSphere BoundingSphere Field Value BoundingSphere The bounding sphere. Properties IsShadowCaster Gets or sets a boolean indicating if this model component is casting shadows. [DataMember(30)] [Display(\"Cast shadows\", null)] public bool IsShadowCaster { get; set; } Property Value bool A boolean indicating if this model component is casting shadows. Materials Gets the materials; non-null ones will override materials from Materials (same slots should be used). [DataMember(40)] public IndexingDictionary<Material> Materials { get; } Property Value IndexingDictionary<Material> The materials overriding Materials ones. MeshInfos Gets the current per-entity state for each mesh in the associated model. public IReadOnlyList<ModelComponent.MeshInfo> MeshInfos { get; } Property Value IReadOnlyList<ModelComponent.MeshInfo> Model Gets or sets the model. [DataMember(10)] public Model Model { get; set; } Property Value Model The model. RenderGroup The render group for this component. [DataMember(20)] [Display(\"Render group\", null)] public RenderGroup RenderGroup { get; set; } Property Value RenderGroup Skeleton [DataMember] public SkeletonUpdater Skeleton { get; } Property Value SkeletonUpdater Methods GetMaterial(int) Gets the material at the specified index. If the material is not overriden by this component, it will try to get it from Materials public Material GetMaterial(int index) Parameters index int The index of the material Returns Material The material at the specified index or null if not found GetMaterialCount() Gets the number of materials (computed from Materials) public int GetMaterialCount() Returns int"
  },
  "api/Stride.Engine.ModelNodeLinkComponent.html": {
    "href": "api/Stride.Engine.ModelNodeLinkComponent.html",
    "title": "Class ModelNodeLinkComponent | Stride API",
    "summary": "Class ModelNodeLinkComponent Namespace Stride.Engine Assembly Stride.Engine.dll [DataContract(\"ModelNodeLinkComponent\")] [Display(\"Bone link\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentProcessor(typeof(ModelNodeLinkProcessor))] [ComponentOrder(1500)] [ComponentCategory(\"Model\")] public sealed class ModelNodeLinkComponent : EntityComponent, IIdentifiable Inheritance object EntityComponent ModelNodeLinkComponent Implements IIdentifiable Inherited Members EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Properties IsValid public bool IsValid { get; } Property Value bool NodeName Gets or sets the name of the node. [DataMember(20)] [Display(\"Bone\", null)] public string NodeName { get; set; } Property Value string The name of the node. Target Gets or sets the model which contains the hierarchy to use. [DataMember(10)] [Display(\"Model (parent if not set)\", null)] public ModelComponent Target { get; set; } Property Value ModelComponent The model which contains the hierarchy to use. Methods ValidityCheck() public void ValidityCheck() ValidityCheck(ModelComponent) public void ValidityCheck(ModelComponent targetToValidate) Parameters targetToValidate ModelComponent"
  },
  "api/Stride.Engine.ModelNodeTransformLink.html": {
    "href": "api/Stride.Engine.ModelNodeTransformLink.html",
    "title": "Class ModelNodeTransformLink | Stride API",
    "summary": "Class ModelNodeTransformLink Namespace Stride.Engine Assembly Stride.Engine.dll public class ModelNodeTransformLink : TransformLink Inheritance object TransformLink ModelNodeTransformLink Extension Methods UnsafeUtilities.As<T>(object?) Constructors ModelNodeTransformLink(ModelComponent, string) public ModelNodeTransformLink(ModelComponent parentModelComponent, string nodeName) Parameters parentModelComponent ModelComponent nodeName string Fields Transform public TransformTRS Transform Field Value TransformTRS Methods ComputeMatrix(bool, out Matrix) Compute a world matrix this link represents. public override void ComputeMatrix(bool recursive, out Matrix matrix) Parameters recursive bool matrix Matrix The computed world matrix. NeedsRecreate(Entity, string) public bool NeedsRecreate(Entity parentEntity, string targetNodeName) Parameters parentEntity Entity targetNodeName string Returns bool"
  },
  "api/Stride.Engine.ModelTransformUsage.html": {
    "href": "api/Stride.Engine.ModelTransformUsage.html",
    "title": "Enum ModelTransformUsage | Stride API",
    "summary": "Enum ModelTransformUsage Namespace Stride.Engine Assembly Stride.Engine.dll public enum ModelTransformUsage Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Ignore = 0 PostMultiply = 2 PreMultiply = 1"
  },
  "api/Stride.Engine.ModelViewHierarchyTransformOperation.html": {
    "href": "api/Stride.Engine.ModelViewHierarchyTransformOperation.html",
    "title": "Class ModelViewHierarchyTransformOperation | Stride API",
    "summary": "Class ModelViewHierarchyTransformOperation Namespace Stride.Engine Assembly Stride.Engine.dll Updates Skeleton. public class ModelViewHierarchyTransformOperation : TransformOperation Inheritance object TransformOperation ModelViewHierarchyTransformOperation Extension Methods UnsafeUtilities.As<T>(object?) Constructors ModelViewHierarchyTransformOperation(ModelComponent) public ModelViewHierarchyTransformOperation(ModelComponent modelComponent) Parameters modelComponent ModelComponent Fields ModelComponent public readonly ModelComponent ModelComponent Field Value ModelComponent Methods Process(TransformComponent) public override void Process(TransformComponent transformComponent) Parameters transformComponent TransformComponent"
  },
  "api/Stride.Engine.Network.ClientRouterMessage.html": {
    "href": "api/Stride.Engine.Network.ClientRouterMessage.html",
    "title": "Enum ClientRouterMessage | Stride API",
    "summary": "Enum ClientRouterMessage Namespace Stride.Engine.Network Assembly Stride.Engine.dll Message exchanged between client and router. Note: shouldn't collide with RouterMessage. public enum ClientRouterMessage : ushort Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields RequestServer = 0 ServerStarted = 1"
  },
  "api/Stride.Engine.Network.ExceptionMessage.html": {
    "href": "api/Stride.Engine.Network.ExceptionMessage.html",
    "title": "Class ExceptionMessage | Stride API",
    "summary": "Class ExceptionMessage Namespace Stride.Engine.Network Assembly Stride.Engine.dll In the case of a SocketMessage when we use it in a SendReceiveAsync we want to propagate exceptions from the remote host public class ExceptionMessage : SocketMessage Inheritance object SocketMessage ExceptionMessage Inherited Members SocketMessage.StreamId SocketMessage.NextStreamId Extension Methods UnsafeUtilities.As<T>(object?) Fields ExceptionInfo Remote exception information public ExceptionInfo ExceptionInfo Field Value ExceptionInfo"
  },
  "api/Stride.Engine.Network.RouterClient.html": {
    "href": "api/Stride.Engine.Network.RouterClient.html",
    "title": "Class RouterClient | Stride API",
    "summary": "Class RouterClient Namespace Stride.Engine.Network Assembly Stride.Engine.dll public class RouterClient Inheritance object RouterClient Extension Methods UnsafeUtilities.As<T>(object?) Fields DefaultListenPort The default port to listen for connection from router. public static readonly int DefaultListenPort Field Value int DefaultPort The default port to connect to router server. public static readonly int DefaultPort Field Value int Log public static readonly Logger Log Field Value Logger Methods RegisterService() Starts a service. public static void RegisterService() Exceptions NotImplementedException RequestServer(string, CancellationToken) Requests a specific server. public static Task<SimpleSocket> RequestServer(string serverUrl, CancellationToken cancellationToken = default) Parameters serverUrl string cancellationToken CancellationToken Returns Task<SimpleSocket>"
  },
  "api/Stride.Engine.Network.SimpleSocket.html": {
    "href": "api/Stride.Engine.Network.SimpleSocket.html",
    "title": "Class SimpleSocket | Stride API",
    "summary": "Class SimpleSocket Namespace Stride.Engine.Network Assembly Stride.Engine.dll Manages socket connection+ack and low-level communication. High-level communication is supposed to happen in SocketMessageLayer. public class SimpleSocket : IDisposable Inheritance object SimpleSocket Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields Connected public Action<SimpleSocket> Connected Field Value Action<SimpleSocket> Disconnected public Action<SimpleSocket> Disconnected Field Value Action<SimpleSocket> Properties ReadStream public Stream ReadStream { get; } Property Value Stream RemoteAddress public string RemoteAddress { get; } Property Value string RemotePort public int RemotePort { get; } Property Value int WriteStream public Stream WriteStream { get; } Property Value Stream Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() StartClient(string, int, bool) public Task StartClient(string address, int port, bool needAck = true) Parameters address string port int needAck bool Returns Task StartServer(int, bool, int) public Task StartServer(int port, bool singleConnection, int retryCount = 1) Parameters port int singleConnection bool retryCount int Returns Task"
  },
  "api/Stride.Engine.Network.SimpleSocketException.html": {
    "href": "api/Stride.Engine.Network.SimpleSocketException.html",
    "title": "Class SimpleSocketException | Stride API",
    "summary": "Class SimpleSocketException Namespace Stride.Engine.Network Assembly Stride.Engine.dll Used when there is a socket exception. public class SimpleSocketException : Exception, ISerializable Inheritance object Exception SimpleSocketException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState Extension Methods UnsafeUtilities.As<T>(object?) Constructors SimpleSocketException(string) public SimpleSocketException(string message) Parameters message string"
  },
  "api/Stride.Engine.Network.SocketExtensions.html": {
    "href": "api/Stride.Engine.Network.SocketExtensions.html",
    "title": "Class SocketExtensions | Stride API",
    "summary": "Class SocketExtensions Namespace Stride.Engine.Network Assembly Stride.Engine.dll public static class SocketExtensions Inheritance object SocketExtensions Methods Read7BitEncodedInt(Stream) public static Task<int> Read7BitEncodedInt(this Stream socket) Parameters socket Stream Returns Task<int> ReadAllAsync(Stream, byte[], int, int) public static Task ReadAllAsync(this Stream socket, byte[] buffer, int offset, int size) Parameters socket Stream buffer byte[] offset int size int Returns Task ReadGuidAsync(Stream) public static Task<Guid> ReadGuidAsync(this Stream socket) Parameters socket Stream Returns Task<Guid> ReadInt16Async(Stream) public static Task<short> ReadInt16Async(this Stream socket) Parameters socket Stream Returns Task<short> ReadInt32Async(Stream) public static Task<int> ReadInt32Async(this Stream socket) Parameters socket Stream Returns Task<int> ReadStringAsync(Stream) public static Task<string> ReadStringAsync(this Stream socket) Parameters socket Stream Returns Task<string> Write7BitEncodedInt(Stream, int) public static Task Write7BitEncodedInt(this Stream socket, int value) Parameters socket Stream value int Returns Task WriteGuidAsync(Stream, Guid) public static Task WriteGuidAsync(this Stream socket, Guid guid) Parameters socket Stream guid Guid Returns Task WriteInt16Async(Stream, short) public static Task WriteInt16Async(this Stream socket, short value) Parameters socket Stream value short Returns Task WriteInt32Async(Stream, int) public static Task WriteInt32Async(this Stream socket, int value) Parameters socket Stream value int Returns Task WriteStringAsync(Stream, string) public static Task WriteStringAsync(this Stream socket, string value) Parameters socket Stream value string Returns Task"
  },
  "api/Stride.Engine.Network.SocketMessage.html": {
    "href": "api/Stride.Engine.Network.SocketMessage.html",
    "title": "Class SocketMessage | Stride API",
    "summary": "Class SocketMessage Namespace Stride.Engine.Network Assembly Stride.Engine.dll [DataContract(Inherited = true)] public class SocketMessage Inheritance object SocketMessage Derived ExceptionMessage RemoteEffectCompilerEffectAnswer RemoteEffectCompilerEffectRequest Extension Methods UnsafeUtilities.As<T>(object?) Fields StreamId An ID that will identify the message, in order to answer to it. public int StreamId Field Value int Properties NextStreamId public static int NextStreamId { get; } Property Value int"
  },
  "api/Stride.Engine.Network.SocketMessageLayer.html": {
    "href": "api/Stride.Engine.Network.SocketMessageLayer.html",
    "title": "Class SocketMessageLayer | Stride API",
    "summary": "Class SocketMessageLayer Namespace Stride.Engine.Network Assembly Stride.Engine.dll High-level layer that can be used on top of SimpleSocket to send and receive objects using serialization. public class SocketMessageLayer Inheritance object SocketMessageLayer Extension Methods UnsafeUtilities.As<T>(object?) Constructors SocketMessageLayer(SimpleSocket, bool) public SocketMessageLayer(SimpleSocket context, bool isServer) Parameters context SimpleSocket isServer bool Properties Context public SimpleSocket Context { get; } Property Value SimpleSocket Methods AddPacketHandler<T>(Action<T>, bool) public void AddPacketHandler<T>(Action<T> handler, bool oneTime = false) Parameters handler Action<T> oneTime bool Type Parameters T AddPacketHandler<T>(Func<T, Task>, bool) public void AddPacketHandler<T>(Func<T, Task> asyncHandler, bool oneTime = false) Parameters asyncHandler Func<T, Task> oneTime bool Type Parameters T MessageLoop() public Task MessageLoop() Returns Task Send(object) public Task Send(object obj) Parameters obj object Returns Task SendReceiveAsync(SocketMessage) public Task<SocketMessage> SendReceiveAsync(SocketMessage query) Parameters query SocketMessage Returns Task<SocketMessage>"
  },
  "api/Stride.Engine.Network.html": {
    "href": "api/Stride.Engine.Network.html",
    "title": "Namespace Stride.Engine.Network | Stride API",
    "summary": "Namespace Stride.Engine.Network Classes ExceptionMessage In the case of a SocketMessage when we use it in a SendReceiveAsync we want to propagate exceptions from the remote host RouterClient SimpleSocket Manages socket connection+ack and low-level communication. High-level communication is supposed to happen in SocketMessageLayer. SimpleSocketException Used when there is a socket exception. SocketExtensions SocketMessage SocketMessageLayer High-level layer that can be used on top of SimpleSocket to send and receive objects using serialization. Enums ClientRouterMessage Message exchanged between client and router. Note: shouldn't collide with RouterMessage."
  },
  "api/Stride.Engine.OpaqueComponentId.html": {
    "href": "api/Stride.Engine.OpaqueComponentId.html",
    "title": "Struct OpaqueComponentId | Stride API",
    "summary": "Struct OpaqueComponentId Namespace Stride.Engine Assembly Stride.Engine.dll Contains the id of a component public readonly ref struct OpaqueComponentId Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Constructors OpaqueComponentId(EntityComponent) public OpaqueComponentId(EntityComponent component) Parameters component EntityComponent OpaqueComponentId(int) public OpaqueComponentId(int id) Parameters id int Methods Match(EntityComponent) public bool Match(EntityComponent component) Parameters component EntityComponent Returns bool Match(ISet<int>) public bool Match(ISet<int> otherIds) Parameters otherIds ISet<int> Returns bool Match(int) public bool Match(int otherId) Parameters otherId int Returns bool Match<T>(IDictionary<int, T>, out T) public bool Match<T>(IDictionary<int, T> otherIds, out T value) Parameters otherIds IDictionary<int, T> value T Returns bool Type Parameters T"
  },
  "api/Stride.Engine.PhysicsComponent.ColliderShapeCollection.html": {
    "href": "api/Stride.Engine.PhysicsComponent.ColliderShapeCollection.html",
    "title": "Class PhysicsComponent.ColliderShapeCollection | Stride API",
    "summary": "Class PhysicsComponent.ColliderShapeCollection Namespace Stride.Engine Assembly Stride.Physics.dll [DataContract] public class PhysicsComponent.ColliderShapeCollection : FastCollection<IInlineColliderShapeDesc>, IList<IInlineColliderShapeDesc>, ICollection<IInlineColliderShapeDesc>, IReadOnlyList<IInlineColliderShapeDesc>, IReadOnlyCollection<IInlineColliderShapeDesc>, IEnumerable<IInlineColliderShapeDesc>, IEnumerable Inheritance object FastCollection<IInlineColliderShapeDesc> PhysicsComponent.ColliderShapeCollection Implements IList<IInlineColliderShapeDesc> ICollection<IInlineColliderShapeDesc> IReadOnlyList<IInlineColliderShapeDesc> IReadOnlyCollection<IInlineColliderShapeDesc> IEnumerable<IInlineColliderShapeDesc> IEnumerable Inherited Members FastCollection<IInlineColliderShapeDesc>.Capacity FastCollection<IInlineColliderShapeDesc>.Count FastCollection<IInlineColliderShapeDesc>.this[int] FastCollection<IInlineColliderShapeDesc>.Add(IInlineColliderShapeDesc) FastCollection<IInlineColliderShapeDesc>.Clear() FastCollection<IInlineColliderShapeDesc>.Contains(IInlineColliderShapeDesc) FastCollection<IInlineColliderShapeDesc>.CopyTo(IInlineColliderShapeDesc[], int) FastCollection<IInlineColliderShapeDesc>.IndexOf(IInlineColliderShapeDesc) FastCollection<IInlineColliderShapeDesc>.Insert(int, IInlineColliderShapeDesc) FastCollection<IInlineColliderShapeDesc>.Remove(IInlineColliderShapeDesc) FastCollection<IInlineColliderShapeDesc>.RemoveAt(int) FastCollection<IInlineColliderShapeDesc>.AddRange<TE>(TE) FastCollection<IInlineColliderShapeDesc>.GetEnumerator() FastCollection<IInlineColliderShapeDesc>.Sort() FastCollection<IInlineColliderShapeDesc>.Sort(IComparer<IInlineColliderShapeDesc>) FastCollection<IInlineColliderShapeDesc>.Sort(int, int, IComparer<IInlineColliderShapeDesc>) FastCollection<IInlineColliderShapeDesc>.IsReadOnly FastCollection<IInlineColliderShapeDesc>.EnsureCapacity(int) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors ColliderShapeCollection(PhysicsComponent) public ColliderShapeCollection(PhysicsComponent componentParam) Parameters componentParam PhysicsComponent Methods ClearItems() protected override void ClearItems() InsertItem(int, IInlineColliderShapeDesc) protected override void InsertItem(int index, IInlineColliderShapeDesc item) Parameters index int item IInlineColliderShapeDesc RemoveItem(int) protected override void RemoveItem(int index) Parameters index int SetItem(int, IInlineColliderShapeDesc) protected override void SetItem(int index, IInlineColliderShapeDesc item) Parameters index int item IInlineColliderShapeDesc"
  },
  "api/Stride.Engine.PhysicsComponent.html": {
    "href": "api/Stride.Engine.PhysicsComponent.html",
    "title": "Class PhysicsComponent | Stride API",
    "summary": "Class PhysicsComponent Namespace Stride.Engine Assembly Stride.Physics.dll [DataContract(\"PhysicsComponent\", Inherited = true)] [Display(\"Physics\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentProcessor(typeof(PhysicsProcessor))] [ComponentOrder(3000)] [ComponentCategory(\"Physics\")] public abstract class PhysicsComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent PhysicsComponent Implements IIdentifiable Derived CharacterComponent PhysicsTriggerComponentBase Inherited Members EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Constructors PhysicsComponent() protected PhysicsComponent() Fields BoneIndex public int BoneIndex Field Value int BoneWorldMatrix public Matrix BoneWorldMatrix Field Value Matrix BoneWorldMatrixOut public Matrix BoneWorldMatrixOut Field Value Matrix attachInProgress protected bool attachInProgress Field Value bool colliderShape protected ColliderShape colliderShape Field Value ColliderShape logger protected static Logger logger Field Value Logger Properties CanCollideWith Gets or sets the can collide with. [DataMember(40)] [Display(\"Collides with...\", null)] public CollisionFilterGroupFlags CanCollideWith { get; set; } Property Value CollisionFilterGroupFlags The can collide with. Remarks The collider will still produce events, to allow non trigger rigidbodies or static colliders to act as a trigger if required for certain filtering groups. CanScaleShape public bool CanScaleShape { get; set; } Property Value bool CanSleep Gets or sets if this element can enter sleep state [DataMember(55)] [Display(\"Can sleep\", null)] public bool CanSleep { get; set; } Property Value bool true, false CcdMotionThreshold [DataMember(67)] public float CcdMotionThreshold { get; set; } Property Value float CcdSweptSphereRadius [DataMember(68)] public float CcdSweptSphereRadius { get; set; } Property Value float ColliderShape public virtual ColliderShape ColliderShape { get; set; } Property Value ColliderShape ColliderShapeChanged public bool ColliderShapeChanged { get; } Property Value bool ColliderShapes [DataMember(200)] public PhysicsComponent.ColliderShapeCollection ColliderShapes { get; } Property Value PhysicsComponent.ColliderShapeCollection CollisionGroup Gets or sets the collision group. [DataMember(30)] [Display(\"Collision group\", null)] public CollisionFilterGroups CollisionGroup { get; set; } Property Value CollisionFilterGroups The collision group. Remarks The collider will still produce events, to allow non trigger rigidbodies or static colliders to act as a trigger if required for certain filtering groups. Collisions public TrackingHashSet<Collision> Collisions { get; } Property Value TrackingHashSet<Collision> Data protected PhysicsProcessor.AssociatedData Data { get; set; } Property Value PhysicsProcessor.AssociatedData DebugEntity public Entity DebugEntity { get; set; } Property Value Entity Enabled Gets or sets if this element is enabled in the physics engine [DataMember(-10)] public override bool Enabled { get; set; } Property Value bool true, false Friction Gets or sets the friction of this element [DataMember(65)] public float Friction { get; set; } Property Value float true, false Remarks It's important to realise that friction and restitution are not values of any particular surface, but rather a value of the interaction of two surfaces. So why is it defined for each object? In order to determine the overall friction and restitution between any two surfaces in a collision. IsActive Gets a value indicating whether this instance is active (awake). public bool IsActive { get; } Property Value bool true if this instance is active; otherwise, false. PhysicsWorldTransform public Matrix PhysicsWorldTransform { get; set; } Property Value Matrix ProcessCollisions Gets or sets if this element will store collisions [Display(\"Record collision events\", null)] [Obsolete(\"Always processed and stored by now\")] public bool ProcessCollisions { get; set; } Property Value bool true, false Restitution Gets or sets if this element restitution [DataMember(60)] public float Restitution { get; set; } Property Value float true, false RollingFriction Gets or sets the rolling friction of this element [DataMember(66)] public float RollingFriction { get; set; } Property Value float true, false Simulation public Simulation Simulation { get; } Property Value Simulation Tag Gets or sets the tag. public string Tag { get; set; } Property Value string The tag. Methods Activate(bool) Attempts to awake the collider. public void Activate(bool forceActivation = false) Parameters forceActivation bool if set to true [force activation]. AddDebugEntity(Scene, RenderGroup, bool) public void AddDebugEntity(Scene scene, RenderGroup renderGroup = RenderGroup.Group0, bool alwaysAddOffset = false) Parameters scene Scene renderGroup RenderGroup alwaysAddOffset bool CollisionEnded() public ChannelMicroThreadAwaiter<Collision> CollisionEnded() Returns ChannelMicroThreadAwaiter<Collision> ComposeShape() Made virtual for added behavior in CharacterComponent with UAF exception public virtual void ComposeShape() IgnoreCollisionWith(PhysicsComponent, CollisionState) public void IgnoreCollisionWith(PhysicsComponent other, CollisionState state) Parameters other PhysicsComponent state CollisionState IsIgnoringCollisionWith(PhysicsComponent) public bool IsIgnoringCollisionWith(PhysicsComponent other) Parameters other PhysicsComponent Returns bool NewCollision() public ChannelMicroThreadAwaiter<Collision> NewCollision() Returns ChannelMicroThreadAwaiter<Collision> OnAttach() Called whenever an entity with this component is added to scene. protected virtual void OnAttach() OnDetach() protected virtual void OnDetach() OnUpdateBones() protected virtual void OnUpdateBones() OnUpdateDraw() protected virtual void OnUpdateDraw() RemoveDebugEntity(Scene) public void RemoveDebugEntity(Scene scene) Parameters scene Scene UpdatePhysicsTransformation(bool) Forces an update from the TransformComponent to the Collider.PhysicsWorldTransform. Useful to manually force movements. In the case of dynamic rigidbodies a velocity reset should be applied first. public void UpdatePhysicsTransformation(bool forceUpdateTransform = true) Parameters forceUpdateTransform bool Ensure that the Transform.WorldMatrix we are reading from is up to date"
  },
  "api/Stride.Engine.Prefab.html": {
    "href": "api/Stride.Engine.Prefab.html",
    "title": "Class Prefab | Stride API",
    "summary": "Class Prefab Namespace Stride.Engine Assembly Stride.Engine.dll A prefab that contains entities. [DataContract(\"Prefab\")] [ContentSerializer(typeof(DataContentSerializerWithReuse<Prefab>))] [DataSerializerGlobal(typeof(ReferenceSerializer<Prefab>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public sealed class Prefab Inheritance object Prefab Extension Methods UnsafeUtilities.As<T>(object?) Properties Entities The entities. public List<Entity> Entities { get; } Property Value List<Entity> Methods Instantiate() Instantiates entities from a prefab that can be later added to a Scene. public List<Entity> Instantiate() Returns List<Entity> A collection of entities extracted from the prefab"
  },
  "api/Stride.Engine.Processors.CameraProcessor.html": {
    "href": "api/Stride.Engine.Processors.CameraProcessor.html",
    "title": "Class CameraProcessor | Stride API",
    "summary": "Class CameraProcessor Namespace Stride.Engine.Processors Assembly Stride.Engine.dll The processor for CameraComponent. public class CameraProcessor : EntityProcessor<CameraComponent> Inheritance object EntityProcessor EntityProcessor<CameraComponent, CameraComponent> EntityProcessor<CameraComponent> CameraProcessor Inherited Members EntityProcessor<CameraComponent>.GenerateComponentData(Entity, CameraComponent) EntityProcessor<CameraComponent>.IsAssociatedDataValid(Entity, CameraComponent, CameraComponent) EntityProcessor<CameraComponent, CameraComponent>.ComponentDatas EntityProcessor<CameraComponent, CameraComponent>.OnSystemAdd() EntityProcessor<CameraComponent, CameraComponent>.OnSystemRemove() EntityProcessor<CameraComponent, CameraComponent>.RemoveAllEntities() EntityProcessor<CameraComponent, CameraComponent>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<CameraComponent, CameraComponent>.GenerateComponentData(Entity, CameraComponent) EntityProcessor<CameraComponent, CameraComponent>.IsAssociatedDataValid(Entity, CameraComponent, CameraComponent) EntityProcessor<CameraComponent, CameraComponent>.OnEntityComponentAdding(Entity, CameraComponent, CameraComponent) EntityProcessor<CameraComponent, CameraComponent>.OnEntityComponentRemoved(Entity, CameraComponent, CameraComponent) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.OnSystemAdd() EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors CameraProcessor() Initializes a new instance of the CameraProcessor class. public CameraProcessor() Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext OnEntityComponentRemoved(Entity, CameraComponent, CameraComponent) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, CameraComponent component, CameraComponent data) Parameters entity Entity The entity. component CameraComponent data CameraComponent The associated data."
  },
  "api/Stride.Engine.Processors.CameraProjectionMode.html": {
    "href": "api/Stride.Engine.Processors.CameraProjectionMode.html",
    "title": "Enum CameraProjectionMode | Stride API",
    "summary": "Enum CameraProjectionMode Namespace Stride.Engine.Processors Assembly Stride.Engine.dll Projection of a CameraComponent. [DataContract(\"CameraProjectionMode\")] public enum CameraProjectionMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Orthographic = 1 An orthographic projection. Perspective = 0 A perspective projection."
  },
  "api/Stride.Engine.Processors.InstanceProcessor.html": {
    "href": "api/Stride.Engine.Processors.InstanceProcessor.html",
    "title": "Class InstanceProcessor | Stride API",
    "summary": "Class InstanceProcessor Namespace Stride.Engine.Processors Assembly Stride.Engine.dll public class InstanceProcessor : EntityProcessor<InstanceComponent> Inheritance object EntityProcessor EntityProcessor<InstanceComponent, InstanceComponent> EntityProcessor<InstanceComponent> InstanceProcessor Inherited Members EntityProcessor<InstanceComponent>.GenerateComponentData(Entity, InstanceComponent) EntityProcessor<InstanceComponent>.IsAssociatedDataValid(Entity, InstanceComponent, InstanceComponent) EntityProcessor<InstanceComponent, InstanceComponent>.ComponentDatas EntityProcessor<InstanceComponent, InstanceComponent>.OnSystemAdd() EntityProcessor<InstanceComponent, InstanceComponent>.OnSystemRemove() EntityProcessor<InstanceComponent, InstanceComponent>.RemoveAllEntities() EntityProcessor<InstanceComponent, InstanceComponent>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<InstanceComponent, InstanceComponent>.GenerateComponentData(Entity, InstanceComponent) EntityProcessor<InstanceComponent, InstanceComponent>.IsAssociatedDataValid(Entity, InstanceComponent, InstanceComponent) EntityProcessor<InstanceComponent, InstanceComponent>.OnEntityComponentAdding(Entity, InstanceComponent, InstanceComponent) EntityProcessor<InstanceComponent, InstanceComponent>.OnEntityComponentRemoved(Entity, InstanceComponent, InstanceComponent) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.Draw(RenderContext) EntityProcessor.OnSystemAdd() EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InstanceProcessor() public InstanceProcessor() Methods OnEntityComponentAdding(Entity, InstanceComponent, InstanceComponent) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, InstanceComponent component, InstanceComponent data) Parameters entity Entity The entity. component InstanceComponent data InstanceComponent The associated data. OnEntityComponentRemoved(Entity, InstanceComponent, InstanceComponent) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, InstanceComponent component, InstanceComponent data) Parameters entity Entity The entity. component InstanceComponent data InstanceComponent The associated data."
  },
  "api/Stride.Engine.Processors.InstancingProcessor.InstancingData.html": {
    "href": "api/Stride.Engine.Processors.InstancingProcessor.InstancingData.html",
    "title": "Class InstancingProcessor.InstancingData | Stride API",
    "summary": "Class InstancingProcessor.InstancingData Namespace Stride.Engine.Processors Assembly Stride.Engine.dll public class InstancingProcessor.InstancingData Inheritance object InstancingProcessor.InstancingData Extension Methods UnsafeUtilities.As<T>(object?) Fields ModelComponent public ModelComponent ModelComponent Field Value ModelComponent RenderInstancing public RenderInstancing RenderInstancing Field Value RenderInstancing RenderModel public RenderModel RenderModel Field Value RenderModel TransformComponent public TransformComponent TransformComponent Field Value TransformComponent"
  },
  "api/Stride.Engine.Processors.InstancingProcessor.html": {
    "href": "api/Stride.Engine.Processors.InstancingProcessor.html",
    "title": "Class InstancingProcessor | Stride API",
    "summary": "Class InstancingProcessor Namespace Stride.Engine.Processors Assembly Stride.Engine.dll public class InstancingProcessor : EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData>, IEntityComponentRenderProcessor Inheritance object EntityProcessor EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData> InstancingProcessor Implements IEntityComponentRenderProcessor Inherited Members EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData>.ComponentDatas EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData>.OnSystemAdd() EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData>.OnSystemRemove() EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData>.RemoveAllEntities() EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData>.GenerateComponentData(Entity, InstancingComponent) EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData>.IsAssociatedDataValid(Entity, InstancingComponent, InstancingProcessor.InstancingData) EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData>.OnEntityComponentAdding(Entity, InstancingComponent, InstancingProcessor.InstancingData) EntityProcessor<InstancingComponent, InstancingProcessor.InstancingData>.OnEntityComponentRemoved(Entity, InstancingComponent, InstancingProcessor.InstancingData) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InstancingProcessor() public InstancingProcessor() Properties VisibilityGroup public VisibilityGroup VisibilityGroup { get; set; } Property Value VisibilityGroup Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext GenerateComponentData(Entity, InstancingComponent) Generates associated data to the given entity. protected override InstancingProcessor.InstancingData GenerateComponentData(Entity entity, InstancingComponent component) Parameters entity Entity The entity. component InstancingComponent Returns InstancingProcessor.InstancingData The associated data. IsAssociatedDataValid(Entity, InstancingComponent, InstancingData) Checks if the current associated data is valid, or if readding the entity is required. protected override bool IsAssociatedDataValid(Entity entity, InstancingComponent component, InstancingProcessor.InstancingData associatedData) Parameters entity Entity The entity. component InstancingComponent associatedData InstancingProcessor.InstancingData The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise. OnEntityComponentAdding(Entity, InstancingComponent, InstancingData) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, InstancingComponent component, InstancingProcessor.InstancingData data) Parameters entity Entity The entity. component InstancingComponent data InstancingProcessor.InstancingData The associated data. OnEntityComponentRemoved(Entity, InstancingComponent, InstancingData) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, InstancingComponent component, InstancingProcessor.InstancingData data) Parameters entity Entity The entity. component InstancingComponent data InstancingProcessor.InstancingData The associated data. OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd() OnSystemRemove() Run when this EntityProcessor is removed from an EntityManager. protected override void OnSystemRemove()"
  },
  "api/Stride.Engine.Processors.LightShaftBoundingVolumeProcessor.html": {
    "href": "api/Stride.Engine.Processors.LightShaftBoundingVolumeProcessor.html",
    "title": "Class LightShaftBoundingVolumeProcessor | Stride API",
    "summary": "Class LightShaftBoundingVolumeProcessor Namespace Stride.Engine.Processors Assembly Stride.Engine.dll public class LightShaftBoundingVolumeProcessor : EntityProcessor<LightShaftBoundingVolumeComponent> Inheritance object EntityProcessor EntityProcessor<LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent> EntityProcessor<LightShaftBoundingVolumeComponent> LightShaftBoundingVolumeProcessor Inherited Members EntityProcessor<LightShaftBoundingVolumeComponent>.GenerateComponentData(Entity, LightShaftBoundingVolumeComponent) EntityProcessor<LightShaftBoundingVolumeComponent>.IsAssociatedDataValid(Entity, LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent) EntityProcessor<LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent>.ComponentDatas EntityProcessor<LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent>.OnSystemAdd() EntityProcessor<LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent>.OnSystemRemove() EntityProcessor<LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent>.RemoveAllEntities() EntityProcessor<LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent>.GenerateComponentData(Entity, LightShaftBoundingVolumeComponent) EntityProcessor<LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent>.IsAssociatedDataValid(Entity, LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent) EntityProcessor<LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent>.OnEntityComponentAdding(Entity, LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent) EntityProcessor<LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent>.OnEntityComponentRemoved(Entity, LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Draw(RenderContext) EntityProcessor.OnSystemAdd() EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Methods GetBoundingVolumesForComponent(LightShaftComponent) public IReadOnlyList<RenderLightShaftBoundingVolume> GetBoundingVolumesForComponent(LightShaftComponent component) Parameters component LightShaftComponent Returns IReadOnlyList<RenderLightShaftBoundingVolume> OnEntityComponentAdding(Entity, LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, LightShaftBoundingVolumeComponent component, LightShaftBoundingVolumeComponent data) Parameters entity Entity The entity. component LightShaftBoundingVolumeComponent data LightShaftBoundingVolumeComponent The associated data. OnEntityComponentRemoved(Entity, LightShaftBoundingVolumeComponent, LightShaftBoundingVolumeComponent) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, LightShaftBoundingVolumeComponent component, LightShaftBoundingVolumeComponent data) Parameters entity Entity The entity. component LightShaftBoundingVolumeComponent data LightShaftBoundingVolumeComponent The associated data. Update(GameTime) Performs work related to this processor. public override void Update(GameTime time) Parameters time GameTime"
  },
  "api/Stride.Engine.Processors.LightShaftProcessor.AssociatedData.html": {
    "href": "api/Stride.Engine.Processors.LightShaftProcessor.AssociatedData.html",
    "title": "Class LightShaftProcessor.AssociatedData | Stride API",
    "summary": "Class LightShaftProcessor.AssociatedData Namespace Stride.Engine.Processors Assembly Stride.Engine.dll public class LightShaftProcessor.AssociatedData Inheritance object LightShaftProcessor.AssociatedData Extension Methods UnsafeUtilities.As<T>(object?) Fields Component public LightShaftComponent Component Field Value LightShaftComponent LightComponent public LightComponent LightComponent Field Value LightComponent"
  },
  "api/Stride.Engine.Processors.LightShaftProcessor.html": {
    "href": "api/Stride.Engine.Processors.LightShaftProcessor.html",
    "title": "Class LightShaftProcessor | Stride API",
    "summary": "Class LightShaftProcessor Namespace Stride.Engine.Processors Assembly Stride.Engine.dll public class LightShaftProcessor : EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData>, IEntityComponentRenderProcessor Inheritance object EntityProcessor EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData> LightShaftProcessor Implements IEntityComponentRenderProcessor Inherited Members EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData>.ComponentDatas EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData>.OnSystemAdd() EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData>.OnSystemRemove() EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData>.RemoveAllEntities() EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData>.GenerateComponentData(Entity, LightShaftComponent) EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData>.IsAssociatedDataValid(Entity, LightShaftComponent, LightShaftProcessor.AssociatedData) EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData>.OnEntityComponentAdding(Entity, LightShaftComponent, LightShaftProcessor.AssociatedData) EntityProcessor<LightShaftComponent, LightShaftProcessor.AssociatedData>.OnEntityComponentRemoved(Entity, LightShaftComponent, LightShaftProcessor.AssociatedData) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Draw(RenderContext) EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Properties VisibilityGroup public VisibilityGroup VisibilityGroup { get; set; } Property Value VisibilityGroup Methods GenerateComponentData(Entity, LightShaftComponent) Generates associated data to the given entity. protected override LightShaftProcessor.AssociatedData GenerateComponentData(Entity entity, LightShaftComponent component) Parameters entity Entity The entity. component LightShaftComponent Returns LightShaftProcessor.AssociatedData The associated data. IsAssociatedDataValid(Entity, LightShaftComponent, AssociatedData) Checks if the current associated data is valid, or if readding the entity is required. protected override bool IsAssociatedDataValid(Entity entity, LightShaftComponent component, LightShaftProcessor.AssociatedData associatedData) Parameters entity Entity The entity. component LightShaftComponent associatedData LightShaftProcessor.AssociatedData The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise. OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd() OnSystemRemove() Run when this EntityProcessor is removed from an EntityManager. protected override void OnSystemRemove() Update(GameTime) Performs work related to this processor. public override void Update(GameTime time) Parameters time GameTime"
  },
  "api/Stride.Engine.Processors.ModelNodeLinkProcessor.html": {
    "href": "api/Stride.Engine.Processors.ModelNodeLinkProcessor.html",
    "title": "Class ModelNodeLinkProcessor | Stride API",
    "summary": "Class ModelNodeLinkProcessor Namespace Stride.Engine.Processors Assembly Stride.Engine.dll public class ModelNodeLinkProcessor : EntityProcessor<ModelNodeLinkComponent> Inheritance object EntityProcessor EntityProcessor<ModelNodeLinkComponent, ModelNodeLinkComponent> EntityProcessor<ModelNodeLinkComponent> ModelNodeLinkProcessor Inherited Members EntityProcessor<ModelNodeLinkComponent>.GenerateComponentData(Entity, ModelNodeLinkComponent) EntityProcessor<ModelNodeLinkComponent>.IsAssociatedDataValid(Entity, ModelNodeLinkComponent, ModelNodeLinkComponent) EntityProcessor<ModelNodeLinkComponent, ModelNodeLinkComponent>.ComponentDatas EntityProcessor<ModelNodeLinkComponent, ModelNodeLinkComponent>.OnSystemAdd() EntityProcessor<ModelNodeLinkComponent, ModelNodeLinkComponent>.OnSystemRemove() EntityProcessor<ModelNodeLinkComponent, ModelNodeLinkComponent>.RemoveAllEntities() EntityProcessor<ModelNodeLinkComponent, ModelNodeLinkComponent>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<ModelNodeLinkComponent, ModelNodeLinkComponent>.GenerateComponentData(Entity, ModelNodeLinkComponent) EntityProcessor<ModelNodeLinkComponent, ModelNodeLinkComponent>.IsAssociatedDataValid(Entity, ModelNodeLinkComponent, ModelNodeLinkComponent) EntityProcessor<ModelNodeLinkComponent, ModelNodeLinkComponent>.OnEntityComponentAdding(Entity, ModelNodeLinkComponent, ModelNodeLinkComponent) EntityProcessor<ModelNodeLinkComponent, ModelNodeLinkComponent>.OnEntityComponentRemoved(Entity, ModelNodeLinkComponent, ModelNodeLinkComponent) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.OnSystemAdd() EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors ModelNodeLinkProcessor() public ModelNodeLinkProcessor() Properties ModelNodeLinkComponents public Dictionary<ModelNodeLinkComponent, ModelNodeLinkComponent>.KeyCollection ModelNodeLinkComponents { get; } Property Value Dictionary<ModelNodeLinkComponent, ModelNodeLinkComponent>.KeyCollection Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext OnEntityComponentAdding(Entity, ModelNodeLinkComponent, ModelNodeLinkComponent) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, ModelNodeLinkComponent component, ModelNodeLinkComponent data) Parameters entity Entity The entity. component ModelNodeLinkComponent data ModelNodeLinkComponent The associated data. OnEntityComponentRemoved(Entity, ModelNodeLinkComponent, ModelNodeLinkComponent) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, ModelNodeLinkComponent component, ModelNodeLinkComponent data) Parameters entity Entity The entity. component ModelNodeLinkComponent data ModelNodeLinkComponent The associated data."
  },
  "api/Stride.Engine.Processors.ModelTransformProcessor.ModelTransformationInfo.html": {
    "href": "api/Stride.Engine.Processors.ModelTransformProcessor.ModelTransformationInfo.html",
    "title": "Class ModelTransformProcessor.ModelTransformationInfo | Stride API",
    "summary": "Class ModelTransformProcessor.ModelTransformationInfo Namespace Stride.Engine.Processors Assembly Stride.Engine.dll public class ModelTransformProcessor.ModelTransformationInfo Inheritance object ModelTransformProcessor.ModelTransformationInfo Extension Methods UnsafeUtilities.As<T>(object?) Fields TransformOperation public ModelViewHierarchyTransformOperation TransformOperation Field Value ModelViewHierarchyTransformOperation"
  },
  "api/Stride.Engine.Processors.ModelTransformProcessor.html": {
    "href": "api/Stride.Engine.Processors.ModelTransformProcessor.html",
    "title": "Class ModelTransformProcessor | Stride API",
    "summary": "Class ModelTransformProcessor Namespace Stride.Engine.Processors Assembly Stride.Engine.dll The processor for ModelComponent. public class ModelTransformProcessor : EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo> Inheritance object EntityProcessor EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo> ModelTransformProcessor Inherited Members EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo>.ComponentDatas EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo>.OnSystemAdd() EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo>.OnSystemRemove() EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo>.RemoveAllEntities() EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo>.GenerateComponentData(Entity, ModelComponent) EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo>.IsAssociatedDataValid(Entity, ModelComponent, ModelTransformProcessor.ModelTransformationInfo) EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo>.OnEntityComponentAdding(Entity, ModelComponent, ModelTransformProcessor.ModelTransformationInfo) EntityProcessor<ModelComponent, ModelTransformProcessor.ModelTransformationInfo>.OnEntityComponentRemoved(Entity, ModelComponent, ModelTransformProcessor.ModelTransformationInfo) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.Draw(RenderContext) EntityProcessor.OnSystemAdd() EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors ModelTransformProcessor() Initializes a new instance of the ModelTransformProcessor class. public ModelTransformProcessor() Methods GenerateComponentData(Entity, ModelComponent) Generates associated data to the given entity. protected override ModelTransformProcessor.ModelTransformationInfo GenerateComponentData(Entity entity, ModelComponent component) Parameters entity Entity The entity. component ModelComponent Returns ModelTransformProcessor.ModelTransformationInfo The associated data. IsAssociatedDataValid(Entity, ModelComponent, ModelTransformationInfo) Checks if the current associated data is valid, or if readding the entity is required. protected override bool IsAssociatedDataValid(Entity entity, ModelComponent component, ModelTransformProcessor.ModelTransformationInfo associatedData) Parameters entity Entity The entity. component ModelComponent associatedData ModelTransformProcessor.ModelTransformationInfo The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise. OnEntityComponentAdding(Entity, ModelComponent, ModelTransformationInfo) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, ModelComponent component, ModelTransformProcessor.ModelTransformationInfo data) Parameters entity Entity The entity. component ModelComponent data ModelTransformProcessor.ModelTransformationInfo The associated data. OnEntityComponentRemoved(Entity, ModelComponent, ModelTransformationInfo) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, ModelComponent component, ModelTransformProcessor.ModelTransformationInfo data) Parameters entity Entity The entity. component ModelComponent data ModelTransformProcessor.ModelTransformationInfo The associated data."
  },
  "api/Stride.Engine.Processors.ScriptProcessor.html": {
    "href": "api/Stride.Engine.Processors.ScriptProcessor.html",
    "title": "Class ScriptProcessor | Stride API",
    "summary": "Class ScriptProcessor Namespace Stride.Engine.Processors Assembly Stride.Engine.dll Manage scripts public sealed class ScriptProcessor : EntityProcessor<ScriptComponent> Inheritance object EntityProcessor EntityProcessor<ScriptComponent, ScriptComponent> EntityProcessor<ScriptComponent> ScriptProcessor Inherited Members EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.Draw(RenderContext) Extension Methods UnsafeUtilities.As<T>(object?) Constructors ScriptProcessor() public ScriptProcessor() Methods OnEntityComponentAdding(Entity, ScriptComponent, ScriptComponent) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, ScriptComponent component, ScriptComponent associatedData) Parameters entity Entity The entity. component ScriptComponent associatedData ScriptComponent OnEntityComponentRemoved(Entity, ScriptComponent, ScriptComponent) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, ScriptComponent component, ScriptComponent associatedData) Parameters entity Entity The entity. component ScriptComponent associatedData ScriptComponent OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd()"
  },
  "api/Stride.Engine.Processors.ScriptSystem.html": {
    "href": "api/Stride.Engine.Processors.ScriptSystem.html",
    "title": "Class ScriptSystem | Stride API",
    "summary": "Class ScriptSystem Namespace Stride.Engine.Processors Assembly Stride.Engine.dll The script system handles scripts scheduling in a game. public sealed class ScriptSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase ScriptSystem Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Inherited Members GameSystemBase.Game GameSystemBase.Services GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.Draw(GameTime) GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.Initialize() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Enabled GameSystemBase.UpdateOrder ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ScriptSystem(IServiceRegistry) Initializes a new instance of the GameSystemBase class. public ScriptSystem(IServiceRegistry registry) Parameters registry IServiceRegistry The registry. Remarks The GameSystem is expecting the following services to be registered: IGame and ContentManager. Properties Scheduler Gets the scheduler. public Scheduler Scheduler { get; } Property Value Scheduler The scheduler. Methods Add(ScriptComponent) Add the provided script to the script system. public void Add(ScriptComponent script) Parameters script ScriptComponent The script to add AddTask(Func<Task>, long) Adds the specified micro thread function. public MicroThread AddTask(Func<Task> microThreadFunction, long priority = 0) Parameters microThreadFunction Func<Task> The micro thread function. priority long Lower values will run the associated micro thread sooner Returns MicroThread MicroThread. Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. LiveReload(ScriptComponent, ScriptComponent) Called by a live scripting debugger to notify the ScriptSystem about reloaded scripts. public void LiveReload(ScriptComponent oldScript, ScriptComponent newScript) Parameters oldScript ScriptComponent The old script newScript ScriptComponent The new script NextFrame() Allows to wait for next frame. public ChannelMicroThreadAwaiter<int> NextFrame() Returns ChannelMicroThreadAwaiter<int> ChannelMicroThreadAwaiter<System.Int32>. Remove(ScriptComponent) Remove the provided script from the script system. public void Remove(ScriptComponent script) Parameters script ScriptComponent The script to remove Update(GameTime) This method is called when this game component is updated. public override void Update(GameTime gameTime) Parameters gameTime GameTime The current timing. WhenAll(params MicroThread[]) Waits all micro thread finished their task completion. public Task WhenAll(params MicroThread[] microThreads) Parameters microThreads MicroThread[] The micro threads. Returns Task Task."
  },
  "api/Stride.Engine.Processors.TransformProcessor.html": {
    "href": "api/Stride.Engine.Processors.TransformProcessor.html",
    "title": "Class TransformProcessor | Stride API",
    "summary": "Class TransformProcessor Namespace Stride.Engine.Processors Assembly Stride.Engine.dll Handle Children and updates WorldMatrix of entities. public class TransformProcessor : EntityProcessor<TransformComponent> Inheritance object EntityProcessor EntityProcessor<TransformComponent, TransformComponent> EntityProcessor<TransformComponent> TransformProcessor Inherited Members EntityProcessor<TransformComponent>.GenerateComponentData(Entity, TransformComponent) EntityProcessor<TransformComponent>.IsAssociatedDataValid(Entity, TransformComponent, TransformComponent) EntityProcessor<TransformComponent, TransformComponent>.ComponentDatas EntityProcessor<TransformComponent, TransformComponent>.OnSystemAdd() EntityProcessor<TransformComponent, TransformComponent>.OnSystemRemove() EntityProcessor<TransformComponent, TransformComponent>.RemoveAllEntities() EntityProcessor<TransformComponent, TransformComponent>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<TransformComponent, TransformComponent>.GenerateComponentData(Entity, TransformComponent) EntityProcessor<TransformComponent, TransformComponent>.IsAssociatedDataValid(Entity, TransformComponent, TransformComponent) EntityProcessor<TransformComponent, TransformComponent>.OnEntityComponentAdding(Entity, TransformComponent, TransformComponent) EntityProcessor<TransformComponent, TransformComponent>.OnEntityComponentRemoved(Entity, TransformComponent, TransformComponent) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors TransformProcessor() Initializes a new instance of the TransformProcessor class. public TransformProcessor() Methods Draw(RenderContext) Updates all the WorldMatrix. public override void Draw(RenderContext context) Parameters context RenderContext The render context. OnEntityComponentAdding(Entity, TransformComponent, TransformComponent) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, TransformComponent component, TransformComponent data) Parameters entity Entity The entity. component TransformComponent data TransformComponent The associated data. OnEntityComponentRemoved(Entity, TransformComponent, TransformComponent) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, TransformComponent component, TransformComponent data) Parameters entity Entity The entity. component TransformComponent data TransformComponent The associated data. OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd() OnSystemRemove() Run when this EntityProcessor is removed from an EntityManager. protected override void OnSystemRemove()"
  },
  "api/Stride.Engine.Processors.UIElementLinkProcessor.html": {
    "href": "api/Stride.Engine.Processors.UIElementLinkProcessor.html",
    "title": "Class UIElementLinkProcessor | Stride API",
    "summary": "Class UIElementLinkProcessor Namespace Stride.Engine.Processors Assembly Stride.UI.dll public class UIElementLinkProcessor : EntityProcessor<UIElementLinkComponent> Inheritance object EntityProcessor EntityProcessor<UIElementLinkComponent, UIElementLinkComponent> EntityProcessor<UIElementLinkComponent> UIElementLinkProcessor Inherited Members EntityProcessor<UIElementLinkComponent>.GenerateComponentData(Entity, UIElementLinkComponent) EntityProcessor<UIElementLinkComponent>.IsAssociatedDataValid(Entity, UIElementLinkComponent, UIElementLinkComponent) EntityProcessor<UIElementLinkComponent, UIElementLinkComponent>.ComponentDatas EntityProcessor<UIElementLinkComponent, UIElementLinkComponent>.OnSystemAdd() EntityProcessor<UIElementLinkComponent, UIElementLinkComponent>.OnSystemRemove() EntityProcessor<UIElementLinkComponent, UIElementLinkComponent>.RemoveAllEntities() EntityProcessor<UIElementLinkComponent, UIElementLinkComponent>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<UIElementLinkComponent, UIElementLinkComponent>.GenerateComponentData(Entity, UIElementLinkComponent) EntityProcessor<UIElementLinkComponent, UIElementLinkComponent>.IsAssociatedDataValid(Entity, UIElementLinkComponent, UIElementLinkComponent) EntityProcessor<UIElementLinkComponent, UIElementLinkComponent>.OnEntityComponentAdding(Entity, UIElementLinkComponent, UIElementLinkComponent) EntityProcessor<UIElementLinkComponent, UIElementLinkComponent>.OnEntityComponentRemoved(Entity, UIElementLinkComponent, UIElementLinkComponent) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.OnSystemAdd() EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors UIElementLinkProcessor() public UIElementLinkProcessor() Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext OnEntityComponentRemoved(Entity, UIElementLinkComponent, UIElementLinkComponent) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, UIElementLinkComponent component, UIElementLinkComponent data) Parameters entity Entity The entity. component UIElementLinkComponent data UIElementLinkComponent The associated data."
  },
  "api/Stride.Engine.Processors.html": {
    "href": "api/Stride.Engine.Processors.html",
    "title": "Namespace Stride.Engine.Processors | Stride API",
    "summary": "Namespace Stride.Engine.Processors Classes CameraProcessor The processor for CameraComponent. InstanceProcessor InstancingProcessor InstancingProcessor.InstancingData LightShaftBoundingVolumeProcessor LightShaftProcessor LightShaftProcessor.AssociatedData ModelNodeLinkProcessor ModelTransformProcessor The processor for ModelComponent. ModelTransformProcessor.ModelTransformationInfo ScriptProcessor Manage scripts ScriptSystem The script system handles scripts scheduling in a game. TransformProcessor Handle Children and updates WorldMatrix of entities. UIElementLinkProcessor Enums CameraProjectionMode Projection of a CameraComponent."
  },
  "api/Stride.Engine.RequireComponentAttribute.html": {
    "href": "api/Stride.Engine.RequireComponentAttribute.html",
    "title": "Class RequireComponentAttribute | Stride API",
    "summary": "Class RequireComponentAttribute Namespace Stride.Engine Assembly Stride.Engine.dll Allows to declare that a component requires another component in order to run (used for ScriptComponent [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] public class RequireComponentAttribute : EntityComponentAttributeBase Inheritance object Attribute EntityComponentAttributeBase RequireComponentAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?) Constructors RequireComponentAttribute(Type) Initializes a new instance of RequireComponentAttribute. public RequireComponentAttribute(Type type) Parameters type Type Type of the required EntityComponent Properties Type Gets the type of the required component (Must be an EntityComponent. public Type Type { get; } Property Value Type"
  },
  "api/Stride.Engine.Scene.EntityCollection.html": {
    "href": "api/Stride.Engine.Scene.EntityCollection.html",
    "title": "Class Scene.EntityCollection | Stride API",
    "summary": "Class Scene.EntityCollection Namespace Stride.Engine Assembly Stride.Engine.dll [DataContract] public class Scene.EntityCollection : TrackingCollection<Entity>, IList<Entity>, ICollection<Entity>, IReadOnlyList<Entity>, IReadOnlyCollection<Entity>, IEnumerable<Entity>, IEnumerable, ITrackingCollectionChanged Inheritance object FastCollection<Entity> TrackingCollection<Entity> Scene.EntityCollection Implements IList<Entity> ICollection<Entity> IReadOnlyList<Entity> IReadOnlyCollection<Entity> IEnumerable<Entity> IEnumerable ITrackingCollectionChanged Inherited Members TrackingCollection<Entity>.CollectionChanged TrackingCollection<Entity>.ClearItems() TrackingCollection<Entity>.ClearItemsEvents() TrackingCollection<Entity>.SetItem(int, Entity) FastCollection<Entity>.Capacity FastCollection<Entity>.Count FastCollection<Entity>.this[int] FastCollection<Entity>.Add(Entity) FastCollection<Entity>.Clear() FastCollection<Entity>.Contains(Entity) FastCollection<Entity>.CopyTo(Entity[], int) FastCollection<Entity>.IndexOf(Entity) FastCollection<Entity>.Insert(int, Entity) FastCollection<Entity>.Remove(Entity) FastCollection<Entity>.RemoveAt(int) FastCollection<Entity>.AddRange<TE>(TE) FastCollection<Entity>.GetEnumerator() FastCollection<Entity>.Sort() FastCollection<Entity>.Sort(IComparer<Entity>) FastCollection<Entity>.Sort(int, int, IComparer<Entity>) FastCollection<Entity>.IsReadOnly FastCollection<Entity>.EnsureCapacity(int) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors EntityCollection(Scene) public EntityCollection(Scene sceneParam) Parameters sceneParam Scene Methods InsertItem(int, Entity) protected override void InsertItem(int index, Entity item) Parameters index int item Entity RemoveItem(int) protected override void RemoveItem(int index) Parameters index int"
  },
  "api/Stride.Engine.Scene.SceneCollection.html": {
    "href": "api/Stride.Engine.Scene.SceneCollection.html",
    "title": "Class Scene.SceneCollection | Stride API",
    "summary": "Class Scene.SceneCollection Namespace Stride.Engine Assembly Stride.Engine.dll [DataContract] public class Scene.SceneCollection : TrackingCollection<Scene>, IList<Scene>, ICollection<Scene>, IReadOnlyList<Scene>, IReadOnlyCollection<Scene>, IEnumerable<Scene>, IEnumerable, ITrackingCollectionChanged Inheritance object FastCollection<Scene> TrackingCollection<Scene> Scene.SceneCollection Implements IList<Scene> ICollection<Scene> IReadOnlyList<Scene> IReadOnlyCollection<Scene> IEnumerable<Scene> IEnumerable ITrackingCollectionChanged Inherited Members TrackingCollection<Scene>.CollectionChanged TrackingCollection<Scene>.ClearItems() TrackingCollection<Scene>.ClearItemsEvents() TrackingCollection<Scene>.SetItem(int, Scene) FastCollection<Scene>.Capacity FastCollection<Scene>.Count FastCollection<Scene>.this[int] FastCollection<Scene>.Add(Scene) FastCollection<Scene>.Clear() FastCollection<Scene>.Contains(Scene) FastCollection<Scene>.CopyTo(Scene[], int) FastCollection<Scene>.IndexOf(Scene) FastCollection<Scene>.Insert(int, Scene) FastCollection<Scene>.Remove(Scene) FastCollection<Scene>.RemoveAt(int) FastCollection<Scene>.AddRange<TE>(TE) FastCollection<Scene>.GetEnumerator() FastCollection<Scene>.Sort() FastCollection<Scene>.Sort(IComparer<Scene>) FastCollection<Scene>.Sort(int, int, IComparer<Scene>) FastCollection<Scene>.IsReadOnly FastCollection<Scene>.EnsureCapacity(int) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors SceneCollection(Scene) public SceneCollection(Scene sceneParam) Parameters sceneParam Scene Methods InsertItem(int, Scene) protected override void InsertItem(int index, Scene item) Parameters index int item Scene RemoveItem(int) protected override void RemoveItem(int index) Parameters index int"
  },
  "api/Stride.Engine.Scene.html": {
    "href": "api/Stride.Engine.Scene.html",
    "title": "Class Scene | Stride API",
    "summary": "Class Scene Namespace Stride.Engine Assembly Stride.Engine.dll A scene. [DataContract(\"Scene\")] [ContentSerializer(typeof(DataContentSerializerWithReuse<Scene>))] [DataSerializerGlobal(typeof(ReferenceSerializer<Scene>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public sealed class Scene : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder, IIdentifiable Inheritance object DisposeBase ComponentBase Scene Implements IDisposable IComponent IReferencable ICollectorHolder IIdentifiable Inherited Members ComponentBase.Tags ComponentBase.Name DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors Scene() Initializes a new instance of the Scene class. public Scene() Fields Offset An offset applied to all entities of the scene relative to it's parent scene. public Vector3 Offset Field Value Vector3 WorldMatrix The absolute transform applied to all entities of the scene. public Matrix WorldMatrix Field Value Matrix Remarks This field is overwritten by the transform processor each frame. Properties Children The child scenes. public TrackingCollection<Scene> Children { get; } Property Value TrackingCollection<Scene> Entities The entities. public TrackingCollection<Entity> Entities { get; } Property Value TrackingCollection<Entity> Id Gets the id of this instance [DataMember(-10)] [Display(null, null, Browsable = false)] public Guid Id { get; set; } Property Value Guid Parent The parent scene. public Scene Parent { get; set; } Property Value Scene Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. UpdateWorldMatrix() Updates the world transform of the scene. public void UpdateWorldMatrix()"
  },
  "api/Stride.Engine.SceneInstance.html": {
    "href": "api/Stride.Engine.SceneInstance.html",
    "title": "Class SceneInstance | Stride API",
    "summary": "Class SceneInstance Namespace Stride.Engine Assembly Stride.Engine.dll Manage a collection of entities within a RootScene. public sealed class SceneInstance : EntityManager, IDisposable, IComponent, IReferencable, ICollectorHolder, IReadOnlySet<Entity>, IReadOnlyCollection<Entity>, IEnumerable<Entity>, IEnumerable Inheritance object DisposeBase ComponentBase EntityManager SceneInstance Implements IDisposable IComponent IReferencable ICollectorHolder IReadOnlySet<Entity> IReadOnlyCollection<Entity> IEnumerable<Entity> IEnumerable Inherited Members EntityManager.ExecutionMode EntityManager.EntityAdded EntityManager.EntityRemoved EntityManager.HierarchyChanged EntityManager.ComponentTypeAdded EntityManager.ComponentChanged EntityManager.Services EntityManager.Processors EntityManager.Count EntityManager.ComponentTypes EntityManager.Update(GameTime) EntityManager.Contains(Entity) EntityManager.GetEnumerator() EntityManager.GetProcessor<TProcessor>() EntityManager.Remove(Entity) EntityManager.Draw(RenderContext) ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors SceneInstance(IServiceRegistry) Initializes a new instance of the EntityManager class. public SceneInstance(IServiceRegistry registry) Parameters registry IServiceRegistry The registry. SceneInstance(IServiceRegistry, Scene, ExecutionMode) Initializes a new instance of the SceneInstance class. public SceneInstance(IServiceRegistry services, Scene rootScene, ExecutionMode executionMode = ExecutionMode.Runtime) Parameters services IServiceRegistry The services. rootScene Scene The scene entity root. executionMode ExecutionMode The mode that determines which processors are executed. Exceptions ArgumentNullException services or rootScene Fields Current A property key to get the current scene from the Tags. public static readonly PropertyKey<SceneInstance> Current Field Value PropertyKey<SceneInstance> CurrentRenderSystem A property key to get the current render system from the Tags. public static readonly PropertyKey<RenderSystem> CurrentRenderSystem Field Value PropertyKey<RenderSystem> CurrentVisibilityGroup A property key to get the current visibility group from the Tags. public static readonly PropertyKey<VisibilityGroup> CurrentVisibilityGroup Field Value PropertyKey<VisibilityGroup> Properties RootScene Gets the scene. public Scene RootScene { get; set; } Property Value Scene The scene. VisibilityGroups public TrackingCollection<VisibilityGroup> VisibilityGroups { get; } Property Value TrackingCollection<VisibilityGroup> Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. GetCurrent(RenderContext) Gets the current scene valid only from a rendering context. May be null. public static SceneInstance GetCurrent(RenderContext context) Parameters context RenderContext The context. Returns SceneInstance Stride.Engine.SceneInstance. Events RootSceneChanged Occurs when the scene changed from a scene child component. public event EventHandler<EventArgs> RootSceneChanged Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Engine.SceneSystem.SplashScreenState.html": {
    "href": "api/Stride.Engine.SceneSystem.SplashScreenState.html",
    "title": "Enum SceneSystem.SplashScreenState | Stride API",
    "summary": "Enum SceneSystem.SplashScreenState Namespace Stride.Engine Assembly Stride.Engine.dll public enum SceneSystem.SplashScreenState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields FadingIn = 2 FadingOut = 4 Intro = 1 Invalid = 0 Showing = 3"
  },
  "api/Stride.Engine.SceneSystem.html": {
    "href": "api/Stride.Engine.SceneSystem.html",
    "title": "Class SceneSystem | Stride API",
    "summary": "Class SceneSystem Namespace Stride.Engine Assembly Stride.Engine.dll The scene system handles the scenes of a game. public class SceneSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase SceneSystem Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Inherited Members GameSystemBase.Game GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.Initialize() GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) GameSystemBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors SceneSystem(IServiceRegistry) Initializes a new instance of the GameSystemBase class. public SceneSystem(IServiceRegistry registry) Parameters registry IServiceRegistry The registry. Remarks The GameSystem is expecting the following services to be registered: IGame and IContentManager. Properties DoubleViewSplashScreen Is the splash screen displayed in VR double view. public bool DoubleViewSplashScreen { get; set; } Property Value bool GraphicsCompositor public GraphicsCompositor GraphicsCompositor { get; set; } Property Value GraphicsCompositor InitialGraphicsCompositorUrl URL of the graphics compositor loaded at initialization. public string InitialGraphicsCompositorUrl { get; set; } Property Value string InitialSceneUrl URL of the scene loaded at initialization. public string InitialSceneUrl { get; set; } Property Value string SceneInstance Gets or sets the root scene. public SceneInstance SceneInstance { get; set; } Property Value SceneInstance The scene Exceptions ArgumentNullException Scene cannot be null SplashScreenColor Splash screen background color. public Color4 SplashScreenColor { get; set; } Property Value Color4 SplashScreenEnabled If splash screen rendering is enabled, true if a splash screen texture is present, and only in release builds public bool SplashScreenEnabled { get; set; } Property Value bool SplashScreenUrl URL of the splash screen texture loaded at initialization. public string SplashScreenUrl { get; set; } Property Value string Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. Draw(GameTime) Draws the Game Component. public override void Draw(GameTime gameTime) Parameters gameTime GameTime The current timing information. LoadContent() protected override void LoadContent() Update(GameTime) This method is called when this game component is updated. public override void Update(GameTime gameTime) Parameters gameTime GameTime The current timing."
  },
  "api/Stride.Engine.ScriptComponent.html": {
    "href": "api/Stride.Engine.ScriptComponent.html",
    "title": "Class ScriptComponent | Stride API",
    "summary": "Class ScriptComponent Namespace Stride.Engine Assembly Stride.Engine.dll Script component. [DataContract(\"ScriptComponent\", Inherited = true)] [DefaultEntityComponentProcessor(typeof(ScriptProcessor), ExecutionMode = ExecutionMode.Runtime)] [Display(null, null, Expand = ExpandRule.Once)] [ComponentOrder(1000)] [ComponentCategory(\"Scripts\")] public abstract class ScriptComponent : EntityComponent, IIdentifiable, ICollectorHolder Inheritance object EntityComponent ScriptComponent Implements IIdentifiable ICollectorHolder Derived AsyncScript StartupScript Inherited Members EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods PhysicsScriptComponentExtensions.GetSimulation(ScriptComponent) UnsafeUtilities.As<T>(object?) Constructors ScriptComponent() protected ScriptComponent() Fields LiveScriptingMask public const uint LiveScriptingMask = 128 Field Value uint ScriptGlobalProfilingKey The global profiling key for scripts. Activate/deactivate this key to activate/deactivate profiling for all your scripts. public static readonly ProfilingKey ScriptGlobalProfilingKey Field Value ProfilingKey Properties Audio public AudioSystem Audio { get; } Property Value AudioSystem Collector The object collector associated with this script. public ObjectCollector Collector { get; } Property Value ObjectCollector Content public ContentManager Content { get; } Property Value ContentManager DebugText public DebugTextSystem DebugText { get; } Property Value DebugTextSystem EffectSystem public EffectSystem EffectSystem { get; } Property Value EffectSystem Game public IGame Game { get; } Property Value IGame GameProfiler public GameProfilingSystem GameProfiler { get; } Property Value GameProfilingSystem GraphicsDevice public GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice Input public InputManager Input { get; } Property Value InputManager IsLiveReloading Determines whether the script is currently undergoing live reloading. public bool IsLiveReloading { get; } Property Value bool Log protected Logger Log { get; } Property Value Logger Priority The priority this script will be scheduled with (compared to other scripts). [DataMember(10000)] public int Priority { get; set; } Property Value int ProfilingKey Gets the profiling key to activate/deactivate profiling for the current script class. public ProfilingKey ProfilingKey { get; } Property Value ProfilingKey SceneSystem public SceneSystem SceneSystem { get; } Property Value SceneSystem Script public ScriptSystem Script { get; } Property Value ScriptSystem Services public IServiceRegistry Services { get; } Property Value IServiceRegistry SpriteAnimation public SpriteAnimationSystem SpriteAnimation { get; } Property Value SpriteAnimationSystem Streaming Gets the streaming system. public StreamingManager Streaming { get; } Property Value StreamingManager The streaming system. Methods Cancel() Called when the script's update loop is canceled. public virtual void Cancel() PriorityUpdated() Internal helper function called when Priority is changed. protected virtual void PriorityUpdated()"
  },
  "api/Stride.Engine.SpriteComponent.html": {
    "href": "api/Stride.Engine.SpriteComponent.html",
    "title": "Class SpriteComponent | Stride API",
    "summary": "Class SpriteComponent Namespace Stride.Engine Assembly Stride.Engine.dll Add a Sprite to an Entity. It could be an animated sprite. [DataContract(\"SpriteComponent\")] [Display(\"Sprite\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentRenderer(typeof(SpriteRenderProcessor))] [ComponentOrder(10000)] [ComponentCategory(\"Sprites\")] public sealed class SpriteComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent SpriteComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors SpriteComponent() Creates a new instance of SpriteComponent public SpriteComponent() Fields IgnoreDepth Ignore the depth of other elements of the scene when rendering the sprite by disabling the depth test. [DataMember(60)] [Display(\"Ignore Depth\", null)] public bool IgnoreDepth Field Value bool IsAlphaCutoff Discard pixels with low alpha value when rendering the sprite by performing alpha cut off test. [DataMember(65)] [Display(\"Is Alpha Cutoff\", null)] public bool IsAlphaCutoff Field Value bool SpriteType The type of the sprite. [DataMember(10)] [Display(\"Type\", null)] public SpriteType SpriteType Field Value SpriteType Properties BlendMode Discard pixels with low alpha value when rendering the sprite by performing alpha cut off test. [DataMember(67)] [Display(\"Blend mode\", null)] public SpriteBlend BlendMode { get; set; } Property Value SpriteBlend Color The color shade to apply on the sprite. [DataMember(40)] [Display(\"Color\", null)] public Color4 Color { get; set; } Property Value Color4 CurrentFrame Gets the current frame of the animation. public int CurrentFrame { get; } Property Value int CurrentSprite Gets the current sprite. public Sprite CurrentSprite { get; } Property Value Sprite Intensity The intensity by which the color is scaled. [DataMember(42)] [Display(\"Intensity\", null)] public float Intensity { get; set; } Property Value float PremultipliedAlpha Gets or sets a value indicating whether the sprite is a pre-multiplied alpha (default is true). [DataMember(50)] public bool PremultipliedAlpha { get; set; } Property Value bool true if the texture is pre-multiplied by alpha; otherwise, false. RenderGroup The render group for this component. [DataMember(90)] [Display(\"Render group\", null)] public RenderGroup RenderGroup { get; set; } Property Value RenderGroup Sampler Specifies the texture sampling method to be used for this sprite [DataMember(70)] [Display(\"Sampler\", null)] public SpriteSampler Sampler { get; set; } Property Value SpriteSampler SpriteProvider The group of sprites associated to the component. [DataMember(5)] [Display(\"Source\", null)] public ISpriteProvider SpriteProvider { get; set; } Property Value ISpriteProvider Swizzle Specifies the swizzle method for sampling (how to access and mix the color channels) [DataMember(80)] [Display(\"Swizzle\", null)] public SwizzleMode Swizzle { get; set; } Property Value SwizzleMode"
  },
  "api/Stride.Engine.StartupScript.html": {
    "href": "api/Stride.Engine.StartupScript.html",
    "title": "Class StartupScript | Stride API",
    "summary": "Class StartupScript Namespace Stride.Engine Assembly Stride.Engine.dll public abstract class StartupScript : ScriptComponent, IIdentifiable, ICollectorHolder Inheritance object EntityComponent ScriptComponent StartupScript Implements IIdentifiable ICollectorHolder Derived SyncScript Inherited Members ScriptComponent.LiveScriptingMask ScriptComponent.ScriptGlobalProfilingKey ScriptComponent.ProfilingKey ScriptComponent.Services ScriptComponent.Game ScriptComponent.GraphicsDevice ScriptComponent.Content ScriptComponent.GameProfiler ScriptComponent.Input ScriptComponent.Script ScriptComponent.SceneSystem ScriptComponent.EffectSystem ScriptComponent.DebugText ScriptComponent.Audio ScriptComponent.SpriteAnimation ScriptComponent.Streaming ScriptComponent.Log ScriptComponent.Priority ScriptComponent.IsLiveReloading ScriptComponent.Collector ScriptComponent.PriorityUpdated() ScriptComponent.Cancel() EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods PhysicsScriptComponentExtensions.GetSimulation(ScriptComponent) UnsafeUtilities.As<T>(object?) Methods Start() Called before the script enters it's update loop. public virtual void Start()"
  },
  "api/Stride.Engine.SyncScript.html": {
    "href": "api/Stride.Engine.SyncScript.html",
    "title": "Class SyncScript | Stride API",
    "summary": "Class SyncScript Namespace Stride.Engine Assembly Stride.Engine.dll A script whose Update() will be called every frame. public abstract class SyncScript : StartupScript, IIdentifiable, ICollectorHolder Inheritance object EntityComponent ScriptComponent StartupScript SyncScript Implements IIdentifiable ICollectorHolder Inherited Members StartupScript.Start() ScriptComponent.LiveScriptingMask ScriptComponent.ScriptGlobalProfilingKey ScriptComponent.ProfilingKey ScriptComponent.Services ScriptComponent.Game ScriptComponent.GraphicsDevice ScriptComponent.Content ScriptComponent.GameProfiler ScriptComponent.Input ScriptComponent.Script ScriptComponent.SceneSystem ScriptComponent.EffectSystem ScriptComponent.DebugText ScriptComponent.Audio ScriptComponent.SpriteAnimation ScriptComponent.Streaming ScriptComponent.Log ScriptComponent.Priority ScriptComponent.IsLiveReloading ScriptComponent.Collector ScriptComponent.Cancel() EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods PhysicsScriptComponentExtensions.GetSimulation(ScriptComponent) UnsafeUtilities.As<T>(object?) Methods PriorityUpdated() Internal helper function called when Priority is changed. protected override void PriorityUpdated() Update() Called every frame. public abstract void Update()"
  },
  "api/Stride.Engine.TransformComponent.TransformChildrenCollection.html": {
    "href": "api/Stride.Engine.TransformComponent.TransformChildrenCollection.html",
    "title": "Class TransformComponent.TransformChildrenCollection | Stride API",
    "summary": "Class TransformComponent.TransformChildrenCollection Namespace Stride.Engine Assembly Stride.Engine.dll [DataContract] public class TransformComponent.TransformChildrenCollection : FastCollection<TransformComponent>, IList<TransformComponent>, ICollection<TransformComponent>, IReadOnlyList<TransformComponent>, IReadOnlyCollection<TransformComponent>, IEnumerable<TransformComponent>, IEnumerable Inheritance object FastCollection<TransformComponent> TransformComponent.TransformChildrenCollection Implements IList<TransformComponent> ICollection<TransformComponent> IReadOnlyList<TransformComponent> IReadOnlyCollection<TransformComponent> IEnumerable<TransformComponent> IEnumerable Inherited Members FastCollection<TransformComponent>.Capacity FastCollection<TransformComponent>.Count FastCollection<TransformComponent>.this[int] FastCollection<TransformComponent>.Add(TransformComponent) FastCollection<TransformComponent>.Clear() FastCollection<TransformComponent>.Contains(TransformComponent) FastCollection<TransformComponent>.CopyTo(TransformComponent[], int) FastCollection<TransformComponent>.IndexOf(TransformComponent) FastCollection<TransformComponent>.Insert(int, TransformComponent) FastCollection<TransformComponent>.Remove(TransformComponent) FastCollection<TransformComponent>.RemoveAt(int) FastCollection<TransformComponent>.AddRange<TE>(TE) FastCollection<TransformComponent>.GetEnumerator() FastCollection<TransformComponent>.Sort() FastCollection<TransformComponent>.Sort(IComparer<TransformComponent>) FastCollection<TransformComponent>.Sort(int, int, IComparer<TransformComponent>) FastCollection<TransformComponent>.IsReadOnly FastCollection<TransformComponent>.EnsureCapacity(int) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors TransformChildrenCollection(TransformComponent) public TransformChildrenCollection(TransformComponent transformParam) Parameters transformParam TransformComponent Methods ClearItems() protected override void ClearItems() InsertItem(int, TransformComponent) protected override void InsertItem(int index, TransformComponent item) Parameters index int item TransformComponent RemoveItem(int) protected override void RemoveItem(int index) Parameters index int SetItem(int, TransformComponent) protected override void SetItem(int index, TransformComponent item) Parameters index int item TransformComponent"
  },
  "api/Stride.Engine.TransformComponent.html": {
    "href": "api/Stride.Engine.TransformComponent.html",
    "title": "Class TransformComponent | Stride API",
    "summary": "Class TransformComponent Namespace Stride.Engine Assembly Stride.Engine.dll Defines Position, Rotation and Scale of its Entity. [DataContract(\"TransformComponent\")] [DataSerializerGlobal(null, typeof(FastCollection<TransformComponent>), DataSerializerGenericMode.None, false, false)] [DefaultEntityComponentProcessor(typeof(TransformProcessor))] [Display(\"Transform\", null, Expand = ExpandRule.Once)] [ComponentOrder(0)] public sealed class TransformComponent : EntityComponent, IIdentifiable Inheritance object EntityComponent TransformComponent Implements IIdentifiable Inherited Members EntityComponent.Entity EntityComponent.Id Extension Methods EntityTransformExtensions.GetWorldTransformation(TransformComponent, out Vector3, out Quaternion, out Vector3) EntityTransformExtensions.LocalToWorld(TransformComponent, Vector3) EntityTransformExtensions.LocalToWorld(TransformComponent, ref Vector3, ref Quaternion, ref Vector3) EntityTransformExtensions.LocalToWorld(TransformComponent, ref Vector3, out Vector3) EntityTransformExtensions.SetWorld(TransformComponent, Quaternion) EntityTransformExtensions.SetWorld(TransformComponent, Vector3) EntityTransformExtensions.SetWorld(TransformComponent, Vector3, Quaternion) EntityTransformExtensions.WorldToLocal(TransformComponent, Vector3) EntityTransformExtensions.WorldToLocal(TransformComponent, ref Vector3, ref Quaternion, ref Vector3) EntityTransformExtensions.WorldToLocal(TransformComponent, ref Vector3, out Vector3) UnsafeUtilities.As<T>(object?) Constructors TransformComponent() Initializes a new instance of the TransformComponent class. public TransformComponent() Fields LocalMatrix The local matrix. Its value is automatically recomputed at each frame from the position, rotation and scale. One can use UpdateLocalMatrix() to force the update to happen before next frame. public Matrix LocalMatrix Field Value Matrix Remarks The setter should not be used and is accessible only for performance purposes. Position The translation relative to the parent transformation. [DataMember(10)] public Vector3 Position Field Value Vector3 PostOperations This is where we can register some custom work to be done after world matrix has been computed, such as updating model node hierarchy or physics for local node. public FastListStruct<TransformOperation> PostOperations Field Value FastListStruct<TransformOperation> Rotation The rotation relative to the parent transformation. [DataMember(20)] public Quaternion Rotation Field Value Quaternion Scale The scaling relative to the parent transformation. [DataMember(30)] public Vector3 Scale Field Value Vector3 TransformLink public TransformLink TransformLink Field Value TransformLink WorldMatrix The world matrix. Its value is automatically recomputed at each frame from the local and the parent matrices. One can use UpdateWorldMatrix() to force the update to happen before next frame. public Matrix WorldMatrix Field Value Matrix Remarks The setter should not be used and is accessible only for performance purposes. Properties Children Gets the children of this TransformComponent. public FastCollection<TransformComponent> Children { get; } Property Value FastCollection<TransformComponent> Parent Gets or sets the parent of this TransformComponent. public TransformComponent Parent { get; set; } Property Value TransformComponent The parent. RotationEulerXYZ Gets or sets the euler rotation, with XYZ order. Not stable: setting value and getting it again might return different value as it is internally encoded as a Quaternion in Rotation. public Vector3 RotationEulerXYZ { get; set; } Property Value Vector3 The euler rotation. UseTRS Gets or sets a value indicating whether to use the Translation/Rotation/Scale. [Display(null, null, Browsable = false)] public bool UseTRS { get; set; } Property Value bool true if [use TRS]; otherwise, false. Methods UpdateLocalFromWorld() Updates the local matrix based on the world matrix and the parent entity's or containing scene's world matrix. public void UpdateLocalFromWorld() UpdateLocalMatrix() Updates the local matrix. If UseTRS is true, LocalMatrix will be updated from Position, Rotation and Scale. public void UpdateLocalMatrix() UpdateWorldMatrix() Updates the world matrix. It will first call UpdateLocalMatrix() on self, and UpdateWorldMatrix() on Parent if not null. Then WorldMatrix will be updated by multiplying LocalMatrix and parent WorldMatrix (if any). public void UpdateWorldMatrix()"
  },
  "api/Stride.Engine.TransformLink.html": {
    "href": "api/Stride.Engine.TransformLink.html",
    "title": "Class TransformLink | Stride API",
    "summary": "Class TransformLink Namespace Stride.Engine Assembly Stride.Engine.dll Gives the ability to control how parent matrix is computed in a TransformComponent. public abstract class TransformLink Inheritance object TransformLink Derived ModelNodeTransformLink UIElementTransformLink Extension Methods UnsafeUtilities.As<T>(object?) Methods ComputeMatrix(bool, out Matrix) Compute a world matrix this link represents. public abstract void ComputeMatrix(bool recursive, out Matrix matrix) Parameters recursive bool matrix Matrix The computed world matrix."
  },
  "api/Stride.Engine.TransformOperation.html": {
    "href": "api/Stride.Engine.TransformOperation.html",
    "title": "Class TransformOperation | Stride API",
    "summary": "Class TransformOperation Namespace Stride.Engine Assembly Stride.Engine.dll Performs some work after world matrix has been updated. public abstract class TransformOperation Inheritance object TransformOperation Derived ModelViewHierarchyTransformOperation Extension Methods UnsafeUtilities.As<T>(object?) Methods Process(TransformComponent) public abstract void Process(TransformComponent transformComponent) Parameters transformComponent TransformComponent"
  },
  "api/Stride.Engine.UIComponent.html": {
    "href": "api/Stride.Engine.UIComponent.html",
    "title": "Class UIComponent | Stride API",
    "summary": "Class UIComponent Namespace Stride.Engine Assembly Stride.UI.dll Add an UIPage to an Entity. [DataContract(\"UIComponent\")] [Display(\"UI\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentRenderer(typeof(UIRenderProcessor))] [DefaultEntityComponentProcessor(typeof(UIProcessor))] [ComponentOrder(9800)] [ComponentCategory(\"UI\")] public sealed class UIComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent UIComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors UIComponent() public UIComponent() Fields DefaultDepth public static readonly float DefaultDepth Field Value float DefaultHeight public static readonly float DefaultHeight Field Value float DefaultWidth public static readonly float DefaultWidth Field Value float FixedSizeVerticalUnit A fixed size UI component with height of 1 will be this much of the vertical resolution on screen public const float FixedSizeVerticalUnit = 1 Field Value float Properties IsBillboard Gets or sets the value indicating whether the UI should be displayed as billboard. [DataMember(50)] [Display(\"Billboard\", null)] public bool IsBillboard { get; set; } Property Value bool IsFixedSize Gets or sets the value indicating whether the UI should be always a fixed size on the screen. [DataMember(70)] [Display(\"Fixed Size\", null)] public bool IsFixedSize { get; set; } Property Value bool IsFullScreen Gets or sets the value indicating whether the UI should be full screen. [DataMember(20)] [Display(\"Full Screen\", null)] public bool IsFullScreen { get; set; } Property Value bool Page Gets or sets the UI page. [DataMember(10)] [Display(\"Page\", null)] public UIPage Page { get; set; } Property Value UIPage RenderGroup The render group for this component. [DataMember(80)] [Display(\"Render group\", null)] public RenderGroup RenderGroup { get; set; } Property Value RenderGroup Resolution Gets or sets the virtual resolution of the UI in virtual pixels. [DataMember(30)] [Display(\"Resolution\", null)] public Vector3 Resolution { get; set; } Property Value Vector3 ResolutionStretch Gets or sets the camera. [DataMember(40)] [Display(\"Resolution Stretch\", null)] public ResolutionStretch ResolutionStretch { get; set; } Property Value ResolutionStretch The camera. Sampler Specifies the sampling method to be used for this component [DataMember(15)] [Display(\"Sampler\", null)] public UIElementSampler Sampler { get; set; } Property Value UIElementSampler Size Gets or sets the actual size of the UI component in world units. This value is ignored in fullscreen mode. [DataMember(35)] [Display(\"Size\", null)] public Vector3 Size { get; set; } Property Value Vector3 SnapText Gets or sets the value indicating of the UI texts should be snapped to closest pixel. [DataMember(60)] [Display(\"Snap Text\", null)] public bool SnapText { get; set; } Property Value bool"
  },
  "api/Stride.Engine.UIElementLinkComponent.html": {
    "href": "api/Stride.Engine.UIElementLinkComponent.html",
    "title": "Class UIElementLinkComponent | Stride API",
    "summary": "Class UIElementLinkComponent Namespace Stride.Engine Assembly Stride.UI.dll [DataContract(\"UIElementLinkComponent\")] [Display(\"UI element link\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentProcessor(typeof(UIElementLinkProcessor))] [ComponentOrder(1600)] [ComponentCategory(\"UI\")] public sealed class UIElementLinkComponent : EntityComponent, IIdentifiable Inheritance object EntityComponent UIElementLinkComponent Implements IIdentifiable Inherited Members EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Properties Camera Gets or sets the camera component which is required if the UI component is a billboard. [Display(\"Camera (if billboard)\", null)] public CameraComponent Camera { get; set; } Property Value CameraComponent The camera component which is required if the UI component is a billboard. NodeName Gets or sets the name of the element. public string NodeName { get; set; } Property Value string The name of the element. Target Gets or sets the ui component which contains the hierarchy to use. [Display(\"Target (Parent if not set)\", null)] public UIComponent Target { get; set; } Property Value UIComponent The ui component which contains the hierarchy to use."
  },
  "api/Stride.Engine.UIElementTransformLink.html": {
    "href": "api/Stride.Engine.UIElementTransformLink.html",
    "title": "Class UIElementTransformLink | Stride API",
    "summary": "Class UIElementTransformLink Namespace Stride.Engine Assembly Stride.UI.dll public class UIElementTransformLink : TransformLink Inheritance object TransformLink UIElementTransformLink Extension Methods UnsafeUtilities.As<T>(object?) Constructors UIElementTransformLink(UIComponent, CameraComponent, string, bool) public UIElementTransformLink(UIComponent parentUIComponent, CameraComponent camera, string elementName, bool forceRecursive) Parameters parentUIComponent UIComponent camera CameraComponent elementName string forceRecursive bool Fields Transform public TransformTRS Transform Field Value TransformTRS Methods ComputeMatrix(bool, out Matrix) Compute a world matrix this link represents. public override void ComputeMatrix(bool recursive, out Matrix matrix) Parameters recursive bool matrix Matrix The computed world matrix. GetUICameraComponent(UIComponent) protected CameraComponent GetUICameraComponent(UIComponent uiComponent) Parameters uiComponent UIComponent Returns CameraComponent NeedsRecreate(Entity, string) public bool NeedsRecreate(Entity parentEntity, string targetNodeName) Parameters parentEntity Entity targetNodeName string Returns bool"
  },
  "api/Stride.Engine.UILibrary.html": {
    "href": "api/Stride.Engine.UILibrary.html",
    "title": "Class UILibrary | Stride API",
    "summary": "Class UILibrary Namespace Stride.Engine Assembly Stride.UI.dll [DataContract(\"UIlibrary\")] [ContentSerializer(typeof(DataContentSerializerWithReuse<UILibrary>))] [DataSerializerGlobal(typeof(ReferenceSerializer<UILibrary>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public class UILibrary : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase UILibrary Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UILibraryExtensions.InstantiateElement<TElement>(UILibrary, string) UnsafeUtilities.As<T>(object?) Constructors UILibrary() public UILibrary() Properties UIElements Gets the UI elements. public Dictionary<string, UIElement> UIElements { get; } Property Value Dictionary<string, UIElement>"
  },
  "api/Stride.Engine.UILibraryExtensions.html": {
    "href": "api/Stride.Engine.UILibraryExtensions.html",
    "title": "Class UILibraryExtensions | Stride API",
    "summary": "Class UILibraryExtensions Namespace Stride.Engine Assembly Stride.UI.dll public static class UILibraryExtensions Inheritance object UILibraryExtensions Methods InstantiateElement<TElement>(UILibrary, string) Instantiates a copy of the element of the library identified by name. public static TElement InstantiateElement<TElement>(this UILibrary library, string name) where TElement : UIElement Parameters library UILibrary The library. name string The name of the element in the library. Returns TElement Type Parameters TElement The type of the element."
  },
  "api/Stride.Engine.UIPage.html": {
    "href": "api/Stride.Engine.UIPage.html",
    "title": "Class UIPage | Stride API",
    "summary": "Class UIPage Namespace Stride.Engine Assembly Stride.UI.dll A page containing a UI hierarchy. [DataContract(\"UIPage\")] [ContentSerializer(typeof(DataContentSerializerWithReuse<UIPage>))] [DataSerializerGlobal(typeof(ReferenceSerializer<UIPage>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public sealed class UIPage : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase UIPage Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties RootElement Gets or sets the root element of the page. [DataMember] public UIElement RootElement { get; set; } Property Value UIElement"
  },
  "api/Stride.Engine.html": {
    "href": "api/Stride.Engine.html",
    "title": "Namespace Stride.Engine | Stride API",
    "summary": "Namespace Stride.Engine Classes ActivableEntityComponent An EntityComponent that can be enabled and disabled. AllowMultipleComponentsAttribute Allows a component of the same type to be added multiple time to the same entity (default is false) AnimationComponent Add animation capabilities to an Entity. It will usually apply to Skeleton AsyncScript A script which can be implemented as an async microthread. AudioEmitterComponent Component representing an audio emitter. AudioListenerComponent Component representing an audio listener. BackgroundComponent Add a background to an Entity. CameraComponent Describes the camera projection and view. ComponentCategoryAttribute Defines the category of a component type. This information is used to group component types in Game Studio. ComponentOrderAttribute Defines the order of a component type. This information is used to determine the most \"important\" component of a collection Entity Represents a game entity that typically aggregates multiple EntityComponent instances. For more information about entities, see Adding entities and Managing entities. EntityComponent Base class for Entity components. EntityComponentAttributeBase Base class for attributes for EntityComponent EntityComponentCollection A collection of EntityComponent managed exclusively by the Entity. EntityExtensions Extensions for Entity EntityManager Manage a collection of entities. EntityProcessor Entity processor, triggered on various EntityManager events such as Entity and Component additions and removals. EntityProcessorCollection Ordered collection of EntityProcessor based on the Order property. EntityProcessor<TComponent> Base implementation of EntityProcessor<TComponent, TData> when the TComponent and TData are the same EntityProcessor<TComponent, TData> Helper class for EntityProcessor, that will keep track of Entity matching certain EntityComponent requirements. EntityTransformExtensions Extensions for Entity and the TransformComponent. Game Main Game class system. GameSystem InputSystem The input system updating the input manager exposed by Input. InstanceComponent Represents a single instance of a model instancing component. InstancingComponent InstancingEntityTransform InstancingExtensions InstancingUserArray InstancingUserBuffer LightComponent Add a light to an Entity, that will be used during rendering. LightComponentExtensions Extensions for the LightComponent class. LightProbeComponent LightShaftBoundingVolumeComponent A bounding volume for light shafts to be rendered in, can take any Model as a volume LightShaftComponent The source for light shafts, should be placed on the same entity as the light component which will be used for light shafts ModelComponent Add a Model to an Entity, that will be used during rendering. ModelComponent.MeshInfo Per-entity state of each individual mesh of a model. ModelNodeLinkComponent ModelNodeTransformLink ModelViewHierarchyTransformOperation Updates Skeleton. PhysicsComponent PhysicsComponent.ColliderShapeCollection Prefab A prefab that contains entities. RequireComponentAttribute Allows to declare that a component requires another component in order to run (used for ScriptComponent Scene A scene. Scene.EntityCollection Scene.SceneCollection SceneInstance Manage a collection of entities within a RootScene. SceneSystem The scene system handles the scenes of a game. ScriptComponent Script component. SpriteComponent Add a Sprite to an Entity. It could be an animated sprite. StartupScript SyncScript A script whose Update() will be called every frame. TransformComponent Defines Position, Rotation and Scale of its Entity. TransformComponent.TransformChildrenCollection TransformLink Gives the ability to control how parent matrix is computed in a TransformComponent. TransformOperation Performs some work after world matrix has been updated. UIComponent Add an UIPage to an Entity. UIElementLinkComponent UIElementTransformLink UILibrary UILibraryExtensions UIPage A page containing a UI hierarchy. Structs EntityComponentAttributes Allow to query attributes used on an EntityComponent OpaqueComponentId Contains the id of a component Interfaces IAnimatableSpriteProvider The base interface for all classes providing animated sprites. IBlendTreeBuilder IInstancing ISceneRendererContext ISpriteProvider The base interface for all classes providing sprites. Enums CollisionState ModelTransformUsage SceneSystem.SplashScreenState"
  },
  "api/Stride.Extensions.BoundingExtensions.html": {
    "href": "api/Stride.Extensions.BoundingExtensions.html",
    "title": "Class BoundingExtensions | Stride API",
    "summary": "Class BoundingExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll public static class BoundingExtensions Inheritance object BoundingExtensions Methods ComputeBounds(VertexBufferBinding, ref Matrix, out BoundingSphere) public static BoundingBox ComputeBounds(this VertexBufferBinding vertexBufferBinding, ref Matrix matrix, out BoundingSphere boundingSphere) Parameters vertexBufferBinding VertexBufferBinding matrix Matrix boundingSphere BoundingSphere Returns BoundingBox"
  },
  "api/Stride.Extensions.GeometricPrimitiveExtensions.html": {
    "href": "api/Stride.Extensions.GeometricPrimitiveExtensions.html",
    "title": "Class GeometricPrimitiveExtensions | Stride API",
    "summary": "Class GeometricPrimitiveExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll An extension class for the GeometricPrimitive public static class GeometricPrimitiveExtensions Inheritance object GeometricPrimitiveExtensions Methods ToMeshDraw<T>(GeometricPrimitive<T>) public static MeshDraw ToMeshDraw<T>(this GeometricPrimitive<T> primitive) where T : unmanaged, IVertex Parameters primitive GeometricPrimitive<T> Returns MeshDraw Type Parameters T"
  },
  "api/Stride.Extensions.HalfBufferExtensions.html": {
    "href": "api/Stride.Extensions.HalfBufferExtensions.html",
    "title": "Class HalfBufferExtensions | Stride API",
    "summary": "Class HalfBufferExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll public static class HalfBufferExtensions Inheritance object HalfBufferExtensions Methods CompactHalf(ref VertexBufferBinding) public static void CompactHalf(ref VertexBufferBinding vertexBufferBinding) Parameters vertexBufferBinding VertexBufferBinding"
  },
  "api/Stride.Extensions.IndexExtensions.IndexMappingResult.html": {
    "href": "api/Stride.Extensions.IndexExtensions.IndexMappingResult.html",
    "title": "Struct IndexExtensions.IndexMappingResult | Stride API",
    "summary": "Struct IndexExtensions.IndexMappingResult Namespace Stride.Extensions Assembly Stride.Rendering.dll public struct IndexExtensions.IndexMappingResult Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Indices public int[] Indices Field Value int[] Vertices public int[] Vertices Field Value int[]"
  },
  "api/Stride.Extensions.IndexExtensions.html": {
    "href": "api/Stride.Extensions.IndexExtensions.html",
    "title": "Class IndexExtensions | Stride API",
    "summary": "Class IndexExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll public static class IndexExtensions Inheritance object IndexExtensions Methods CompactIndexBuffer(MeshDraw) Compacts the index buffer from 32 bits to 16 bits per index, if possible. public static bool CompactIndexBuffer(this MeshDraw meshData) Parameters meshData MeshDraw The mesh data. Returns bool Returns true if index buffer was actually compacted. Exceptions NotImplementedException GenerateIndexBuffer(MeshDraw, VertexDeclaration) Generates an index buffer for this mesh data. public static void GenerateIndexBuffer(this MeshDraw meshData, VertexDeclaration declaration) Parameters meshData MeshDraw The mesh data. declaration VertexDeclaration The final vertex declaration GenerateIndexBufferAEN(IndexBufferBinding, VertexBufferBinding, CommandList) public static int[] GenerateIndexBufferAEN(IndexBufferBinding indexBuffer, VertexBufferBinding vertexBuffer, CommandList commandList = null) Parameters indexBuffer IndexBufferBinding vertexBuffer VertexBufferBinding commandList CommandList Returns int[] GenerateIndexBufferAEN(MeshDraw) Generates the index buffer with dominant edge and vertex information. Each triangle gets its indices expanded to 12 control points, with 0 to 2 being original triangle, 3 to 8 being dominant edges and 9 to 11 being dominant vertices. public static void GenerateIndexBufferAEN(this MeshDraw meshData) Parameters meshData MeshDraw The mesh data. GenerateIndexMapping(VertexBufferBinding, CommandList, params string[]) Generates an index mapping with the specified vertex elements. If no vertex elements are specified, use the whole vertex. public static IndexExtensions.IndexMappingResult GenerateIndexMapping(this VertexBufferBinding vertexBufferBinding, CommandList commandList, params string[] usages) Parameters vertexBufferBinding VertexBufferBinding The vertex buffer binding. commandList CommandList usages string[] The vertex element usages to consider. Returns IndexExtensions.IndexMappingResult GetReversedWindingOrder(MeshDraw, out byte[]) Reverses the winding order of an index buffer. Assumes it is stored in TriangleList format. Works on both 32 and 16 bit indices. public static bool GetReversedWindingOrder(this MeshDraw meshData, out byte[] outBytes) Parameters meshData MeshDraw outBytes byte[] Output of the operation, the indices matching the reversed winding order Returns bool RemoveIndexBuffer(MeshDraw) Expand vertices using index buffer (if existing), and remove it. public static void RemoveIndexBuffer(this MeshDraw meshData) Parameters meshData MeshDraw The mesh data. ReverseWindingOrder(MeshDraw) Reverses the winding order of an index buffer. Assumes it is stored in TriangleList format. Works on both 32 and 16 bit indices. public static bool ReverseWindingOrder(this MeshDraw meshData) Parameters meshData MeshDraw Returns bool"
  },
  "api/Stride.Extensions.MergeExtensions.html": {
    "href": "api/Stride.Extensions.MergeExtensions.html",
    "title": "Class MergeExtensions | Stride API",
    "summary": "Class MergeExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll public static class MergeExtensions Inheritance object MergeExtensions Methods CreateDeclarationMergeGroup(IList<MeshDraw>) Group meshes that can be merged because they have the same vertex declaration. public static List<List<MeshDraw>> CreateDeclarationMergeGroup(IList<MeshDraw> meshDrawDatas) Parameters meshDrawDatas IList<MeshDraw> The list of meshes. Returns List<List<MeshDraw>> A list of grouped meshes. CreateIntIndexBuffer(int, int, byte[], bool) Create an int typed index buffer. public static byte[] CreateIntIndexBuffer(int offset, int count, byte[] baseIndices = null, bool is32Bits = true) Parameters offset int The offset to apply to the indices. count int The number of indices. baseIndices byte[] A possible base index buffer is32Bits bool Stating if baseIndices is filled with 32 bits int Returns byte[] A new index buffer. CreateOptimizedMergeGroups(IList<MeshDraw>, bool) Create group of MeshDrawData that will be merged. public static List<List<MeshDraw>> CreateOptimizedMergeGroups(IList<MeshDraw> meshDrawDatas, bool can32BitIndex) Parameters meshDrawDatas IList<MeshDraw> List of MehsDrawData to merge. can32BitIndex bool A flag stating if 32 bit index buffers are allowed. Returns List<List<MeshDraw>> A List of groups to merge internally. CreateShortIndexBuffer(int, int, byte[], bool) Create an short typed index buffer. public static byte[] CreateShortIndexBuffer(int offset, int count, byte[] baseIndices = null, bool is32Bit = true) Parameters offset int The offset to apply to the indices. count int The number of indices. baseIndices byte[] A possible base index buffer is32Bit bool Stating if baseIndices is filled with 32 bits int Returns byte[] A new index buffer. GroupDrawData(IList<MeshDraw>, bool) Group the meshes. public static List<MeshDraw> GroupDrawData(this IList<MeshDraw> meshDrawDatas, bool can32BitIndex) Parameters meshDrawDatas IList<MeshDraw> The list of meshes to group. can32BitIndex bool A flag stating if 32 bit index buffers are allowed Returns List<MeshDraw> The list of merged meshes. IsIndexed(IList<MeshDraw>) Check if a index buffer will be needed for this merge group. public static bool IsIndexed(IList<MeshDraw> meshDrawDatas) Parameters meshDrawDatas IList<MeshDraw> The list of MeshDrawdata to merge. Returns bool True if an index is needed, false otherwise. MergeDrawData(IList<MeshDraw>, bool) Transform a vertex buffer positions, normals, tangents and bitangents using the given matrix. public static MeshDraw MergeDrawData(IList<MeshDraw> meshDrawDatas, bool can32BitIndex) Parameters meshDrawDatas IList<MeshDraw> The mesh draw datas. can32BitIndex bool A flag stating if 32 bit index buffers. Returns MeshDraw"
  },
  "api/Stride.Extensions.PolySortExtensions.html": {
    "href": "api/Stride.Extensions.PolySortExtensions.html",
    "title": "Class PolySortExtensions | Stride API",
    "summary": "Class PolySortExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll public static class PolySortExtensions Inheritance object PolySortExtensions Methods SortMeshPolygons(MeshDraw, Vector3) public static void SortMeshPolygons(this MeshDraw meshData, Vector3 viewDirectionForSorting) Parameters meshData MeshDraw viewDirectionForSorting Vector3"
  },
  "api/Stride.Extensions.SimpleExtensions.html": {
    "href": "api/Stride.Extensions.SimpleExtensions.html",
    "title": "Class SimpleExtensions | Stride API",
    "summary": "Class SimpleExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll public static class SimpleExtensions Inheritance object SimpleExtensions Methods IsSimple(IndexBufferBinding) Determines whether the specified index buffer binding data is simple. A index buffer binding data is simple if: Offset is 0. Is32Bit is true. Buffer.Content.Length is equal to sizeof(int) * Count. public static bool IsSimple(this IndexBufferBinding indexBufferBindingData) Parameters indexBufferBindingData IndexBufferBinding The index buffer binding data. Returns bool IsSimple(VertexBufferBinding) Determines whether the specified vertex buffer binding data is simple. A vertex buffer binding data is simple if: Offset is 0. Stride is 0 (automatic), or equals to Declaration.VertexStride. Buffer.Content.Length is equal to Declaration.VertexStride * Count public static bool IsSimple(this VertexBufferBinding vertexBufferBindingData) Parameters vertexBufferBindingData VertexBufferBinding The vertex buffer binding data. Returns bool IsSimple(MeshDraw) Determines whether the specified mesh draw data is simple. A MeshDraw is simple if: It contains only one VertexBufferBinding, which must be simple. It contains either no VertexBufferBinding, or a simple one. StartLocation is 0. DrawCount is IndexBuffer.Count if there is an index buffer, otherwise VertexBuffers[0].Count. public static bool IsSimple(this MeshDraw meshDrawData) Parameters meshDrawData MeshDraw The mesh draw data. Returns bool"
  },
  "api/Stride.Extensions.SplitExtensions.html": {
    "href": "api/Stride.Extensions.SplitExtensions.html",
    "title": "Class SplitExtensions | Stride API",
    "summary": "Class SplitExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll public static class SplitExtensions Inheritance object SplitExtensions Methods SplitMesh(MeshDraw, bool) Split the mesh if it has strictly more than 65535 vertices (max index = 65534) on a plaftorm that does not support 32 bits indices. public static List<MeshDraw> SplitMesh(MeshDraw meshDrawData, bool can32bitIndex) Parameters meshDrawData MeshDraw The mesh to analyze. can32bitIndex bool A flag stating if 32 bit indices are allowed. Returns List<MeshDraw> A list of meshes. SplitMeshes(List<Mesh>, bool) public static List<Mesh> SplitMeshes(List<Mesh> meshes, bool can32bitIndex) Parameters meshes List<Mesh> can32bitIndex bool Returns List<Mesh>"
  },
  "api/Stride.Extensions.TNBExtensions.html": {
    "href": "api/Stride.Extensions.TNBExtensions.html",
    "title": "Class TNBExtensions | Stride API",
    "summary": "Class TNBExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll public static class TNBExtensions Inheritance object TNBExtensions Methods GenerateTangentBinormal(MeshDraw) Generates the tangents and binormals for this mesh data. Tangents and bitangents will be encoded as float4: float3 for tangent and an additional float for handedness (1 or -1), so that bitangent can be reconstructed. More info at http://www.terathon.com/code/tangent.html public static void GenerateTangentBinormal(this MeshDraw meshData) Parameters meshData MeshDraw The mesh data."
  },
  "api/Stride.Extensions.TransformExtensions.html": {
    "href": "api/Stride.Extensions.TransformExtensions.html",
    "title": "Class TransformExtensions | Stride API",
    "summary": "Class TransformExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll public static class TransformExtensions Inheritance object TransformExtensions Methods TransformBuffer(VertexBufferBinding, ref Matrix) Transform a vertex buffer positions, normals, tangents and bitangents using the given matrix. public static void TransformBuffer(this VertexBufferBinding vertexBufferBinding, ref Matrix matrix) Parameters vertexBufferBinding VertexBufferBinding The vertex container to transform matrix Matrix The matrix to use for the transform TransformBuffer(VertexBufferBinding, byte[], ref Matrix) Transform a vertex buffer positions, normals, tangents and bitangents using the given matrix. Using as source/destination data the provided bufferData byte array. public static void TransformBuffer(this VertexBufferBinding vertexBufferBinding, byte[] bufferData, ref Matrix matrix) Parameters vertexBufferBinding VertexBufferBinding The vertex container to transform bufferData byte[] The source/destination data array to transform matrix Matrix The matrix to use for the transform"
  },
  "api/Stride.Extensions.VertexExtensions.html": {
    "href": "api/Stride.Extensions.VertexExtensions.html",
    "title": "Class VertexExtensions | Stride API",
    "summary": "Class VertexExtensions Namespace Stride.Extensions Assembly Stride.Rendering.dll public static class VertexExtensions Inheritance object VertexExtensions Methods GetVertexBufferData<T>(MeshDraw, params string[]) Extracts a selection of vertices from a vertex buffer stored in this mesh data. [Obsolete(\"Use VertexBufferHelper instead\")] public static T[] GetVertexBufferData<T>(this MeshDraw meshData, params string[] vertexElementToExtract) where T : unmanaged Parameters meshData MeshDraw The mesh data. vertexElementToExtract string[] The declaration to extract (e.g. \"POSITION0\"...etc.) Returns T[] Type Parameters T"
  },
  "api/Stride.Extensions.html": {
    "href": "api/Stride.Extensions.html",
    "title": "Namespace Stride.Extensions | Stride API",
    "summary": "Namespace Stride.Extensions Classes BoundingExtensions GeometricPrimitiveExtensions An extension class for the GeometricPrimitive HalfBufferExtensions IndexExtensions MergeExtensions PolySortExtensions SimpleExtensions SplitExtensions TNBExtensions TransformExtensions VertexExtensions Structs IndexExtensions.IndexMappingResult"
  },
  "api/Stride.Games.AppContextType.html": {
    "href": "api/Stride.Games.AppContextType.html",
    "title": "Enum AppContextType | Stride API",
    "summary": "Enum AppContextType Namespace Stride.Games Assembly Stride.Graphics.dll Defines the type of a GameContext, which usually determines the platform, or a combination of platform and UI/presentation framework. public enum AppContextType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Android = 3 The Game runs on an Android device in an AndroidStrideGameView. Desktop = 0 The Game runs on desktop in a Windows Forms' Form or Control. DesktopSDL = 1 The Game runs on desktop in a SDL window. DesktopWpf = 2 The Game runs on desktop in a WPF window through a D3DImage. UWPCoreWindow = 5 The Game runs on UWP (Universal Windows Platform) in a CoreWindow. UWPXaml = 4 The Game runs on UWP (Universal Windows Platform) in a Xaml SwapChainPanel. iOS = 6 The Game runs on an iOS device in an iPhoneOSGameView."
  },
  "api/Stride.Games.GameBase.html": {
    "href": "api/Stride.Games.GameBase.html",
    "title": "Class GameBase | Stride API",
    "summary": "Class GameBase Namespace Stride.Games Assembly Stride.Games.dll The game. public abstract class GameBase : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder, IGame Inheritance object DisposeBase ComponentBase GameBase Implements IDisposable IComponent IReferencable ICollectorHolder IGame Derived Game Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors GameBase() Initializes a new instance of the GameBase class. protected GameBase() Fields Log protected readonly ILogger Log Field Value ILogger graphicsDeviceManager protected IGraphicsDeviceManager graphicsDeviceManager Field Value IGraphicsDeviceManager Properties Content Gets the ContentManager. public ContentManager Content { get; } Property Value ContentManager Context Gets the game context. public GameContext Context { get; } Property Value GameContext The game context. DrawInterpolationFactor Is used when we draw without running an update beforehand, so when both IsFixedTimeStep and IsDrawDesynchronized are set. It returns a number between 0 and 1 which represents the current position our DrawTime is in relation to the previous and next step. 0.5 would mean that we are rendering at a time halfway between the previous and next fixed-step. public float DrawInterpolationFactor { get; } Property Value float The draw interpolation factor. DrawTime The total and delta time to be used for logic running in the draw loop. public GameTime DrawTime { get; } Property Value GameTime DrawWhileMinimized Should this instance still render/draw when the window is minimized. Updates are still going to run regardless of the value set. public bool DrawWhileMinimized { get; set; } Property Value bool ForceOneUpdatePerDraw Gets or sets a value indicating whether this instance should force exactly one update step per one draw step protected bool ForceOneUpdatePerDraw { get; set; } Property Value bool true if this instance forces one update step per one draw step; otherwise, false. FullPlatformName Gets the full name of the device this game is running if available public string FullPlatformName { get; } Property Value string GameSystems Gets the game components registered by this game. public GameSystemCollection GameSystems { get; } Property Value GameSystemCollection The game components. GraphicsContext Gets the graphics context. public GraphicsContext GraphicsContext { get; } Property Value GraphicsContext The graphics context. GraphicsDevice Gets the graphics device. public GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice The graphics device. InactiveSleepTime Gets or sets the time between each Tick() when IsActive is false. public TimeSpan InactiveSleepTime { get; set; } Property Value TimeSpan The inactive sleep time. IsActive Gets a value indicating whether this instance is active. public bool IsActive { get; } Property Value bool true if this instance is active; otherwise, false. IsDrawDesynchronized When IsFixedTimeStep is set, is it allowed to render frames between two steps when we have time to do so. public bool IsDrawDesynchronized { get; set; } Property Value bool true if this instance's drawing is desychronized ; otherwise, false. IsExiting Gets a value indicating whether this instance is exiting. public bool IsExiting { get; } Property Value bool true if this instance is exiting; otherwise, false. IsFixedTimeStep Gets or sets a value indicating whether the elapsed time between each update should be constant, see TargetElapsedTime to configure the duration. public bool IsFixedTimeStep { get; set; } Property Value bool true if this instance is fixed time step; otherwise, false. IsMouseVisible Gets or sets a value indicating whether the mouse should be visible. public bool IsMouseVisible { get; set; } Property Value bool true if the mouse should be visible; otherwise, false. IsRunning Gets a value indicating whether this instance is running. public bool IsRunning { get; } Property Value bool LaunchParameters Gets the launch parameters. public LaunchParameters LaunchParameters { get; } Property Value LaunchParameters The launch parameters. MakeWindowVisibleOnRun Specifies if Visible is set to true during Run(GameContext). Only valid when IsUserManagingRun is false. protected bool MakeWindowVisibleOnRun { get; set; } Property Value bool MinimizedMinimumUpdateRate Access to the throttler used to set the minimum time allowed between each updates while the window is minimized and, depending on TreatNotFocusedLikeMinimized, while unfocused. public ThreadThrottler MinimizedMinimumUpdateRate { get; } Property Value ThreadThrottler Services Gets the service container. public ServiceRegistry Services { get; } Property Value ServiceRegistry The service container. TargetElapsedTime Gets or sets the target elapsed time, this is the duration of each tick/update when IsFixedTimeStep is enabled. public TimeSpan TargetElapsedTime { get; set; } Property Value TimeSpan The target elapsed time. TreatNotFocusedLikeMinimized Considers windows without user focus like a minimized window for MinimizedMinimumUpdateRate public bool TreatNotFocusedLikeMinimized { get; set; } Property Value bool UpdateTime The total and delta time to be used for logic running in the update loop. public GameTime UpdateTime { get; } Property Value GameTime Window Gets the abstract window. public GameWindow Window { get; } Property Value GameWindow The window. WindowMinimumUpdateRate Access to the throttler used to set the minimum time allowed between each updates. public ThreadThrottler WindowMinimumUpdateRate { get; } Property Value ThreadThrottler Methods BeginDraw() Starts the drawing of a frame. This method is followed by calls to Update(GameTime), Draw(GameTime) and EndDraw(bool). protected virtual bool BeginDraw() Returns bool true to continue drawing, false to not call Draw(GameTime) and EndDraw(bool) BeginRun() Called after all components are initialized, before the game loop starts. protected virtual void BeginRun() ConfirmRenderingSettings(bool) public abstract void ConfirmRenderingSettings(bool gameCreation) Parameters gameCreation bool Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. Draw(GameTime) Reference page contains code sample. protected virtual void Draw(GameTime gameTime) Parameters gameTime GameTime Time passed since the last call to Draw. EndDraw(bool) Ends the drawing of a frame. This method will always be preceeded by calls to BeginDraw() and perhaps Draw(GameTime) depending on if we had to do so. protected virtual void EndDraw(bool present) Parameters present bool EndRun() Called after the game loop has stopped running before exiting. protected virtual void EndRun() Exit() Exits the game. public void Exit() Initialize() Called after the Game is created, but before GraphicsDevice is available and before LoadContent(). Reference page contains code sample. protected virtual void Initialize() OnActivated(object, EventArgs) Raises the Activated event. Override this method to add code to handle when the game gains focus. protected virtual void OnActivated(object sender, EventArgs args) Parameters sender object The Game. args EventArgs Arguments for the Activated event. OnDeactivated(object, EventArgs) Raises the Deactivated event. Override this method to add code to handle when the game loses focus. protected virtual void OnDeactivated(object sender, EventArgs args) Parameters sender object The Game. args EventArgs Arguments for the Deactivated event. OnExiting(object, EventArgs) Raises an Exiting event. Override this method to add code to handle when the game is exiting. protected virtual void OnExiting(object sender, EventArgs args) Parameters sender object The Game. args EventArgs Arguments for the Exiting event. OnWindowCreated() protected virtual void OnWindowCreated() PrepareContext() Creates or updates Context before window and device are created. protected virtual void PrepareContext() RawTick(TimeSpan, int, float, bool) Call this method within your overriden RawTickProducer() to update and draw the game yourself. As this version is manual, there are a lot of functionality purposefully skipped: clamping elapsed time to a maximum, skipping drawing when the window is minimized, ResetElapsedTime(), SuppressDraw(), IsFixedTimeStep, IsDrawDesynchronized, MinimizedMinimumUpdateRate / WindowMinimumUpdateRate / TreatNotFocusedLikeMinimized. protected void RawTick(TimeSpan elapsedTimePerUpdate, int updateCount = 1, float drawInterpolationFactor = 0, bool drawFrame = true) Parameters elapsedTimePerUpdate TimeSpan The amount of time passed between each update of the game's system, the total time passed would be elapsedTimePerUpdate * updateCount. updateCount int The amount of updates that will be executed on the game's systems. drawInterpolationFactor float See DrawInterpolationFactor drawFrame bool Draw a frame. RawTickProducer() Calls RawTick(TimeSpan, int, float, bool) automatically based on this game's setup, override it to implement your own system. protected virtual void RawTickProducer() ResetElapsedTime() Resets the elapsed time counter. public void ResetElapsedTime() Run(GameContext) Call this method to initialize the game, begin running the game loop, and start processing events for the game. public void Run(GameContext gameContext = null) Parameters gameContext GameContext The window Context for this game. Exceptions InvalidOperationException Cannot run this instance while it is already running ShowMissingRequirementMessage(Exception) This is used to display an error message if there is no suitable graphics device or sound card. protected virtual bool ShowMissingRequirementMessage(Exception exception) Parameters exception Exception The exception to display. Returns bool The bool. SuppressDraw() Prevents calls to Draw until the next Update. public void SuppressDraw() Tick() Updates the game's clock and calls Update and Draw. public void Tick() UnloadContent() Called when graphics resources need to be unloaded. Override this method to unload any game-specific graphics resources. protected virtual void UnloadContent() Update(GameTime) Reference page contains links to related conceptual articles. protected virtual void Update(GameTime gameTime) Parameters gameTime GameTime Time passed since the last call to Update. Events Activated Occurs when [activated]. public event EventHandler<EventArgs> Activated Event Type EventHandler<EventArgs> Deactivated Occurs when [deactivated]. public event EventHandler<EventArgs> Deactivated Event Type EventHandler<EventArgs> Exiting Occurs when [exiting]. public event EventHandler<EventArgs> Exiting Event Type EventHandler<EventArgs> UnhandledException public event EventHandler<GameUnhandledExceptionEventArgs> UnhandledException Event Type EventHandler<GameUnhandledExceptionEventArgs> WindowCreated Occurs when [window created]. public event EventHandler<EventArgs> WindowCreated Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Games.GameContext-1.html": {
    "href": "api/Stride.Games.GameContext-1.html",
    "title": "Class GameContext<TK> | Stride API",
    "summary": "Class GameContext<TK> Namespace Stride.Games Assembly Stride.Games.dll Generic version of GameContext. The later is used to describe a generic game Context. This version enables us to constraint the game context to a specifc toolkit and ensures a better cohesion between the various toolkit specific classes, such as InputManager, GameWindow. public abstract class GameContext<TK> : GameContext Type Parameters TK Inheritance object GameContext GameContext<TK> Derived GameContextSDL Inherited Members GameContext.ContextType GameContext.IsUserManagingRun GameContext.RunCallback GameContext.ExitCallback GameContext.DeviceCreationFlags GameContext.InitializeDatabase GameContext.ProductLocation Extension Methods UnsafeUtilities.As<T>(object?) Constructors GameContext(TK, int, int, bool) Initializes a new instance of the GameContext class. protected GameContext(TK control, int requestedWidth = 0, int requestedHeight = 0, bool isUserManagingRun = false) Parameters control TK The control. requestedWidth int Width of the requested. requestedHeight int Height of the requested. isUserManagingRun bool Properties Control Underlying control associated with context. public TK Control { get; } Property Value TK"
  },
  "api/Stride.Games.GameContext.html": {
    "href": "api/Stride.Games.GameContext.html",
    "title": "Class GameContext | Stride API",
    "summary": "Class GameContext Namespace Stride.Games Assembly Stride.Games.dll Contains context used to render the Game (i.e. it abstracts a Windows Forms Control, or a DrawingSurface for UWP, etc.) public abstract class GameContext Inheritance object GameContext Derived GameContext<TK> Extension Methods UnsafeUtilities.As<T>(object?) Fields DeviceCreationFlags The device creation flags that will be used to create the GraphicsDevice. public DeviceCreationFlags DeviceCreationFlags Field Value DeviceCreationFlags The device creation flags. InitializeDatabase Indicate whether the game must initialize the default database when it starts running. public bool InitializeDatabase Field Value bool Properties ContextType Context type of this instance. public AppContextType ContextType { get; protected set; } Property Value AppContextType ExitCallback Gets the exit callback to be called when IsUserManagingRun is true when exiting the game. public Action ExitCallback { get; } Property Value Action The run loop. IsUserManagingRun Indicating whether the user will call the main loop. E.g. Stride is used as a library. public bool IsUserManagingRun { get; protected set; } Property Value bool ProductLocation Product location of game. TODO: Only used for retrieving game's icon. See ProductName for future refactoring public static string ProductLocation { get; } Property Value string RunCallback Gets the main loop callback to be called when IsUserManagingRun is true. public Action RunCallback { get; } Property Value Action The run loop."
  },
  "api/Stride.Games.GameContextFactory.html": {
    "href": "api/Stride.Games.GameContextFactory.html",
    "title": "Class GameContextFactory | Stride API",
    "summary": "Class GameContextFactory Namespace Stride.Games Assembly Stride.Games.dll Given a AppContextType creates the corresponding GameContext instance based on the current executing platform. public static class GameContextFactory Inheritance object GameContextFactory Methods NewGameContext(AppContextType, int, int, bool) Given a type create the appropriate game Context for the current executing platform. public static GameContext NewGameContext(AppContextType type, int requestedWidth = 0, int requestedHeight = 0, bool isUserManagingRun = false) Parameters type AppContextType requestedWidth int requestedHeight int isUserManagingRun bool Returns GameContext NewGameContextAndroid() public static GameContext NewGameContextAndroid() Returns GameContext NewGameContextDesktop(int, int, bool) public static GameContext NewGameContextDesktop(int requestedWidth = 0, int requestedHeight = 0, bool isUserManagingRun = false) Parameters requestedWidth int requestedHeight int isUserManagingRun bool Returns GameContext NewGameContextSDL(int, int, bool) public static GameContext NewGameContextSDL(int requestedWidth = 0, int requestedHeight = 0, bool isUserManagingRun = false) Parameters requestedWidth int requestedHeight int isUserManagingRun bool Returns GameContext NewGameContextUWPCoreWindow(int, int) public static GameContext NewGameContextUWPCoreWindow(int requestedWidth = 0, int requestedHeight = 0) Parameters requestedWidth int requestedHeight int Returns GameContext NewGameContextUWPXaml(int, int) public static GameContext NewGameContextUWPXaml(int requestedWidth = 0, int requestedHeight = 0) Parameters requestedWidth int requestedHeight int Returns GameContext NewGameContextWpf(int, int, bool) public static GameContext NewGameContextWpf(int requestedWidth = 0, int requestedHeight = 0, bool isUserManagingRun = false) Parameters requestedWidth int requestedHeight int isUserManagingRun bool Returns GameContext NewGameContextiOS() public static GameContext NewGameContextiOS() Returns GameContext"
  },
  "api/Stride.Games.GameContextSDL.html": {
    "href": "api/Stride.Games.GameContextSDL.html",
    "title": "Class GameContextSDL | Stride API",
    "summary": "Class GameContextSDL Namespace Stride.Games Assembly Stride.Games.dll A GameContext to use for rendering to an existing SDL Window. public class GameContextSDL : GameContext<Window> Inheritance object GameContext GameContext<Window> GameContextSDL Inherited Members GameContext<Window>.Control GameContext.ContextType GameContext.IsUserManagingRun GameContext.RunCallback GameContext.ExitCallback GameContext.DeviceCreationFlags GameContext.InitializeDatabase GameContext.ProductLocation Extension Methods UnsafeUtilities.As<T>(object?) Constructors GameContextSDL(Window, int, int, bool) Initializes a new instance of the GameContext class. public GameContextSDL(Window control, int requestedWidth = 0, int requestedHeight = 0, bool isUserManagingRun = false) Parameters control Window The control. requestedWidth int Width of the requested. requestedHeight int Height of the requested. isUserManagingRun bool"
  },
  "api/Stride.Games.GameFormSDL.html": {
    "href": "api/Stride.Games.GameFormSDL.html",
    "title": "Class GameFormSDL | Stride API",
    "summary": "Class GameFormSDL Namespace Stride.Games Assembly Stride.Games.dll Default Rendering Form on SDL based applications. public class GameFormSDL : Window, IDisposable Inheritance object Window GameFormSDL Implements IDisposable Inherited Members Window.SDL Window.SendToBack() Window.BringToFront() Window.MousePosition Window.RelativeCursorPosition Window.TopMost Window.MinimizeOnFocusLoss Window.Show() Window.FullscreenIsBorderlessWindow Window.IsFullScreen Window.Visible Window.WindowState Window.Focused Window.MaximizeBox Window.Size Window.Opacity Window.ClientSize Window.ClientRectangle Window.Location Window.Text Window.FormBorderStyle Window.SetRelativeMouseMode(bool) Window.PointerButtonPressActions Window.PointerButtonReleaseActions Window.MouseWheelActions Window.MouseMoveActions Window.KeyDownActions Window.KeyUpActions Window.TextEditingActions Window.TextInputActions Window.CloseActions Window.JoystickDeviceAdded Window.JoystickDeviceRemoved Window.FingerMoveActions Window.FingerPressActions Window.FingerReleaseActions Window.SizeChangedActions Window.UserResizedActions Window.ActivateActions Window.DeActivateActions Window.MinimizedActions Window.MaximizedActions Window.RestoredActions Window.MouseEnterActions Window.MouseLeaveActions Window.FocusGainedActions Window.FocusLostActions Window.DropFileActions Window.ProcessEvent(Event) Window.Handle Window.Display Window.Surface Window.SdlHandle Window.Exists Window.IsDisposed Window.Disposed Window.Dispose(bool) Window.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors GameFormSDL() Initializes a new instance of the 'GameForm' class. public GameFormSDL() GameFormSDL(string) Initializes a new instance of the 'GameForm' class. public GameFormSDL(string text) Parameters text string The text. Events AppActivated Occurs when [app activated]. public event EventHandler<EventArgs> AppActivated Event Type EventHandler<EventArgs> AppDeactivated Occurs when [app deactivated]. public event EventHandler<EventArgs> AppDeactivated Event Type EventHandler<EventArgs> FullscreenToggle Occurs when alt-enter key combination has been pressed. public event EventHandler<EventArgs> FullscreenToggle Event Type EventHandler<EventArgs> PauseRendering Occurs when the application should stop rendering. public event EventHandler<EventArgs> PauseRendering Event Type EventHandler<EventArgs> ResumeRendering Occurs when the application should resume rendering, if it is paused. public event EventHandler<EventArgs> ResumeRendering Event Type EventHandler<EventArgs> SizeChanged Occurs when the size of the window has changed. public event EventHandler<EventArgs> SizeChanged Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Games.GameGraphicsParameters.html": {
    "href": "api/Stride.Games.GameGraphicsParameters.html",
    "title": "Class GameGraphicsParameters | Stride API",
    "summary": "Class GameGraphicsParameters Namespace Stride.Games Assembly Stride.Games.dll Describes the preferred graphics configuration for a Game. public class GameGraphicsParameters Inheritance object GameGraphicsParameters Extension Methods UnsafeUtilities.As<T>(object?) Fields ColorSpace The color space to use for presenting the frame to the screen. public ColorSpace ColorSpace Field Value ColorSpace Remarks The Color Space defines how colors are represented and displayed on the screen. Common values include: Gamma It usually represents sRGB, the standard RGB color space used in most monitors and applications. It offers a limited range of colors suitable for general purposes. Linear A linear color space suitable for high-dynamic-range color values like HDR10, supporting a wider range of brightness and colors. This is commonly used in modern HDR displays for enhanced image quality. Choosing the appropriate color space affects the visual quality of your application. For example, sRGB is recommended for compatibility, while HDR10 may enhance visuals in games or applications designed for HDR content. IsFullScreen A value indicating whether the application must render in full-screen mode (true) or inside a window (false). public bool IsFullScreen Field Value bool PreferredBackBufferFormat A PixelFormat specifying the display format. public PixelFormat PreferredBackBufferFormat Field Value PixelFormat PreferredBackBufferHeight The preferred height of the back-buffer, in pixels. public int PreferredBackBufferHeight Field Value int Remarks Both PreferredBackBufferWidth and PreferredBackBufferHeight determine both the screen resolution (if in full-screen mode) or the window size (if in windowed-mode). PreferredBackBufferWidth The preferred width of the back-buffer, in pixels. public int PreferredBackBufferWidth Field Value int Remarks Both PreferredBackBufferWidth and PreferredBackBufferHeight determine both the screen resolution (if in full-screen mode) or the window size (if in windowed-mode). PreferredDepthStencilFormat A PixelFormat specifying the depth-stencil format. public PixelFormat PreferredDepthStencilFormat Field Value PixelFormat Remarks The Depth Buffer (also known as Z-buffer) is used to determine the depth of each pixel so close geometry correctly occludes farther geometry. The format determines the precission of the depth buffer. The Stencil Buffer is used to store additional information for each pixel, such as marking or discarding specific pixels for different effects. This format determines both because usually the stencil buffer is a part of the depth buffer reserved for other uses. Some examples are D24_UNorm_S8_UInt, where the depth buffer uses 24 bits and the stencil buffer uses 8 bits, for a total of 32 bits per pixel, or D32_Float, which uses 32 bits for the depth buffer and no bits for the stencil buffer. PreferredFullScreenOutputIndex The index of the output (monitor) to use when rendering in full-screen mode. public int PreferredFullScreenOutputIndex Field Value int Remarks This output index does not have any effect when windowed mode is used (i.e. when IsFullScreen is set to false). PreferredGraphicsProfile An array of GraphicsProfiles ordered according to preference, where they will be tested in order from the start and the first to succeed will be selected. public GraphicsProfile[] PreferredGraphicsProfile Field Value GraphicsProfile[] Remarks The Graphics Profile determines which hardware and software characteristics and features are available for rendering, so it directly impacts things as performance, image quality, and graphics effects complexity. Also, higher profiles may enable advanced graphical effects but require modern hardware. PreferredMultisampleCount A MultisampleCount indicating the number of sample locations during multi-sampling. public MultisampleCount PreferredMultisampleCount Field Value MultisampleCount Remarks The multi-sampling is applied to the back-buffer to reduce the aliasing artifacts. This is known as Multi-Sampling Anti-Aliasing (MSAA). The higher the number of samples, the aliasing patterns will be less visible, but it will result in more memory being consumed, and costlier rasterization. If None is selected, no multi-sampling will be applied. Common values include X2 (minimal anti-aliasing) and X8 (high-quality anti-aliasing). Higher values increase GPU workload. PreferredRefreshRate The preferred refresh rate, in hertz. public Rational PreferredRefreshRate Field Value Rational Remarks The Refresh Rate is the number of times per second the screen is refreshed, i.e. the number of frames per second the monitor can display. The value is represented as a Rational, so it can represent both usual integer refresh rates (e.g. 60Hz) and fractional refresh rates (e.g. 59.94Hz). Usually, the refresh rate is only respected when rendering in full-screen mode (i.e. when IsFullScreen is set to true). Common refresh rates include 60Hz, 120Hz, and 144Hz, depending on monitor capabilities. RequiredAdapterUid A value indicating whether the application should use a specific adapter (based on its AdapterUid) for rendering. public string? RequiredAdapterUid Field Value string Remarks If RequiredAdapterUid is not null, the engine will try to initialize a device with the same AdapterUid. SynchronizeWithVerticalRetrace A value indicating whether to synchronize the presentation of the rendered frame with the vertical retrace (i.e. PreferredRefreshRate) of the monitor. public bool SynchronizeWithVerticalRetrace Field Value bool Remarks The synchronization with the vertical refresh, also known as V-Sync, limits the frequency of presenting frames to the screen to PreferredRefreshRate. If enabled (true), the number of frames produced each second will be limited by the number of times the monitor can refresh its image each second. If disabled (false), the number of frames produced each second will be unlimited. However, due to mismatch between frame generation and monitor refresh rate, an artifact known as screen tearing can occur when multiple frames are displayed simultanously. This is especially noticeable at high frame rates."
  },
  "api/Stride.Games.GameProfilingKeys.html": {
    "href": "api/Stride.Games.GameProfilingKeys.html",
    "title": "Class GameProfilingKeys | Stride API",
    "summary": "Class GameProfilingKeys Namespace Stride.Games Assembly Stride.Games.dll Keys used for profiling the game class. public static class GameProfilingKeys Inheritance object GameProfilingKeys Fields EntityProcessorInitialize Profiling Entity processors initialization. public static readonly ProfilingKey EntityProcessorInitialize Field Value ProfilingKey Game public static readonly ProfilingKey Game Field Value ProfilingKey GameDraw Profiling Draw() method of a GameBase. This profiling is only used through markers published every seconds. public static readonly ProfilingKey GameDraw Field Value ProfilingKey GameDrawFPS Profiling Draw() method of a GameBase. This profiling is only used through markers published every seconds. public static readonly ProfilingKey GameDrawFPS Field Value ProfilingKey GameEndDraw Profiling EndDraw() method of a GameBase. This profiling is only used through markers published every seconds. public static readonly ProfilingKey GameEndDraw Field Value ProfilingKey GameInitialize Profiling initialization of a Game instance. public static readonly ProfilingKey GameInitialize Field Value ProfilingKey GameLoadContent Profiling load content of a Game instance. public static readonly ProfilingKey GameLoadContent Field Value ProfilingKey GameSystemInitialize Profiling initialization of a IGameSystemBase. public static readonly ProfilingKey GameSystemInitialize Field Value ProfilingKey GameSystemLoadContent Profiling LoadContent of a IGameSystemBase. public static readonly ProfilingKey GameSystemLoadContent Field Value ProfilingKey GameUpdate Profiling Update() method of a GameBase. This profiling is only used through markers published every seconds. public static readonly ProfilingKey GameUpdate Field Value ProfilingKey ObjectDatabaseInitialize Profiling Object Database initialization. public static readonly ProfilingKey ObjectDatabaseInitialize Field Value ProfilingKey"
  },
  "api/Stride.Games.GameSystemBase.html": {
    "href": "api/Stride.Games.GameSystemBase.html",
    "title": "Class GameSystemBase | Stride API",
    "summary": "Class GameSystemBase Namespace Stride.Games Assembly Stride.Games.dll Base class for a Game System. public abstract class GameSystemBase : ComponentBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Derived AudioSystem GameSystem InputSystem ScriptSystem SceneSystem GameWindowRenderer DebugTextSystem GameProfilingSystem EffectSystem GameFontSystem SpriteAnimationSystem StreamingManager UISystem VideoSystem VRDeviceSystem Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks A Game System is a component that can be used to manage game logic, resources, or other systems within the Game. For example, it can be used to manage audio, input, or other subsystems. Game Systems are typically added to the GameBase class and are initialized when the game starts. If the Game System needs to be updated or drawn, it can implement the IUpdateable and IDrawable interfaces respectively. Constructors GameSystemBase(IServiceRegistry) Initializes a new instance of the GameSystemBase class. protected GameSystemBase(IServiceRegistry registry) Parameters registry IServiceRegistry The registry. Remarks The GameSystem is expecting the following services to be registered: IGame and IContentManager. Properties Content Gets the content manager. This value can be null in a mock environment. protected IContentManager? Content { get; } Property Value IContentManager The content. DrawOrder Gets the draw order relative to other Game Components. IDrawable components with a lower value are drawn first. public int DrawOrder { get; set; } Property Value int Enabled Gets a value indicating whether the game component's Update method should be called by Update(GameTime). public bool Enabled { get; set; } Property Value bool true if update is enabled; otherwise, false. Game Gets the Game associated with this GameSystemBase. This value can be null in a mock environment. public GameBase? Game { get; } Property Value GameBase The game. Remarks This value can be null GraphicsDevice Gets the Graphics Device. protected GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice The Graphics Device. This can be null if it has not been initialized yet. Services Gets the services registry. [NotNull] public IServiceRegistry Services { get; } Property Value IServiceRegistry The services registry. UpdateOrder Gets the update order relative to other game components. Lower values are updated first. public int UpdateOrder { get; set; } Property Value int The update order. Visible Gets a value indicating whether the Game Component's Draw(GameTime) method should be called by Draw(GameTime). public bool Visible { get; set; } Property Value bool true if the Game Component is visible and should be drawn; otherwise, false. Methods BeginDraw() Starts the drawing of the Game Component. It prepares the drawable component for rendering and determines whether a following Draw(GameTime) and EndDraw() call should occur. public virtual bool BeginDraw() Returns bool true if Draw(GameTime) should be called; false otherwise. Draw(GameTime) Draws the Game Component. public virtual void Draw(GameTime gameTime) Parameters gameTime GameTime The current timing information. EndDraw() Ends the drawing of the Game Component. public virtual void EndDraw() Remarks This method must be preceeded by calls to Draw(GameTime) and BeginDraw(). Exceptions GraphicsDeviceException The Game Device this Game Component is using to draw itself is not in a valid state to end drawing, or it is not available. Initialize() Initializes the Game System. public virtual void Initialize() Remarks This method is called when the component is added to the Game. This can be used for tasks like querying for services the component needs and setting up non-graphics resources (as here the Graphics Device may have not been initialized yet). InitializeGraphicsDeviceService() Initializes the Graphics Device Service if it has not been initialized. protected void InitializeGraphicsDeviceService() Remarks Upon returning from this method, the IGraphicsDeviceService may be available to get the GraphicsDevice, so that the Game System can use it if it is initialized. LoadContent() protected virtual void LoadContent() OnDrawOrderChanged(object, EventArgs) Method that is called when the DrawOrder property changes. Raises the DrawOrderChanged event. protected virtual void OnDrawOrderChanged(object source, EventArgs e) Parameters source object The source of the event. e EventArgs An EventArgs that contains the event data. OnUpdateOrderChanged(object, EventArgs) protected virtual void OnUpdateOrderChanged(object source, EventArgs e) Parameters source object e EventArgs UnloadContent() protected virtual void UnloadContent() Update(GameTime) This method is called when this game component is updated. public virtual void Update(GameTime gameTime) Parameters gameTime GameTime The current timing. Events DrawOrderChanged Occurs when the DrawOrder property changes. public event EventHandler<EventArgs> DrawOrderChanged Event Type EventHandler<EventArgs> EnabledChanged Occurs when the Enabled property changes. public event EventHandler<EventArgs> EnabledChanged Event Type EventHandler<EventArgs> UpdateOrderChanged Occurs when the UpdateOrder property changes. public event EventHandler<EventArgs> UpdateOrderChanged Event Type EventHandler<EventArgs> VisibleChanged Occurs when the Visible property changes. public event EventHandler<EventArgs> VisibleChanged Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Games.GameSystemCollection.html": {
    "href": "api/Stride.Games.GameSystemCollection.html",
    "title": "Class GameSystemCollection | Stride API",
    "summary": "Class GameSystemCollection Namespace Stride.Games Assembly Stride.Games.dll A collection of game components. public class GameSystemCollection : TrackingCollection<IGameSystemBase>, ITrackingCollectionChanged, IGameSystemCollection, IList<IGameSystemBase>, ICollection<IGameSystemBase>, IReadOnlyList<IGameSystemBase>, IReadOnlyCollection<IGameSystemBase>, IEnumerable<IGameSystemBase>, IEnumerable, IDisposable Inheritance object FastCollection<IGameSystemBase> TrackingCollection<IGameSystemBase> GameSystemCollection Implements ITrackingCollectionChanged IGameSystemCollection IList<IGameSystemBase> ICollection<IGameSystemBase> IReadOnlyList<IGameSystemBase> IReadOnlyCollection<IGameSystemBase> IEnumerable<IGameSystemBase> IEnumerable IDisposable Inherited Members TrackingCollection<IGameSystemBase>.CollectionChanged TrackingCollection<IGameSystemBase>.InsertItem(int, IGameSystemBase) TrackingCollection<IGameSystemBase>.RemoveItem(int) TrackingCollection<IGameSystemBase>.ClearItems() TrackingCollection<IGameSystemBase>.ClearItemsEvents() TrackingCollection<IGameSystemBase>.SetItem(int, IGameSystemBase) FastCollection<IGameSystemBase>.Capacity FastCollection<IGameSystemBase>.Count FastCollection<IGameSystemBase>.this[int] FastCollection<IGameSystemBase>.Add(IGameSystemBase) FastCollection<IGameSystemBase>.Clear() FastCollection<IGameSystemBase>.Contains(IGameSystemBase) FastCollection<IGameSystemBase>.CopyTo(IGameSystemBase[], int) FastCollection<IGameSystemBase>.IndexOf(IGameSystemBase) FastCollection<IGameSystemBase>.Insert(int, IGameSystemBase) FastCollection<IGameSystemBase>.Remove(IGameSystemBase) FastCollection<IGameSystemBase>.RemoveAt(int) FastCollection<IGameSystemBase>.AddRange<TE>(TE) FastCollection<IGameSystemBase>.GetEnumerator() FastCollection<IGameSystemBase>.Sort() FastCollection<IGameSystemBase>.Sort(IComparer<IGameSystemBase>) FastCollection<IGameSystemBase>.Sort(int, int, IComparer<IGameSystemBase>) FastCollection<IGameSystemBase>.IsReadOnly FastCollection<IGameSystemBase>.EnsureCapacity(int) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors GameSystemCollection(IServiceRegistry) public GameSystemCollection(IServiceRegistry registry) Parameters registry IServiceRegistry Properties IsFirstUpdateDone Gets a value indicating whether first update has been done. public bool IsFirstUpdateDone { get; } Property Value bool true if first update has been done; otherwise, false. State Gets the state of this game system collection. public GameSystemState State { get; } Property Value GameSystemState The state of this game system collection. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Draw(GameTime) Reference page contains code sample. public virtual void Draw(GameTime gameTime) Parameters gameTime GameTime Time passed since the last call to Draw. Initialize() public void Initialize() LoadContent() Loads the content. public virtual void LoadContent() UnloadContent() Called when graphics resources need to be unloaded. Override this method to unload any game-specific graphics resources. public virtual void UnloadContent() Update(GameTime) Reference page contains links to related conceptual articles. public virtual void Update(GameTime gameTime) Parameters gameTime GameTime Time passed since the last call to Update."
  },
  "api/Stride.Games.GameSystemState.html": {
    "href": "api/Stride.Games.GameSystemState.html",
    "title": "Enum GameSystemState | Stride API",
    "summary": "Enum GameSystemState Namespace Stride.Games Assembly Stride.Games.dll Describes state of the GameSystemCollection. public enum GameSystemState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ContentLoaded = 2 Initialized = 1 None = 0"
  },
  "api/Stride.Games.GameTime.html": {
    "href": "api/Stride.Games.GameTime.html",
    "title": "Class GameTime | Stride API",
    "summary": "Class GameTime Namespace Stride.Games Assembly Stride.Games.dll Current timing used for variable-step (real time) or fixed-step (game time) games. public class GameTime Inheritance object GameTime Extension Methods UnsafeUtilities.As<T>(object?) Constructors GameTime() Initializes a new instance of the GameTime class. public GameTime() GameTime(TimeSpan, TimeSpan) Initializes a new instance of the GameTime class. public GameTime(TimeSpan totalTime, TimeSpan elapsedTime) Parameters totalTime TimeSpan The total game time since the start of the game. elapsedTime TimeSpan The elapsed game time since the last update. Properties Elapsed Gets the elapsed game time since the last update public TimeSpan Elapsed { get; } Property Value TimeSpan The elapsed game time. Factor Gets or sets the time factor. This value controls how much the warped time flows, this includes physics, animations and particles. A value between 0 and 1 will slow time, a value above 1 will make it faster. public double Factor { get; set; } Property Value double The multiply factor, a double value higher or equal to 0 FrameCount Gets the current frame count since the start of the game. public int FrameCount { get; } Property Value int FramePerSecond Gets the number of frame per second (FPS) for the current running game. public float FramePerSecond { get; } Property Value float The frame per second. FramePerSecondUpdated Gets a value indicating whether the FramePerSecond and TimePerFrame were updated for this frame. public bool FramePerSecondUpdated { get; } Property Value bool true if the FramePerSecond and TimePerFrame were updated for this frame; otherwise, false. TimePerFrame Gets the time per frame. public TimeSpan TimePerFrame { get; } Property Value TimeSpan The time per frame. Total Gets the amount of game time since the start of the game. public TimeSpan Total { get; } Property Value TimeSpan The total game time. WarpElapsed Gets the amount of time elapsed multiplied by the time factor. public TimeSpan WarpElapsed { get; } Property Value TimeSpan The warped elapsed time Methods ResetTimeFactor() public void ResetTimeFactor()"
  },
  "api/Stride.Games.GameUnhandledExceptionEventArgs.html": {
    "href": "api/Stride.Games.GameUnhandledExceptionEventArgs.html",
    "title": "Class GameUnhandledExceptionEventArgs | Stride API",
    "summary": "Class GameUnhandledExceptionEventArgs Namespace Stride.Games Assembly Stride.Games.dll public class GameUnhandledExceptionEventArgs Inheritance object GameUnhandledExceptionEventArgs Extension Methods UnsafeUtilities.As<T>(object?) Constructors GameUnhandledExceptionEventArgs(object, bool) Initializes a new instance of the GameUnhandledExceptionEventArgs class. public GameUnhandledExceptionEventArgs(object exceptionObject, bool isTerminating) Parameters exceptionObject object The exception object. isTerminating bool if set to true [is terminating]. Properties ExceptionObject Gets the unhandled exception object. public object ExceptionObject { get; } Property Value object The unhandled exception object. IsTerminating Gets a value indicating whether the CLR is terminating. public bool IsTerminating { get; } Property Value bool true if CLR is terminating; otherwise, false."
  },
  "api/Stride.Games.GameWindow-1.html": {
    "href": "api/Stride.Games.GameWindow-1.html",
    "title": "Class GameWindow<TK> | Stride API",
    "summary": "Class GameWindow<TK> Namespace Stride.Games Assembly Stride.Games.dll public abstract class GameWindow<TK> : GameWindow, IDisposable, IComponent, IReferencable, ICollectorHolder Type Parameters TK Inheritance object DisposeBase ComponentBase GameWindow GameWindow<TK> Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GameWindow.IsActivated GameWindow.Activated GameWindow.ClientSizeChanged GameWindow.Deactivated GameWindow.OrientationChanged GameWindow.FullscreenChanged GameWindow.Closing GameWindow.AllowUserResizing GameWindow.ClientBounds GameWindow.CurrentOrientation GameWindow.IsMinimized GameWindow.Focused GameWindow.IsMouseVisible GameWindow.NativeWindow GameWindow.Visible GameWindow.Opacity GameWindow.Position GameWindow.IsBorderLess GameWindow.Title GameWindow.PreferredWindowedSize GameWindow.PreferredFullscreenSize GameWindow.FullscreenIsBorderlessWindow GameWindow.IsFullscreen GameWindow.BeginScreenDeviceChange(bool) GameWindow.EndScreenDeviceChange() GameWindow.EndScreenDeviceChange(int, int) GameWindow.SetSize(Int2) GameWindow.CreateUserManagedMessageLoop() GameWindow.SetSupportedOrientations(DisplayOrientation) GameWindow.OnActivated(object, EventArgs) GameWindow.OnClientSizeChanged(object, EventArgs) GameWindow.OnDeactivated(object, EventArgs) GameWindow.OnOrientationChanged(object, EventArgs) GameWindow.OnFullscreenToggle(object, EventArgs) GameWindow.OnDisableFullScreen(object, EventArgs) GameWindow.OnClosing(object, EventArgs) GameWindow.SetTitle(string) ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Methods Initialize(GameContext) protected override sealed void Initialize(GameContext gameContext) Parameters gameContext GameContext Initialize(GameContext<TK>) protected abstract void Initialize(GameContext<TK> context) Parameters context GameContext<TK>"
  },
  "api/Stride.Games.GameWindow.html": {
    "href": "api/Stride.Games.GameWindow.html",
    "title": "Class GameWindow | Stride API",
    "summary": "Class GameWindow Namespace Stride.Games Assembly Stride.Games.dll An abstract window. public abstract class GameWindow : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GameWindow Implements IDisposable IComponent IReferencable ICollectorHolder Derived GameWindow<TK> Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields IsActivated Indicate if the window is currently activated. public bool IsActivated Field Value bool Properties AllowUserResizing Gets or sets, user possibility to resize this window. public abstract bool AllowUserResizing { get; set; } Property Value bool ClientBounds Gets the client bounds. public abstract Rectangle ClientBounds { get; } Property Value Rectangle The client bounds. CurrentOrientation Gets the current orientation. public abstract DisplayOrientation CurrentOrientation { get; } Property Value DisplayOrientation The current orientation. Focused Gets a value indicating whether this instance is in focus. public abstract bool Focused { get; } Property Value bool true if this instance is in focus; otherwise, false. FullscreenIsBorderlessWindow Whether the fullscreen mode should be a borderless window matching the desktop size. public bool FullscreenIsBorderlessWindow { get; set; } Property Value bool Remarks This flag is currently ignored on all game platforms other than SDL. IsBorderLess Gets or sets a value indicating whether this window has a border public abstract bool IsBorderLess { get; set; } Property Value bool true if this window has a border; otherwise, false. IsFullscreen Switches between fullscreen and windowed mode. public bool IsFullscreen { get; set; } Property Value bool IsMinimized Gets a value indicating whether this instance is minimized. public abstract bool IsMinimized { get; } Property Value bool true if this instance is minimized; otherwise, false. IsMouseVisible Gets or sets a value indicating whether the mouse pointer is visible over this window. public abstract bool IsMouseVisible { get; set; } Property Value bool true if this instance is mouse visible; otherwise, false. NativeWindow Gets the native window. public abstract WindowHandle NativeWindow { get; } Property Value WindowHandle The native window. Opacity Gets or sets the opacity of the window. public abstract double Opacity { get; set; } Property Value double 1.0d is fully opaque, 0.0d is fully transparent. The value will automatically be clamped to [0.0d, 1.0d]. Remarks The default value, if the window is null, is considered fully opaque (1.0d). Position Gets or sets the position of the window on the screen. public virtual Int2 Position { get; set; } Property Value Int2 PreferredFullscreenSize The size the window should have when switching from windowed to fullscreen mode. To get the current actual size use ClientBounds. public Int2 PreferredFullscreenSize { get; set; } Property Value Int2 PreferredWindowedSize The size the window should have when switching from fullscreen to windowed mode. To get the current actual size use ClientBounds. This gets overwritten when the user resizes the window. public Int2 PreferredWindowedSize { get; set; } Property Value Int2 Title Gets or sets the title of the window. public string Title { get; set; } Property Value string Visible Gets or sets a value indicating whether this GameWindow is visible. public abstract bool Visible { get; set; } Property Value bool true if visible; otherwise, false. Methods BeginScreenDeviceChange(bool) public abstract void BeginScreenDeviceChange(bool willBeFullScreen) Parameters willBeFullScreen bool CreateUserManagedMessageLoop() public virtual IMessageLoop CreateUserManagedMessageLoop() Returns IMessageLoop EndScreenDeviceChange() public void EndScreenDeviceChange() EndScreenDeviceChange(int, int) public abstract void EndScreenDeviceChange(int clientWidth, int clientHeight) Parameters clientWidth int clientHeight int Initialize(GameContext) protected abstract void Initialize(GameContext gameContext) Parameters gameContext GameContext OnActivated(object, EventArgs) protected void OnActivated(object source, EventArgs e) Parameters source object e EventArgs OnClientSizeChanged(object, EventArgs) protected void OnClientSizeChanged(object source, EventArgs e) Parameters source object e EventArgs OnClosing(object, EventArgs) protected void OnClosing(object source, EventArgs e) Parameters source object e EventArgs OnDeactivated(object, EventArgs) protected void OnDeactivated(object source, EventArgs e) Parameters source object e EventArgs OnDisableFullScreen(object, EventArgs) protected void OnDisableFullScreen(object source, EventArgs e) Parameters source object e EventArgs OnFullscreenToggle(object, EventArgs) protected void OnFullscreenToggle(object source, EventArgs e) Parameters source object e EventArgs OnOrientationChanged(object, EventArgs) protected void OnOrientationChanged(object source, EventArgs e) Parameters source object e EventArgs SetSize(Int2) Sets the size of the client area and triggers the ClientSizeChanged event. This will trigger a backbuffer resize too. public void SetSize(Int2 size) Parameters size Int2 SetSupportedOrientations(DisplayOrientation) protected abstract void SetSupportedOrientations(DisplayOrientation orientations) Parameters orientations DisplayOrientation SetTitle(string) protected abstract void SetTitle(string title) Parameters title string Events Activated Occurs when this window is activated. public event EventHandler<EventArgs> Activated Event Type EventHandler<EventArgs> ClientSizeChanged Occurs when device client size is changed. public event EventHandler<EventArgs> ClientSizeChanged Event Type EventHandler<EventArgs> Closing Occurs before the window gets destroyed. public event EventHandler<EventArgs> Closing Event Type EventHandler<EventArgs> Deactivated Occurs when this window is deactivated. public event EventHandler<EventArgs> Deactivated Event Type EventHandler<EventArgs> FullscreenChanged Occurs when device fullscreen mode is changed. public event EventHandler<EventArgs> FullscreenChanged Event Type EventHandler<EventArgs> OrientationChanged Occurs when device orientation is changed. public event EventHandler<EventArgs> OrientationChanged Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Games.GameWindowRenderer.html": {
    "href": "api/Stride.Games.GameWindowRenderer.html",
    "title": "Class GameWindowRenderer | Stride API",
    "summary": "Class GameWindowRenderer Namespace Stride.Games Assembly Stride.Games.dll A Game System that allows to render to a window. public class GameWindowRenderer : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase GameWindowRenderer Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Inherited Members GameSystemBase.Game GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.Draw(GameTime) GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Update(GameTime) GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) GameSystemBase.LoadContent() GameSystemBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks Note that this Game System can be used only on desktop Windows with Windows Forms currently. Constructors GameWindowRenderer(IServiceRegistry, GameContext) Initializes a new instance of the GameWindowRenderer class. public GameWindowRenderer(IServiceRegistry registry, GameContext gameContext) Parameters registry IServiceRegistry The service registry. gameContext GameContext The Game context that contains information about the underlying platform's native window. Properties GameContext Gets a context object that contains information about the underlying platform's native window. public GameContext GameContext { get; } Property Value GameContext PreferredBackBufferFormat Gets or sets the preferred format for the Back-Buffer. public PixelFormat PreferredBackBufferFormat { get; set; } Property Value PixelFormat PreferredBackBufferHeight Gets or sets the preferred height for the Back-Buffer, in pixels. public int PreferredBackBufferHeight { get; set; } Property Value int PreferredBackBufferWidth Gets or sets the preferred width for the Back-Buffer, in pixels. public int PreferredBackBufferWidth { get; set; } Property Value int PreferredDepthStencilFormat Gets or sets the preferred Depth-Stencil format. public PixelFormat PreferredDepthStencilFormat { get; set; } Property Value PixelFormat PreferredOutputColorSpace Gets or sets the preferred output color space the Presenter should use. public ColorSpaceType PreferredOutputColorSpace { get; set; } Property Value ColorSpaceType Remarks The output color space can be used to render to HDR monitors. Note that this is currently only supported in Stride when using the Direct3D Graphics API. For more information about High Dynamic Range (HDR) rendering, see https://learn.microsoft.com/en-us/windows/win32/direct3darticles/high-dynamic-range. Presenter Gets or sets the presenter that is used to render the Game to the window. public GraphicsPresenter Presenter { get; protected set; } Property Value GraphicsPresenter Window Gets the window where the Game is rendered. public GameWindow Window { get; } Property Value GameWindow Methods BeginDraw() Starts the drawing of the Game Component. It prepares the drawable component for rendering and determines whether a following Draw(GameTime) and EndDraw() call should occur. public override bool BeginDraw() Returns bool true if Draw(GameTime) should be called; false otherwise. CreateOrUpdatePresenter() Creates a new GraphicsPresenter or updates the existing one for rendering graphics. protected virtual void CreateOrUpdatePresenter() Remarks This method initializes the Presenter if it is currently null, using the requested size and format. It configures the presentation parameters, including Depth-Stencil format and presentation interval. Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. EndDraw() Ends the drawing of the Game Component. public override void EndDraw() Remarks This method must be preceeded by calls to Draw(GameTime) and BeginDraw(). Exceptions GraphicsDeviceException The Game Device this Game Component is using to draw itself is not in a valid state to end drawing, or it is not available. Initialize() Initializes the Game System. public override void Initialize() Remarks This method is called when the component is added to the Game. This can be used for tasks like querying for services the component needs and setting up non-graphics resources (as here the Graphics Device may have not been initialized yet)."
  },
  "api/Stride.Games.GraphicsDeviceInformation.html": {
    "href": "api/Stride.Games.GraphicsDeviceInformation.html",
    "title": "Class GraphicsDeviceInformation | Stride API",
    "summary": "Class GraphicsDeviceInformation Namespace Stride.Games Assembly Stride.Games.dll Contains information needed to create a GraphicsDevice with a specific configuration. public class GraphicsDeviceInformation : IEquatable<GraphicsDeviceInformation> Inheritance object GraphicsDeviceInformation Implements IEquatable<GraphicsDeviceInformation> Extension Methods UnsafeUtilities.As<T>(object?) Constructors GraphicsDeviceInformation() Initializes a new instance of the GraphicsDeviceInformation class. public GraphicsDeviceInformation() Properties Adapter Gets or sets the Graphics Adapter that will do the rendering. public GraphicsAdapter Adapter { get; set; } Property Value GraphicsAdapter DeviceCreationFlags Gets or sets the creation flags. public DeviceCreationFlags DeviceCreationFlags { get; set; } Property Value DeviceCreationFlags A combination of flags specifying which features and modes to request from the created Graphics Device. GraphicsProfile Gets or sets the graphics profile to aim for, which determines the hardware and software features that are considered minimum for the Graphics Device. public GraphicsProfile GraphicsProfile { get; set; } Property Value GraphicsProfile PresentationParameters Gets or sets the presentation parameters, which determine how the Graphics Device will present the rendered frame to the screen. public PresentationParameters PresentationParameters { get; set; } Property Value PresentationParameters Methods Clone() Creates a new object that is a copy of the current instance. public GraphicsDeviceInformation Clone() Returns GraphicsDeviceInformation A new object that is a copy of this instance. Equals(GraphicsDeviceInformation?) Indicates whether the current object is equal to another object of the same type. public bool Equals(GraphicsDeviceInformation? other) Parameters other GraphicsDeviceInformation An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Determines whether the specified object is equal to the current object. public override bool Equals(object? obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Operators operator ==(GraphicsDeviceInformation, GraphicsDeviceInformation) public static bool operator ==(GraphicsDeviceInformation left, GraphicsDeviceInformation right) Parameters left GraphicsDeviceInformation right GraphicsDeviceInformation Returns bool operator !=(GraphicsDeviceInformation, GraphicsDeviceInformation) public static bool operator !=(GraphicsDeviceInformation left, GraphicsDeviceInformation right) Parameters left GraphicsDeviceInformation right GraphicsDeviceInformation Returns bool"
  },
  "api/Stride.Games.GraphicsDeviceManager.html": {
    "href": "api/Stride.Games.GraphicsDeviceManager.html",
    "title": "Class GraphicsDeviceManager | Stride API",
    "summary": "Class GraphicsDeviceManager Namespace Stride.Games Assembly Stride.Games.dll Manages the GraphicsDevice life-cycle, providing access to it and events that can be subscribed to be notified of when the device is created, reset, or disposed. public class GraphicsDeviceManager : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder, IGraphicsDeviceManager, IGraphicsDeviceService Inheritance object DisposeBase ComponentBase GraphicsDeviceManager Implements IDisposable IComponent IReferencable ICollectorHolder IGraphicsDeviceManager IGraphicsDeviceService Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields DefaultBackBufferHeight Default height for the Back-Buffer. public static readonly int DefaultBackBufferHeight Field Value int DefaultBackBufferWidth Default width for the Back-Buffer. public static readonly int DefaultBackBufferWidth Field Value int Properties DeviceCreationFlags Gets or sets the device creation flags that will be used to create the Graphics Device. public DeviceCreationFlags DeviceCreationFlags { get; set; } Property Value DeviceCreationFlags GraphicsDevice Gets the Graphics Device associated with this manager. public GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice IsFullScreen Gets or sets a value indicating whether the Graphics Device should present in full-screen mode. public bool IsFullScreen { get; set; } Property Value bool true if the device should render is full screen; otherwise, false. PreferredBackBufferFormat Gets or sets the preferred pixel format for the Back-Buffers. public PixelFormat PreferredBackBufferFormat { get; set; } Property Value PixelFormat Remarks Not all pixel formats are supported for Back-Buffers by all Graphics Devices. Typical formats are R8G8B8A8_UNorm or B8G8R8A8_UNorm, although there are some more advanced formats depending on the Graphics Device capabilities and intended use (e.g. R16G16B16A16_Float for HDR rendering). PreferredBackBufferHeight Gets or sets the preferred height of the Back-Buffer, in pixels. public int PreferredBackBufferHeight { get; set; } Property Value int PreferredBackBufferWidth Gets or sets the preferred width of the Back-Buffer, in pixels. public int PreferredBackBufferWidth { get; set; } Property Value int PreferredColorSpace Gets or sets the preferred color space for the Back-Buffers. public ColorSpace PreferredColorSpace { get; set; } Property Value ColorSpace PreferredDepthStencilFormat Gets or sets the preferred format for the Depth-Stencil Buffer. public PixelFormat PreferredDepthStencilFormat { get; set; } Property Value PixelFormat Remarks Not all formats are supported for Depth-Stencil Buffers by all Graphics Devices. Typical formats are D24_UNorm_S8_UInt or D32_Float_S8X24_UInt. The format also determines the number of bits used for the depth and stencil buffers. For example. the D24_UNorm_S8_UInt format uses 24 bits for the Depth-Buffer and 8 bits for the Stencil-Buffer, while D32_Float uses 32 bits for the Depth-Buffer and no Stencil-Buffer. PreferredFullScreenOutputIndex Gets or sets the preferred output (monitor) index to use when switching to fullscreen mode. Doesn't have any effect when windowed mode is used. public int PreferredFullScreenOutputIndex { get; set; } Property Value int PreferredGraphicsProfile Gets or sets the graphics profiles that are going to be tested when initializing the Graphics Device, in order of preference. public GraphicsProfile[] PreferredGraphicsProfile { get; set; } Property Value GraphicsProfile[] Remarks By default, the preferred graphics profiles are, in order of preference, better first: Level_11_1, Level_11_0, Level_10_1, Level_10_0, Level_9_3, Level_9_2, and Level_9_1. PreferredMultisampleCount Gets or sets the level of multisampling for the Back-Buffers. public MultisampleCount PreferredMultisampleCount { get; set; } Property Value MultisampleCount PreferredRefreshRate Gets or sets the preferred refresh rate, in hertz (number of frames per second). public Rational PreferredRefreshRate { get; set; } Property Value Rational The preferred refresh rate as a Rational value, where the numerator is the number of frames per second and the denominator is usually 1 (e.g., 60 frames per second is represented as 60 / 1). However, some adapters may support fractional refresh rates, such as 59.94 Hz, which would be represented as 5994 / 100. RequiredAdapterUid Gets or sets the unique identifier of the Graphis Adapter that should be used to create the Graphics Device. public string RequiredAdapterUid { get; set; } Property Value string If this property is set to a non-null string the engine will try to initialize the Graphics Device to present to an adapter with the same unique Id ShaderProfile Gets or sets the Shader graphics profile that will be used to compile shaders. public GraphicsProfile? ShaderProfile { get; set; } Property Value GraphicsProfile? Remarks If this property is not set, the profile used to compile Shaders will be taken from the Graphics Device. based on the list provided by PreferredGraphicsProfile. SupportedOrientations Gets or sets the supported orientations for displaying the Back-Buffers. public DisplayOrientation SupportedOrientations { get; set; } Property Value DisplayOrientation SynchronizeWithVerticalRetrace Gets or sets a value indicating whether the Graphics Device should synchronize with the vertical retrace, commonly known as VSync. public bool SynchronizeWithVerticalRetrace { get; set; } Property Value bool true to synchronize with the vertical retrace, which can help prevent screen tearing and ensure smoother animations by waiting for the monitor to finish displaying the current frame; false to not synchronize, which may result in faster frame rates but can lead to screen tearing. Methods ApplyChanges() Applies the changes in the graphics settings and changes or recreates the GraphicsDevice according to the new values. Does not have any effect if the GraphicsDevice is null. public void ApplyChanges() Exceptions InvalidOperationException Thrown if the Graphics Device could not be created or reconfigured. CanResetDevice(GraphicsDeviceInformation) Determines whether the Graphics Device is compatible with the the specified new GraphicsDeviceInformation and can be reset with it. protected virtual bool CanResetDevice(GraphicsDeviceInformation newDeviceInfo) Parameters newDeviceInfo GraphicsDeviceInformation The new device information to check compatibility with. Returns bool true if the Graphics Device is compatible with newDeviceInfo and can be reinitialized with the new settings; otherwise, false. Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. FindBestDevice(bool) Finds the best Graphics Device configuration that is compatible with the set preferences. protected virtual GraphicsDeviceInformation FindBestDevice(bool anySuitableDevice) Parameters anySuitableDevice bool A value indicating whether to search for any suitable device on any of the available adapters (true) or only from the default adapter (false). Returns GraphicsDeviceInformation The graphics device information. Exceptions InvalidOperationException None of the graphics profiles specified in PreferredGraphicsProfile are supported. InvalidOperationException A compatible screen mode could not be found based on the current settings. Check the full-screen mode, the preferred Back-Buffer width and height, and the preferred Back-Buffer format. IsPreferredProfileAvailable(GraphicsProfile[], out GraphicsProfile) Determines whether any of the preferred graphics profiles is available on the system. protected virtual bool IsPreferredProfileAvailable(GraphicsProfile[] preferredProfiles, out GraphicsProfile availableProfile) Parameters preferredProfiles GraphicsProfile[] An array of preferred graphics profiles to check for availability. The profiles should be ordered by preference, with the most preferred profile first. availableProfile GraphicsProfile When the method returns, contains the highest graphics profile supported by the system that meets or exceeds the preferences specified in preferredProfiles. If no preferred profile is available, this will contain the lowest supported graphics profile. Returns bool true if a graphics profile that meets or exceeds one of the preferred profiles is available; otherwise, false. OnDeviceCreated(object, EventArgs) Method called when the Graphics Device is created. Invokes the DeviceCreated event. protected virtual void OnDeviceCreated(object sender, EventArgs args) Parameters sender object args EventArgs OnDeviceDisposing(object, EventArgs) Method called when the Graphics Device is about to be disposed. Invokes the DeviceDisposing event. protected virtual void OnDeviceDisposing(object sender, EventArgs args) Parameters sender object args EventArgs OnDeviceReset(object, EventArgs) Method called when the Graphics Device is reset. Invokes the DeviceReset event. protected virtual void OnDeviceReset(object sender, EventArgs args) Parameters sender object args EventArgs OnDeviceResetting(object, EventArgs) Method called when the Graphics Device is resetting, but before it is actually reset. Invokes the DeviceResetting event. protected virtual void OnDeviceResetting(object sender, EventArgs args) Parameters sender object args EventArgs OnPreparingDeviceSettings(object, PreparingDeviceSettingsEventArgs) Method called when the Graphics Device is preparing to be created or reset, so the application can examine or modify the device settings before the device is created or reset. Invokes the PreparingDeviceSettings event. protected virtual void OnPreparingDeviceSettings(object sender, PreparingDeviceSettingsEventArgs args) Parameters sender object args PreparingDeviceSettingsEventArgs RankDevices(List<GraphicsDeviceInformation>) Ranks a list of GraphicsDeviceInformations before creating a new Graphics Device. protected virtual void RankDevices(List<GraphicsDeviceInformation> foundDevices) Parameters foundDevices List<GraphicsDeviceInformation> A list of possible device configurations to be ranked and reordered. SelectOrientation(DisplayOrientation, int, int, bool) Determines the appropriate display orientation based on the specified parameters. protected static DisplayOrientation SelectOrientation(DisplayOrientation orientation, int width, int height, bool allowLandscapeLeftAndRight) Parameters orientation DisplayOrientation The desired display orientation. If set to Default, the orientation will be determined based on the provided dimensions and landscape allowance. width int The width of the display area, in pixels. height int The height of the display area, in pixels. allowLandscapeLeftAndRight bool A value indicating whether both landscape orientations (LandscapeLeft and LandscapeRight) are allowed. Returns DisplayOrientation The selected DisplayOrientation based on the input parameters. Returns Portrait if the height is greater than or equal to the width. If landscape is allowed, returns a combination of LandscapeLeft and LandscapeRight. Otherwise, returns LandscapeRight. Events DeviceCreated Occurs when a new Graphics Device is successfully created. public event EventHandler<EventArgs> DeviceCreated Event Type EventHandler<EventArgs> DeviceDisposing Occurs when the Graphics Device is being disposed. public event EventHandler<EventArgs> DeviceDisposing Event Type EventHandler<EventArgs> DeviceReset Occurs when the Graphics Device is being reset. public event EventHandler<EventArgs> DeviceReset Event Type EventHandler<EventArgs> DeviceResetting Occurs when the Graphics Device is being reset, but before it is actually reset. public event EventHandler<EventArgs> DeviceResetting Event Type EventHandler<EventArgs> PreparingDeviceSettings Occurs when the Graphics Device is being initialized to give a chance to the application at adjusting the final settings for the device creation. public event EventHandler<PreparingDeviceSettingsEventArgs> PreparingDeviceSettings Event Type EventHandler<PreparingDeviceSettingsEventArgs>"
  },
  "api/Stride.Games.GraphicsDeviceManagerProfilingKeys.html": {
    "href": "api/Stride.Games.GraphicsDeviceManagerProfilingKeys.html",
    "title": "Class GraphicsDeviceManagerProfilingKeys | Stride API",
    "summary": "Class GraphicsDeviceManagerProfilingKeys Namespace Stride.Games Assembly Stride.Games.dll Profiling keys for GraphicsDeviceManager. public static class GraphicsDeviceManagerProfilingKeys Inheritance object GraphicsDeviceManagerProfilingKeys Fields CreateDevice Profiling graphics device initialization. public static readonly ProfilingKey CreateDevice Field Value ProfilingKey GraphicsDeviceManager public static readonly ProfilingKey GraphicsDeviceManager Field Value ProfilingKey"
  },
  "api/Stride.Games.IContentable.html": {
    "href": "api/Stride.Games.IContentable.html",
    "title": "Interface IContentable | Stride API",
    "summary": "Interface IContentable Namespace Stride.Games Assembly Stride.Games.dll An interface to load and unload asset. public interface IContentable Extension Methods UnsafeUtilities.As<T>(object?) Methods LoadContent() Loads the assets. void LoadContent() UnloadContent() Called when graphics resources need to be unloaded. Override this method to unload any game-specific graphics resources. void UnloadContent()"
  },
  "api/Stride.Games.IDrawable.html": {
    "href": "api/Stride.Games.IDrawable.html",
    "title": "Interface IDrawable | Stride API",
    "summary": "Interface IDrawable Namespace Stride.Games Assembly Stride.Games.dll An interface for a drawable Game Component that is called by the GameBase class. public interface IDrawable Extension Methods UnsafeUtilities.As<T>(object?) Properties DrawOrder Gets the draw order relative to other Game Components. IDrawable components with a lower value are drawn first. int DrawOrder { get; } Property Value int Visible Gets a value indicating whether the Game Component's Draw(GameTime) method should be called by Draw(GameTime). bool Visible { get; } Property Value bool true if the Game Component is visible and should be drawn; otherwise, false. Methods BeginDraw() Starts the drawing of the Game Component. It prepares the drawable component for rendering and determines whether a following Draw(GameTime) and EndDraw() call should occur. bool BeginDraw() Returns bool true if Draw(GameTime) should be called; false otherwise. Draw(GameTime) Draws the Game Component. void Draw(GameTime gameTime) Parameters gameTime GameTime The current timing information. EndDraw() Ends the drawing of the Game Component. void EndDraw() Remarks This method must be preceeded by calls to Draw(GameTime) and BeginDraw(). Exceptions GraphicsDeviceException The Game Device this Game Component is using to draw itself is not in a valid state to end drawing, or it is not available. Events DrawOrderChanged Occurs when the DrawOrder property changes. event EventHandler<EventArgs> DrawOrderChanged Event Type EventHandler<EventArgs> VisibleChanged Occurs when the Visible property changes. event EventHandler<EventArgs> VisibleChanged Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Games.IGame.html": {
    "href": "api/Stride.Games.IGame.html",
    "title": "Interface IGame | Stride API",
    "summary": "Interface IGame Namespace Stride.Games Assembly Stride.Games.dll public interface IGame Extension Methods UnsafeUtilities.As<T>(object?) Properties Content Gets or sets the ContentManager. ContentManager Content { get; } Property Value ContentManager The content manager. Context Gets the game context. GameContext Context { get; } Property Value GameContext The game context. DrawInterpolationFactor Gets the draw interpolation factor, which is (UpdateTime - DrawTime) / TargetElapsedTime. If IsFixedTimeStep is false, it will be 0 as UpdateTime and DrawTime will be equal. float DrawInterpolationFactor { get; } Property Value float The draw interpolation factor. DrawTime Gets the current draw time. GameTime DrawTime { get; } Property Value GameTime The current draw time. GameSystems Gets the game components registered by this game. GameSystemCollection GameSystems { get; } Property Value GameSystemCollection The game components. GraphicsContext Gets the graphics context. GraphicsContext GraphicsContext { get; } Property Value GraphicsContext The graphics context. GraphicsDevice Gets the graphics device. GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice The graphics device. InactiveSleepTime Gets or sets the inactive sleep time. TimeSpan InactiveSleepTime { get; set; } Property Value TimeSpan The inactive sleep time. IsActive Gets a value indicating whether this instance is active. bool IsActive { get; } Property Value bool true if this instance is active; otherwise, false. IsDrawDesynchronized Gets or sets a value indicating whether draw can happen as fast as possible, even when IsFixedTimeStep is set. bool IsDrawDesynchronized { get; set; } Property Value bool true if this instance allows desychronized drawing; otherwise, false. IsFixedTimeStep Gets or sets a value indicating whether this instance is fixed time step. bool IsFixedTimeStep { get; set; } Property Value bool true if this instance is fixed time step; otherwise, false. IsMouseVisible Gets or sets a value indicating whether the mouse should be visible. bool IsMouseVisible { get; set; } Property Value bool true if the mouse should be visible; otherwise, false. IsRunning Gets a value indicating whether is running. bool IsRunning { get; } Property Value bool LaunchParameters Gets the launch parameters. LaunchParameters LaunchParameters { get; } Property Value LaunchParameters The launch parameters. Services Gets the service container. ServiceRegistry Services { get; } Property Value ServiceRegistry The service container. TargetElapsedTime Gets or sets the target elapsed time. TimeSpan TargetElapsedTime { get; set; } Property Value TimeSpan The target elapsed time. UpdateTime Gets the current game time. GameTime UpdateTime { get; } Property Value GameTime The current game time. Window Gets the abstract window. GameWindow Window { get; } Property Value GameWindow The window. Events Activated Occurs when [activated]. event EventHandler<EventArgs> Activated Event Type EventHandler<EventArgs> Deactivated Occurs when [deactivated]. event EventHandler<EventArgs> Deactivated Event Type EventHandler<EventArgs> Exiting Occurs when [exiting]. event EventHandler<EventArgs> Exiting Event Type EventHandler<EventArgs> WindowCreated Occurs when [window created]. event EventHandler<EventArgs> WindowCreated Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Games.IGamePlatform.html": {
    "href": "api/Stride.Games.IGamePlatform.html",
    "title": "Interface IGamePlatform | Stride API",
    "summary": "Interface IGamePlatform Namespace Stride.Games Assembly Stride.Games.dll Interface for a game platform (OS, machine dependent). public interface IGamePlatform Extension Methods UnsafeUtilities.As<T>(object?) Properties DefaultAppDirectory Gets the default app directory. string DefaultAppDirectory { get; } Property Value string The default app directory. MainWindow Gets the main window. GameWindow MainWindow { get; } Property Value GameWindow The main window. Methods CreateWindow(GameContext) Creates the a new GameWindow. See remarks. GameWindow CreateWindow(GameContext gameContext = null) Parameters gameContext GameContext The window context. See remarks. Returns GameWindow A new game window. Remarks This is currently only supported on Windows Desktop. The window context supported on windows is a subclass of System.Windows.Forms.Control (or null and a default GameForm will be created)."
  },
  "api/Stride.Games.IGameSystemBase.html": {
    "href": "api/Stride.Games.IGameSystemBase.html",
    "title": "Interface IGameSystemBase | Stride API",
    "summary": "Interface IGameSystemBase Namespace Stride.Games Assembly Stride.Games.dll Interface for a component that represents a Game System. public interface IGameSystemBase : IComponent, IReferencable Inherited Members IComponent.Name IReferencable.ReferenceCount IReferencable.AddReference() IReferencable.Release() Extension Methods UnsafeUtilities.As<T>(object?) Remarks A Game System is a component that can be used to manage game logic, resources, or other systems within the Game. For example, it can be used to manage audio, input, or other subsystems. Game Systems are typically added to the GameBase class and are initialized when the game starts. If the Game System needs to be updated or drawn, it can implement the IUpdateable and IDrawable interfaces respectively. Methods Initialize() Initializes the Game System. void Initialize() Remarks This method is called when the component is added to the Game. This can be used for tasks like querying for services the component needs and setting up non-graphics resources (as here the Graphics Device may have not been initialized yet)."
  },
  "api/Stride.Games.IGameSystemCollection.html": {
    "href": "api/Stride.Games.IGameSystemCollection.html",
    "title": "Interface IGameSystemCollection | Stride API",
    "summary": "Interface IGameSystemCollection Namespace Stride.Games Assembly Stride.Games.dll A list of game systems. public interface IGameSystemCollection : IList<IGameSystemBase>, ICollection<IGameSystemBase>, IReadOnlyList<IGameSystemBase>, IReadOnlyCollection<IGameSystemBase>, IEnumerable<IGameSystemBase>, IEnumerable Inherited Members IList<IGameSystemBase>.IndexOf(IGameSystemBase) IList<IGameSystemBase>.Insert(int, IGameSystemBase) IList<IGameSystemBase>.RemoveAt(int) IList<IGameSystemBase>.this[int] ICollection<IGameSystemBase>.Add(IGameSystemBase) ICollection<IGameSystemBase>.Clear() ICollection<IGameSystemBase>.Contains(IGameSystemBase) ICollection<IGameSystemBase>.CopyTo(IGameSystemBase[], int) ICollection<IGameSystemBase>.Remove(IGameSystemBase) ICollection<IGameSystemBase>.Count ICollection<IGameSystemBase>.IsReadOnly IEnumerable<IGameSystemBase>.GetEnumerator() Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Games.IGraphicsDeviceFactory.html": {
    "href": "api/Stride.Games.IGraphicsDeviceFactory.html",
    "title": "Interface IGraphicsDeviceFactory | Stride API",
    "summary": "Interface IGraphicsDeviceFactory Namespace Stride.Games Assembly Stride.Games.dll Base interface for a factory that creates GraphicsDevice instances. public interface IGraphicsDeviceFactory Extension Methods UnsafeUtilities.As<T>(object?) Remarks The implementers of IGraphicsDeviceFactory are responsible for creating GraphicsDevice instances, and for selecting the best device based on the preferred configuration. A good example of a factory is the Stride.Games.GamePlatform class, which not only abstracts the platform, but also the windowing system and the Graphics Device creation. Methods ChangeOrCreateDevice(GraphicsDevice?, GraphicsDeviceInformation) Changes an existing Graphics Device or creates a new one with the specified configuration. GraphicsDevice ChangeOrCreateDevice(GraphicsDevice? currentDevice, GraphicsDeviceInformation deviceInformation) Parameters currentDevice GraphicsDevice An optional GraphicsDevice instance to reconfigure. Specify null to create a new device. deviceInformation GraphicsDeviceInformation The GraphicsDeviceInformation containing the Graphics Adapter, Graphics Profile, and other relevant flags and parameters required to configure the Graphics Device. Returns GraphicsDevice The created (or changed) Graphics Device. FindBestDevices(GameGraphicsParameters) Returns a list of GraphicsDeviceInformation instances, representing the best found Graphics Adapters and their corresponding configuration to create a Graphics Device based on the given graphics parameters. List<GraphicsDeviceInformation> FindBestDevices(GameGraphicsParameters graphicsParameters) Parameters graphicsParameters GameGraphicsParameters The preferred graphics configuration. Returns List<GraphicsDeviceInformation> A list of the best found configurations for creating a Graphics Device."
  },
  "api/Stride.Games.IGraphicsDeviceManager.html": {
    "href": "api/Stride.Games.IGraphicsDeviceManager.html",
    "title": "Interface IGraphicsDeviceManager | Stride API",
    "summary": "Interface IGraphicsDeviceManager Namespace Stride.Games Assembly Stride.Games.dll Defines the interface for an object that manages the Graphics Device lifecycle. public interface IGraphicsDeviceManager Extension Methods UnsafeUtilities.As<T>(object?) Methods BeginDraw() Called by the Game at the beginning of drawing. bool BeginDraw() Returns bool true if the Graphics Device is ready to draw; false if the Graphics Device is not ready or if the Game should skip drawing this frame. CreateDevice() Creates a valid Graphics Device ready to draw. void CreateDevice() Exceptions InvalidOperationException Thrown if the Graphics Device could not be created. EndDraw(bool) Called by the Game at the end of drawing. void EndDraw(bool present) Parameters present bool A value indicating whether the Game should present the Back-Buffer to the screen. Exceptions GraphicsException Could not present the Back-Buffer after drawing. GraphicsDeviceException The Graphics Device is not in a valid state to end drawing, or it is not available."
  },
  "api/Stride.Games.IMessageLoop.html": {
    "href": "api/Stride.Games.IMessageLoop.html",
    "title": "Interface IMessageLoop | Stride API",
    "summary": "Interface IMessageLoop Namespace Stride.Games Assembly Stride.Games.dll public interface IMessageLoop : IDisposable Inherited Members IDisposable.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Methods NextFrame() bool NextFrame() Returns bool"
  },
  "api/Stride.Games.IUpdateable.html": {
    "href": "api/Stride.Games.IUpdateable.html",
    "title": "Interface IUpdateable | Stride API",
    "summary": "Interface IUpdateable Namespace Stride.Games Assembly Stride.Games.dll An interface that is called by Update(GameTime). public interface IUpdateable Extension Methods UnsafeUtilities.As<T>(object?) Properties Enabled Gets a value indicating whether the game component's Update method should be called by Update(GameTime). bool Enabled { get; } Property Value bool true if update is enabled; otherwise, false. UpdateOrder Gets the update order relative to other game components. Lower values are updated first. int UpdateOrder { get; } Property Value int The update order. Methods Update(GameTime) This method is called when this game component is updated. void Update(GameTime gameTime) Parameters gameTime GameTime The current timing. Events EnabledChanged Occurs when the Enabled property changes. event EventHandler<EventArgs> EnabledChanged Event Type EventHandler<EventArgs> UpdateOrderChanged Occurs when the UpdateOrder property changes. event EventHandler<EventArgs> UpdateOrderChanged Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Games.LaunchParameters.html": {
    "href": "api/Stride.Games.LaunchParameters.html",
    "title": "Class LaunchParameters | Stride API",
    "summary": "Class LaunchParameters Namespace Stride.Games Assembly Stride.Games.dll Parameters used when launching an application. public class LaunchParameters : Dictionary<string, string>, IDictionary<string, string>, ICollection<KeyValuePair<string, string>>, IReadOnlyDictionary<string, string>, IReadOnlyCollection<KeyValuePair<string, string>>, IEnumerable<KeyValuePair<string, string>>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable Inheritance object Dictionary<string, string> LaunchParameters Implements IDictionary<string, string> ICollection<KeyValuePair<string, string>> IReadOnlyDictionary<string, string> IReadOnlyCollection<KeyValuePair<string, string>> IEnumerable<KeyValuePair<string, string>> IDictionary ICollection IEnumerable IDeserializationCallback ISerializable Inherited Members Dictionary<string, string>.Add(string, string) Dictionary<string, string>.Clear() Dictionary<string, string>.ContainsKey(string) Dictionary<string, string>.ContainsValue(string) Dictionary<string, string>.EnsureCapacity(int) Dictionary<string, string>.GetAlternateLookup<TAlternateKey>() Dictionary<string, string>.GetEnumerator() Dictionary<string, string>.OnDeserialization(object) Dictionary<string, string>.Remove(string) Dictionary<string, string>.Remove(string, out string) Dictionary<string, string>.TrimExcess() Dictionary<string, string>.TrimExcess(int) Dictionary<string, string>.TryAdd(string, string) Dictionary<string, string>.TryGetAlternateLookup<TAlternateKey>(out Dictionary<string, string>.AlternateLookup<TAlternateKey>) Dictionary<string, string>.TryGetValue(string, out string) Dictionary<string, string>.Comparer Dictionary<string, string>.Count Dictionary<string, string>.Capacity Dictionary<string, string>.this[string] Dictionary<string, string>.Keys Dictionary<string, string>.Values Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors LaunchParameters() Initializes a new instance of the LaunchParameters class. public LaunchParameters()"
  },
  "api/Stride.Games.PreparingDeviceSettingsEventArgs.html": {
    "href": "api/Stride.Games.PreparingDeviceSettingsEventArgs.html",
    "title": "Class PreparingDeviceSettingsEventArgs | Stride API",
    "summary": "Class PreparingDeviceSettingsEventArgs Namespace Stride.Games Assembly Stride.Games.dll Describes settings to apply before preparing a device for creation, used by OnPreparingDeviceSettings(object, PreparingDeviceSettingsEventArgs). public class PreparingDeviceSettingsEventArgs : EventArgs Inheritance object EventArgs PreparingDeviceSettingsEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Constructors PreparingDeviceSettingsEventArgs(GraphicsDeviceInformation) Initializes a new instance of the PreparingDeviceSettingsEventArgs class. public PreparingDeviceSettingsEventArgs(GraphicsDeviceInformation graphicsDeviceInformation) Parameters graphicsDeviceInformation GraphicsDeviceInformation The graphics device information. Properties GraphicsDeviceInformation Gets the graphics device information. public GraphicsDeviceInformation GraphicsDeviceInformation { get; } Property Value GraphicsDeviceInformation The graphics device information."
  },
  "api/Stride.Games.Time.AbsoluteStopwatch.html": {
    "href": "api/Stride.Games.Time.AbsoluteStopwatch.html",
    "title": "Class AbsoluteStopwatch | Stride API",
    "summary": "Class AbsoluteStopwatch Namespace Stride.Games.Time Assembly Stride.Games.dll Represent an absolute time measurement stopwatch. (with as few internal overhead as possible) It measures elapsed time in seconds between calls to Start method and Elapsed property. public class AbsoluteStopwatch Inheritance object AbsoluteStopwatch Extension Methods UnsafeUtilities.As<T>(object?) Properties Elapsed Gets the time elapsed since previous call to Start method, in seconds. public double Elapsed { get; } Property Value double Methods Start() Start the stopwatch. (use this method also to restart stopwatching) public void Start()"
  },
  "api/Stride.Games.Time.ITimedValue-1.html": {
    "href": "api/Stride.Games.Time.ITimedValue-1.html",
    "title": "Interface ITimedValue<T> | Stride API",
    "summary": "Interface ITimedValue<T> Namespace Stride.Games.Time Assembly Stride.Games.dll public interface ITimedValue<out T> Type Parameters T Extension Methods UnsafeUtilities.As<T>(object?) Properties Time double Time { get; } Property Value double Value T Value { get; } Property Value T"
  },
  "api/Stride.Games.Time.ReadOnlyTimedValue-1.html": {
    "href": "api/Stride.Games.Time.ReadOnlyTimedValue-1.html",
    "title": "Class ReadOnlyTimedValue<T> | Stride API",
    "summary": "Class ReadOnlyTimedValue<T> Namespace Stride.Games.Time Assembly Stride.Games.dll public class ReadOnlyTimedValue<T> : ITimedValue<T> Type Parameters T Inheritance object ReadOnlyTimedValue<T> Implements ITimedValue<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors ReadOnlyTimedValue(ITimedValue<T>) public ReadOnlyTimedValue(ITimedValue<T> timedValue) Parameters timedValue ITimedValue<T> ReadOnlyTimedValue(double, T) public ReadOnlyTimedValue(double time, T value) Parameters time double value T Properties Time public double Time { get; } Property Value double Value public T Value { get; } Property Value T"
  },
  "api/Stride.Games.Time.TimedValue-1.html": {
    "href": "api/Stride.Games.Time.TimedValue-1.html",
    "title": "Class TimedValue<T> | Stride API",
    "summary": "Class TimedValue<T> Namespace Stride.Games.Time Assembly Stride.Games.dll public class TimedValue<T> : ITimedValue<T> Type Parameters T Inheritance object TimedValue<T> Implements ITimedValue<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors TimedValue(double, T) public TimedValue(double time, T value) Parameters time double value T Properties Time public double Time { get; set; } Property Value double Value public T Value { get; set; } Property Value T"
  },
  "api/Stride.Games.Time.TimerTick.html": {
    "href": "api/Stride.Games.Time.TimerTick.html",
    "title": "Class TimerTick | Stride API",
    "summary": "Class TimerTick Namespace Stride.Games.Time Assembly Stride.Games.dll This provides timing information similar to Stopwatch but an update occurring only on a Tick() method. public class TimerTick Inheritance object TimerTick Extension Methods UnsafeUtilities.As<T>(object?) Constructors TimerTick() Initializes a new instance of the TimerTick class. public TimerTick() TimerTick(TimeSpan) Initializes a new instance of the TimerTick class. public TimerTick(TimeSpan startTime) Parameters startTime TimeSpan The start time. Properties ElapsedTime Gets the elapsed time since the previous call to Tick(). public TimeSpan ElapsedTime { get; } Property Value TimeSpan ElapsedTimeWithPause Gets the elapsed time since the previous call to Tick() including Pause() public TimeSpan ElapsedTimeWithPause { get; } Property Value TimeSpan IsPaused Gets a value indicating whether this instance is paused. public bool IsPaused { get; } Property Value bool true if this instance is paused; otherwise, false. SpeedFactor Gets or sets the speed factor. Default is 1.0 public double SpeedFactor { get; set; } Property Value double The speed factor. StartTime Gets the start time when this timer was created. public TimeSpan StartTime { get; } Property Value TimeSpan TotalTime Gets the total time elasped since the last reset or when this timer was created. public TimeSpan TotalTime { get; } Property Value TimeSpan TotalTimeWithPause Gets the total time elasped since the last reset or when this timer was created, including Pause() public TimeSpan TotalTimeWithPause { get; } Property Value TimeSpan Methods Pause() Pauses this instance. public void Pause() Reset() Resets this instance. TotalTime is set to zero. public void Reset() Reset(TimeSpan) Resets this instance. TotalTime is set to startTime. public void Reset(TimeSpan startTime) Parameters startTime TimeSpan The start time. Resume() Resumes this instance, only if a call to Pause() has been already issued. public void Resume() Tick() Update the TotalTime and ElapsedTime, public void Tick() Remarks This method must be called on a regular basis at every tick."
  },
  "api/Stride.Games.Time.html": {
    "href": "api/Stride.Games.Time.html",
    "title": "Namespace Stride.Games.Time | Stride API",
    "summary": "Namespace Stride.Games.Time Classes AbsoluteStopwatch Represent an absolute time measurement stopwatch. (with as few internal overhead as possible) It measures elapsed time in seconds between calls to Start method and Elapsed property. ReadOnlyTimedValue<T> TimedValue<T> TimerTick This provides timing information similar to Stopwatch but an update occurring only on a Tick() method. Interfaces ITimedValue<T>"
  },
  "api/Stride.Games.html": {
    "href": "api/Stride.Games.html",
    "title": "Namespace Stride.Games | Stride API",
    "summary": "Namespace Stride.Games Classes GameBase The game. GameContext Contains context used to render the Game (i.e. it abstracts a Windows Forms Control, or a DrawingSurface for UWP, etc.) GameContextFactory Given a AppContextType creates the corresponding GameContext instance based on the current executing platform. GameContextSDL A GameContext to use for rendering to an existing SDL Window. GameContext<TK> Generic version of GameContext. The later is used to describe a generic game Context. This version enables us to constraint the game context to a specifc toolkit and ensures a better cohesion between the various toolkit specific classes, such as InputManager, GameWindow. GameFormSDL Default Rendering Form on SDL based applications. GameGraphicsParameters Describes the preferred graphics configuration for a Game. GameProfilingKeys Keys used for profiling the game class. GameSystemBase Base class for a Game System. GameSystemCollection A collection of game components. GameTime Current timing used for variable-step (real time) or fixed-step (game time) games. GameUnhandledExceptionEventArgs GameWindow An abstract window. GameWindowRenderer A Game System that allows to render to a window. GameWindow<TK> GraphicsDeviceInformation Contains information needed to create a GraphicsDevice with a specific configuration. GraphicsDeviceManager Manages the GraphicsDevice life-cycle, providing access to it and events that can be subscribed to be notified of when the device is created, reset, or disposed. GraphicsDeviceManagerProfilingKeys Profiling keys for GraphicsDeviceManager. LaunchParameters Parameters used when launching an application. PreparingDeviceSettingsEventArgs Describes settings to apply before preparing a device for creation, used by OnPreparingDeviceSettings(object, PreparingDeviceSettingsEventArgs). Interfaces IContentable An interface to load and unload asset. IDrawable An interface for a drawable Game Component that is called by the GameBase class. IGame IGamePlatform Interface for a game platform (OS, machine dependent). IGameSystemBase Interface for a component that represents a Game System. IGameSystemCollection A list of game systems. IGraphicsDeviceFactory Base interface for a factory that creates GraphicsDevice instances. IGraphicsDeviceManager Defines the interface for an object that manages the Graphics Device lifecycle. IMessageLoop IUpdateable An interface that is called by Update(GameTime). Enums AppContextType Defines the type of a GameContext, which usually determines the platform, or a combination of platform and UI/presentation framework. GameSystemState Describes state of the GameSystemCollection."
  },
  "api/Stride.Graphics.BatchBase-1.DeviceResourceContext.html": {
    "href": "api/Stride.Graphics.BatchBase-1.DeviceResourceContext.html",
    "title": "Class BatchBase<TDrawInfo>.DeviceResourceContext | Stride API",
    "summary": "Class BatchBase<TDrawInfo>.DeviceResourceContext Namespace Stride.Graphics Assembly Stride.Graphics.dll Use a ResourceContext per GraphicsDevice (DeviceContext) protected class BatchBase<TDrawInfo>.DeviceResourceContext : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase BatchBase<TDrawInfo>.DeviceResourceContext Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DeviceResourceContext(GraphicsDevice, VertexDeclaration, ResourceBufferInfo) public DeviceResourceContext(GraphicsDevice device, VertexDeclaration declaration, BatchBase<TDrawInfo>.ResourceBufferInfo resourceBufferInfo) Parameters device GraphicsDevice declaration VertexDeclaration resourceBufferInfo BatchBase<TDrawInfo>.ResourceBufferInfo Fields IndexBuffer The index buffer of the batch. public Buffer IndexBuffer Field Value Buffer IndexBufferPosition The current position in index into the index array buffer. public int IndexBufferPosition Field Value int IndexCount Gets the number of indices. public readonly int IndexCount Field Value int InputElements public readonly InputElementDescription[] InputElements Field Value InputElementDescription[] IsInImmediateMode Indicate if the batch system is drawing in immediate mode for this buffer. public bool IsInImmediateMode Field Value bool IsIndexBufferDynamic Gets a boolean indicating if the index buffer is dynamic. public readonly bool IsIndexBufferDynamic Field Value bool VertexBuffer The vertex buffer of the batch. public Buffer VertexBuffer Field Value Buffer VertexBufferPosition The current position in vertex into the vertex array buffer. public int VertexBufferPosition Field Value int VertexCount Gets the number of vertices. public readonly int VertexCount Field Value int VertexDeclaration public readonly VertexDeclaration VertexDeclaration Field Value VertexDeclaration"
  },
  "api/Stride.Graphics.BatchBase-1.DrawTextures.html": {
    "href": "api/Stride.Graphics.BatchBase-1.DrawTextures.html",
    "title": "Struct BatchBase<TDrawInfo>.DrawTextures | Stride API",
    "summary": "Struct BatchBase<TDrawInfo>.DrawTextures Namespace Stride.Graphics Assembly Stride.Graphics.dll protected struct BatchBase<TDrawInfo>.DrawTextures Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Texture0 public Texture Texture0 Field Value Texture Methods NotEqual(ref DrawTextures, ref DrawTextures) public static bool NotEqual(ref BatchBase<TDrawInfo>.DrawTextures left, ref BatchBase<TDrawInfo>.DrawTextures right) Parameters left BatchBase<TDrawInfo>.DrawTextures right BatchBase<TDrawInfo>.DrawTextures Returns bool"
  },
  "api/Stride.Graphics.BatchBase-1.ElementInfo.html": {
    "href": "api/Stride.Graphics.BatchBase-1.ElementInfo.html",
    "title": "Struct BatchBase<TDrawInfo>.ElementInfo | Stride API",
    "summary": "Struct BatchBase<TDrawInfo>.ElementInfo Namespace Stride.Graphics Assembly Stride.Graphics.dll The structure containing all the information required to batch one element. protected struct BatchBase<TDrawInfo>.ElementInfo Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ElementInfo(int, int, in TDrawInfo, float) public ElementInfo(int vertexCount, int indexCount, in TDrawInfo drawInfo, float depth = 0) Parameters vertexCount int indexCount int drawInfo TDrawInfo depth float Fields Depth The depth of the element. Used to sort the elements. public float Depth Field Value float DrawInfo The user draw information. public TDrawInfo DrawInfo Field Value TDrawInfo IndexCount The number of indices needed to draw the element. public int IndexCount Field Value int VertexCount The number of vertex needed to draw the element. public int VertexCount Field Value int"
  },
  "api/Stride.Graphics.BatchBase-1.QueueComparer-1.html": {
    "href": "api/Stride.Graphics.BatchBase-1.QueueComparer-1.html",
    "title": "Class BatchBase<TDrawInfo>.QueueComparer<TInfo> | Stride API",
    "summary": "Class BatchBase<TDrawInfo>.QueueComparer<TInfo> Namespace Stride.Graphics Assembly Stride.Graphics.dll protected abstract class BatchBase<TDrawInfo>.QueueComparer<TInfo> : IComparer<int> Type Parameters TInfo Inheritance object BatchBase<TDrawInfo>.QueueComparer<TInfo> Implements IComparer<int> Extension Methods UnsafeUtilities.As<T>(object?) Fields ImageInfos public TInfo[] ImageInfos Field Value TInfo[] Methods Compare(int, int) Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. public abstract int Compare(int x, int y) Parameters x int The first object to compare. y int The second object to compare. Returns int A signed integer that indicates the relative values of x and y, as shown in the following table. Value Meaning Less than zero x is less than y. Zero x equals y. Greater than zero x is greater than y."
  },
  "api/Stride.Graphics.BatchBase-1.ResourceBufferInfo.html": {
    "href": "api/Stride.Graphics.BatchBase-1.ResourceBufferInfo.html",
    "title": "Class BatchBase<TDrawInfo>.ResourceBufferInfo | Stride API",
    "summary": "Class BatchBase<TDrawInfo>.ResourceBufferInfo Namespace Stride.Graphics Assembly Stride.Graphics.dll A class containing information on how to build the batch vertex and index buffer. protected class BatchBase<TDrawInfo>.ResourceBufferInfo Inheritance object BatchBase<TDrawInfo>.ResourceBufferInfo Derived BatchBase<TDrawInfo>.StaticQuadBufferInfo Extension Methods UnsafeUtilities.As<T>(object?) Constructors ResourceBufferInfo(string, short[], int, int) protected ResourceBufferInfo(string resourceKey, short[] staticIndices, int indexCount, int vertexCount) Parameters resourceKey string staticIndices short[] indexCount int vertexCount int Fields ResourceKey The key used to identify the GPU resource. public readonly string ResourceKey Field Value string StaticIndices Gets or sets the static indices to use for the index buffer. public short[] StaticIndices Field Value short[] Properties BatchCapacity The initial number of draw calls that can be batched at one time. public int BatchCapacity { get; set; } Property Value int Remarks Data structure will adjust their size when needed if capacity is not sufficient IndexCount Gets the number indices of the index buffer. public int IndexCount { get; } Property Value int IsIndexBufferDynamic Gets the value indicating whether the index buffer is static or dynamic. public bool IsIndexBufferDynamic { get; } Property Value bool VertexCount Gets the number indices of the vertex buffer. public int VertexCount { get; protected set; } Property Value int Methods CreateDynamicIndexBufferInfo(string, int, int) Create the buffer resource information for a batch having both a dynamic index buffer and vertex buffer. public static BatchBase<TDrawInfo>.ResourceBufferInfo CreateDynamicIndexBufferInfo(string resourceKey, int indexCount, int vertexCount) Parameters resourceKey string The name of key to use to identify the resource indexCount int The number of indices contained by the index buffer vertexCount int The number of vertices contained by the vertex buffer Returns BatchBase<TDrawInfo>.ResourceBufferInfo CreateStaticIndexBufferInfo(string, short[], int) Create the buffer resource information for a batch having a dynamic vertex buffer but a static index buffer. public static BatchBase<TDrawInfo>.ResourceBufferInfo CreateStaticIndexBufferInfo(string resourceKey, short[] staticIndices, int vertexCount) Parameters resourceKey string The name of key to use to identify the resource staticIndices short[] The value of the indices to upload into the index buffer. vertexCount int The number of vertices contained by the vertex buffer Returns BatchBase<TDrawInfo>.ResourceBufferInfo"
  },
  "api/Stride.Graphics.BatchBase-1.StaticQuadBufferInfo.html": {
    "href": "api/Stride.Graphics.BatchBase-1.StaticQuadBufferInfo.html",
    "title": "Class BatchBase<TDrawInfo>.StaticQuadBufferInfo | Stride API",
    "summary": "Class BatchBase<TDrawInfo>.StaticQuadBufferInfo Namespace Stride.Graphics Assembly Stride.Graphics.dll A class containing the information required to build a vertex and index buffer for simple quad based batching. protected class BatchBase<TDrawInfo>.StaticQuadBufferInfo : BatchBase<TDrawInfo>.ResourceBufferInfo Inheritance object BatchBase<TDrawInfo>.ResourceBufferInfo BatchBase<TDrawInfo>.StaticQuadBufferInfo Inherited Members BatchBase<TDrawInfo>.ResourceBufferInfo.ResourceKey BatchBase<TDrawInfo>.ResourceBufferInfo.BatchCapacity BatchBase<TDrawInfo>.ResourceBufferInfo.VertexCount BatchBase<TDrawInfo>.ResourceBufferInfo.IndexCount BatchBase<TDrawInfo>.ResourceBufferInfo.StaticIndices BatchBase<TDrawInfo>.ResourceBufferInfo.IsIndexBufferDynamic BatchBase<TDrawInfo>.ResourceBufferInfo.CreateDynamicIndexBufferInfo(string, int, int) BatchBase<TDrawInfo>.ResourceBufferInfo.CreateStaticIndexBufferInfo(string, short[], int) Extension Methods UnsafeUtilities.As<T>(object?) Remarks The index buffer is used in static mode and contains six indices for each quad. The vertex buffer contains 4 vertices for each quad. Rectangle is composed of two triangles as follow: v0 - - - v1 v0 - - - v1 | \\ | | t1 / | If cycle=true: | \\ t1 | If cycle=false: | / | | t2 \\ | | / t2 | v3 - - - v2 v2 - - - v3 Fields IndicesByElement public const int IndicesByElement = 6 Field Value int VertexByElement public const int VertexByElement = 4 Field Value int Methods CreateQuadBufferInfo(string, bool, int, int) public static BatchBase<TDrawInfo>.StaticQuadBufferInfo CreateQuadBufferInfo(string resourceKey, bool cycle, int maxQuadNumber, int batchCapacity = 64) Parameters resourceKey string cycle bool maxQuadNumber int batchCapacity int Returns BatchBase<TDrawInfo>.StaticQuadBufferInfo"
  },
  "api/Stride.Graphics.BatchBase-1.TextureIdComparer.html": {
    "href": "api/Stride.Graphics.BatchBase-1.TextureIdComparer.html",
    "title": "Class BatchBase<TDrawInfo>.TextureIdComparer | Stride API",
    "summary": "Class BatchBase<TDrawInfo>.TextureIdComparer Namespace Stride.Graphics Assembly Stride.Graphics.dll protected class BatchBase<TDrawInfo>.TextureIdComparer : IComparer<int> Inheritance object BatchBase<TDrawInfo>.TextureIdComparer Implements IComparer<int> Extension Methods UnsafeUtilities.As<T>(object?) Fields SpriteTextures public Texture[] SpriteTextures Field Value Texture[] Methods Compare(int, int) Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. public int Compare(int left, int right) Parameters left int right int Returns int A signed integer that indicates the relative values of x and y, as shown in the following table. Value Meaning Less than zero x is less than y. Zero x equals y. Greater than zero x is greater than y."
  },
  "api/Stride.Graphics.BatchBase-1.html": {
    "href": "api/Stride.Graphics.BatchBase-1.html",
    "title": "Class BatchBase<TDrawInfo> | Stride API",
    "summary": "Class BatchBase<TDrawInfo> Namespace Stride.Graphics Assembly Stride.Graphics.dll Base class to batch a group of draw calls into one. public abstract class BatchBase<TDrawInfo> : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder where TDrawInfo : struct Type Parameters TDrawInfo A structure containing all the required information to draw one element of the batch. Inheritance object DisposeBase ComponentBase BatchBase<TDrawInfo> Implements IDisposable IComponent IReferencable ICollectorHolder Derived Sprite3DBatch SpriteBatch UIBatch Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors BatchBase(GraphicsDevice, EffectBytecode, EffectBytecode, ResourceBufferInfo, VertexDeclaration, int) protected BatchBase(GraphicsDevice device, EffectBytecode defaultEffectBytecode, EffectBytecode defaultEffectBytecodeSRgb, BatchBase<TDrawInfo>.ResourceBufferInfo resourceBufferInfo, VertexDeclaration vertexDeclaration, int indexSize = 2) Parameters device GraphicsDevice defaultEffectBytecode EffectBytecode defaultEffectBytecodeSRgb EffectBytecode resourceBufferInfo BatchBase<TDrawInfo>.ResourceBufferInfo vertexDeclaration VertexDeclaration indexSize int Fields DefaultEffect protected readonly EffectInstance DefaultEffect Field Value EffectInstance DefaultEffectSRgb protected readonly EffectInstance DefaultEffectSRgb Field Value EffectInstance ResourceContext protected BatchBase<TDrawInfo>.DeviceResourceContext ResourceContext Field Value BatchBase<TDrawInfo>.DeviceResourceContext ResourceContextPool protected readonly ThreadLocal<BatchBase<TDrawInfo>.DeviceResourceContext> ResourceContextPool Field Value ThreadLocal<BatchBase<TDrawInfo>.DeviceResourceContext> blendState protected BlendStateDescription? blendState Field Value BlendStateDescription? depthStencilState protected DepthStencilStateDescription? depthStencilState Field Value DepthStencilStateDescription? graphicsDevice protected GraphicsDevice graphicsDevice Field Value GraphicsDevice mutablePipeline protected MutablePipelineState mutablePipeline Field Value MutablePipelineState rasterizerState protected RasterizerStateDescription? rasterizerState Field Value RasterizerStateDescription? samplerState protected SamplerState samplerState Field Value SamplerState sortMode protected SpriteSortMode sortMode Field Value SpriteSortMode stencilReferenceValue protected int stencilReferenceValue Field Value int Properties BackToFrontComparer protected BatchBase<TDrawInfo>.QueueComparer<BatchBase<TDrawInfo>.ElementInfo> BackToFrontComparer { get; set; } Property Value BatchBase<TDrawInfo>.QueueComparer<BatchBase<TDrawInfo>.ElementInfo> Effect The effect used for the current Begin/End session. protected EffectInstance Effect { get; } Property Value EffectInstance FrontToBackComparer protected BatchBase<TDrawInfo>.QueueComparer<BatchBase<TDrawInfo>.ElementInfo> FrontToBackComparer { get; set; } Property Value BatchBase<TDrawInfo>.QueueComparer<BatchBase<TDrawInfo>.ElementInfo> GraphicsContext protected GraphicsContext GraphicsContext { get; } Property Value GraphicsContext Parameters Gets the parameters applied on the SpriteBatch effect. public ParameterCollection Parameters { get; } Property Value ParameterCollection The parameters. TextureComparer protected BatchBase<TDrawInfo>.TextureIdComparer TextureComparer { get; set; } Property Value BatchBase<TDrawInfo>.TextureIdComparer Methods Begin(GraphicsContext, EffectInstance, SpriteSortMode, BlendStateDescription?, SamplerState, DepthStencilStateDescription?, RasterizerStateDescription?, int) Begins a sprite batch rendering using the specified sorting mode and blend state, sampler, depth stencil, rasterizer state objects and a custom effect. Passing null for any of the state objects selects the default default state objects (BlendState.AlphaBlend, depthStencilState.None, RasterizerState.CullCounterClockwise, SamplerState.LinearClamp). Passing a null effect selects the default effect shader. protected void Begin(GraphicsContext graphicsContext, EffectInstance effect, SpriteSortMode sessionSortMode, BlendStateDescription? sessionBlendState, SamplerState sessionSamplerState, DepthStencilStateDescription? sessionDepthStencilState, RasterizerStateDescription? sessionRasterizerState, int stencilValue) Parameters graphicsContext GraphicsContext The graphics context to use. effect EffectInstance The effect to use for this begin/end draw session (default effect if null) sessionSortMode SpriteSortMode Sprite drawing order used for the Begin/End session. sessionBlendState BlendStateDescription? Blending state used for the Begin/End session sessionSamplerState SamplerState Texture sampling used for the Begin/End session sessionDepthStencilState DepthStencilStateDescription? Depth and stencil state used for the Begin/End session sessionRasterizerState RasterizerStateDescription? Rasterization state used for the Begin/End session stencilValue int The value of the stencil buffer to take as reference for the Begin/End session Exceptions InvalidOperationException Only one SpriteBatch at a time can use SpriteSortMode.Immediate CheckBeginHasBeenCalled(string) protected void CheckBeginHasBeenCalled(string functionName) Parameters functionName string CheckEndHasBeenCalled(string) protected void CheckEndHasBeenCalled(string functionName) Parameters functionName string Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. Draw(Texture, in ElementInfo) protected void Draw(Texture texture, in BatchBase<TDrawInfo>.ElementInfo elementInfo) Parameters texture Texture elementInfo BatchBase<TDrawInfo>.ElementInfo End() Flushes the sprite batch and restores the device state to how it was before Begin was called. public void End() PrepareForRendering() protected virtual void PrepareForRendering() UpdateBufferValuesFromElementInfo(ref ElementInfo, nint, nint, int) Update the mapped vertex and index buffer values using the provided element info. protected abstract void UpdateBufferValuesFromElementInfo(ref BatchBase<TDrawInfo>.ElementInfo elementInfo, nint vertexPointer, nint indexPointer, int vexterStartOffset) Parameters elementInfo BatchBase<TDrawInfo>.ElementInfo The structure containing the information about the element to draw. vertexPointer nint The pointer to the vertex array buffer to update. indexPointer nint The pointer to the index array buffer to update. This value is null if the index buffer used is static. vexterStartOffset int The offset in the vertex buffer where the vertex of the element starts"
  },
  "api/Stride.Graphics.Blend.html": {
    "href": "api/Stride.Graphics.Blend.html",
    "title": "Enum Blend | Stride API",
    "summary": "Enum Blend Namespace Stride.Graphics Assembly Stride.Graphics.dll A Blend Option identifying the data source and an optional pre-blend operation, which help define how Pixel Shader output is mixed with the destination color in rendering operations. [DataContract] public enum Blend Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BlendFactor = 14 The data source is a blend factor set in the BlendStateDescription. No pre-blend operation. The blend factor is directly used for blending. DestinationAlpha = 7 The data source is the alpha value that comes from the existing Render Target before blending. No pre-blend operation. The alpha value is directly used for blending. DestinationColor = 9 The data source is color data already present in a Render Target. No pre-blend operation. Each component is directly used for blending. InverseBlendFactor = 15 The data source is a blend factor set in the BlendStateDescription. The pre-blend operation inverts the data. The blend factor is inverted (1 - blendFactor) before blending. InverseDestinationAlpha = 8 The data source is the alpha value that comes from the existing Render Target before blending. The pre-blend operation inverts the data. The alpha value is inverted (1 - A) before blending. InverseDestinationColor = 10 The data source is color data already present in a Render Target. The pre-blend operation inverts the data. Each component is inverted (1 - RGB) before blending. InverseSecondarySourceAlpha = 19 The data source is primary alpha data (A0) and secondary alpha data (A1), both generated by the Pixel Shader, for use in dual-source color blending. The pre-blend operation inverts the data. Both alpha values are inverted (1 - A) before blending. InverseSecondarySourceColor = 17 The data source is primary color data (RGB0) and secondary color data (RGB1), both generated by the Pixel Shader, for use in dual-source color blending. The pre-blend operation inverts the data. Each component of both of the colors is inverted (1 - RGB) before blending. This can create interesting effects like color negation. InverseSourceAlpha = 6 The data source is alpha data (A) generated by the Pixel Shader. The pre-blend operation inverts the data. The alpha value is inverted (1 - A) before blending. InverseSourceColor = 4 The data source is color data (RGB) generated by the Pixel Shader. The pre-blend operation inverts the data. Each component is inverted (1 - RGB) before blending. One = 2 The data source is the one vector (1, 1, 1, 1), meaning each component of the color generated by the Pixel Shader is multiplied by one No pre-blend operation. SecondarySourceAlpha = 18 The data source is primary alpha data (A0) and secondary alpha data (A1), both generated by the Pixel Shader, for use in dual-source color blending. No pre-blend operation. The alpha value is directly used for blending. SecondarySourceColor = 16 Uses two color outputs (RGB0 and RGB1) from the Pixel Shader for advanced blending techniques. No pre-blend operation. Each component is directly used for blending. SourceAlpha = 5 The data source is alpha data (A) generated by the Pixel Shader. No pre-blend operation. The alpha value is directly used for blending. SourceAlphaSaturate = 11 The data source is alpha data generated by the Pixel Shader. The pre-blend operation clamps the data to 1 or less. This ensures the alpha value does not exceed 1, preventing unintended brightness shifts. SourceColor = 3 The data source is color data (RGB) generated by the Pixel Shader. No pre-blend operation. Each component is directly used for blending. Zero = 1 The data source is the zero vector (0, 0, 0, 0), meaning each component of the color generated by the Pixel Shader is multiplied by zero. No pre-blend operation. Remarks Blend options are specified in a BlendStateDescription."
  },
  "api/Stride.Graphics.BlendFunction.html": {
    "href": "api/Stride.Graphics.BlendFunction.html",
    "title": "Enum BlendFunction | Stride API",
    "summary": "Enum BlendFunction Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines a function for color blending. [DataContract] public enum BlendFunction Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Add = 1 The function adds destination to the source: (srcColor * srcBlend) + (destColor * destBlend) Max = 5 The function finds the maximum of the source and destination: max( (srcColor * srcBlend), (destColor * destBlend) ) Min = 4 The function finds the minimum of the source and destination: min( (srcColor * srcBlend), (destColor * destBlend) ) ReverseSubtract = 3 The function subtracts source from destination: (destColor * destBlend) - (srcColor * srcBlend) Subtract = 2 The function subtracts destination from source: (srcColor * srcBlend) − (destColor * destBlend) Remarks The runtime implements color (RGB) blending and alpha blending separately. Therefore, a Blend State requires separate blend operations for RGB data and alpha data. These blend operations are specified in a BlendStateDescription and in a BlendStateRenderTargetDescription."
  },
  "api/Stride.Graphics.BlendStateDescription.RenderTargetBlendStates.html": {
    "href": "api/Stride.Graphics.BlendStateDescription.RenderTargetBlendStates.html",
    "title": "Struct BlendStateDescription.RenderTargetBlendStates | Stride API",
    "summary": "Struct BlendStateDescription.RenderTargetBlendStates Namespace Stride.Graphics Assembly Stride.Graphics.dll A structure that contains an inline array of BlendStateRenderTargetDescription for up to eight render targets. public struct BlendStateDescription.RenderTargetBlendStates Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Count Gets the number of Render Target blend descriptions in a Blend State Description. public readonly int Count { get; } Property Value int Methods AsReadOnlySpan() Returns a read-only span of BlendStateRenderTargetDescription for the Render Targets. [UnscopedRef] public readonly ReadOnlySpan<BlendStateRenderTargetDescription> AsReadOnlySpan() Returns ReadOnlySpan<BlendStateRenderTargetDescription> A ReadOnlySpan<T> of Blend State descriptions for the Render Targets. AsSpan() Returns a writable span of BlendStateRenderTargetDescription for the Render Targets. [UnscopedRef] public Span<BlendStateRenderTargetDescription> AsSpan() Returns Span<BlendStateRenderTargetDescription> A Span<T> of Blend State descriptions for the Render Targets."
  },
  "api/Stride.Graphics.BlendStateDescription.html": {
    "href": "api/Stride.Graphics.BlendStateDescription.html",
    "title": "Struct BlendStateDescription | Stride API",
    "summary": "Struct BlendStateDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll A description of a Blend State, which defines how colors are blended when rendering to one or multiple Render Targets. [DataContract] public struct BlendStateDescription : IEquatable<BlendStateDescription> Implements IEquatable<BlendStateDescription> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks This structure controls transparency, color mixing, and blend modes across all the Render Targets. Modify this to achieve effects like alpha blending, additive blending, or custom shader-based blends. It also controls whether to use alpha-to-coverage as a multi-sampling technique when writing a pixel to a Render Target. Constructors BlendStateDescription() Initializes a new instance of the BlendStateDescription structure with default values. public BlendStateDescription() Remarks The default values are: <ul><li><span class=\"term\">Alpha-to-Coverage</span>Disabled</li><li><span class=\"term\">Independent Blending</span>Disabled. Only enable blend for the first Render Target</li><li>Disable blending for all the Render Targets.</li></ul> </remarks> BlendStateDescription(Blend, Blend) Initializes a new instance of the BlendStateDescription structure with default values, and the specified blending for the first Render Target. public BlendStateDescription(Blend sourceBlend, Blend destinationBlend) Parameters sourceBlend Blend The source blend. destinationBlend Blend The destination blend. Remarks The default values are: <ul><li><span class=\"term\">Alpha-to-Coverage</span>Disabled</li><li><span class=\"term\">Independent Blending</span>Disabled. Only enable blend for the first Render Target</li><li>Disable blending for all the Render Targets.</li></ul> </remarks> Fields AlphaToCoverageEnable A value that determines whether or not to use alpha-to-coverage as a multi-sampling technique when writing a pixel to a Render Target. public bool AlphaToCoverageEnable Field Value bool Remarks Alpha-to-coverage is a technique that uses the alpha value of a pixel to determine how much coverage it should have in a multi-sampled anti-aliasing (MSAA) scenario. This can help achieve smoother edges in transparent textures by blending the coverage of the pixel based on its alpha value. Default A Blend State description with default values. public static readonly BlendStateDescription Default Field Value BlendStateDescription Remarks The default values are: Alpha-to-CoverageDisabled Independent BlendingDisabled. Only enable blend for the first Render Target Disable blending for all the Render Targets. DefaultAlphaToCoverageEnable Default value for AlphaToCoverageEnable. public const bool DefaultAlphaToCoverageEnable = false Field Value bool DefaultIndependentBlendEnable Default value for IndependentBlendEnable. public const bool DefaultIndependentBlendEnable = false Field Value bool IndependentBlendEnable A value indicating whether to enable independent blending in simultaneous Render Targets, meaning per-Render Target blending settings. public bool IndependentBlendEnable Field Value bool Remarks If set to true, each of the RenderTargets can have its own blend settings. If set to false, only the first Render Target (RenderTarget0) is taken into account. The others (RenderTarget1 to RenderTarget7) are ignored. RenderTargets An array of Render Target blend descriptions (see BlendStateRenderTargetDescription); these correspond to the eight Render Targets that can be set to the output-merger stage at one time. public BlendStateDescription.RenderTargetBlendStates RenderTargets Field Value BlendStateDescription.RenderTargetBlendStates Methods Equals(BlendStateDescription) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(BlendStateDescription other) Parameters other BlendStateDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(BlendStateDescription, BlendStateDescription) public static bool operator ==(BlendStateDescription left, BlendStateDescription right) Parameters left BlendStateDescription right BlendStateDescription Returns bool operator !=(BlendStateDescription, BlendStateDescription) public static bool operator !=(BlendStateDescription left, BlendStateDescription right) Parameters left BlendStateDescription right BlendStateDescription Returns bool See Also BlendStates"
  },
  "api/Stride.Graphics.BlendStateRenderTargetDescription.html": {
    "href": "api/Stride.Graphics.BlendStateRenderTargetDescription.html",
    "title": "Struct BlendStateRenderTargetDescription | Stride API",
    "summary": "Struct BlendStateRenderTargetDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll A description of a Blend State for a Render Target, which defines how colors are blended when rendering. [DataContract] public struct BlendStateRenderTargetDescription : IEquatable<BlendStateRenderTargetDescription> Implements IEquatable<BlendStateRenderTargetDescription> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks This structure controls transparency, color mixing, and blend modes for a Render Target. Modify this to achieve effects like alpha blending, additive blending, or custom shader-based blends. Constructors BlendStateRenderTargetDescription() Initializes a new instance of the BlendStateRenderTargetDescription structure with default values. public BlendStateRenderTargetDescription() Remarks The default values are: <ul><li>The blending is disabled.</li><li> For both Color and Alpha: <ul><li><span class=\"term\">Source</span><xref href=\"Stride.Graphics.Blend.One\" data-throw-if-not-resolved=\"false\"></xref></li><li><span class=\"term\">Destination</span><xref href=\"Stride.Graphics.Blend.Zero\" data-throw-if-not-resolved=\"false\"></xref></li><li><span class=\"term\">Compare Function</span><xref href=\"Stride.Graphics.BlendFunction.Add\" data-throw-if-not-resolved=\"false\"></xref> (additive)</li></ul> </li><li>All color channels can be written (<xref href=\"Stride.Graphics.ColorWriteChannels.All\" data-throw-if-not-resolved=\"false\"></xref>).</li></ul> </remarks> Fields AlphaBlendFunction Defines the function used to combine the alpha data sources. public BlendFunction AlphaBlendFunction Field Value BlendFunction See Also BlendFunction AlphaDestinationBlend Specifies the second alpha data source and includes an optional pre-blend operation. public Blend AlphaDestinationBlend Field Value Blend Remarks Blend options that end in Color are not allowed. See Also Blend AlphaSourceBlend Specifies the first alpha data source and includes an optional pre-blend operation. public Blend AlphaSourceBlend Field Value Blend Remarks Blend options that end in Color are not allowed. See Also Blend BlendEnable A value indicating whether to enable or disable blending. public bool BlendEnable Field Value bool ColorBlendFunction Defines the function used to combine the color (RGB) data sources. public BlendFunction ColorBlendFunction Field Value BlendFunction See Also BlendFunction ColorDestinationBlend Specifies the second color (RGB) data source and includes an optional pre-blend operation. public Blend ColorDestinationBlend Field Value Blend See Also Blend ColorSourceBlend Specifies the first color (RGB) data source and includes an optional pre-blend operation. public Blend ColorSourceBlend Field Value Blend See Also Blend ColorWriteChannels A combination of flags that specify which color channels (Red, Green, Blue, Alpha) can be written to the Render Target when blending. public ColorWriteChannels ColorWriteChannels Field Value ColorWriteChannels Default A BlendStateRenderTargetDescription structure with default values. public static readonly BlendStateRenderTargetDescription Default Field Value BlendStateRenderTargetDescription Remarks The default values are: The blending is disabled. For both Color and Alpha: <ul><li><span class=\"term\">Source</span><xref href=\"Stride.Graphics.Blend.One\" data-throw-if-not-resolved=\"false\"></xref></li><li><span class=\"term\">Destination</span><xref href=\"Stride.Graphics.Blend.Zero\" data-throw-if-not-resolved=\"false\"></xref></li><li><span class=\"term\">Compare Function</span><xref href=\"Stride.Graphics.BlendFunction.Add\" data-throw-if-not-resolved=\"false\"></xref> (additive)</li></ul> All color channels can be written (All). DefaultAlphaBlendFunction Default value for AlphaBlendFunction. public const BlendFunction DefaultAlphaBlendFunction = Add Field Value BlendFunction DefaultAlphaDestinationBlend Default value for AlphaDestinationBlend. public const Blend DefaultAlphaDestinationBlend = Zero Field Value Blend DefaultAlphaSourceBlend Default value for AlphaSourceBlend. public const Blend DefaultAlphaSourceBlend = One Field Value Blend DefaultBlendEnable Default value for BlendEnable. public const bool DefaultBlendEnable = false Field Value bool DefaultColorBlendFunction Default value for ColorBlendFunction. public const BlendFunction DefaultColorBlendFunction = Add Field Value BlendFunction DefaultColorDestinationBlend Default value for ColorDestinationBlend. public const Blend DefaultColorDestinationBlend = Zero Field Value Blend DefaultColorSourceBlend Default value for ColorSourceBlend. public const Blend DefaultColorSourceBlend = One Field Value Blend DefaultColorWriteChannels Default value for ColorWriteChannels. public const ColorWriteChannels DefaultColorWriteChannels = All Field Value ColorWriteChannels Methods Equals(BlendStateRenderTargetDescription) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(BlendStateRenderTargetDescription other) Parameters other BlendStateRenderTargetDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(BlendStateRenderTargetDescription, BlendStateRenderTargetDescription) public static bool operator ==(BlendStateRenderTargetDescription left, BlendStateRenderTargetDescription right) Parameters left BlendStateRenderTargetDescription right BlendStateRenderTargetDescription Returns bool operator !=(BlendStateRenderTargetDescription, BlendStateRenderTargetDescription) public static bool operator !=(BlendStateRenderTargetDescription left, BlendStateRenderTargetDescription right) Parameters left BlendStateRenderTargetDescription right BlendStateRenderTargetDescription Returns bool"
  },
  "api/Stride.Graphics.BlendStates.html": {
    "href": "api/Stride.Graphics.BlendStates.html",
    "title": "Class BlendStates | Stride API",
    "summary": "Class BlendStates Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines a set of built-in BlendStateDescriptions for common blending configurations. public static class BlendStates Inheritance object BlendStates Fields Additive A built-in Blend State description with settings for additive blending, that is adding the destination data to the source data without using alpha. public static readonly BlendStateDescription Additive Field Value BlendStateDescription Remarks This built-in state object has the following settings for the first Render Target: Property Value ColorSourceBlend SourceAlpha AlphaSourceBlend SourceAlpha ColorDestinationBlend One AlphaDestinationBlend One AlphaBlend A built-in Blend State description with settings for alpha blending, that is blending the source and destination data using alpha. public static readonly BlendStateDescription AlphaBlend Field Value BlendStateDescription Remarks This built-in state object has the following settings for the first Render Target: Property Value ColorSourceBlend One AlphaSourceBlend One ColorDestinationBlend InverseSourceAlpha AlphaDestinationBlend InverseSourceAlpha ColorDisabled A built-in Blend State description with settings for disabling color rendering on the first Render Target (target 0), that is rendering only to the Depth-Stencil Buffer. public static readonly BlendStateDescription ColorDisabled Field Value BlendStateDescription Remarks This is the same as the Default state, but with the first Render Target's color write channels disabled. Default A built-in Blend State description with default settings, that is no blend at all. public static readonly BlendStateDescription Default Field Value BlendStateDescription Remarks The default values are: Alpha-to-CoverageDisabled Independent BlendingDisabled. Only enable blend for the first Render Target Disable blending for all the Render Targets. NonPremultiplied A built-in Blend State description with settings for blending with non-premultipled alpha, that is blending source and destination data using alpha while assuming the color data contains no alpha information. public static readonly BlendStateDescription NonPremultiplied Field Value BlendStateDescription Remarks This built-in state object has the following settings for the first Render Target: Property Value ColorSourceBlend SourceAlpha AlphaSourceBlend SourceAlpha ColorDestinationBlend InverseSourceAlpha AlphaDestinationBlend InverseSourceAlpha Opaque A built-in Blend State description with settings for opaque blending, that is overwriting the destination with the source data. public static readonly BlendStateDescription Opaque Field Value BlendStateDescription Remarks This built-in state object has the following settings for the first Render Target: Property Value ColorSourceBlend One AlphaSourceBlend One ColorDestinationBlend Zero AlphaDestinationBlend Zero"
  },
  "api/Stride.Graphics.Buffer-1.html": {
    "href": "api/Stride.Graphics.Buffer-1.html",
    "title": "Class Buffer<T> | Stride API",
    "summary": "Class Buffer<T> Namespace Stride.Graphics Assembly Stride.Graphics.dll All-in-one GPU buffer that is able to represent many types of Buffers (shader Constant Buffers, Structured Buffers, Raw Buffers, Argument Buffers, etc.), but with typed information. public class Buffer<T> : Buffer, IDisposable, IComponent, IReferencable, ICollectorHolder where T : unmanaged Type Parameters T The type of the elements of the Buffer. Inheritance object DisposeBase ComponentBase GraphicsResourceBase GraphicsResource Buffer Buffer<T> Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members Buffer.elementCount Buffer.Description Buffer.Usage Buffer.Flags Buffer.SizeInBytes Buffer.StructureByteStride Buffer.ElementCount Buffer.ViewFlags Buffer.ViewFormat Buffer.InitialCounterOffset Buffer.ToStaging() Buffer.Clone() Buffer.InitializeFromImpl(ref readonly BufferDescription, BufferFlags, PixelFormat, nint) Buffer.GetData<TData>(CommandList) Buffer.GetData<TData>(CommandList, TData[]) Buffer.GetData<TData>(CommandList, ref TData) Buffer.GetData<TData>(CommandList, Buffer, ref TData) Buffer.GetData<TData>(CommandList, Buffer, TData[]) Buffer.GetData(CommandList, Buffer, DataPointer) Buffer.GetData<TData>(CommandList, Buffer, Span<TData>) Buffer.SetData<TData>(CommandList, ref readonly TData, int) Buffer.SetData<TData>(CommandList, TData[], int) Buffer.SetData(CommandList, DataPointer, int) Buffer.SetData<TData>(CommandList, ReadOnlySpan<TData>, int) Buffer.New(GraphicsDevice, BufferDescription, PixelFormat) Buffer.New(GraphicsDevice, int, BufferFlags, GraphicsResourceUsage) Buffer.New<T>(GraphicsDevice, int, BufferFlags, GraphicsResourceUsage) Buffer.New(GraphicsDevice, int, BufferFlags, PixelFormat, GraphicsResourceUsage) Buffer.New(GraphicsDevice, int, int, BufferFlags, GraphicsResourceUsage) Buffer.New(GraphicsDevice, int, int, BufferFlags, PixelFormat, GraphicsResourceUsage) Buffer.New<T>(GraphicsDevice, ref readonly T, BufferFlags, GraphicsResourceUsage) Buffer.New<T>(GraphicsDevice, ref readonly T, BufferFlags, PixelFormat, GraphicsResourceUsage) Buffer.New<T>(GraphicsDevice, T[], BufferFlags, GraphicsResourceUsage) Buffer.New<T>(GraphicsDevice, T[], BufferFlags, PixelFormat, GraphicsResourceUsage) Buffer.New<T>(GraphicsDevice, ReadOnlySpan<T>, BufferFlags, PixelFormat, GraphicsResourceUsage) Buffer.New(GraphicsDevice, ReadOnlySpan<byte>, int, BufferFlags, PixelFormat, GraphicsResourceUsage) Buffer.New(GraphicsDevice, DataPointer, int, BufferFlags, GraphicsResourceUsage) Buffer.New(GraphicsDevice, DataPointer, int, BufferFlags, PixelFormat, GraphicsResourceUsage) Buffer.RecreateWith<T>(T[]) Buffer.RecreateWith(nint) Buffer.Recreate<T>(T[]) Buffer.OnDestroyed(bool) Buffer.OnRecreate() Buffer.Recreate(nint) Buffer.OnNameChanged() GraphicsResource.NativeShaderResourceView GraphicsResource.NativeUnorderedAccessView GraphicsResourceBase.NativeResource GraphicsResourceBase.NativeDeviceChild GraphicsResourceBase.UnsetNativeDeviceChild() GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) GraphicsResourceBase.NativeDevice GraphicsResourceBase.IsDebugMode GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed GraphicsResourceBase.OnPause() GraphicsResourceBase.OnResume() GraphicsResourceBase.Destroy() ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods GraphicsSerializerExtensions.GetSerializationData(Buffer) GraphicsSerializerExtensions.SetSerializationData(Buffer, BufferData) ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks Buffer<T> constains static methods for creating new Buffers with typed information by specifying all their characteristics. Also look for the following static methods that aid in the creation of specific kinds of Buffers: Buffer.Argument (for Argument Buffers), Buffer.Constant (for Constant Buffers), Buffer.Index (for Index Buffers), Buffer.Raw (for Raw Buffers), Buffer.Structured (for Structured Buffers), Buffer.Typed (for Typed Buffers), and Buffer.Vertex (for Vertex Buffers). You can also check the methods of Buffer for creating Buffers with the maximum flexibility. Consult the documentation of your graphics API for more information on each kind of Buffer. Constructors Buffer(GraphicsDevice, BufferDescription, BufferFlags, PixelFormat, nint, string?) Initializes a new instance of typed Buffer<T>. protected Buffer(GraphicsDevice device, BufferDescription description, BufferFlags bufferFlags, PixelFormat viewFormat, nint dataPointer, string? name = null) Parameters device GraphicsDevice The GraphicsDevice. description BufferDescription The description of the Buffer's characteristics. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. viewFormat PixelFormat View format used if the Buffer is used as a Shader Resource View, or None if not. dataPointer nint The data pointer to the initial data the Buffer will contain. name string A name for the Buffer, used for debugging purposes. Specify null to not set a name and use the name of the type instead. Fields ElementSize The size of the elements in this Buffer<T> (i.e. the size of T). public readonly int ElementSize Field Value int Methods GetData(CommandList) Gets the contents of the Buffer as an array of data. public T[] GetData(CommandList commandList) Parameters commandList CommandList The CommandList. Returns T[] An array of data with the contents of the Buffer. Remarks This method only works when called from the main thread that is accessing the main GraphicsDevice. This method creates internally a staging resource (if this Buffer is not already a staging resource), copies to it and map it to memory. Use a method that allows to specify an explicit staging resource for optimal performance. SetData(CommandList, ref readonly T, int) Copies the contents an array of data on CPU memory into the Buffer in GPU memory. public void SetData(CommandList commandList, ref readonly T fromData, int offsetInBytes = 0) Parameters commandList CommandList The CommandList. fromData T The data to copy from. offsetInBytes int The offset in bytes to write to. Remarks See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions. Exceptions ArgumentException offsetInBytes is only supported for Buffers declared with Default. SetData(CommandList, T[], int) Copies the contents of an array of data on CPU memory into the Buffer in GPU memory. public void SetData(CommandList commandList, T[] fromData, int offsetInBytes = 0) Parameters commandList CommandList The CommandList. fromData T[] The array of data to copy from. offsetInBytes int The offset in bytes from the start of the Buffer where data is to be written. Remarks See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions. Exceptions ArgumentException offsetInBytes is only supported for Buffers declared with Default. See Also Buffer Buffer.Argument Buffer.Constant Buffer.Index Buffer.Raw Buffer.Structured Buffer.Typed Buffer.Vertex"
  },
  "api/Stride.Graphics.Buffer.Argument.html": {
    "href": "api/Stride.Graphics.Buffer.Argument.html",
    "title": "Class Buffer.Argument | Stride API",
    "summary": "Class Buffer.Argument Namespace Stride.Graphics Assembly Stride.Graphics.dll Helper methods for creating Argument Buffers. public static class Buffer.Argument Inheritance object Buffer.Argument Remarks An Argument Buffer is a Buffer that is used to pass arguments / parameters to shaders or in indirect rendering (i.e. GPU-driven rendering). The key differences with Constant Buffers is that Argument Buffer are (by default) writable by the GPU, can have an arbitrary size, and have somewhat slower access than Constant Buffers (as they are more akin to regular Buffers). Methods New(GraphicsDevice, int, GraphicsResourceUsage) Creates a new Argument Buffer of a given size. public static Buffer New(GraphicsDevice device, int bufferSize, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. bufferSize int Size of the Buffer in bytes. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer A new instance of Buffer. New<T>(GraphicsDevice, GraphicsResourceUsage) Creates a new Argument Buffer. public static Buffer<T> New<T>(GraphicsDevice device, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, ref readonly T, GraphicsResourceUsage) Creates a new Argument Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, ref readonly T value, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. value T The value to initialize the Argument Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. See Also Buffer Buffer<T>"
  },
  "api/Stride.Graphics.Buffer.Constant.html": {
    "href": "api/Stride.Graphics.Buffer.Constant.html",
    "title": "Class Buffer.Constant | Stride API",
    "summary": "Class Buffer.Constant Namespace Stride.Graphics Assembly Stride.Graphics.dll Helper methods for creating Constant Buffers. public static class Buffer.Constant Inheritance object Buffer.Constant Remarks A Constant Buffer is a Buffer that is used to pass shader constants / parameters to shaders. They have fast access due to special hardware optimizations, being read-only to shaders, and being of a limited size (64 kB usually). Methods New(GraphicsDevice, DataPointer, GraphicsResourceUsage) Creates a new Constant Buffer with initial data. [Obsolete(\"This method is obsolete. Use the span-based methods instead\")] public static Buffer New(GraphicsDevice device, DataPointer dataPointer, GraphicsResourceUsage usage = GraphicsResourceUsage.Dynamic) Parameters device GraphicsDevice The GraphicsDevice. dataPointer DataPointer The data pointer to the data to initialize the Constant Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Dynamic. Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, GraphicsResourceUsage) Creates a new Constant Buffer of a given size. public static Buffer New(GraphicsDevice device, int bufferSize, GraphicsResourceUsage usage = GraphicsResourceUsage.Dynamic) Parameters device GraphicsDevice The GraphicsDevice. bufferSize int Size of the Buffer in bytes. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Dynamic. Returns Buffer A new instance of Buffer. New(GraphicsDevice, ReadOnlySpan<byte>, GraphicsResourceUsage) Creates a new Constant Buffer with initial data. public static Buffer New(GraphicsDevice device, ReadOnlySpan<byte> data, GraphicsResourceUsage usage = GraphicsResourceUsage.Dynamic) Parameters device GraphicsDevice The GraphicsDevice. data ReadOnlySpan<byte> The data to initialize the Constant Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Dynamic. Returns Buffer A new instance of Buffer. New<T>(GraphicsDevice) Creates a new Constant Buffer with Dynamic usage. public static Buffer<T> New<T>(GraphicsDevice device) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, ref readonly T, GraphicsResourceUsage) Creates a new Constant Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, ref readonly T value, GraphicsResourceUsage usage = GraphicsResourceUsage.Dynamic) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. value T The value to initialize the Constant Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Dynamic. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, T[], GraphicsResourceUsage) Creates a new Constant Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, T[] data, GraphicsResourceUsage usage = GraphicsResourceUsage.Dynamic) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. data T[] The data to initialize the Constant Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Dynamic. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. See Also Buffer Buffer<T>"
  },
  "api/Stride.Graphics.Buffer.Index.html": {
    "href": "api/Stride.Graphics.Buffer.Index.html",
    "title": "Class Buffer.Index | Stride API",
    "summary": "Class Buffer.Index Namespace Stride.Graphics Assembly Stride.Graphics.dll Helper methods for creating Index Buffers. public static class Buffer.Index Inheritance object Buffer.Index Remarks An Index Buffer is a Buffer that stores indices that reference vertices in a Vertex Buffer. They are used for efficient rendering of triangle lists / strip. They are, however, limited to only 16-bit or 32-bit values. Methods New(GraphicsDevice, DataPointer, GraphicsResourceUsage) Creates a new Index Buffer. [Obsolete(\"This method is obsolete. Use the span-based methods instead\")] public static Buffer New(GraphicsDevice device, DataPointer dataPointer, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) Parameters device GraphicsDevice The GraphicsDevice. dataPointer DataPointer The data pointer to the data to initialize the Index Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Immutable. Returns Buffer A new instance of Buffer. New(GraphicsDevice, byte[], bool, GraphicsResourceUsage) Creates a new Index Buffer with initial data. public static Buffer New(GraphicsDevice device, byte[] data, bool is32BitIndex, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) Parameters device GraphicsDevice The GraphicsDevice. data byte[] The data to initialize the Index Buffer. is32BitIndex bool true if the Buffer will use 32-bit indices; false for using 16-bit indices. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Immutable. Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, GraphicsResourceUsage) Creates a new Index Buffer of a given size. public static Buffer New(GraphicsDevice device, int bufferSize, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. bufferSize int Size of the Buffer in bytes. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer A new instance of Buffer. New(GraphicsDevice, ReadOnlySpan<byte>, GraphicsResourceUsage) Creates a new Index Buffer with initial data. public static Buffer New(GraphicsDevice device, ReadOnlySpan<byte> data, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) Parameters device GraphicsDevice The GraphicsDevice. data ReadOnlySpan<byte> The data to initialize the Index Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Immutable. Returns Buffer A new instance of Buffer. New<T>(GraphicsDevice, GraphicsResourceUsage) Creates a new Index Buffer. public static Buffer<T> New<T>(GraphicsDevice device, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the indices stored in the Buffer. It can only be short or int. New<T>(GraphicsDevice, ref readonly T, GraphicsResourceUsage) Creates a new Index Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, ref readonly T value, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. value T The value to initialize the Index Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Immutable. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the indices stored in the Buffer. It can only be short or int. New<T>(GraphicsDevice, T[], GraphicsResourceUsage) Creates a new Index Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, T[] data, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. data T[] The data to initialize the Index Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Immutable. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the indices stored in the Buffer. It can only be short or int. See Also Buffer Buffer<T>"
  },
  "api/Stride.Graphics.Buffer.Raw.html": {
    "href": "api/Stride.Graphics.Buffer.Raw.html",
    "title": "Class Buffer.Raw | Stride API",
    "summary": "Class Buffer.Raw Namespace Stride.Graphics Assembly Stride.Graphics.dll Helper methods for creating Raw Buffers. public static class Buffer.Raw Inheritance object Buffer.Raw Remarks A Raw Buffer is a Buffer that can be read in shaders as raw bytes. They are unformatted Buffers that can be accessed at byte level. An example of this kind of Buffer in SDSL would be: ByteAddressBuffer bab; RWByteAddressBuffer rwbab; // For Raw Buffers supporting unordered access Methods New(GraphicsDevice, DataPointer, BufferFlags, GraphicsResourceUsage) Creates a new Raw Buffer with initial data. [Obsolete(\"This method is obsolete. Use the span-based methods instead\")] public static Buffer New(GraphicsDevice device, DataPointer dataPointer, BufferFlags additionalFlags = BufferFlags.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. dataPointer DataPointer The data pointer to the data to initialize the Raw Buffer. additionalFlags BufferFlags Additional flags. For example, you can specify IndexBuffer to create a combined Raw/Index Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, BufferFlags, GraphicsResourceUsage) Creates a new Raw Buffer of a given size. public static Buffer New(GraphicsDevice device, int bufferSize, BufferFlags additionalFlags = BufferFlags.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. bufferSize int Size of the Buffer in bytes. additionalFlags BufferFlags Additional flags. For example, you can specify IndexBuffer to create a combined Raw/Index Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer A new instance of Buffer. New(GraphicsDevice, ReadOnlySpan<byte>, BufferFlags, GraphicsResourceUsage) Creates a new Raw Buffer with initial data. public static Buffer New(GraphicsDevice device, ReadOnlySpan<byte> data, BufferFlags additionalFlags = BufferFlags.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. data ReadOnlySpan<byte> The data to initialize the Raw Buffer. additionalFlags BufferFlags Additional flags. For example, you can specify IndexBuffer to create a combined Raw/Index Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer A new instance of Buffer. New<T>(GraphicsDevice, BufferFlags, GraphicsResourceUsage) Creates a new Raw Buffer. public static Buffer<T> New<T>(GraphicsDevice device, BufferFlags additionalFlags = BufferFlags.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. additionalFlags BufferFlags Additional flags. For example, you can specify IndexBuffer to create a combined Raw/Index Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, ref readonly T, BufferFlags, GraphicsResourceUsage) Creates a new Raw Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, ref readonly T value, BufferFlags additionalFlags = BufferFlags.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. value T The value to initialize the Raw Buffer. additionalFlags BufferFlags Additional flags. For example, you can specify IndexBuffer to create a combined Raw/Index Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, T[], BufferFlags, GraphicsResourceUsage) Creates a new Raw Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, T[] data, BufferFlags additionalFlags = BufferFlags.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. data T[] The data to initialize the Raw Buffer. additionalFlags BufferFlags Additional flags. For example, you can specify IndexBuffer to create a combined Raw/Index Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. See Also Buffer Buffer<T>"
  },
  "api/Stride.Graphics.Buffer.Structured.html": {
    "href": "api/Stride.Graphics.Buffer.Structured.html",
    "title": "Class Buffer.Structured | Stride API",
    "summary": "Class Buffer.Structured Namespace Stride.Graphics Assembly Stride.Graphics.dll Helper methods for creating Structured Buffers. public static class Buffer.Structured Inheritance object Buffer.Structured Remarks A Structured Buffer is a Buffer that can be read in shaders using a structured format. They are an array of uniformly sized structures. An example of this kind of Buffer in SDSL would be: StructuredBuffer<float4> sb; RWStructuredBuffer<float4> rwsb; // For Structured Buffers supporting unordered access Methods New(GraphicsDevice, DataPointer, int, bool) Creates a new Structured Buffer with initial data. [Obsolete(\"This method is obsolete. Use the span-based methods instead\")] public static Buffer New(GraphicsDevice device, DataPointer dataPointer, int elementSize, bool unorderedAccess = false) Parameters device GraphicsDevice The GraphicsDevice. dataPointer DataPointer The data pointer to the data to initialize the Structured Buffer. elementSize int The size in bytes of each element (the structure). unorderedAccess bool true if the Buffer should support unordered access (RW in SDSL). Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, int, bool) Creates a new Structured Buffer of a given size. public static Buffer New(GraphicsDevice device, int elementCount, int elementSize, bool unorderedAccess = false) Parameters device GraphicsDevice The GraphicsDevice. elementCount int The number of elements in the Buffer. elementSize int The size in bytes of each element (the structure). unorderedAccess bool true if the Buffer should support unordered access (RW in SDSL). Returns Buffer A new instance of Buffer. New(GraphicsDevice, ReadOnlySpan<byte>, int, bool) Creates a new Structured Buffer with initial data. public static Buffer New(GraphicsDevice device, ReadOnlySpan<byte> data, int elementSize, bool unorderedAccess = false) Parameters device GraphicsDevice The GraphicsDevice. data ReadOnlySpan<byte> The data to initialize the Structured Buffer. elementSize int The size in bytes of each element (the structure). unorderedAccess bool true if the Buffer should support unordered access (RW in SDSL). Returns Buffer A new instance of Buffer. New<T>(GraphicsDevice, int, bool) Creates a new Structured Buffer of a given size. public static Buffer<T> New<T>(GraphicsDevice device, int elementCount, bool unorderedAccess = false) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. elementCount int The number of elements in the Buffer. unorderedAccess bool true if the Buffer should support unordered access (RW in SDSL). Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, T[], bool) Creates a new Structured Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, T[] data, bool unorderedAccess = false) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. data T[] The data to initialize the Structured Buffer. unorderedAccess bool true if the Buffer should support unordered access (RW in SDSL). Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the Structured buffer to get the sizeof from See Also Buffer Buffer<T>"
  },
  "api/Stride.Graphics.Buffer.StructuredAppend.html": {
    "href": "api/Stride.Graphics.Buffer.StructuredAppend.html",
    "title": "Class Buffer.StructuredAppend | Stride API",
    "summary": "Class Buffer.StructuredAppend Namespace Stride.Graphics Assembly Stride.Graphics.dll Helper methods for creating Structured Append Buffers. public static class Buffer.StructuredAppend Inheritance object Buffer.StructuredAppend Remarks A Structured Append Buffer (also known as Append / Consume Buffer) is a Buffer that allows atomic append operations from shaders. They work like a stack: elements can be appended to the end. They are a special kind of Structured Buffers, so they are also an array of uniformly sized structures. An example of this kind of Buffer in SLSL would be: AppendStructuredBuffer<float4> asb; ConsumeStructuredBuffer<float4> csb; Methods New(GraphicsDevice, DataPointer, int) Creates a new Structured Append Buffer with initial data. [Obsolete(\"This method is obsolete. Use the span-based methods instead\")] public static Buffer New(GraphicsDevice device, DataPointer dataPointer, int elementSize) Parameters device GraphicsDevice The GraphicsDevice. dataPointer DataPointer The data pointer to the data to initialize the Structured Append Buffer. elementSize int The size in bytes of each element (the structure). Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, int) Creates a new Structured Append Buffer of a given size. public static Buffer New(GraphicsDevice device, int elementCount, int elementSize) Parameters device GraphicsDevice The GraphicsDevice. elementCount int The number of elements in the Buffer. elementSize int The size in bytes of each element (the structure). Returns Buffer A new instance of Buffer. New(GraphicsDevice, ReadOnlySpan<byte>, int) Creates a new Structured Append Buffer with initial data. public static Buffer New(GraphicsDevice device, ReadOnlySpan<byte> data, int elementSize) Parameters device GraphicsDevice The GraphicsDevice. data ReadOnlySpan<byte> The data to initialize the Structured Append Buffer. elementSize int The size in bytes of each element (the structure). Returns Buffer A new instance of Buffer. New<T>(GraphicsDevice, int) Creates a new Structured Append Buffer of a given size. public static Buffer<T> New<T>(GraphicsDevice device, int elementCount) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. elementCount int The number of elements in the Buffer. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, T[]) Creates a new Structured Append Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, T[] data) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. data T[] The data to initialize the Structured Append Buffer. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. See Also Buffer Buffer<T>"
  },
  "api/Stride.Graphics.Buffer.StructuredCounter.html": {
    "href": "api/Stride.Graphics.Buffer.StructuredCounter.html",
    "title": "Class Buffer.StructuredCounter | Stride API",
    "summary": "Class Buffer.StructuredCounter Namespace Stride.Graphics Assembly Stride.Graphics.dll Helper methods for creating Structured Counter Buffers. public static class Buffer.StructuredCounter Inheritance object Buffer.StructuredCounter Remarks A Structured Counter Buffer is a Buffer that allows atomic append operations from shaders (similar to Append / Consume Buffers, see Buffer.StructuredAppend), but with an associated counter. That counter can be read / written atomically from shaders. They are a special kind of Structured Buffers, so they are also an array of uniformly sized structures. An example of this kind of Buffer in SLSL would be: StructuredBuffer<float4> sb; RWStructuredBuffer<float4> rwsb; // For structured buffers supporting unordered access Methods New(GraphicsDevice, DataPointer, int) Creates a new Structured Counter Buffer with initial data. [Obsolete(\"This method is obsolete. Use the span-based methods instead\")] public static Buffer New(GraphicsDevice device, DataPointer dataPointer, int elementSize) Parameters device GraphicsDevice The GraphicsDevice. dataPointer DataPointer The data pointer to the data to initialize the Structured Counter Buffer. elementSize int The size in bytes of each element (the structure). Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, int) Creates a new Structured Counter Buffer of a given size. public static Buffer New(GraphicsDevice device, int elementCount, int elementSize) Parameters device GraphicsDevice The GraphicsDevice. elementCount int The number of elements in the Buffer. elementSize int The size in bytes of each element (the structure). Returns Buffer A new instance of Buffer. New(GraphicsDevice, ReadOnlySpan<byte>, int) Creates a new Structured Counter Buffer with initial data. public static Buffer New(GraphicsDevice device, ReadOnlySpan<byte> data, int elementSize) Parameters device GraphicsDevice The GraphicsDevice. data ReadOnlySpan<byte> The data to initialize the Structured Counter Buffer. elementSize int The size in bytes of each element (the structure). Returns Buffer A new instance of Buffer. New<T>(GraphicsDevice, int) Creates a new Structured Counter Buffer of a given size. public static Buffer<T> New<T>(GraphicsDevice device, int elementCount) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. elementCount int The number of elements in the Buffer. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, T[]) Creates a new Structured Counter Buffer with initial data. public static Buffer New<T>(GraphicsDevice device, T[] data) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. data T[] The data to initialize the Structured Counter Buffer. Returns Buffer A new instance of Buffer. Type Parameters T Type of the StructuredCounter buffer to get the sizeof from See Also Buffer Buffer<T>"
  },
  "api/Stride.Graphics.Buffer.Typed.html": {
    "href": "api/Stride.Graphics.Buffer.Typed.html",
    "title": "Class Buffer.Typed | Stride API",
    "summary": "Class Buffer.Typed Namespace Stride.Graphics Assembly Stride.Graphics.dll Helper methods for creating Typed Buffers. public static class Buffer.Typed Inheritance object Buffer.Typed Remarks A Typed Buffer is a Buffer that is accessed through a Shader Resource View with a specific format. Because of this, they are created with that specific format. An example of this kind of Buffer in SDSL would be: Buffer<float4> tb; Methods New(GraphicsDevice, DataPointer, PixelFormat, bool, GraphicsResourceUsage) Creates a new Typed Buffer with initial data. [Obsolete(\"This method is obsolete. Use the span-based methods instead\")] public static Buffer New(GraphicsDevice device, DataPointer dataPointer, PixelFormat elementFormat, bool unorderedAccess = false, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. dataPointer DataPointer The data pointer to the data to initialize the Typed Buffer. elementFormat PixelFormat The format of the typed elements in the Buffer. unorderedAccess bool true if the Buffer should support unordered access (RW in SDSL). usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, PixelFormat, bool, GraphicsResourceUsage) Creates a new Typed Buffer of a given size. public static Buffer New(GraphicsDevice device, int elementCount, PixelFormat elementFormat, bool unorderedAccess = false, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. elementCount int The number of data with the following viewFormat. elementFormat PixelFormat The format of the typed elements in the Buffer. unorderedAccess bool true if the Buffer should support unordered access (RW in SDSL). usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer A new instance of Buffer. New<T>(GraphicsDevice, ReadOnlySpan<T>, PixelFormat, bool, GraphicsResourceUsage) Creates a new Typed Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, ReadOnlySpan<T> data, PixelFormat elementFormat, bool unorderedAccess = false, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. data ReadOnlySpan<T> The data to initialize the Typed Buffer. elementFormat PixelFormat The format of the typed elements in the Buffer. unorderedAccess bool true if the Buffer should support unordered access (RW in SDSL). usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, T[], PixelFormat, bool, GraphicsResourceUsage) Creates a new Typed Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, T[] data, PixelFormat elementFormat, bool unorderedAccess = false, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. data T[] The data to initialize the Typed Buffer. elementFormat PixelFormat The format of the typed elements in the Buffer. unorderedAccess bool true if the Buffer should support unordered access (RW in SDSL). usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. See Also Buffer Buffer<T>"
  },
  "api/Stride.Graphics.Buffer.Vertex.html": {
    "href": "api/Stride.Graphics.Buffer.Vertex.html",
    "title": "Class Buffer.Vertex | Stride API",
    "summary": "Class Buffer.Vertex Namespace Stride.Graphics Assembly Stride.Graphics.dll Helper methods for creating Vertex Buffers. public static class Buffer.Vertex Inheritance object Buffer.Vertex Remarks A Vertex Buffer is a Buffer that is used as input to the vertex shader stage. They store vertex data for 3D models (positions, normals, UVs, etc.). Methods New(GraphicsDevice, DataPointer, GraphicsResourceUsage) Creates a new Vertex Buffer with initial data. [Obsolete(\"This method is obsolete. Use the span-based methods instead\")] public static Buffer New(GraphicsDevice device, DataPointer dataPointer, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) Parameters device GraphicsDevice The GraphicsDevice. dataPointer DataPointer The data pointer to the data to initialize the Vertex buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Immutable. Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, GraphicsResourceUsage, BufferFlags) Creates a new Vertex Buffer of a given size. public static Buffer New(GraphicsDevice device, int bufferSize, GraphicsResourceUsage usage = GraphicsResourceUsage.Default, BufferFlags additionalFlags = BufferFlags.None) Parameters device GraphicsDevice The GraphicsDevice. bufferSize int Size of the Buffer in bytes. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. additionalFlags BufferFlags Additional Buffer flags. For example, you can specify StreamOutput to use the Buffer as a Stream Output target. Returns Buffer A new instance of Buffer. New(GraphicsDevice, ReadOnlySpan<byte>, GraphicsResourceUsage) Creates a new Vertex Buffer with initial data. public static Buffer New(GraphicsDevice device, ReadOnlySpan<byte> data, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) Parameters device GraphicsDevice The GraphicsDevice. data ReadOnlySpan<byte> The data to initialize the Vertex buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Immutable. Returns Buffer A new instance of Buffer. New<T>(GraphicsDevice, GraphicsResourceUsage) Creates a new Vertex Buffer. public static Buffer<T> New<T>(GraphicsDevice device, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, int, GraphicsResourceUsage) Creates a new Vertex Buffer. public static Buffer<T> New<T>(GraphicsDevice device, int vertexCount, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. vertexCount int The number of vertices in this Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Default. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, ref readonly T, GraphicsResourceUsage) Creates a new Vertex Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, ref readonly T value, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. value T The value to initialize the Vertex buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Immutable. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. New<T>(GraphicsDevice, T[], GraphicsResourceUsage) Creates a new Vertex Buffer with initial data. public static Buffer<T> New<T>(GraphicsDevice device, T[] data, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. data T[] The data to initialize the Vertex buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. By default, it is Immutable. Returns Buffer<T> A new instance of Buffer. Type Parameters T Type of the data stored in the Buffer. See Also Buffer Buffer<T>"
  },
  "api/Stride.Graphics.Buffer.html": {
    "href": "api/Stride.Graphics.Buffer.html",
    "title": "Class Buffer | Stride API",
    "summary": "Class Buffer Namespace Stride.Graphics Assembly Stride.Graphics.dll All-in-one GPU Buffer that is able to represent many types of Buffers (shader Constant Buffers, Structured Buffers, Raw Buffers, Argument Buffers, etc.). [DataSerializer(typeof(BufferSerializer))] [DataSerializerGlobal(typeof(ReferenceSerializer<Buffer>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] [ContentSerializer(typeof(DataContentSerializer<Buffer>))] public class Buffer : GraphicsResource, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase GraphicsResource Buffer Implements IDisposable IComponent IReferencable ICollectorHolder Derived Buffer<T> Inherited Members GraphicsResource.NativeShaderResourceView GraphicsResource.NativeUnorderedAccessView GraphicsResourceBase.NativeResource GraphicsResourceBase.NativeDeviceChild GraphicsResourceBase.UnsetNativeDeviceChild() GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) GraphicsResourceBase.NativeDevice GraphicsResourceBase.IsDebugMode GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed GraphicsResourceBase.OnPause() GraphicsResourceBase.OnResume() GraphicsResourceBase.Destroy() ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) GraphicsSerializerExtensions.GetSerializationData(Buffer) GraphicsSerializerExtensions.SetSerializationData(Buffer, BufferData) UnsafeUtilities.As<T>(object?) Remarks Buffer constains static methods for creating new Buffers by specifying all their characteristics. Also look for the following static methods that aid in the creation of specific kinds of Buffers: Buffer.Argument (for Argument Buffers), Buffer.Constant (for Constant Buffers), Buffer.Index (for Index Buffers), Buffer.Raw (for Raw Buffers), Buffer.Structured (for Structured Buffers), Buffer.Typed (for Typed Buffers), and Buffer.Vertex (for Vertex Buffers). Consult the documentation of your graphics API for more information on each kind of Buffer. Constructors Buffer() public Buffer() Buffer(GraphicsDevice) Initializes a new instance of the Buffer class. protected Buffer(GraphicsDevice device) Parameters device GraphicsDevice The GraphicsDevice the Buffer belongs to. Buffer(GraphicsDevice, string?) Initializes a new instance of the Buffer class. protected Buffer(GraphicsDevice device, string? name) Parameters device GraphicsDevice The GraphicsDevice the Buffer belongs to. name string A string to use as a name for identifying the Buffer. Useful when debugging. Specify null to use the type's name instead. Fields elementCount protected int elementCount Field Value int Properties Description Gets a description of the Buffer. public BufferDescription Description { get; } Property Value BufferDescription ElementCount Gets the number of elements in the Buffer. public int ElementCount { get; protected set; } Property Value int Remarks This value is valid for Structured Buffers, Raw Buffers, and Index Buffers that are used as a Shared Resource View. Flags Gets a combination of flags describing the type of the Buffer. public BufferFlags Flags { get; } Property Value BufferFlags InitialCounterOffset Gets or sets the initial Append / Consume Buffer counter offset. public int InitialCounterOffset { get; set; } Property Value int A value of -1 indicates the current offset should be kept. Any other values set the hidden counter for that Appendable / Consumable Buffer. The default value is -1. Remarks This value is only relevant for Buffers which have the StructuredAppendBuffer or StructuredCounterBuffer flags, otherwise it is ignored. SizeInBytes Gets the size of the Buffer in bytes. public int SizeInBytes { get; } Property Value int StructureByteStride Gets the size of the structure (in bytes) when the Buffer represents a typed / structured buffer. public int StructureByteStride { get; } Property Value int Usage Gets a value that indicates how the Buffer is to be read from and written to. public GraphicsResourceUsage Usage { get; } Property Value GraphicsResourceUsage ViewFlags Gets a combination of flags describing how a View over the Buffer should behave. public BufferFlags ViewFlags { get; } Property Value BufferFlags ViewFormat Gets the format of the elements of the Buffer as interpreted through a View. public PixelFormat ViewFormat { get; } Property Value PixelFormat Methods Clone() Returns a new Buffer with exactly the same characteristics as the Buffer, but does not copy its contents. public Buffer Clone() Returns Buffer A clone of the Buffer. GetData(CommandList, Buffer, DataPointer) Copies the contents of the Buffer from GPU memory to a CPU memory pointer using a specific staging resource. [Obsolete(\"This method is obsolete. Use the Span-based methods instead\")] public void GetData(CommandList commandList, Buffer stagingBuffer, DataPointer toData) Parameters commandList CommandList The CommandList. stagingBuffer Buffer The staging buffer used to transfer the data from GPU memory. toData DataPointer To destination data pointer. Remarks This method only works when called from the main thread that is accessing the main GraphicsDevice. Exceptions ArgumentException The length of the destination data buffer (toData) is larger than the size of the Buffer. GetData<TData>(CommandList) Gets the contents of the Buffer as an array of data. public TData[] GetData<TData>(CommandList commandList) where TData : unmanaged Parameters commandList CommandList The CommandList. Returns TData[] An array of data with the contents of the Buffer. Type Parameters TData The type of the data to read from the Buffer. Remarks This method only works when called from the main thread that is accessing the main GraphicsDevice. This method creates internally a staging resource (if this Buffer is not already a staging resource), copies to it and map it to memory. Use a method that allows to specify an explicit staging resource for optimal performance. GetData<TData>(CommandList, Buffer, Span<TData>) Copies the content of the Buffer from GPU memory to a CPU memory pointer using a specific staging resource. public void GetData<TData>(CommandList commandList, Buffer stagingBuffer, Span<TData> toData) where TData : unmanaged Parameters commandList CommandList The CommandList. stagingBuffer Buffer The staging buffer used to transfer the data from GPU memory. toData Span<TData> To destination span where the read data will be written. Type Parameters TData The type of the data to read from the Buffer. Remarks This method only works when called from the main thread that is accessing the main GraphicsDevice. Exceptions ArgumentException The length of the destination data buffer (toData) is larger than the size of the Buffer. GetData<TData>(CommandList, Buffer, ref TData) Copies a single data element of the Buffer from GPU memory to data on CPU memory using a specific staging resource. public void GetData<TData>(CommandList commandList, Buffer stagingBuffer, ref TData toData) where TData : unmanaged Parameters commandList CommandList The CommandList. stagingBuffer Buffer The staging buffer used to transfer the data from GPU memory. toData TData When this method returns, contains the element read from the Buffer. Type Parameters TData The type of the data to read from the Buffer. Remarks This method only works when called from the main thread that is accessing the main GraphicsDevice. Exceptions ArgumentException The length of the destination data buffer (toData) is larger than the size of the Buffer. GetData<TData>(CommandList, Buffer, TData[]) Copies data from the Buffer from GPU memory into an array on CPU memory using a specific staging resource. public void GetData<TData>(CommandList commandList, Buffer stagingBuffer, TData[] toData) where TData : unmanaged Parameters commandList CommandList The CommandList. stagingBuffer Buffer The staging buffer used to transfer the data from GPU memory. toData TData[] Array where the read data should be copied. Type Parameters TData The type of the data to read from the Buffer. Remarks This method only works when called from the main thread that is accessing the main GraphicsDevice. Exceptions ArgumentException The length of the destination data buffer (toData) is larger than the size of the Buffer. GetData<TData>(CommandList, ref TData) Gets a single data element of the Buffer. public void GetData<TData>(CommandList commandList, ref TData toData) where TData : unmanaged Parameters commandList CommandList The CommandList. toData TData When this method returns, contains the element read from the Buffer. Type Parameters TData The type of the data to read from the Buffer. Remarks This method only works when called from the main thread that is accessing the main GraphicsDevice. This method creates internally a staging resource (if this Buffer is not already a staging resource), copies to it and map it to memory. Use a method that allows to specify an explicit staging resource for optimal performance. Exceptions ArgumentException The length of the destination data buffer (toData) is larger than the size of the Buffer. GetData<TData>(CommandList, TData[]) Copies the contents of the Buffer to an array of data. public void GetData<TData>(CommandList commandList, TData[] toData) where TData : unmanaged Parameters commandList CommandList The CommandList. toData TData[] The destination array where to copy the Buffer contents. Type Parameters TData The type of the data to read from the Buffer. Remarks This method only works when called from the main thread that is accessing the main GraphicsDevice. This method creates internally a staging resource (if this Buffer is not already a staging resource), copies to it and map it to memory. Use a method that allows to specify an explicit staging resource for optimal performance. Exceptions ArgumentException The length of the destination data buffer (toData) is larger than the size of the Buffer. InitializeFromImpl(ref readonly BufferDescription, BufferFlags, PixelFormat, nint) Initializes this Buffer instance with the provided options. protected Buffer InitializeFromImpl(ref readonly BufferDescription description, BufferFlags viewFlags, PixelFormat viewFormat, nint dataPointer) Parameters description BufferDescription A BufferDescription structure describing the buffer characteristics. viewFlags BufferFlags A combination of flags determining how the Views over this buffer should behave. viewFormat PixelFormat View format used if the buffer is used as a Shader Resource View, or None if not. dataPointer nint The data pointer to the data to initialize the buffer with. Returns Buffer This same instance of Buffer already initialized. Exceptions ArgumentException Element size (StructureByteStride) must be greater than zero for Structured Buffers. New(GraphicsDevice, BufferDescription, PixelFormat) Creates a new Buffer. public static Buffer New(GraphicsDevice device, BufferDescription description, PixelFormat viewFormat = PixelFormat.None) Parameters device GraphicsDevice The GraphicsDevice. description BufferDescription The description of the Buffer. viewFormat PixelFormat View format used if the Buffer is used as a Shader Resource View, or None if not. Returns Buffer A new instance of Buffer. New(GraphicsDevice, DataPointer, int, BufferFlags, GraphicsResourceUsage) Creates a new Buffer. [Obsolete(\"This method is obsolete. Use the span-based methods instead\")] public static Buffer New(GraphicsDevice device, DataPointer dataPointer, int elementSize, BufferFlags bufferFlags, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. dataPointer DataPointer The data pointer to the initial data the Buffer will contain. elementSize int The size of an element in bytes. For Index Buffers this must be equal to 2 (ths size of short) or 4 bytes (the size of int). For Structured / Typed Buffers this must be equal to the size of the element struct. For other types of Buffers, this can be set to 0. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer A new instance of Buffer. New(GraphicsDevice, DataPointer, int, BufferFlags, PixelFormat, GraphicsResourceUsage) Creates a new Buffer. [Obsolete(\"This method is obsolete. Use the span-based methods instead\")] public static Buffer New(GraphicsDevice device, DataPointer dataPointer, int elementSize, BufferFlags bufferFlags, PixelFormat viewFormat = PixelFormat.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. dataPointer DataPointer The data pointer to the initial data the Buffer will contain. elementSize int The size of an element in bytes. For Index Buffers this must be equal to 2 (ths size of short) or 4 bytes (the size of int). For Structured / Typed Buffers this must be equal to the size of the element struct. For other types of Buffers, this can be set to 0. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. viewFormat PixelFormat View format used if the Buffer is used as a Shader Resource View, or None if not. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, BufferFlags, GraphicsResourceUsage) Creates a new Buffer. public static Buffer New(GraphicsDevice device, int bufferSize, BufferFlags bufferFlags, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. bufferSize int Size of the Buffer in bytes. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, BufferFlags, PixelFormat, GraphicsResourceUsage) Creates a new Buffer. public static Buffer New(GraphicsDevice device, int bufferSize, BufferFlags bufferFlags, PixelFormat viewFormat = PixelFormat.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. bufferSize int Size of the Buffer in bytes. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. viewFormat PixelFormat View format used if the Buffer is used as a Shader Resource View, or None if not. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, int, BufferFlags, GraphicsResourceUsage) Creates a new Buffer. public static Buffer New(GraphicsDevice device, int bufferSize, int elementSize, BufferFlags bufferFlags, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. bufferSize int Size of the Buffer in bytes. elementSize int Size of an element in the Buffer. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer A new instance of Buffer. New(GraphicsDevice, int, int, BufferFlags, PixelFormat, GraphicsResourceUsage) Creates a new Buffer. public static Buffer New(GraphicsDevice device, int bufferSize, int elementSize, BufferFlags bufferFlags, PixelFormat viewFormat = PixelFormat.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. bufferSize int Size of the Buffer in bytes. elementSize int Size of an element in the Buffer. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. viewFormat PixelFormat View format used if the Buffer is used as a Shader Resource View, or None if not. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer A new instance of Buffer. New(GraphicsDevice, ReadOnlySpan<byte>, int, BufferFlags, PixelFormat, GraphicsResourceUsage) Creates a new Buffer from a byte array. public static Buffer New(GraphicsDevice device, ReadOnlySpan<byte> initialValues, int elementSize, BufferFlags bufferFlags, PixelFormat viewFormat = PixelFormat.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) Parameters device GraphicsDevice The GraphicsDevice. initialValues ReadOnlySpan<byte> The initial data the Buffer will contain. elementSize int The size of an element in bytes. For Index Buffers this must be equal to 2 (ths size of short) or 4 bytes (the size of int). For Structured / Typed Buffers this must be equal to the size of the element struct. For other types of Buffers, this can be set to 0. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. viewFormat PixelFormat View format used if the Buffer is used as a Shader Resource View, or None if not. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer A new instance of Buffer. New<T>(GraphicsDevice, int, BufferFlags, GraphicsResourceUsage) Creates a new Buffer. public static Buffer<T> New<T>(GraphicsDevice device, int elementCount, BufferFlags bufferFlags, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. elementCount int Number of elements of type T the Buffer will contain. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer<T> A new instance of Buffer. Type Parameters T The type of elements the Buffer will contain. New<T>(GraphicsDevice, ReadOnlySpan<T>, BufferFlags, PixelFormat, GraphicsResourceUsage) Creates a new Buffer. public static Buffer<T> New<T>(GraphicsDevice device, ReadOnlySpan<T> initialValues, BufferFlags bufferFlags, PixelFormat viewFormat = PixelFormat.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. initialValues ReadOnlySpan<T> The initial data the Buffer will contain. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. viewFormat PixelFormat View format used if the Buffer is used as a Shader Resource View, or None if not. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer<T> A new instance of Buffer. Type Parameters T The type of the elements the Buffer will contain. New<T>(GraphicsDevice, ref readonly T, BufferFlags, GraphicsResourceUsage) Creates a new Buffer. public static Buffer<T> New<T>(GraphicsDevice device, ref readonly T value, BufferFlags bufferFlags, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. value T The initial value for the element in the Buffer. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer<T> A new instance of Buffer. Type Parameters T The type of the element the Buffer will contain. New<T>(GraphicsDevice, ref readonly T, BufferFlags, PixelFormat, GraphicsResourceUsage) Creates a new Buffer. public static Buffer<T> New<T>(GraphicsDevice device, ref readonly T value, BufferFlags bufferFlags, PixelFormat viewFormat = PixelFormat.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. value T The initial value for the element in the Buffer. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. viewFormat PixelFormat View format used if the Buffer is used as a Shader Resource View, or None if not. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer<T> A new instance of Buffer. Type Parameters T The type of the element the Buffer will contain. New<T>(GraphicsDevice, T[], BufferFlags, GraphicsResourceUsage) Creates a new Buffer. public static Buffer<T> New<T>(GraphicsDevice device, T[] initialValue, BufferFlags bufferFlags, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. initialValue T[] The initial data the Buffer will contain. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer<T> A new instance of Buffer. Type Parameters T The type of the elements the Buffer will contain. New<T>(GraphicsDevice, T[], BufferFlags, PixelFormat, GraphicsResourceUsage) Creates a new Buffer. public static Buffer<T> New<T>(GraphicsDevice device, T[] initialValue, BufferFlags bufferFlags, PixelFormat viewFormat = PixelFormat.None, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. initialValue T[] The initial value of the Buffer. bufferFlags BufferFlags The buffer flags to specify the type of Buffer. viewFormat PixelFormat View format used if the Buffer is used as a Shader Resource View, or None if not. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. Returns Buffer<T> A new instance of Buffer. Type Parameters T The type of the elements the Buffer will contain. OnDestroyed(bool) Called when the GraphicsDevice has been detected to be internally destroyed, or when the Destroy() methad has been called. Raises the Destroyed event. protected override void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the resource should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). Remarks This method releases the underlying native resources (Silk.NET.Direct3D11.ID3D11Resource and Silk.NET.Direct3D11.ID3D11DeviceChild). OnNameChanged() Called when the Name property has changed. protected override void OnNameChanged() OnRecreate() Called when the GraphicsDevice has been recreated. protected override bool OnRecreate() Returns bool true if resource has transitioned to the Active state. Recreate(nint) Recreates this buffer explicitly with the provided data. Usually called after the GraphicsDevice has been reset. public void Recreate(nint dataPointer) Parameters dataPointer nint The data pointer to the data to use to recreate the buffer with. Specify Zero if no initial data is needed. RecreateWith(nint) Sets the Buffer to be recreated with the specified data whenever the GraphicsDevice it depends on is reset. public Buffer RecreateWith(nint dataPointer) Parameters dataPointer nint The data pointer to the data to use to recreate the Buffer with. Returns Buffer This instance. RecreateWith<T>(T[]) Sets the Buffer to be recreated with the specified data whenever the GraphicsDevice it depends on is reset. public Buffer RecreateWith<T>(T[] data) where T : unmanaged Parameters data T[] The data to use to recreate the Buffer with. Returns Buffer This instance. Type Parameters T The type of the elements the Buffer will contain. Recreate<T>(T[]) Recreates the Buffer explicitly with the provided data. Usually called after the GraphicsDevice has been reset. public void Recreate<T>(T[] data) where T : unmanaged Parameters data T[] The data to use to recreate the Buffer with. Type Parameters T The type of the elements the Buffer will contain. SetData(CommandList, DataPointer, int) Copies data from a pointer to data on CPU memory into the Buffer in GPU memory. [Obsolete(\"This method is obsolete. Use the Span-based methods instead\")] public void SetData(CommandList commandList, DataPointer fromData, int offsetInBytes = 0) Parameters commandList CommandList The CommandList. fromData DataPointer The pointer to the data to copy from. offsetInBytes int The offset in bytes from the start of the Buffer where data is to be written. Remarks See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions. Exceptions ArgumentException offsetInBytes is only supported for Buffers declared with Default. SetData<TData>(CommandList, ReadOnlySpan<TData>, int) Copies data from a span of data on CPU memory into the Buffer in GPU memory. public void SetData<TData>(CommandList commandList, ReadOnlySpan<TData> fromData, int offsetInBytes = 0) where TData : unmanaged Parameters commandList CommandList The CommandList. fromData ReadOnlySpan<TData> The span of data to copy from. offsetInBytes int The offset in bytes from the start of the Buffer where data is to be written. Type Parameters TData The type of the data to write into the Buffer. Remarks See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions. Exceptions ArgumentException The length of fromData is larger than the size of the Buffer. ArgumentException offsetInBytes is only supported for Buffers declared with Default. SetData<TData>(CommandList, ref readonly TData, int) Copies the contents an array of data on CPU memory into the Buffer in GPU memory. public void SetData<TData>(CommandList commandList, ref readonly TData fromData, int offsetInBytes = 0) where TData : unmanaged Parameters commandList CommandList The CommandList. fromData TData The data to copy from. offsetInBytes int The offset in bytes to write to. Type Parameters TData The type of the data to write into the Buffer. Remarks See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions. Exceptions ArgumentException offsetInBytes is only supported for Buffers declared with Default. SetData<TData>(CommandList, TData[], int) Copies the contents of an array of data on CPU memory into the Buffer in GPU memory. public void SetData<TData>(CommandList commandList, TData[] fromData, int offsetInBytes = 0) where TData : unmanaged Parameters commandList CommandList The CommandList. fromData TData[] The array of data to copy from. offsetInBytes int The offset in bytes from the start of the Buffer where data is to be written. Type Parameters TData The type of the data to write into the Buffer. Remarks See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions. Exceptions ArgumentException offsetInBytes is only supported for Buffers declared with Default. ToStaging() Returns a staging Buffer that can be read / written by the CPU that is equivalent to the Buffer. public Buffer ToStaging() Returns Buffer A new instance of the Buffer as a staging resource. See Also Buffer<T> Buffer.Argument Buffer.Constant Buffer.Index Buffer.Raw Buffer.Structured Buffer.Typed Buffer.Vertex"
  },
  "api/Stride.Graphics.BufferDescription.html": {
    "href": "api/Stride.Graphics.BufferDescription.html",
    "title": "Struct BufferDescription | Stride API",
    "summary": "Struct BufferDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a GPU Buffer. public struct BufferDescription : IEquatable<BufferDescription> Implements IEquatable<BufferDescription> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors BufferDescription(int, BufferFlags, GraphicsResourceUsage, int) Initializes a new instance of BufferDescription struct. public BufferDescription(int sizeInBytes, BufferFlags bufferFlags, GraphicsResourceUsage usage, int structureByteStride = 0) Parameters sizeInBytes int Size of the Buffer in bytes. bufferFlags BufferFlags Buffer flags describing the type of Buffer. usage GraphicsResourceUsage The usage for the Buffer, which determines who can read/write data. structureByteStride int If the Buffer is a Structured Buffer or a Typed Buffer, this parameter indicates the stride of each element of the Buffer (the structure). The stride is not only the size of the structure, but also any padding in between two consecutive elements. For any other kind of Buffer, this parameter can be 0. Fields BufferFlags Flags describing the type of Buffer. public BufferFlags BufferFlags Field Value BufferFlags SizeInBytes Size of the Buffer in bytes. public int SizeInBytes Field Value int StructureByteStride The size in bytes of the structure (each element in the Buffer) when it represents a Structured Buffer or a Typed Buffer. public int StructureByteStride Field Value int Usage Usage for the Buffer, which determines who can read / write data. public GraphicsResourceUsage Usage Field Value GraphicsResourceUsage Methods Equals(BufferDescription) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(BufferDescription other) Parameters other BufferDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(BufferDescription, BufferDescription) public static bool operator ==(BufferDescription left, BufferDescription right) Parameters left BufferDescription right BufferDescription Returns bool operator !=(BufferDescription, BufferDescription) public static bool operator !=(BufferDescription left, BufferDescription right) Parameters left BufferDescription right BufferDescription Returns bool"
  },
  "api/Stride.Graphics.BufferFlags.html": {
    "href": "api/Stride.Graphics.BufferFlags.html",
    "title": "Enum BufferFlags | Stride API",
    "summary": "Enum BufferFlags Namespace Stride.Graphics Assembly Stride.Graphics.dll Identifies the intended use of a graphics Buffer when rendering. [Flags] [DataContract] public enum BufferFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ArgumentBuffer = 1024 The buffer is an indirect arguments buffer. ConstantBuffer = 1 The buffer is a constant buffer. IndexBuffer = 2 The buffer is an index buffer. None = 0 No special flags. RawBuffer = 512 The buffer is a raw buffer. RenderTarget = 8 The buffer can be used as a render target. ShaderResource = 16 The buffer can be used as a shader resource. StreamOutput = 2048 The buffer is a buffer for the geometry shader stream-output stage. StructuredAppendBuffer = 224 The buffer can be used as a structured buffer that supports unordered acccess and append. StructuredBuffer = 64 The buffer can be used as a structured buffer. StructuredCounterBuffer = 352 The buffer can be used as a structured buffer that supports unordered acccess and counter. UnorderedAccess = 32 The buffer can be used as an unordered access buffer. VertexBuffer = 4 The buffer is a vertex buffer."
  },
  "api/Stride.Graphics.BufferPool.html": {
    "href": "api/Stride.Graphics.BufferPool.html",
    "title": "Class BufferPool | Stride API",
    "summary": "Class BufferPool Namespace Stride.Graphics Assembly Stride.Graphics.dll public class BufferPool : IDisposable Inheritance object BufferPool Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields Data public nint Data Field Value nint Size public int Size Field Value int Methods Allocate(GraphicsDevice, int, BufferPoolAllocationType, ref BufferPoolAllocationResult) public void Allocate(GraphicsDevice graphicsDevice, int size, BufferPoolAllocationType type, ref BufferPoolAllocationResult bufferPoolAllocationResult) Parameters graphicsDevice GraphicsDevice size int type BufferPoolAllocationType bufferPoolAllocationResult BufferPoolAllocationResult CanAllocate(int) public bool CanAllocate(int size) Parameters size int Returns bool Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Map(CommandList) public void Map(CommandList commandList) Parameters commandList CommandList New(GraphicsResourceAllocator, GraphicsDevice, int) public static BufferPool New(GraphicsResourceAllocator allocator, GraphicsDevice graphicsDevice, int size) Parameters allocator GraphicsResourceAllocator graphicsDevice GraphicsDevice size int Returns BufferPool Reset() public void Reset() Unmap() public void Unmap()"
  },
  "api/Stride.Graphics.BufferPoolAllocationResult.html": {
    "href": "api/Stride.Graphics.BufferPoolAllocationResult.html",
    "title": "Struct BufferPoolAllocationResult | Stride API",
    "summary": "Struct BufferPoolAllocationResult Namespace Stride.Graphics Assembly Stride.Graphics.dll public struct BufferPoolAllocationResult Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Buffer public Buffer Buffer Field Value Buffer Data public nint Data Field Value nint Offset public int Offset Field Value int Size public int Size Field Value int Uploaded public bool Uploaded Field Value bool"
  },
  "api/Stride.Graphics.BufferPoolAllocationType.html": {
    "href": "api/Stride.Graphics.BufferPoolAllocationType.html",
    "title": "Enum BufferPoolAllocationType | Stride API",
    "summary": "Enum BufferPoolAllocationType Namespace Stride.Graphics Assembly Stride.Graphics.dll public enum BufferPoolAllocationType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields UsedMultipleTime = 1 Notify the allocator that this buffer will be reused for many draw calls. In practice, on older D3D11 (not 11.1) and OpenGL ES 2.0 hardware, we will use a dedicated cbuffer. This has no effect on new API where we can bind cbuffer offsets. UsedOnce = 0 Notify the allocator that this buffer won't be reused for much more than 1 (or few) draw calls. In practice, on older D3D11 (not 11.1) and OpenGL ES 2.0 hardware, we won't use a dedicated cbuffer. This has no effect on new API where we can bind cbuffer offsets."
  },
  "api/Stride.Graphics.ColorExtensions.html": {
    "href": "api/Stride.Graphics.ColorExtensions.html",
    "title": "Class ColorExtensions | Stride API",
    "summary": "Class ColorExtensions Namespace Stride.Graphics Assembly Stride.dll Extension class for Color public static class ColorExtensions Inheritance object ColorExtensions Methods ToColorSpace(Color3, ColorSpace) Converts the color in gamma space to the specified ColorSpace. public static Color3 ToColorSpace(this Color3 color, ColorSpace colorSpace) Parameters color Color3 The color. colorSpace ColorSpace The color space. Returns Color3 The color converted to the specified color space. ToColorSpace(Color3, ColorSpace, ColorSpace) Converts the color from a particualr color space to the specified ColorSpace. public static Color3 ToColorSpace(this Color3 color, ColorSpace sourceColorSpace, ColorSpace colorSpace) Parameters color Color3 The color. sourceColorSpace ColorSpace The color space of this instance. colorSpace ColorSpace The color space. Returns Color3 The color converted to the specified color space. ToColorSpace(Color4, ColorSpace) Converts the color in gamma space to the specified ColorSpace. public static Color4 ToColorSpace(this Color4 color, ColorSpace colorSpace) Parameters color Color4 The color. colorSpace ColorSpace The color space. Returns Color4 The color converted to the specified color space. ToColorSpace(Color4, ColorSpace, ColorSpace) Converts the color from a particualr color space to the specified ColorSpace. public static Color4 ToColorSpace(this Color4 color, ColorSpace sourceColorSpace, ColorSpace colorSpace) Parameters color Color4 The color. sourceColorSpace ColorSpace The color space of this instance. colorSpace ColorSpace The color space. Returns Color4 The color converted to the specified color space. WithAlpha(Color, byte) Create a copy of the color with the provided alpha value. public static Color WithAlpha(this Color color, byte alpha) Parameters color Color The color to take as reference alpha byte The alpha value of the new color Returns Color The color with the provided alpha value"
  },
  "api/Stride.Graphics.ColorSpace.html": {
    "href": "api/Stride.Graphics.ColorSpace.html",
    "title": "Enum ColorSpace | Stride API",
    "summary": "Enum ColorSpace Namespace Stride.Graphics Assembly Stride.dll Defines the color space used for Textures, Materials, lighting calculations, etc. [DataContract(\"ColorSpace\")] public enum ColorSpace Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Gamma = 1 Use a gamma color space. A gamma color space is a color space in which colors are applied a gamma curve (like sRGB) so they are perceptually linear. This is useful when the output of the rendering (or the input Textures) represent final color values that will be presented to a non-HDR screen, or if they represent color values that won't be transformed in a post-processing step. Linear = 0 Use a linear color space, i.e. treat color values as linear values, without applying any gamma correction. The linear color space is useful when the output of the rendering (or the input Textures) represent values that can be transformed in a post-processing step (such as tone-mapping, color-correction, etc.) or if they represent non-final color values (like intermediate buffers) or non-color values (like heights, roughness, etc.)"
  },
  "api/Stride.Graphics.ColorSpaceType.html": {
    "href": "api/Stride.Graphics.ColorSpaceType.html",
    "title": "Enum ColorSpaceType | Stride API",
    "summary": "Enum ColorSpaceType Namespace Stride.Graphics Assembly Stride.dll Specifies the type of color space a Graphics Presenter has to output. public enum ColorSpaceType : uint Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Custom = 4294967295 A custom color definition is used. Rgb_Full_G10_None_P709 = 1 This is the linear RGB color space with BT.709 primaries. Linear gamma means no gamma correction is applied, making it suitable for HDR content and mathematical operations on color values. It is the standard definition for scRGB, and is usually used with 16-bit integer, 16-bit floating point, and 32-bit floating point channels. Commonly used in HDR workflows and when precise color calculations are required. Use with floating-point formats like R16G16B16A16_Float. Color Space: RGB Range: Full (0-255 for 8-bit, 0-1023 for 10-bit, 0-4095 for 12-bit) Gamma: 1.0 (Linear) Siting: Image Primaries: BT.709 Rgb_Full_G2084_None_P2020 = 12 This is RGB with Perceptual Quantizer (PQ) transfer function and BT.2020 primaries. PQ (ST-2084) is designed for HDR content and can represent brightness levels up to 10,000 nits. Used for HDR10 content and high dynamic range applications. Requires HDR-capable displays and processing. Common with formats like R10G10B10A2_UNorm. It is usually used with 10 or 12-bit color channels. Color Space: RGB Range: Full (0-255 for 8-bit, 0-1023 for 10-bit, 0-4095 for 12-bit) Gamma: ST-2084 (PQ) Siting: Image Primaries: BT.2020 Rgb_Full_G22_None_P2020 = 17 This is RGB with wide color gamut BT.2020 primaries and traditional gamma 2.2. Provides wider color gamut than BT.709 while maintaining compatibility with SDR workflows. It is usually used with 10 or 12-bit color channels. Used for wide color gamut content that doesn't require HDR transfer functions. Suitable for displays capable of BT.2020 color reproduction. Color Space: RGB Range: Full (0-255 for 8-bit, 0-1023 for 10-bit, 0-4095 for 12-bit) Gamma: 2.2 Siting: Image Primaries: BT.2020 Rgb_Full_G22_None_P709 = 0 This is the standard definition for sRGB. Note that this is often implemented with a linear segment, but in that case, the exponent is corrected to stay aligned with a gamma 2.2 curve. This is usually used with 8-bit and 10-bit color channels. Use with 8-bit-per-channel Back-Buffers formats, such as B8G8R8A8_UNorm. Color Space: RGB Range: Full (0-255 for 8-bit, 0-1023 for 10-bit, 0-4095 for 12-bit) Gamma: 2.2 Siting: Image Primaries: BT.709 Rgb_Studio_G2084_None_P2020 = 14 This is RGB with Perceptual Quantizer (PQ) transfer function, studio range, and BT.2020 primaries. Studio range provides headroom for HDR processing while maintaining compatibility with broadcast standards. It is usually used with 10 or 12-bit color channels. Used in professional HDR workflows where studio range is required for broadcast compatibility. Color Space: RGB Range: Studio (16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit) Gamma: ST-2084 (PQ) Siting: Image Primaries: BT.2020 Rgb_Studio_G22_None_P2020 = 3 This is RGB with studio range and wide color gamut BT.2020 primaries. BT.2020 provides a much wider color gamut than BT.709, supporting more vivid and saturated colors. It is usually used with 10 or 12-bit color channels. Used in Ultra HD (4K) and HDR content production. Requires displays capable of wide color gamut reproduction. Color Space: RGB Range: Studio (16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit) Gamma: 2.2 Siting: Image Primaries: BT.2020 Rgb_Studio_G22_None_P709 = 2 This is RGB with studio/limited range, commonly used in broadcast and professional video production. The limited range reserves headroom and footroom for video processing. It is the standard definition for ITU-R Recommendation BT.709. Note that due to the inclusion of a linear segment, the transfer curve looks similar to a pure exponential gamma of 1.9. This is usually used with 8-bit and 10-bit color channels. Typically used in broadcast workflows and professional video applications where studio range is required. Color Space: RGB Range: Studio (16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit) Gamma: 2.2 Siting: Image Primaries: BT.709 Rgb_Studio_G24_None_P2020 = 21 This is RGB with gamma 2.4 transfer function, studio range, and wide color gamut BT.2020 primaries. Combines precise gamma 2.4 with wide color gamut for professional workflows. It is usually used with 10 or 12-bit color channels. Used in professional wide color gamut workflows where gamma 2.4 is specified. Color Space: RGB Range: Studio (16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit) Gamma: 2.4 Siting: Image Primaries: BT.2020 Rgb_Studio_G24_None_P709 = 20 This is RGB with gamma 2.4 transfer function, studio range, and BT.709 primaries. Gamma 2.4 is used in some professional and cinema workflows for more precise color reproduction. It is usually used with 8, 10, or 12-bit color channels. Used in professional video production and cinema workflows where gamma 2.4 is specified. Color Space: RGB Range: Studio (16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit) Gamma: 2.4 Siting: Image Primaries: BT.709 YCbCr_Full_G22_Left_P2020 = 11 This is YCbCr with full range and wide color gamut BT.2020 primaries. Full range provides better bit depth utilization while BT.2020 enables wide color gamut reproduction. It is usually used with 10, 12, or 16-bit color channels. Used in wide color gamut applications where full range precision is desired. Color Space: YCbCr Range: Full (0-255 for 8-bit, 0-1023 for 10-bit, 0-4095 for 12-bit) Gamma: 2.2 Siting: Video (Left) Primaries: BT.2020 YCbCr_Full_G22_Left_P601 = 7 This is YCbCr with full range and BT.601 primaries. Full range utilizes the complete bit depth available, providing slightly better precision than studio range. It is usually used with 8, 10, 12, or 16-bit color channels. Sometimes used in JPEG images and certain video codecs that support full range YCbCr, such as H.264 camera capture. Color Space: YCbCr Range: Full (0-255 for 8-bit, 0-1023 for 10-bit, 0-4095 for 12-bit) Gamma: 2.2 Siting: Video (Left) Primaries: BT.601 YCbCr_Full_G22_Left_P709 = 9 This is YCbCr with full range and BT.709 primaries. Full range provides better utilization of the available bit depth compared to studio range. It is usually used with 8, 10, 12, or 16-bit color channels. Used in some video codecs and applications that prefer full range for better precision. Sometimes used for H.264 camera capture. Color Space: YCbCr Range: Full (0-255 for 8-bit, 0-1023 for 10-bit, 0-4095 for 12-bit) Gamma: 2.2 Siting: Video (Left) Primaries: BT.709 YCbCr_Full_G22_None_P709_X601 = 5 This is YCbCr with full range using BT.709 primaries but BT.601 matrix coefficients. This combination is sometimes used for compatibility reasons in certain legacy workflows. It is usually used with 8, 10, 12, or 16-bit color channels. Less common configuration, typically found in specific legacy or compatibility scenarios, for example, it is commonly used in JPEG images and some video codecs. Color Space: YCbCr Range: Full (0-255 for 8-bit, 0-1023 for 10-bit, 0-4095 for 12-bit) Gamma: 2.2 Siting: Image Primaries: BT.709 Transfer Matrix: BT.601 YCbCr_Full_Ghlg_Topleft_P2020 = 19 This is YCbCr with Hybrid Log-Gamma (HLG) transfer function, full range, and BT.2020 primaries. Full range provides better bit depth utilization while maintaining HLG's backward compatibility. It is usually used with 10 or 12-bit color channels. Used in HDR applications where full range precision is desired with HLG transfer function. Color Space: YCbCr Range: Full (0-255 for 8-bit, 0-1023 for 10-bit, 0-4095 for 12-bit) Gamma: HLG (Hybrid Log-Gamma) Siting: Video (Top-Left) Primaries: BT.2020 YCbCr_Studio_G2084_Left_P2020 = 13 This is YCbCr with Perceptual Quantizer (PQ) transfer function, studio range, and BT.2020 primaries. This is the standard color space for HDR10 video content. It is usually used with 10, 12, or 16-bit color channels. The primary color space for HDR10 video streams, Ultra HD Blu-ray, and HDR streaming content. Widely supported by HDR displays and media players. Color Space: YCbCr Range: Studio (luma: 16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit; chroma (Cb/Cr): 16-240 for 8-bit, 64-960 for 10-bit, 256-3840 for 12-bit). Gamma: ST-2084 (PQ) Siting: Video (Left) Primaries: BT.2020 YCbCr_Studio_G2084_Topleft_P2020 = 16 This is YCbCr with Perceptual Quantizer (PQ) transfer function, BT.2020 primaries, and top-left chroma siting. Combines HDR capabilities with specific chroma siting requirements. It is usually used with 10, 12, or 16-bit color channels. Used in HDR video processing where top-left chroma siting is specifically required. Color Space: YCbCr Range: Studio (luma: 16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit; chroma (Cb/Cr): 16-240 for 8-bit, 64-960 for 10-bit, 256-3840 for 12-bit). Gamma: ST-2084 (PQ) Siting: Video (Top-Left) Primaries: BT.2020 YCbCr_Studio_G22_Left_P2020 = 10 This is YCbCr with wide color gamut BT.2020 primaries and studio range. BT.2020 supports a much wider color gamut than BT.709, enabling more vivid and saturated colors. It is usually used with 10, 12, or 16-bit color channels. Used for Ultra HD (4K) content and wide color gamut video production. Requires compatible displays and processing pipelines, like those used in HEVC (H.265) video encoding. Color Space: YCbCr Range: Studio (luma: 16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit; chroma (Cb/Cr): 16-240 for 8-bit, 64-960 for 10-bit, 256-3840 for 12-bit). Gamma: 2.2 Siting: Video (Left) Primaries: BT.2020 YCbCr_Studio_G22_Left_P601 = 6 This is the standard definition television (SDTV) color space with BT.601 primaries and matrix. Left siting means chroma samples are aligned with the left edge of luma samples. It is usually used with 8, 10, 12, or 16-bit color channels. Used for standard definition video content, DVDs, and legacy broadcast systems. Commonly used for MPEG2. It is ususally used with formats like NV12. Color Space: YCbCr Range: Studio (luma: 16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit; chroma (Cb/Cr): 16-240 for 8-bit, 64-960 for 10-bit, 256-3840 for 12-bit). Gamma: 2.2 Siting: Video (Left) Primaries: BT.601 YCbCr_Studio_G22_Left_P709 = 8 This is the standard high definition television (HDTV) color space with BT.709 primaries. This is the most common color space for HD video content and Blu-ray discs. It is usually used with 8, 10, 12, or 16-bit color channels. Widely used for HD video content, streaming, and broadcast television. Compatible with most HD video formats and codecs, like H.264 and HEVC. Color Space: YCbCr Range: Studio (luma: 16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit; chroma (Cb/Cr): 16-240 for 8-bit, 64-960 for 10-bit, 256-3840 for 12-bit). Gamma: 2.2 Siting: Video (Left) Primaries: BT.709 YCbCr_Studio_G22_Topleft_P2020 = 15 This is YCbCr with BT.2020 primaries and top-left chroma siting. Top-left siting means chroma samples are aligned with the top-left corner of the corresponding luma samples. It is usually used with 10, 12, or 16-bit color channels. Used in specific video processing pipelines where top-left chroma siting is required. Color Space: YCbCr Range: Studio (luma: 16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit; chroma (Cb/Cr): 16-240 for 8-bit, 64-960 for 10-bit, 256-3840 for 12-bit). Gamma: 2.2 Siting: Video (Top-Left) Primaries: BT.2020 YCbCr_Studio_G24_Left_P2020 = 23 This is YCbCr with gamma 2.4 transfer function, studio range, and wide color gamut BT.2020 primaries. Combines precise gamma 2.4 with wide color gamut for professional workflows. It is usually used with 10 or 12-bit color channels. Used in professional wide color gamut video production where gamma 2.4 is specified. Color Space: YCbCr Range: Studio (luma: 16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit; chroma (Cb/Cr): 16-240 for 8-bit, 64-960 for 10-bit, 256-3840 for 12-bit). Gamma: 2.4 Siting: Video (Left) Primaries: BT.2020 YCbCr_Studio_G24_Left_P709 = 22 This is YCbCr with gamma 2.4 transfer function, studio range, and BT.709 primaries. Gamma 2.4 provides more precise color reproduction in professional video workflows. It is usually used with 8, 10, or 12-bit color channels. Used in professional video production where gamma 2.4 is specified for HD content. Color Space: YCbCr Range: Studio (luma: 16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit; chroma (Cb/Cr): 16-240 for 8-bit, 64-960 for 10-bit, 256-3840 for 12-bit). Gamma: 2.4 Siting: Video (Left) Primaries: BT.709 YCbCr_Studio_G24_Topleft_P2020 = 24 This is YCbCr with gamma 2.4 transfer function, studio range, BT.2020 primaries, and top-left chroma siting. Combines precise gamma 2.4 with wide color gamut and specific chroma siting requirements. It is usually used with 10 or 12-bit color channels. Used in professional wide color gamut video production where gamma 2.4 and top-left chroma siting are specified. Color Space: YCbCr Range: Studio (luma: 16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit; chroma (Cb/Cr): 16-240 for 8-bit, 64-960 for 10-bit, 256-3840 for 12-bit). Gamma: 2.4 Siting: Video (Top-Left) Primaries: BT.2020 YCbCr_Studio_Ghlg_Topleft_P2020 = 18 This is YCbCr with Hybrid Log-Gamma (HLG) transfer function and BT.2020 primaries. HLG is designed for HDR broadcasting and provides backward compatibility with SDR displays. It is usually used with 10 or 12-bit color channels. Used for HDR broadcasting and live TV where backward compatibility with SDR is important. Common in broadcast television and streaming services. Color Space: YCbCr Range: Studio (luma: 16-235 for 8-bit, 64-940 for 10-bit, 256-3760 for 12-bit; chroma (Cb/Cr): 16-240 for 8-bit, 64-960 for 10-bit, 256-3840 for 12-bit). Gamma: HLG (Hybrid Log-Gamma) Siting: Video (Top-Left) Primaries: BT.2020 Remarks This enum is used within a Graphics Presenter when configuring a Swap Chain to check the color space support of the Graphics Adapter and the Graphics Output, set a specific color space as output of the Swap Chain. It is also referenced in D3D11 video methods It is also used for defining the output color space of video decoding. The constants in this enum are divided into parts that describe the following: Color Space Defines the color space of the color channel data. Rgb The Red / Green / Blue color space color channels. YCbCr Three channel color model which splits luma (brightness) from chroma (color). YUV technically refers to analog signals and YCbCr to digital, but they are used interchangeably. Range Indicates which integer range corresponds to the floating point [0..1] range of the data. For video, integer YCbCr data with ranges of [16..235] or [8..247] are usually mapped to normalized YCbCr with ranges of [0..1] or [-0.5..0.5]. Full For PC desktop content and images. Defines the ranges: For 8-bit: 0-255, for 10-bit: 0-1023, for 12-bit: 0-4095. Studio Often used in video. Enables the calibration of white and black between displays. Defines the ranges: For 8-bit: 16-235, for 10-bit: 64-940, for 12-bit: 256 - 3760. Gamma G10 Gamma 1.0. Linear light levels. G22 Gamma 2.2. Commonly used for sRGB and BT.709 (linear segment + 2.4). G24 Gamma 2.4. Commonly used in cinema and professional video workflows. G2084 SMPTE ST.2084 (Perceptual Quantization). Siting \"Siting\" indicates a horizontal or vertical shift of the chrominance channels relative to the luminance channel. \"Cositing\" indicates values are sited between pixels in the vertical or horizontal direction (also known as being \"sited interstitially\"). None For images. The U and V planes are aligned vertically. Left For video. Chroma samples are aligned horizontally with the luma samples, or with multiples of the luma samples. The U and V planes are aligned vertically. TopLeft For video. The sampling point is the top left pixel (usually of a 2x2 pixel block). Chroma samples are aligned horizontally with the luma samples, or with multiples of the luma samples. Chroma samples are also aligned vertically with the luma samples, or with multiples of the luma samples. Primaries P601 BT.601. Standard defining digital encoding of SDTV video. P709 BT.709. Standard defining digital encoding of HDTV video. P2020 BT.2020. Standard defining ultra-high definition television (UHDTV). Transfer Matrix In most cases, the transfer matrix can be determined from the primaries. For some cases it must be explicitly specified as described below: X601 BT.601. Standard defining digital encoding of SDTV video. X709 BT.709. Standard defining digital encoding of HDTV video. X2020 BT.2020. Standard defining ultra-high definition television (UHDTV)."
  },
  "api/Stride.Graphics.ColorWriteChannels.html": {
    "href": "api/Stride.Graphics.ColorWriteChannels.html",
    "title": "Enum ColorWriteChannels | Stride API",
    "summary": "Enum ColorWriteChannels Namespace Stride.Graphics Assembly Stride.Graphics.dll Identifies which components of each pixel of a Render Target can be written to during blending. [Flags] [DataContract] public enum ColorWriteChannels Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields All = Red | Green | Blue | Alpha Allow data to be stored in all components. Alpha = 8 Allow data to be stored in the alpha component (A). Blue = 4 Allow data to be stored in the blue component (B). Green = 2 Allow data to be stored in the green component (G). None = 0 None of the data is stored. Red = 1 Allow data to be stored in the red component (R). Remarks These flags can be combined with a bitwise OR and set in BlendStateDescription and BlendStateRenderTargetDescription."
  },
  "api/Stride.Graphics.CommandList.html": {
    "href": "api/Stride.Graphics.CommandList.html",
    "title": "Class CommandList | Stride API",
    "summary": "Class CommandList Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents a list of graphics commands for playback, which can include resource binding, primitive-based rendering, etc. public class CommandList : GraphicsResourceBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase CommandList Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsResourceBase.NativeResource GraphicsResourceBase.NativeDeviceChild GraphicsResourceBase.UnsetNativeDeviceChild() GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) GraphicsResourceBase.NativeDevice GraphicsResourceBase.IsDebugMode GraphicsResourceBase.OnRecreate() GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed GraphicsResourceBase.OnPause() GraphicsResourceBase.OnResume() GraphicsResourceBase.Destroy() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) GraphicsDeviceExtensions.DrawQuad(CommandList) UnsafeUtilities.As<T>(object?) Fields MaxRenderTargetCount The maximum number of Render Targets that can be bound simultaneously by Stride. public const int MaxRenderTargetCount = 8 Field Value int MaxViewportAndScissorRectangleCount The maximum number of Viewports or Scissor Rectangles that can be set simultaneously by Stride. public const int MaxViewportAndScissorRectangleCount = 16 Field Value int Properties DepthStencilBuffer Gets the Depth-Stencil Buffer (Z-Buffer) currently bound to the pipeline. public Texture DepthStencilBuffer { get; } Property Value Texture Remarks To set the Depth-Stencil Buffer, use one of the SetRenderTargetAndViewport(Texture, Texture), or SetRenderTargetsAndViewport(ReadOnlySpan<Texture>), or SetRenderTargets(ReadOnlySpan<Texture>) methods. RenderTarget Gets the first Render Target currently bound to the pipeline. public Texture RenderTarget { get; } Property Value Texture Remarks To set Render Targets, use one of the SetRenderTargetAndViewport(Texture, Texture), or SetRenderTargetsAndViewport(ReadOnlySpan<Texture>), or SetRenderTargets(ReadOnlySpan<Texture>) methods. RenderTargetCount Gets the number of Render Targets currently bound to the pipeline. public int RenderTargetCount { get; } Property Value int RenderTargets Gets the set of Render Targets currently bound to the pipeline. public ReadOnlySpan<Texture> RenderTargets { get; } Property Value ReadOnlySpan<Texture> Remarks To set Render Targets, use one of the SetRenderTargetAndViewport(Texture, Texture), or SetRenderTargetsAndViewport(ReadOnlySpan<Texture>), or SetRenderTargets(ReadOnlySpan<Texture>) methods. Scissor Gets the first scissor rectangle bound to the rasterizer stage of the pipeline. public Rectangle Scissor { get; } Property Value Rectangle Remarks To set the scissor rectangles, use one of the SetScissorRectangle(in Rectangle) or SetScissorRectangles(params ReadOnlySpan<Rectangle>) methods. ScissorCount Gets the number of scissor rectangles currently bound to the rasterizer stage of the pipeline. public int ScissorCount { get; } Property Value int Scissors Gets scissor rectangles currently bound to the rasterizer stage of the pipeline. public ReadOnlySpan<Rectangle> Scissors { get; } Property Value ReadOnlySpan<Rectangle> Remarks To set the scissor rectangles, use one of the SetScissorRectangle(in Rectangle) or SetScissorRectangles(params ReadOnlySpan<Rectangle>) methods. Viewport Gets the first viewport bound to the rasterizer stage of the pipeline. public Viewport Viewport { get; } Property Value Viewport Remarks To set the viewport, use one of the SetViewport(in Viewport) or SetViewports(params ReadOnlySpan<Viewport>) methods, or the SetRenderTargetAndViewport(Texture, Texture), or SetRenderTargetsAndViewport(ReadOnlySpan<Texture>) methods. ViewportCount Gets the number of viewports currently bound to the rasterizer stage of the pipeline. public int ViewportCount { get; } Property Value int Viewports Gets the viewports currently bound to the rasterizer stage of the pipeline. public ReadOnlySpan<Viewport> Viewports { get; } Property Value ReadOnlySpan<Viewport> Remarks To set the viewport, use one of the SetViewport(in Viewport) or SetViewports(params ReadOnlySpan<Viewport>) methods, or the SetRenderTargetAndViewport(Texture, Texture), or SetRenderTargetsAndViewport(ReadOnlySpan<Texture>) methods. Methods BeginProfile(Color4, string) Marks the beginning of a profile section. public void BeginProfile(Color4 profileColor, string name) Parameters profileColor Color4 A color that a profiling tool can use to display the event. name string A descriptive name for the profile section. Remarks Each call to BeginProfile(Color4, string) must be matched with a corresponding call to EndProfile(), which defines a region of code that can be identified with a name and possibly a color in a compatible profiling tool. A pair of calls to BeginProfile(Color4, string) and EndProfile() can be nested inside a call to BeginProfile(Color4, string) and EndProfile() in an upper level in the call stack. This allows to form a hierarchy of profile sections. Clear(Texture, Color4) Clears the specified Render Target. public void Clear(Texture renderTarget, Color4 color) Parameters renderTarget Texture The Render Target to clear. color Color4 The color to use to clear the Render Target. Exceptions ArgumentNullException renderTarget is null. Clear(Texture, DepthStencilClearOptions, float, byte) Clears the specified Depth-Stencil Buffer. public void Clear(Texture depthStencilBuffer, DepthStencilClearOptions options, float depth = 1, byte stencil = 0) Parameters depthStencilBuffer Texture The Depth-Stencil Buffer to clear. options DepthStencilClearOptions A combination of DepthStencilClearOptions flags identifying what parts of the Depth-Stencil Buffer to clear. depth float The depth value to use for clearing the Depth Buffer. stencil byte The stencil value to use for clearing the Stencil Buffer. Exceptions ArgumentNullException depthStencilBuffer is null. InvalidOperationException Cannot clear a Stencil Buffer without a Stencil Buffer format. ClearReadWrite(Buffer, Int4) Clears a Read-Write Buffer. public void ClearReadWrite(Buffer buffer, Int4 value) Parameters buffer Buffer The Buffer to clear. It must have been created with read-write / unordered access flags. value Int4 The value to use to clear the Buffer. Exceptions ArgumentNullException buffer is null. ArgumentException buffer must support Unordered Access. ClearReadWrite(Buffer, UInt4) Clears a Read-Write Buffer. public void ClearReadWrite(Buffer buffer, UInt4 value) Parameters buffer Buffer The Buffer to clear. It must have been created with read-write / unordered access flags. value UInt4 The value to use to clear the Buffer. Exceptions ArgumentNullException buffer is null. ArgumentException buffer must support Unordered Access. ClearReadWrite(Buffer, Vector4) Clears a Read-Write Buffer. public void ClearReadWrite(Buffer buffer, Vector4 value) Parameters buffer Buffer The Buffer to clear. It must have been created with read-write / unordered access flags. value Vector4 The value to use to clear the Buffer. Exceptions ArgumentNullException buffer is null. ArgumentException buffer must support Unordered Access. ClearReadWrite(Texture, Int4) Clears a Read-Write Texture. public void ClearReadWrite(Texture texture, Int4 value) Parameters texture Texture The Texture to clear. It must have been created with read-write / unordered access flags. value Int4 The value to use to clear the Texture. Exceptions ArgumentNullException texture is null. ArgumentException texture must support Unordered Access. ClearReadWrite(Texture, UInt4) Clears a Read-Write Texture. public void ClearReadWrite(Texture texture, UInt4 value) Parameters texture Texture The Texture to clear. It must have been created with read-write / unordered access flags. value UInt4 The value to use to clear the Texture. Exceptions ArgumentNullException texture is null. ArgumentException texture must support Unordered Access. ClearReadWrite(Texture, Vector4) Clears a Read-Write Texture. public void ClearReadWrite(Texture texture, Vector4 value) Parameters texture Texture The Texture to clear. It must have been created with read-write / unordered access flags. value Vector4 The value to use to clear the Texture. Exceptions ArgumentNullException texture is null. ArgumentException texture must support Unordered Access. ClearState() Clears and restores the state of the Graphics Device. public void ClearState() Close() Indicates that recording to the Command List has finished. public CompiledCommandList Close() Returns CompiledCommandList A CompiledCommandList representing the frozen list of recorded commands that can be executed at a later time. Remarks Compiled Command Lists are not supported for Direct3D 11. This method returns a default empty one. Copy(GraphicsResource, GraphicsResource) Copies the data from a Graphics Resource to another. Views are ignored and the full underlying data is copied. public void Copy(GraphicsResource source, GraphicsResource destination) Parameters source GraphicsResource The source Graphics Resource. destination GraphicsResource The destination Graphics Resource. Exceptions ArgumentNullException source is null. ArgumentNullException destination is null. CopyCount(Buffer, Buffer, int) Copies data from a Buffer holding variable length data to another Buffer. public void CopyCount(Buffer sourceBuffer, Buffer destinationBuffer, int destinationOffsetInBytes) Parameters sourceBuffer Buffer A Structured Buffer created with either StructuredAppendBuffer or StructuredCounterBuffer. These types of resources have hidden counters tracking \"how many\" records have been written. destinationBuffer Buffer A Buffer resource to copy the data to. Any Buffer that other copy commands, such as Copy(GraphicsResource, GraphicsResource) or CopyRegion(GraphicsResource, int, ResourceRegion?, GraphicsResource, int, int, int, int), are able to write to. destinationOffsetInBytes int The offset in bytes from the start of destinationBuffer to write 32-bit uint structure (vertex) count from sourceBuffer. The offset must be aligned to 4 bytes. Exceptions ArgumentNullException sourceBuffer is null. ArgumentNullException destinationBuffer is null. CopyMultisample(Texture, int, Texture, int, PixelFormat) Copies the data from a multi-sampled Texture (which is resolved) to another Texture. public void CopyMultisample(Texture sourceMultiSampledTexture, int sourceSubResourceIndex, Texture destinationTexture, int destinationSubResourceIndex, PixelFormat format = PixelFormat.None) Parameters sourceMultiSampledTexture Texture The source multi-sampled Texture. sourceSubResourceIndex int The sub-resource index of the source Texture. destinationTexture Texture The destination Texture. destinationSubResourceIndex int The sub-resource index of the destination Texture. format PixelFormat A PixelFormat that indicates how the multi-sampled Texture will be resolved to a single-sampled resource. Remarks The sourceMultiSampledTexture and destinationTexture must have the same dimensions. In addition, they must have compatible formats. There are three scenarios for this: Scenario Requirements Source and destination are prestructured and typed Both the source and destination must have identical formats and that format must be specified in the format parameter. One resource is prestructured and typed and the other is prestructured and typeless The typed resource must have a format that is compatible with the typeless resource (i.e. the typed resource is R32_Float and the typeless resource is R32_Typeless). The format of the typed resource must be specified in the format parameter. Source and destination are prestructured and typeless Both the source and destination must have the same typeless format (i.e. both must have R32_Typeless), and the format parameter must specify a format that is compatible with the source and destination (i.e. if both are R32_Typeless then R32_Float could be specified in the format parameter). For example, given the R16G16B16A16_Typeless format: <ul><li>The source (or destination) format could be <xref href=\"Stride.Graphics.PixelFormat.R16G16B16A16_UNorm\" data-throw-if-not-resolved=\"false\"></xref>.</li><li>The destination (or source) format could be <xref href=\"Stride.Graphics.PixelFormat.R16G16B16A16_Float\" data-throw-if-not-resolved=\"false\"></xref>.</li></ul> </p> Exceptions ArgumentException sourceMultiSampledTexture is not a multi-sampled Texture. ArgumentNullException sourceMultiSampledTexture is null. ArgumentNullException destinationTexture is null. CopyRegion(GraphicsResource, int, ResourceRegion?, GraphicsResource, int, int, int, int) Copies a region from a source Graphics Resource to a destination Graphics Resource. public void CopyRegion(GraphicsResource source, int sourceSubResourceIndex, ResourceRegion? sourceRegion, GraphicsResource destination, int destinationSubResourceIndex, int dstX = 0, int dstY = 0, int dstZ = 0) Parameters source GraphicsResource The source Graphics Resource to copy from. sourceSubResourceIndex int The index of the sub-resource of source to copy from. sourceRegion ResourceRegion? An optional ResourceRegion that defines the source sub-resource to copy from. Specify null the entire source sub-resource is copied. An empty region makes this method to not perform a copy operation. It is considered empty if the top value is greater than or equal to the bottom value, or the left value is greater than or equal to the right value, or the front value is greater than or equal to the back value. destination GraphicsResource The destination Graphics Resource to copy to. destinationSubResourceIndex int The index of the sub-resource of destination to copy to. dstX int The X-coordinate of the upper left corner of the destination region. dstY int The Y-coordinate of the upper left corner of the destination region. For a 1D sub-resource, this must be zero. dstZ int The Z-coordinate of the upper left corner of the destination region. For a 1D or 2D sub-resource, this must be zero. Remarks The sourceRegion must be within the size of the source resource. The destination offsets, (dstX, dstY, and dstZ), allow the source region to be offset when writing into the destination resource; however, the dimensions of the source region and the offsets must be within the size of the resource. If the resources are Buffers, all coordinates are in bytes; if the resources are Textures, all coordinates are in texels. CopyRegion(GraphicsResource, int, ResourceRegion?, GraphicsResource, int, int, int, int) performs the copy on the GPU (similar to a memcpy by the CPU). As a consequence, the source and destination resources: Must be different sub-resources (although they can be from the same Graphics Resource). Must be the same type. Must have compatible formats (identical or from the same type group). For example, a R32G32B32_Float Texture can be copied to a R32G32B32_UInt Texture since both of these formats are in the R32G32B32_Typeless group. May not be currently mapped with MapSubResource(GraphicsResource, int, MapMode, bool, int, int). CopyRegion(GraphicsResource, int, ResourceRegion?, GraphicsResource, int, int, int, int) only supports copy; it doesn't support any stretch, color key, or blend. Exceptions ArgumentNullException source is null. ArgumentNullException destination is null. Dispatch(Buffer, int) Dispatches a Compute Shader workload using an Indirect Buffer, allowing the thread group count to be determined at runtime. public void Dispatch(Buffer indirectBuffer, int offsetInBytes) Parameters indirectBuffer Buffer A Buffer containing the dispatch parameters, structured as (threadCountX, threadCountY, threadCountZ). offsetInBytes int The byte offset within the indirectBuffer where the dispatch parameters are located. Exceptions ArgumentNullException indirectBuffer is null. Dispatch(int, int, int) Dispatches a Compute Shader workload with the specified number of thread groups in each dimension. public void Dispatch(int threadCountX, int threadCountY, int threadCountZ) Parameters threadCountX int Number of thread groups in the X dimension. threadCountY int Number of thread groups in the Y dimension. threadCountZ int Number of thread groups in the Z dimension. Draw(int, int) Issues a non-indexed draw call, rendering a sequence of vertices directly from the bound Vertex Buffer. public void Draw(int vertexCount, int startVertexLocation = 0) Parameters vertexCount int The number of vertices to draw. startVertexLocation int Index of the first vertex in the Vertex Buffer to begin rendering from; it could also be used as the first vertex id generated for a shader parameter marked with the SV_TargetId system-value semantic. DrawAuto() Issues a draw call for geometry of unknown size, typically used with Vertex or Index Buffers populated via Stream Output. The vertex count is inferred from the data written by the GPU. public void DrawAuto() DrawIndexed(int, int, int) Issues an indexed non-instanced draw call using the currently bound Index Buffer. public void DrawIndexed(int indexCount, int startIndexLocation = 0, int baseVertexLocation = 0) Parameters indexCount int Number of indices to draw. startIndexLocation int The location of the first index read by the GPU from the Index Buffer. baseVertexLocation int A value added to each index before reading a vertex from the Vertex Buffer. DrawIndexedInstanced(Buffer, int) Issues an indexed instanced draw call using an Indirect Arguments Buffer, allowing parameters to be determined at runtime. public void DrawIndexedInstanced(Buffer argumentsBuffer, int alignedByteOffsetForArgs = 0) Parameters argumentsBuffer Buffer A Buffer containing the draw parameters (index count, instance count, etc.). alignedByteOffsetForArgs int Byte offset within the argumentsBuffer where the draw arguments are located. Exceptions ArgumentNullException argumentsBuffer is null. DrawIndexedInstanced(int, int, int, int, int) Issues an indexed instanced draw call, rendering multiple instances of indexed geometry. public void DrawIndexedInstanced(int indexCountPerInstance, int instanceCount, int startIndexLocation = 0, int baseVertexLocation = 0, int startInstanceLocation = 0) Parameters indexCountPerInstance int Number of indices read from the Index Buffer for each instance. instanceCount int Number of instances to draw. startIndexLocation int The location of the first index read by the GPU from the Index Buffer. baseVertexLocation int A value added to each index before reading a vertex from the Vertex Buffer. startInstanceLocation int A value added to each index before reading per-instance data from a Vertex Buffer. DrawInstanced(Buffer, int) Issues a non-indexed instanced draw call using an Indirect Arguments Buffer, allowing parameters to be determined at runtime. public void DrawInstanced(Buffer argumentsBuffer, int alignedByteOffsetForArgs = 0) Parameters argumentsBuffer Buffer A Buffer containing the draw parameters (vertex count, instance count, etc.). alignedByteOffsetForArgs int Byte offset within the argumentsBuffer where the draw arguments are located. Exceptions ArgumentNullException argumentsBuffer is null. DrawInstanced(int, int, int, int) Issues a non-indexed instanced draw call, rendering multiple instances of geometry using a Vertex Buffer. public void DrawInstanced(int vertexCountPerInstance, int instanceCount, int startVertexLocation = 0, int startInstanceLocation = 0) Parameters vertexCountPerInstance int The number of vertices to draw per instance. instanceCount int The number of instances to draw. startVertexLocation int The index of the first vertex in the Vertex Buffer. startInstanceLocation int A value added to each index before reading per-instance data from a Vertex Buffer. EndProfile() Marks the end of a profile section previously started by a call to BeginProfile(Color4, string). public void EndProfile() Remarks Each call to BeginProfile(Color4, string) must be matched with a corresponding call to EndProfile(), which defines a region of code that can be identified with a name and possibly a color in a compatible profiling tool. A pair of calls to BeginProfile(Color4, string) and EndProfile() can be nested inside a call to BeginProfile(Color4, string) and EndProfile() in an upper level in the call stack. This allows to form a hierarchy of profile sections. Flush() Closes and executes the Command List. public void Flush() MapSubResource(GraphicsResource, int, MapMode, bool, int, int) Maps a sub-resource of a Graphics Resource to be accessible from CPU memory, and in the process denies the GPU access to that sub-resource. public MappedResource MapSubResource(GraphicsResource resource, int subResourceIndex, MapMode mapMode, bool doNotWait = false, int offsetInBytes = 0, int lengthInBytes = 0) Parameters resource GraphicsResource The Graphics Resource to map to CPU memory. subResourceIndex int The index of the sub-resource to get access to. mapMode MapMode A value of MapMode indicating the way the Graphics Resource should be mapped to CPU memory. doNotWait bool A value indicating if this method will return immediately if the Graphics Resource is still being used by the GPU for writing true. The default value is false, which means the method will wait until the GPU is done. offsetInBytes int The offset in bytes from the beginning of the mapped memory of the sub-resource. Defaults to 0, which means it is mapped from the beginning. lengthInBytes int The length in bytes of the memory to map from the sub-resource. Defaults to 0, which means the entire sub-resource is mapped. Returns MappedResource A MappedResource structure pointing to the GPU resource mapped for CPU access. Remarks For Buffers: Usage Instructions: Ensure the resource was created with the correct usage. For example, you should specify Dynamic if you plan to update its contents frequently. This method can be called multiple times, and nested calls are supported. Use appropriate MapMode values when calling MapSubResource(GraphicsResource, int, MapMode, bool, int, int). For example, WriteDiscard indicates that the old data in the Buffer can be discarded. Restrictions: The MappedResource returned by MapSubResource(GraphicsResource, int, MapMode, bool, int, int) is not guaranteed to be consistent across different calls. Applications should not rely on the address being the same unless MapSubResource(GraphicsResource, int, MapMode, bool, int, int) is persistently nested. MapSubResource(GraphicsResource, int, MapMode, bool, int, int) may invalidate the CPU cache to ensure that CPU reads reflect any modifications made by the GPU. If your graphics API supports them, use fences for synchronization to ensure proper coordination between the CPU and GPU. Ensure that the Buffer data is properly aligned to meet the requirements of your graphics API. Stick to simple usage models (e.g., Dynamic for upload, Default, Staging for readback) unless advanced models are necessary for your application. For Textures: Usage Instructions: Ensure to use the correct data format when writing data to the Texture. Textures can have multiple mipmap levels. You must specify which level you want to map with subResourceIndex. Use appropriate MapMode values when calling MapSubResource(GraphicsResource, int, MapMode, bool, int, int). For example, WriteDiscard is usually used to update dynamic Textures. Restrictions: Not all PixelFormats are compatible with mapping operations. Concurrent access to a Texture both from the CPU and the GPU may not be allowed and might require careful synchronization. Ensure that the Texture data is properly aligned to meet the requirements of your graphics API and the Format. For State Objects (like PipelineState, SamplerState, etc): Restrictions: State Objects are not usually mapped nor directly updated. They are created with specific configurations and are treated as immutable from now on. Instead, if you need changes, you can create a new State Object with the updated settings. After updating the resource, call UnmapSubResource(MappedResource) to release the CPU pointer and allow the GPU to access the updated data. Exceptions ArgumentNullException resource is null. New(GraphicsDevice) Creates a new CommandList. public static CommandList New(GraphicsDevice device) Parameters device GraphicsDevice The Graphics Device. Returns CommandList The new instance of CommandList. Exceptions InvalidOperationException Creation of additional Command Lists is not supported for Direct3D 11. OnDestroyed(bool) Called when the GraphicsDevice has been detected to be internally destroyed, or when the Destroy() methad has been called. Raises the Destroyed event. protected override void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the resource should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). Remarks This method releases the underlying native resources (Silk.NET.Direct3D11.ID3D11Resource and Silk.NET.Direct3D11.ID3D11DeviceChild). Reset() Resets a Command List back to its initial state as if a new Command List was just created. public void Reset() Remarks Deferred execution of Command Lists is not supported for Direct3D 11. This method does nothing. ResetTargets() Unbinds all the Render Targets and the Depth-Stencil Buffer from the output-merger stage. public void ResetTargets() ResourceBarrierTransition(GraphicsResource, GraphicsResourceState) Inserts a barrier that transitions a Graphics Resource to a new state, ensuring proper synchronization between different GPU operations accessing the resource. public void ResourceBarrierTransition(GraphicsResource resource, GraphicsResourceState newState) Parameters resource GraphicsResource The Graphics Resource to transition to a different state. newState GraphicsResourceState The new state of resource. Remarks The Direct3D 11 implementation does not have synchronization barriers for Graphics Resource transitions. SetBlendFactor(Color4) Sets the blend factors for blending each of the RGBA components. public void SetBlendFactor(Color4 blendFactor) Parameters blendFactor Color4 A Color4 representing the blend factors for each RGBA component. The blend factors modulate values for the pixel Shader, Render Target, or both. If you have configured the Blend-State object with BlendFactor or InverseBlendFactor, the blending stage uses the blend factors specified by blendFactor. Otherwise, the blend factors will not be taken into account for the blend stage. See Also SetPipelineState(PipelineState) SetDescriptorSets(int, DescriptorSet[]) Binds an array of Descriptor Sets at the specified index in the current pipeline's Root Signature, making shader resources available for rendering operations. public void SetDescriptorSets(int index, DescriptorSet[] descriptorSets) Parameters index int The starting slot where the Descriptor Sets will be bound. This is not used in the Direct3D 11 implementation. descriptorSets DescriptorSet[] An array of Descriptor Sets containing resource bindings (such as Textures, Samplers, and Constant Buffers) to be used by the currently active Pipeline State. SetIndexBuffer(Buffer, int, bool) Sets the Index Buffer for the input assembler stage of the pipeline. public void SetIndexBuffer(Buffer buffer, int offset, bool is32bits) Parameters buffer Buffer The Index Buffer to set. It must have been created with IndexBuffer. offset int Offset (in bytes) from the start of the Index Buffer to the first index to use. is32bits bool A value indicating if the Index Buffer elements are 32-bit indices (true), or 16-bit (false). SetPipelineState(PipelineState) Sets the configuration of the graphics pipeline which, among other things, control the shaders, input layout, render states, and output settings. public void SetPipelineState(PipelineState pipelineState) Parameters pipelineState PipelineState The Pipeline State object to set. Specify null to use the default one. See Also PipelineState SetRenderTarget(Texture, Texture) Binds a Depth-Stencil Buffer and a single Render Target to the output-merger stage. public void SetRenderTarget(Texture depthStencilView, Texture renderTargetView) Parameters depthStencilView Texture A view of the Depth-Stencil Buffer to bind. Specify null to unbind the currently bound Depth-Stencil Buffer. renderTargetView Texture A view of the Render Target to bind. Specify null to unbind the currently bound Render Targets. Remarks See Use a Render Target in the manual for more information. SetRenderTargetAndViewport(Texture, Texture) Binds a Depth-Stencil Buffer and a single Render Target to the output-merger stage, setting also the viewport according to their dimensions. public void SetRenderTargetAndViewport(Texture depthStencilView, Texture renderTargetView) Parameters depthStencilView Texture A view of the Depth-Stencil Buffer to bind. Specify null to unbind the currently bound Depth-Stencil Buffer. renderTargetView Texture A view of the Render Target to bind. Specify null to unbind the currently bound Render Targets. Remarks See Use a Render Target in the manual for more information. SetRenderTargets(Texture, params ReadOnlySpan<Texture>) Binds a Depth-Stencil Buffer and one or more Render Targets atomically to the output-merger stage. public void SetRenderTargets(Texture depthStencilView, params ReadOnlySpan<Texture> renderTargetViews) Parameters depthStencilView Texture A view of the Depth-Stencil Buffer to bind. Specify null to unbind the currently bound Depth-Stencil Buffer. renderTargetViews ReadOnlySpan<Texture> A set of Render Targets to bind. Specify an empty collection to unbind the currently bound Render Targets. Remarks See Use a Render Target in the manual for more information. Exceptions ArgumentOutOfRangeException renderTargetViews contains too many Render Targets to set. SetRenderTargets(ReadOnlySpan<Texture>) Binds one or more Render Targets atomically to the output-merger stage, and unbinds any Depth-Stencil Buffer. public void SetRenderTargets(ReadOnlySpan<Texture> renderTargetViews) Parameters renderTargetViews ReadOnlySpan<Texture> A set of Render Targets to bind. Specify an empty collection to unbind the currently bound Render Targets. Remarks See Use a Render Target in the manual for more information. Exceptions ArgumentOutOfRangeException renderTargetViews contains too many Render Targets to set. SetRenderTargetsAndViewport(Texture, params ReadOnlySpan<Texture>) Binds a Depth-Stencil Buffer and one or more Render Targets atomically to the output-merger stage, setting also the viewport according to their dimensions. public void SetRenderTargetsAndViewport(Texture depthStencilView, params ReadOnlySpan<Texture> renderTargetViews) Parameters depthStencilView Texture A view of the Depth-Stencil Buffer to bind. Specify null to unbind the currently bound Depth-Stencil Buffer. renderTargetViews ReadOnlySpan<Texture> A set of Render Targets to bind. Specify an empty collection to unbind the currently bound Render Targets. Remarks See Use a Render Target in the manual for more information. Exceptions ArgumentOutOfRangeException renderTargetViews contains too many Render Targets to set. SetRenderTargetsAndViewport(ReadOnlySpan<Texture>) Binds one or more Render Targets atomically to the output-merger stage, setting also the viewport according to their dimensions. Also unbinds the current Depth-Stencil Buffer. public void SetRenderTargetsAndViewport(ReadOnlySpan<Texture> renderTargetViews) Parameters renderTargetViews ReadOnlySpan<Texture> A set of Render Targets to bind. Specify an empty collection to unbind the currently bound Render Targets. Remarks See Use a Render Target in the manual for more information. Exceptions ArgumentOutOfRangeException renderTargetViews contains too many Render Targets to set. SetScissorRectangle(in Rectangle) Binds a single scissor rectangle to the rasterizer stage. public void SetScissorRectangle(in Rectangle rectangle) Parameters rectangle Rectangle The scissor rectangle to set. Remarks See Set the scissor in the manual for more information. SetScissorRectangles(params ReadOnlySpan<Rectangle>) Binds a set of scissor rectangles to the rasterizer stage. public void SetScissorRectangles(params ReadOnlySpan<Rectangle> scissorRectangles) Parameters scissorRectangles ReadOnlySpan<Rectangle> The set of scissor rectangles to bind. Remarks See Set the scissor in the manual for more information. Exceptions ArgumentOutOfRangeException scissorRectangles contains too many scissor rectangles to set. SetStencilReference(int) Sets the reference value for Depth-Stencil tests. public void SetStencilReference(int stencilReference) Parameters stencilReference int Reference value to perform against when doing a Depth-Stencil test. See Also SetPipelineState(PipelineState) SetStreamTargets(params ReadOnlySpan<Buffer>) Sets the stream output Buffers. public void SetStreamTargets(params ReadOnlySpan<Buffer> buffers) Parameters buffers ReadOnlySpan<Buffer> The Buffers to set for stream output. Specify null or an empty array to unset any bound output Buffer. SetVertexBuffer(int, Buffer, int, int) Sets a Vertex Buffer for the input assembler stage of the pipeline. public void SetVertexBuffer(int index, Buffer buffer, int offset, int stride) Parameters index int The input slot for binding the Vertex Buffer; The maximum number of input slots available depends on platform and graphics profile, usually 16 or 32. buffer Buffer The Vertex Buffer to set. It must have been created with VertexBuffer. offset int The number of bytes between the first element of the Vertex Buffer and the first element that will be used. stride int The size (in bytes) of the elements that are to be used from the Vertex Buffer. SetViewport(in Viewport) Binds a single viewport to the rasterizer stage of the pipeline. public void SetViewport(in Viewport viewport) Parameters viewport Viewport SetViewports(params ReadOnlySpan<Viewport>) Binds an array of viewports to the rasterizer stage of the pipeline. public void SetViewports(params ReadOnlySpan<Viewport> viewports) Parameters viewports ReadOnlySpan<Viewport> The viewports to set. Exceptions ArgumentOutOfRangeException viewports contains too many viewports to set. UnmapSubResource(MappedResource) Unmaps a sub-resource of a Graphics Resource, which was previously mapped to CPU memory with MapSubResource(GraphicsResource, int, MapMode, bool, int, int), and in the process re-enables the GPU access to that sub-resource. public void UnmapSubResource(MappedResource mappedResource) Parameters mappedResource MappedResource A MappedResource structure identifying the sub-resource to unmap. UnsetRenderTargets() Unsets the Render Targets currently bound to the pipeline. public void UnsetRenderTargets() WriteTimestamp(QueryPool, int) Submits a GPU timestamp Query. public void WriteTimestamp(QueryPool queryPool, int index) Parameters queryPool QueryPool The QueryPool owning the Query. index int The index of the Query to write."
  },
  "api/Stride.Graphics.CompareFunction.html": {
    "href": "api/Stride.Graphics.CompareFunction.html",
    "title": "Enum CompareFunction | Stride API",
    "summary": "Enum CompareFunction Namespace Stride.Graphics Assembly Stride.dll Identifies comparison functions that can be used to determine how the runtime compares source (new) data against destination (existing) data before storing the new data. [DataContract] public enum CompareFunction Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Always = 8 Always pass the comparison. Equal = 3 If the source data is equal to the destination data, the comparison passes. Greater = 5 If the source data is greater than the destination data, the comparison passes. GreaterEqual = 7 If the source data is greater than or equal to the destination data, the comparison passes. Less = 2 If the source data is less than the destination data, the comparison passes. LessEqual = 4 If the source data is less than or equal to the destination data, the comparison passes. Never = 1 Never pass the comparison. NotEqual = 6 If the source data is not equal to the destination data, the comparison passes. Remarks The comparison functions can be used for a Depth-Stencil Buffer (see DepthStencilState) for depth comparisons or rejections, or for stencil operations, or for Texture sampling (see SamplerState)."
  },
  "api/Stride.Graphics.CompiledCommandList.html": {
    "href": "api/Stride.Graphics.CompiledCommandList.html",
    "title": "Struct CompiledCommandList | Stride API",
    "summary": "Struct CompiledCommandList Namespace Stride.Graphics Assembly Stride.Graphics.dll public struct CompiledCommandList Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks A list of commands that have been recorded for execution at a later time."
  },
  "api/Stride.Graphics.ComputeShaderFormatSupport.html": {
    "href": "api/Stride.Graphics.ComputeShaderFormatSupport.html",
    "title": "Enum ComputeShaderFormatSupport | Stride API",
    "summary": "Enum ComputeShaderFormatSupport Namespace Stride.Graphics Assembly Stride.Graphics.dll Flags specifying which resources and features are supported when using compute shaders for a given pixel format for a graphics device. [Flags] public enum ComputeShaderFormatSupport Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AtomicAdd = 1 AtomicBitwiseOperations = 2 AtomicCompareStoreOrCompareExchange = 4 AtomicExchange = 8 AtomicSignedMinimumOrMaximum = 16 AtomicUnsignedMinimumOrMaximum = 32 MultiplaneOverlay = 16384 None = 0 OutputMergerLogicOperation = 256 Shareable = 1024 Tiled = 512 TypedLoad = 64 TypedStore = 128 Remarks For more information, see Features."
  },
  "api/Stride.Graphics.CubeMapFace.html": {
    "href": "api/Stride.Graphics.CubeMapFace.html",
    "title": "Enum CubeMapFace | Stride API",
    "summary": "Enum CubeMapFace Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines the faces of a cube map for Cube Texture. public enum CubeMapFace Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields NegativeX = 1 Negative x-face of the cube map. NegativeY = 3 Negative y-face of the cube map. NegativeZ = 5 Negative z-face of the cube map. PositiveX = 0 Positive x-face of the cube map. PositiveY = 2 Positive y-face of the cube map. PositiveZ = 4 Positive z-face of the cube map."
  },
  "api/Stride.Graphics.CullMode.html": {
    "href": "api/Stride.Graphics.CullMode.html",
    "title": "Enum CullMode | Stride API",
    "summary": "Enum CullMode Namespace Stride.Graphics Assembly Stride.Graphics.dll Indicates the facing direction of triangles that will be culled (not drawn). [DataContract] public enum CullMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Back = 3 Do not draw triangles that are back-facing. Front = 2 Do not draw triangles that are front-facing. None = 1 Always draw all triangles. Remarks This enumeration is part of a Rasterizer State object description (see RasterizerStateDescription)."
  },
  "api/Stride.Graphics.Data.BufferData.html": {
    "href": "api/Stride.Graphics.Data.BufferData.html",
    "title": "Class BufferData | Stride API",
    "summary": "Class BufferData Namespace Stride.Graphics.Data Assembly Stride.Graphics.dll Content of a GPU buffer (vertex buffer, index buffer, etc...). [DataContract] [ContentSerializer(typeof(DataContentSerializerWithReuse<BufferData>))] public class BufferData Inheritance object BufferData Extension Methods GraphicsSerializerExtensions.ToSerializableVersion(BufferData) UnsafeUtilities.As<T>(object?) Constructors BufferData() public BufferData() BufferData(BufferFlags, byte[]) public BufferData(BufferFlags bufferFlags, byte[] content) Parameters bufferFlags BufferFlags content byte[] Properties BufferFlags Buffer flags describing the type of buffer. public BufferFlags BufferFlags { get; set; } Property Value BufferFlags Content Gets or sets the buffer content. public byte[] Content { get; set; } Property Value byte[] The buffer content. StructureByteStride The size of the structure (in bytes) when it represents a structured/typed buffer. public int StructureByteStride { get; set; } Property Value int Usage Usage of this buffer. public GraphicsResourceUsage Usage { get; set; } Property Value GraphicsResourceUsage Methods New<T>(BufferFlags, T[]) Creates a new instance of BufferData from a typed buffer. public static BufferData New<T>(BufferFlags bufferFlags, T[] content) where T : struct Parameters bufferFlags BufferFlags The flags indicating the type of buffer content T[] An array of data Returns BufferData A buffer data. Type Parameters T Type of the element to store in the buffer data."
  },
  "api/Stride.Graphics.Data.BufferSerializer.html": {
    "href": "api/Stride.Graphics.Data.BufferSerializer.html",
    "title": "Class BufferSerializer | Stride API",
    "summary": "Class BufferSerializer Namespace Stride.Graphics.Data Assembly Stride.Graphics.dll Serializer for Buffer. public class BufferSerializer : DataSerializer<Buffer> Inheritance object DataSerializer DataSerializer<Buffer> BufferSerializer Inherited Members DataSerializer<Buffer>.SerializationType DataSerializer<Buffer>.IsBlittable DataSerializer<Buffer>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Buffer>.Serialize(Buffer, SerializationStream) DataSerializer<Buffer>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods PreSerialize(ref Buffer, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref Buffer buffer, ArchiveMode mode, SerializationStream stream) Parameters buffer Buffer mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref Buffer, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Buffer buffer, ArchiveMode mode, SerializationStream stream) Parameters buffer Buffer mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Graphics.Data.GraphicsSerializerExtensions.html": {
    "href": "api/Stride.Graphics.Data.GraphicsSerializerExtensions.html",
    "title": "Class GraphicsSerializerExtensions | Stride API",
    "summary": "Class GraphicsSerializerExtensions Namespace Stride.Graphics.Data Assembly Stride.Graphics.dll Various extension method for serialization of GPU types having separate CPU serialized data format. public static class GraphicsSerializerExtensions Inheritance object GraphicsSerializerExtensions Methods GetSerializationData(Buffer) Gets the serialized data version of this Buffer. public static BufferData GetSerializationData(this Buffer buffer) Parameters buffer Buffer The buffer. Returns BufferData GetSerializationData(Texture) Gets the serialized data version of this Texture. public static TextureSerializationData GetSerializationData(this Texture texture) Parameters texture Texture The texture. Returns TextureSerializationData SetSerializationData(Buffer, BufferData) Sets the serialized data version of this Buffer. public static void SetSerializationData(this Buffer buffer, BufferData bufferData) Parameters buffer Buffer The buffer. bufferData BufferData The buffer data. SetSerializationData(Texture, TextureSerializationData) Sets the serialized data version of this Texture. public static void SetSerializationData(this Texture texture, TextureSerializationData data) Parameters texture Texture The texture. data TextureSerializationData The data. SetSerializationData(Texture, Image) Sets the serialized data version of this Texture. public static void SetSerializationData(this Texture texture, Image image) Parameters texture Texture The texture. image Image The image. ToSerializableVersion(BufferData) Creates a fake Buffer that will have the given serialized data version. public static Buffer ToSerializableVersion(this BufferData bufferData) Parameters bufferData BufferData The buffer data. Returns Buffer ToSerializableVersion(TextureSerializationData) Creates a fake Texture that will have the given serialized data version. public static Texture ToSerializableVersion(this TextureSerializationData data) Parameters data TextureSerializationData The data. Returns Texture ToSerializableVersion(Image) Creates a fake Texture that will have the given serialized data version. public static Texture ToSerializableVersion(this Image image) Parameters image Image The image. Returns Texture"
  },
  "api/Stride.Graphics.Data.ITexturesStreamingProvider.html": {
    "href": "api/Stride.Graphics.Data.ITexturesStreamingProvider.html",
    "title": "Interface ITexturesStreamingProvider | Stride API",
    "summary": "Interface ITexturesStreamingProvider Namespace Stride.Graphics.Data Assembly Stride.Graphics.dll Used internally to find the currently active textures streaming service public interface ITexturesStreamingProvider Extension Methods UnsafeUtilities.As<T>(object?) Methods FullyLoadTexture(Texture, ref ImageDescription, ref ContentStorageHeader) Loads the texture in a streaming service. void FullyLoadTexture(Texture obj, ref ImageDescription imageDescription, ref ContentStorageHeader storageHeader) Parameters obj Texture The texture object. imageDescription ImageDescription The image description. storageHeader ContentStorageHeader The storage header. RegisterTexture(Texture, ref ImageDescription, ref ContentStorageHeader) Registers the texture in a streaming service. void RegisterTexture(Texture obj, ref ImageDescription imageDescription, ref ContentStorageHeader storageHeader) Parameters obj Texture The texture object. imageDescription ImageDescription The image description. storageHeader ContentStorageHeader The storage header. UnregisterTexture(Texture) Unregisters the texture. void UnregisterTexture(Texture obj) Parameters obj Texture The texture object."
  },
  "api/Stride.Graphics.Data.TextureSerializationData.html": {
    "href": "api/Stride.Graphics.Data.TextureSerializationData.html",
    "title": "Class TextureSerializationData | Stride API",
    "summary": "Class TextureSerializationData Namespace Stride.Graphics.Data Assembly Stride.Graphics.dll Texture serialization data public sealed class TextureSerializationData Inheritance object TextureSerializationData Extension Methods GraphicsSerializerExtensions.ToSerializableVersion(TextureSerializationData) UnsafeUtilities.As<T>(object?) Constructors TextureSerializationData(Image) Initializes a new instance of the TextureSerializationData class. public TextureSerializationData(Image image) Parameters image Image The image. TextureSerializationData(Image, bool, ContentStorageHeader) Initializes a new instance of the TextureSerializationData class. public TextureSerializationData(Image image, bool enableStreaming, ContentStorageHeader storageHeader) Parameters image Image The image. enableStreaming bool Enables/disables texture streaming storageHeader ContentStorageHeader Streaming storage data Fields EnableStreaming Enables/disables texture streaming. public bool EnableStreaming Field Value bool Image The texture image. public Image Image Field Value Image StorageHeader The raw bytes with a content storage header description. public ContentStorageHeader StorageHeader Field Value ContentStorageHeader Methods Write(SerializationStream) Saves this instance to a stream. public void Write(SerializationStream stream) Parameters stream SerializationStream The destination stream."
  },
  "api/Stride.Graphics.Data.TextureSerializer.html": {
    "href": "api/Stride.Graphics.Data.TextureSerializer.html",
    "title": "Class TextureSerializer | Stride API",
    "summary": "Class TextureSerializer Namespace Stride.Graphics.Data Assembly Stride.Graphics.dll Serializer for Texture. public class TextureSerializer : DataSerializer<Texture> Inheritance object DataSerializer DataSerializer<Texture> TextureSerializer Inherited Members DataSerializer<Texture>.SerializationType DataSerializer<Texture>.IsBlittable DataSerializer<Texture>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<Texture>.Serialize(Texture, SerializationStream) DataSerializer<Texture>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods PreSerialize(ref Texture, ArchiveMode, SerializationStream) Performs the first step of serialization or deserialization. public override void PreSerialize(ref Texture texture, ArchiveMode mode, SerializationStream stream) Parameters texture Texture mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to. Remarks Typically, it will instantiate the object if [null], and if it's a collection clear it. Serialize(ref Texture, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref Texture texture, ArchiveMode mode, SerializationStream stream) Parameters texture Texture mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Graphics.Data.html": {
    "href": "api/Stride.Graphics.Data.html",
    "title": "Namespace Stride.Graphics.Data | Stride API",
    "summary": "Namespace Stride.Graphics.Data Classes BufferData Content of a GPU buffer (vertex buffer, index buffer, etc...). BufferSerializer Serializer for Buffer. GraphicsSerializerExtensions Various extension method for serialization of GPU types having separate CPU serialized data format. TextureSerializationData Texture serialization data TextureSerializer Serializer for Texture. Interfaces ITexturesStreamingProvider Used internally to find the currently active textures streaming service"
  },
  "api/Stride.Graphics.DataBox.html": {
    "href": "api/Stride.Graphics.DataBox.html",
    "title": "Struct DataBox | Stride API",
    "summary": "Struct DataBox Namespace Stride.Graphics Assembly Stride.dll Defines a region of data organized in 3D. public struct DataBox : IEquatable<DataBox> Implements IEquatable<DataBox> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors DataBox(nint, int, int) Defines a region of data organized in 3D. public DataBox(nint dataPointer, int rowPitch, int slicePitch) Parameters dataPointer nint A pointer to the data. rowPitch int The number of bytes per row of the data. slicePitch int The number of bytes per slice of the data (for a 3D Texture, a slice is a 2D image). Fields DataPointer A pointer to the data. public nint DataPointer Field Value nint Empty An empty DataBox. public static readonly DataBox Empty Field Value DataBox RowPitch The number of bytes per row of the data. public int RowPitch Field Value int SlicePitch The number of bytes per slice of the data (for a 3D Texture, a slice is a 2D image). public int SlicePitch Field Value int Properties IsEmpty Gets a value indicating whether this data box is empty. public readonly bool IsEmpty { get; } Property Value bool true if this instance is empty; otherwise, false. Methods Equals(DataBox) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(DataBox other) Parameters other DataBox An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(DataBox, DataBox) public static bool operator ==(DataBox left, DataBox right) Parameters left DataBox right DataBox Returns bool operator !=(DataBox, DataBox) public static bool operator !=(DataBox left, DataBox right) Parameters left DataBox right DataBox Returns bool"
  },
  "api/Stride.Graphics.DataPointer.html": {
    "href": "api/Stride.Graphics.DataPointer.html",
    "title": "Struct DataPointer | Stride API",
    "summary": "Struct DataPointer Namespace Stride.Graphics Assembly Stride.dll [Obsolete(\"Use System.Span instead\")] public struct DataPointer Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors DataPointer(nint, int) public DataPointer(nint pointer, int size) Parameters pointer nint size int DataPointer(void*, int) public DataPointer(void* pointer, int size) Parameters pointer void* size int Fields Pointer public nint Pointer Field Value nint Size public int Size Field Value int"
  },
  "api/Stride.Graphics.DataRectangle.html": {
    "href": "api/Stride.Graphics.DataRectangle.html",
    "title": "Struct DataRectangle | Stride API",
    "summary": "Struct DataRectangle Namespace Stride.Graphics Assembly Stride.dll Provides a pointer to 2D data. public struct DataRectangle Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors DataRectangle(nint, int) Initializes a new instance of the DataRectangle class. public DataRectangle(nint dataPointer, int pitch) Parameters dataPointer nint The pointer to the data. pitch int The stride. Fields DataPointer Gets or sets a pointer to the data. public nint DataPointer Field Value nint The stream. Pitch Gets or sets the number of bytes per row. public int Pitch Field Value int The row pitch in bytes."
  },
  "api/Stride.Graphics.DefaultCommandListLock.html": {
    "href": "api/Stride.Graphics.DefaultCommandListLock.html",
    "title": "Struct DefaultCommandListLock | Stride API",
    "summary": "Struct DefaultCommandListLock Namespace Stride.Graphics Assembly Stride.Graphics.dll Used to prevent concurrent uses of CommandList against the main one. public struct DefaultCommandListLock : IDisposable Implements IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors DefaultCommandListLock(CommandList) public DefaultCommandListLock(CommandList lockObject) Parameters lockObject CommandList Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose()"
  },
  "api/Stride.Graphics.DepthStencilClearOptions.html": {
    "href": "api/Stride.Graphics.DepthStencilClearOptions.html",
    "title": "Enum DepthStencilClearOptions | Stride API",
    "summary": "Enum DepthStencilClearOptions Namespace Stride.Graphics Assembly Stride.Graphics.dll Flags that specify what parts of a Depth-Stencil Buffer to clear when calling Clear(Texture, DepthStencilClearOptions, float, byte). [Flags] public enum DepthStencilClearOptions Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields DepthBuffer = 1 Selects the Depth Buffer. None = 0 Neither the Depth Buffer nor the Stencil Buffer will be cleared. Stencil = 2 Selects the Stencil Buffer."
  },
  "api/Stride.Graphics.DepthStencilStateDescription.html": {
    "href": "api/Stride.Graphics.DepthStencilStateDescription.html",
    "title": "Struct DepthStencilStateDescription | Stride API",
    "summary": "Struct DepthStencilStateDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll A description of a Depth-Stencil State, which defines how depth and stencil testing are performed during rasterization. [DataContract] public struct DepthStencilStateDescription : IEquatable<DepthStencilStateDescription> Implements IEquatable<DepthStencilStateDescription> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks This structure controls whether depth and stencil tests are enabled, how they are configured, and how they affect pixel visibility. It allows fine-grained control over depth comparisons, stencil operations, and write masks, enabling advanced rendering techniques such as shadow volumes, outlines, and complex masking. Constructors DepthStencilStateDescription() Initializes a new instance of the DepthStencilStateDescription structure with default values. public DepthStencilStateDescription() Remarks The default values are: <ul><li>Enables depth testing and depth writing.</li><li>Uses the depth comparison function <xref href=\"Stride.Graphics.CompareFunction.LessEqual\" data-throw-if-not-resolved=\"false\"></xref>.</li><li>Disables stencil testing.</li><li>Sets the stencil bitmasks to <xref href=\"System.Byte.MaxValue\" data-throw-if-not-resolved=\"false\"></xref> (all birs set to 1).</li><li> The stencil operations and comparison functions for both front-facing and back-facing pixels are set to <xref href=\"Stride.Graphics.CompareFunction.Always\" data-throw-if-not-resolved=\"false\"></xref> (they always succeed) and <xref href=\"Stride.Graphics.StencilOperation.Keep\" data-throw-if-not-resolved=\"false\"></xref> (the value in the stencil buffer is not modified).</li></ul> </remarks> DepthStencilStateDescription(bool, bool) Initializes a new instance of the DepthStencilStateDescription structure with default values. public DepthStencilStateDescription(bool depthEnable, bool depthWriteEnable) Parameters depthEnable bool A value indicating whether to enable Depth testing. depthWriteEnable bool A value indicating whether to enable writing to the Depth-Stencil Buffer. Remarks The default values are: <ul><li>Enables depth testing and depth writing.</li><li>Uses the depth comparison function <xref href=\"Stride.Graphics.CompareFunction.LessEqual\" data-throw-if-not-resolved=\"false\"></xref>.</li><li>Disables stencil testing.</li><li>Sets the stencil bitmasks to <xref href=\"System.Byte.MaxValue\" data-throw-if-not-resolved=\"false\"></xref> (all birs set to 1).</li><li> The stencil operations and comparison functions for both front-facing and back-facing pixels are set to <xref href=\"Stride.Graphics.CompareFunction.Always\" data-throw-if-not-resolved=\"false\"></xref> (they always succeed) and <xref href=\"Stride.Graphics.StencilOperation.Keep\" data-throw-if-not-resolved=\"false\"></xref> (the value in the stencil buffer is not modified).</li></ul> </remarks> Fields BackFace Describes stencil operations and comparison function for back-facing polygons. public DepthStencilStencilOpDescription BackFace Field Value DepthStencilStencilOpDescription Remarks Typically used in conjunction with FrontFace to implement two-sided stencil operations, such as shadow volume rendering or complex masking. Default A Depth-Stencil State description with default values. public static readonly DepthStencilStateDescription Default Field Value DepthStencilStateDescription Remarks The default values are: Enables depth testing and depth writing. Uses the depth comparison function LessEqual. Disables stencil testing. Sets the stencil bitmasks to MaxValue (all birs set to 1). The stencil operations and comparison functions for both front-facing and back-facing pixels are set to Always (they always succeed) and Keep (the value in the stencil buffer is not modified). DefaultDepthBufferEnable The default value for DepthBufferEnable. public const bool DefaultDepthBufferEnable = true Field Value bool DefaultDepthBufferFunction The default value for DepthBufferFunction. public const CompareFunction DefaultDepthBufferFunction = LessEqual Field Value CompareFunction DefaultDepthBufferWriteEnable The default value for DepthBufferWriteEnable. public const bool DefaultDepthBufferWriteEnable = true Field Value bool DefaultDepthStencilOp The default value for both FrontFace and BackFace. public static readonly DepthStencilStencilOpDescription DefaultDepthStencilOp Field Value DepthStencilStencilOpDescription DefaultStencilEnable The default value for StencilEnable. public const bool DefaultStencilEnable = false Field Value bool DefaultStencilMask The default value for StencilMask. public const byte DefaultStencilMask = 255 Field Value byte DefaultStencilWriteMask The default value for StencilWriteMask. public const byte DefaultStencilWriteMask = 255 Field Value byte DepthBufferEnable Enables or disables depth testing during rasterization. public bool DepthBufferEnable Field Value bool Remarks When enabled, the depth test compares each pixel's depth value against the existing value in the Depth-Stencil Buffer, using the function specified by DepthBufferFunction. If disabled, all pixels pass the depth test. DepthBufferFunction Specifies the comparison function used in the depth test. public CompareFunction DepthBufferFunction Field Value CompareFunction Remarks This function determines whether a pixel should be drawn based on its depth value. For example, CompareFunction.LessEqual allows a pixel to pass if its depth is less than or equal to the current Depth-Stencil Buffer value. DepthBufferWriteEnable Enables or disables writing to the depth buffer. public bool DepthBufferWriteEnable Field Value bool Remarks Disabling depth writes can be useful for rendering transparent objects or overlays that should not affect depth testing of subsequent geometry. FrontFace Describes stencil operations and comparison function for front-facing polygons. public DepthStencilStencilOpDescription FrontFace Field Value DepthStencilStencilOpDescription Remarks This includes the operations to perform when the stencil test fails, when the depth test fails, and when both pass. It also defines the comparison function used for the stencil test. StencilEnable Enables or disables stencil testing. public bool StencilEnable Field Value bool Remarks When enabled, the stencil test is performed for each pixel using the configured stencil operations and masks. This allows for advanced rendering techniques such as masking, outlining, and shadow volumes. StencilMask Bitmask applied to both the reference value and stencil buffer entry during stencil testing. Default is MaxValue. public byte StencilMask Field Value byte Remarks This mask controls which bits are considered significant in the stencil comparison. For example, a mask of 0x0F limits the test to the lower 4 bits of the stencil value. StencilWriteMask Bitmask applied to values written into the stencil buffer. Default is MaxValue. public byte StencilWriteMask Field Value byte Remarks This mask determines which bits can be modified during stencil write operations. It allows selective updating of stencil buffer bits. Methods Clone() Creates a new instance of DepthStencilStateDescription with the same values as this instance. public readonly DepthStencilStateDescription Clone() Returns DepthStencilStateDescription A new Depth-Stencil State description that is a copy of this instance. Equals(DepthStencilStateDescription) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(DepthStencilStateDescription other) Parameters other DepthStencilStateDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(DepthStencilStateDescription, DepthStencilStateDescription) public static bool operator ==(DepthStencilStateDescription left, DepthStencilStateDescription right) Parameters left DepthStencilStateDescription right DepthStencilStateDescription Returns bool operator !=(DepthStencilStateDescription, DepthStencilStateDescription) public static bool operator !=(DepthStencilStateDescription left, DepthStencilStateDescription right) Parameters left DepthStencilStateDescription right DepthStencilStateDescription Returns bool See Also DepthStencilStates"
  },
  "api/Stride.Graphics.DepthStencilStates.html": {
    "href": "api/Stride.Graphics.DepthStencilStates.html",
    "title": "Class DepthStencilStates | Stride API",
    "summary": "Class DepthStencilStates Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines a set of built-in DepthStencilStateDescriptions for common Depth and Stencil testing configurations. public static class DepthStencilStates Inheritance object DepthStencilStates Fields Default A built-in Depth-Stencil State object with default settings. public static readonly DepthStencilStateDescription Default Field Value DepthStencilStateDescription Remarks The default values are: Enables depth testing and depth writing. Uses the depth comparison function LessEqual. Disables stencil testing. Sets the stencil bitmasks to MaxValue (all birs set to 1). The stencil operations and comparison functions for both front-facing and back-facing pixels are set to Always (they always succeed) and Keep (the value in the stencil buffer is not modified). DefaultInverse A built-in Depth-Stencil State object with default settings using GreaterEqual function when comparing depth values. public static readonly DepthStencilStateDescription DefaultInverse Field Value DepthStencilStateDescription DepthRead A built-in Depth-Stencil State object with settings for enabling a read-only Depth-Stencil Buffer. public static readonly DepthStencilStateDescription DepthRead Field Value DepthStencilStateDescription None A built-in Depth-Stencil State object with settings for not using a Depth-Stencil Buffer. public static readonly DepthStencilStateDescription None Field Value DepthStencilStateDescription"
  },
  "api/Stride.Graphics.DepthStencilStencilOpDescription.html": {
    "href": "api/Stride.Graphics.DepthStencilStencilOpDescription.html",
    "title": "Struct DepthStencilStencilOpDescription | Stride API",
    "summary": "Struct DepthStencilStencilOpDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes the stencil operations and comparison function used during stencil testing for a given face orientation (front or back). [DataContract] public struct DepthStencilStencilOpDescription : IEquatable<DepthStencilStencilOpDescription> Implements IEquatable<DepthStencilStencilOpDescription> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks This structure defines how the stencil buffer is updated based on the outcome of the stencil and depth tests. It is used in DepthStencilStateDescription to configure separate behavior for front-facing and back-facing polygons. Constructors DepthStencilStencilOpDescription() Initializes a new instance of the DepthStencilStencilOpDescription structure with default values. public DepthStencilStencilOpDescription() Remarks The default values are: <ul><li> Always keep the current value (<xref href=\"Stride.Graphics.StencilOperation.Keep\" data-throw-if-not-resolved=\"false\"></xref>) in all cases (i.e., <xref href=\"Stride.Graphics.DepthStencilStencilOpDescription.StencilFail\" data-throw-if-not-resolved=\"false\"></xref>, <xref href=\"Stride.Graphics.DepthStencilStencilOpDescription.StencilDepthBufferFail\" data-throw-if-not-resolved=\"false\"></xref>, and <xref href=\"Stride.Graphics.DepthStencilStencilOpDescription.StencilPass\" data-throw-if-not-resolved=\"false\"></xref>). </li><li>A comparison function that always passes (<xref href=\"Stride.Graphics.CompareFunction.Always\" data-throw-if-not-resolved=\"false\"></xref>).</li></ul> </remarks> Fields Default A Depth-Stencil Operation description with default values. public static readonly DepthStencilStencilOpDescription Default Field Value DepthStencilStencilOpDescription Remarks The default values are: Always keep the current value (Keep) in all cases (i.e., StencilFail, StencilDepthBufferFail, and StencilPass). A comparison function that always passes (Always). DefaultStencilDepthBufferFail Default value for StencilDepthBufferFail. public const StencilOperation DefaultStencilDepthBufferFail = Keep Field Value StencilOperation DefaultStencilFail Default value for StencilFail. public const StencilOperation DefaultStencilFail = Keep Field Value StencilOperation DefaultStencilFunction Default value for StencilFunction. public const CompareFunction DefaultStencilFunction = Always Field Value CompareFunction DefaultStencilPass Default value for StencilPass. public const StencilOperation DefaultStencilPass = Keep Field Value StencilOperation StencilDepthBufferFail Specifies the stencil operation to perform when the stencil test passes but the depth test fails. public StencilOperation StencilDepthBufferFail Field Value StencilOperation Remarks This is useful for effects like shadow volumes, where depth failure indicates occlusion. StencilFail Specifies the stencil operation to perform when the stencil test fails. public StencilOperation StencilFail Field Value StencilOperation Remarks This operation is applied regardless of the result of the depth test. Common values include Keep (no change) and Increment/Decrement for masking or outlining effects. StencilFunction Specifies the comparison function used to evaluate the stencil test. public CompareFunction StencilFunction Field Value CompareFunction Remarks The test compares the stencil buffer value with a reference value using this function. For example, Equal passes only if the values match. StencilPass Specifies the stencil operation to perform when both the stencil and depth tests pass. public StencilOperation StencilPass Field Value StencilOperation Remarks This is the most common path for visible pixels. The operation typically updates the stencil buffer to mark the pixel as processed. Methods Equals(DepthStencilStencilOpDescription) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(DepthStencilStencilOpDescription other) Parameters other DepthStencilStencilOpDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(DepthStencilStencilOpDescription, DepthStencilStencilOpDescription) public static bool operator ==(DepthStencilStencilOpDescription left, DepthStencilStencilOpDescription right) Parameters left DepthStencilStencilOpDescription right DepthStencilStencilOpDescription Returns bool operator !=(DepthStencilStencilOpDescription, DepthStencilStencilOpDescription) public static bool operator !=(DepthStencilStencilOpDescription left, DepthStencilStencilOpDescription right) Parameters left DepthStencilStencilOpDescription right DepthStencilStencilOpDescription Returns bool"
  },
  "api/Stride.Graphics.DescriptorPool.html": {
    "href": "api/Stride.Graphics.DescriptorPool.html",
    "title": "Class DescriptorPool | Stride API",
    "summary": "Class DescriptorPool Namespace Stride.Graphics Assembly Stride.Graphics.dll A pool where the application can allocate Descriptors that are grouped together in DescriptorSets. public class DescriptorPool : GraphicsResourceBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase DescriptorPool Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsResourceBase.NativeResource GraphicsResourceBase.NativeDeviceChild GraphicsResourceBase.UnsetNativeDeviceChild() GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) GraphicsResourceBase.NativeDevice GraphicsResourceBase.IsDebugMode GraphicsResourceBase.OnRecreate() GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed GraphicsResourceBase.OnPause() GraphicsResourceBase.OnResume() GraphicsResourceBase.OnDestroyed(bool) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Methods Destroy() Disposes the resources associated with the Graphics Resource, removes itself from the GraphicsDevice's resource registry, and transitions to the Destroyed state. protected override void Destroy() New(GraphicsDevice, DescriptorTypeCount[]) Creates a new Descriptor Pool with space for the specified counts of each Descriptor type. public static DescriptorPool New(GraphicsDevice graphicsDevice, DescriptorTypeCount[] counts) Parameters graphicsDevice GraphicsDevice The Graphics Device. counts DescriptorTypeCount[] A list of DescriptorTypeCount structures indicating the number of each type of Descriptor that need to be allocated. Returns DescriptorPool The new Descriptor Pool. Reset() Clears the Descriptor Pool, resetting all allocated Descriptors. public void Reset()"
  },
  "api/Stride.Graphics.DescriptorSet.html": {
    "href": "api/Stride.Graphics.DescriptorSet.html",
    "title": "Struct DescriptorSet | Stride API",
    "summary": "Struct DescriptorSet Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents a set of Descriptors (such as Textures or Buffers) that can be bound together to a graphics pipeline. public readonly struct DescriptorSet Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties IsValid Gets a value indicating whether this Descriptor Set is valid (i.e. it has been allocated and has a valid start offset). public bool IsValid { get; } Property Value bool Methods New(GraphicsDevice, DescriptorPool, DescriptorSetLayout) Creates a new Descriptor Set. public static DescriptorSet New(GraphicsDevice graphicsDevice, DescriptorPool pool, DescriptorSetLayout layout) Parameters graphicsDevice GraphicsDevice The Graphics Device. pool DescriptorPool The pool where Descriptor Sets are allocated. layout DescriptorSetLayout A description of the Graphics Resources in the Descriptor Set and their layout. Returns DescriptorSet The new Descriptor Set. SetConstantBuffer(int, Buffer, int, int) Sets a Constant Buffer View in the specified slot. public void SetConstantBuffer(int slot, Buffer buffer, int offset, int size) Parameters slot int The slot index. buffer Buffer The Constant Buffer to set. offset int The Constant Buffer View start offset. size int The Constant Buffer View size. SetSamplerState(int, SamplerState) Sets a Sampler State in the specified slot. public void SetSamplerState(int slot, SamplerState samplerState) Parameters slot int The slot index. samplerState SamplerState The Sampler State to set. SetShaderResourceView(int, GraphicsResource) Sets a Shader Resource View on a Graphics Resource in the specified slot. public void SetShaderResourceView(int slot, GraphicsResource shaderResourceView) Parameters slot int The slot index. shaderResourceView GraphicsResource The Shader Resource View on a Graphics Resource to set. SetUnorderedAccessView(int, GraphicsResource) Sets an Unordered Access View in the specified slot. public void SetUnorderedAccessView(int slot, GraphicsResource unorderedAccessView) Parameters slot int The slot index. unorderedAccessView GraphicsResource The Unordered Access View to set. SetValue(int, object) Sets a Descriptor in the specified slot. public void SetValue(int slot, object value) Parameters slot int The slot index. value object The Descriptor to set."
  },
  "api/Stride.Graphics.DescriptorSetLayout.html": {
    "href": "api/Stride.Graphics.DescriptorSetLayout.html",
    "title": "Class DescriptorSetLayout | Stride API",
    "summary": "Class DescriptorSetLayout Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines the Graphics Resources (Descriptors) that need to be bound together, their layout, types, and other associated metadata. This description is used to allocate a DescriptorSet. public class DescriptorSetLayout : GraphicsResourceBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase DescriptorSetLayout Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsResourceBase.NativeResource GraphicsResourceBase.NativeDeviceChild GraphicsResourceBase.UnsetNativeDeviceChild() GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) GraphicsResourceBase.NativeDevice GraphicsResourceBase.IsDebugMode GraphicsResourceBase.OnRecreate() GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed GraphicsResourceBase.OnPause() GraphicsResourceBase.OnResume() GraphicsResourceBase.Destroy() GraphicsResourceBase.OnDestroyed(bool) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Methods New(GraphicsDevice, DescriptorSetLayoutBuilder) Creates a new Descriptor Set Layout. public static DescriptorSetLayout New(GraphicsDevice device, DescriptorSetLayoutBuilder builder) Parameters device GraphicsDevice The Graphics Device. builder DescriptorSetLayoutBuilder A DescriptorSetLayoutBuilder that defines the bound Graphics Resources of the Descriptor Set. Returns DescriptorSetLayout The new DescriptorSetLayout."
  },
  "api/Stride.Graphics.DescriptorSetLayoutBuilder.html": {
    "href": "api/Stride.Graphics.DescriptorSetLayoutBuilder.html",
    "title": "Class DescriptorSetLayoutBuilder | Stride API",
    "summary": "Class DescriptorSetLayoutBuilder Namespace Stride.Graphics Assembly Stride.Graphics.dll Helper class to build a DescriptorSetLayout. public class DescriptorSetLayoutBuilder Inheritance object DescriptorSetLayoutBuilder Extension Methods UnsafeUtilities.As<T>(object?) Properties Hash Gets a hash identifying the current state of a Descriptor Set. This hash is used to know if the Descriptors in the set can be shared. public ObjectId Hash { get; } Property Value ObjectId Methods AddBinding(ParameterKey, string, EffectParameterClass, EffectParameterType, EffectParameterType, int, SamplerState?) Adds a binding to the Descriptor Set layout. public void AddBinding(ParameterKey key, string logicalGroup, EffectParameterClass @class, EffectParameterType type, EffectParameterType elementType, int arraySize = 1, SamplerState? immutableSampler = null) Parameters key ParameterKey The ParameterKey by which the Graphics Resource' Descriptor can be identified in the Shader. logicalGroup string A logical group name, used to group related Descriptors and variables together. class EffectParameterClass The kind of the parameter in the Shader. type EffectParameterType The data type of the parameter in the Shader. elementType EffectParameterType The data type of the elements of the parameter in the Shader in case Type represents an Array, Buffer, or Texture type. arraySize int The number of elements in the Array in case Type represents an Array type. Specify 1 if the parameter is not an Array. This is the default value. immutableSampler SamplerState An optional unmodifiable Sampler State described directly in the Shader for sampling the parameter. Specify null if the parameter does not require a Sampler State."
  },
  "api/Stride.Graphics.DescriptorTypeCount.html": {
    "href": "api/Stride.Graphics.DescriptorTypeCount.html",
    "title": "Struct DescriptorTypeCount | Stride API",
    "summary": "Struct DescriptorTypeCount Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes how many Descriptor of a specific type will need to be allocated in a DescriptorPool. public readonly record struct DescriptorTypeCount : IEquatable<DescriptorTypeCount> Implements IEquatable<DescriptorTypeCount> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors DescriptorTypeCount(EffectParameterClass, int) Describes how many Descriptor of a specific type will need to be allocated in a DescriptorPool. public DescriptorTypeCount(EffectParameterClass Type, int Count) Parameters Type EffectParameterClass The type of the Descriptors to allocate. Count int The number of Descriptors that need to be allocated. Properties Count The number of Descriptors that need to be allocated. public int Count { get; init; } Property Value int Type The type of the Descriptors to allocate. public EffectParameterClass Type { get; init; } Property Value EffectParameterClass"
  },
  "api/Stride.Graphics.DeviceCreationFlags.html": {
    "href": "api/Stride.Graphics.DeviceCreationFlags.html",
    "title": "Enum DeviceCreationFlags | Stride API",
    "summary": "Enum DeviceCreationFlags Namespace Stride.Graphics Assembly Stride.Graphics.dll Flags describing the parameters that are used to create a Graphics Device. [Flags] public enum DeviceCreationFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BgraSupport = 32 Creates a Graphics Device requiring BGRA pixel format support, which is required for Direct2D interoperability with Direct3D resources. Debug = 2 Creates a Graphics Device that supports the debug layer. None = 0 VideoSupport = 2048 Forces the creation of the Graphics Device to fail if the display driver is not implemented as a WDDM 1.2 driver, in which case only a Direct3D device that is created with feature level 9.1, 9.2, or 9.3 supports video; Therefore, if this flag is set, the runtime creates the Direct3D device only for feature level 9.1, 9.2, or 9.3. We recommend not to specify this flag for applications that want to favor Direct3D capability over video. If feature level 10 and higher is available, the runtime will use that feature level regardless of video support. If this flag is set, device creation on the Basic Render Device (BRD) will succeed regardless of the BRD's missing support for video decode. This is because the Media Foundation video stack operates in software mode on BRD. In this situation, if you force the video stack to create the Direct3D device twice (create the device once with this flag, next discover BRD, then again create the device without the flag), you actually degrade performance. If you attempt to create a Direct3D device with driver type Silk.NET.Core.Native.D3DDriverType.Null, Silk.NET.Core.Native.D3DDriverType.Reference, or Silk.NET.Core.Native.D3DDriverType.Software, device creation fails at any feature level because none of the associated drivers provide video capability. If you attempt to create a Direct3D device with driver type Silk.NET.Core.Native.D3DDriverType.Warp, device creation succeeds to allow software fallback for video. This value is not supported until Direct3D 11.1."
  },
  "api/Stride.Graphics.DisplayMode.html": {
    "href": "api/Stride.Graphics.DisplayMode.html",
    "title": "Struct DisplayMode | Stride API",
    "summary": "Struct DisplayMode Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a display mode. public readonly record struct DisplayMode : IEquatable<DisplayMode> Implements IEquatable<DisplayMode> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors DisplayMode(PixelFormat, int, int, Rational) Describes a display mode. public DisplayMode(PixelFormat Format, int Width, int Height, Rational RefreshRate) Parameters Format PixelFormat The pixel format of this display mode. Width int The screen width, in pixels. Height int The screen height, in pixels. RefreshRate Rational The refresh rate, in Hz. DisplayMode(PixelFormat, int, int, uint) Initializes a new instance of the DisplayMode record. public DisplayMode(PixelFormat format, int width, int height, uint refreshRate) Parameters format PixelFormat The pixel format of this display mode. width int The screen width, in pixels. height int The screen height, in pixels. refreshRate uint The refresh rate, in Hz. Properties AspectRatio Gets the aspect ratio of this display mode. public float AspectRatio { get; } Property Value float Remarks The aspect ratio is the ratio of the display mode's Width in relation to the Height, i.e. Width / Height. Format The pixel format of this display mode. public PixelFormat Format { get; init; } Property Value PixelFormat Height The screen height, in pixels. public int Height { get; init; } Property Value int RefreshRate The refresh rate, in Hz. public Rational RefreshRate { get; init; } Property Value Rational Width The screen width, in pixels. public int Width { get; init; } Property Value int"
  },
  "api/Stride.Graphics.DisplayOrientation.html": {
    "href": "api/Stride.Graphics.DisplayOrientation.html",
    "title": "Enum DisplayOrientation | Stride API",
    "summary": "Enum DisplayOrientation Namespace Stride.Graphics Assembly Stride.dll Describes the orientation of the display. [Flags] [DataContract(\"DisplayOrientation\")] public enum DisplayOrientation Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Default = 0 The default value for the orientation. LandscapeLeft = 1 Displays in landscape mode to the left. LandscapeRight = 2 Displays in landscape mode to the right. Portrait = 4 Displays in portrait mode."
  },
  "api/Stride.Graphics.DisplayRotation.html": {
    "href": "api/Stride.Graphics.DisplayRotation.html",
    "title": "Enum DisplayRotation | Stride API",
    "summary": "Enum DisplayRotation Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines the rotation of a display, indicating how the Back-Buffers should be rotated to fit the physical rotation of a monitor. public enum DisplayRotation Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Default = 0 The default value for the rotation (no rotation, or unspecified). Rotate180 = 2 The display is rotated 180 degrees clockwise. Rotate270 = 3 The display is rotated 270 degrees clockwise. Rotate90 = 1 The display is rotated 90 degrees clockwise."
  },
  "api/Stride.Graphics.Effect.html": {
    "href": "api/Stride.Graphics.Effect.html",
    "title": "Class Effect | Stride API",
    "summary": "Class Effect Namespace Stride.Graphics Assembly Stride.Graphics.dll [ContentSerializer(typeof(DataContentSerializer<Effect>))] [DataSerializer(typeof(EffectSerializer))] [DataSerializerGlobal(typeof(ReferenceSerializer<Effect>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public class Effect : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase Effect Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors Effect(GraphicsDevice, EffectBytecode) Initializes a new instance of the Effect class. public Effect(GraphicsDevice device, EffectBytecode bytecode) Parameters device GraphicsDevice The device. bytecode EffectBytecode The bytecode. Exceptions ArgumentNullException device or bytecode Properties Bytecode Gets the bytecode. public EffectBytecode Bytecode { get; } Property Value EffectBytecode The bytecode. Methods HasParameter(ParameterKey) public bool HasParameter(ParameterKey parameterKey) Parameters parameterKey ParameterKey Returns bool"
  },
  "api/Stride.Graphics.EffectDescriptorSetReflection.html": {
    "href": "api/Stride.Graphics.EffectDescriptorSetReflection.html",
    "title": "Class EffectDescriptorSetReflection | Stride API",
    "summary": "Class EffectDescriptorSetReflection Namespace Stride.Graphics Assembly Stride.Graphics.dll A reflection object that describes the Descriptor Sets and their layouts for an Effect / Shader based on reflection data extracted from its bytecode. This includes the bindings for Graphics Resources such as Textures, Buffers, and Sampler States. public class EffectDescriptorSetReflection Inheritance object EffectDescriptorSetReflection Extension Methods UnsafeUtilities.As<T>(object?) Methods AddLayout(string, DescriptorSetLayoutBuilder) Adds a new Descriptor Set layout for the given name. public void AddLayout(string descriptorSetName, DescriptorSetLayoutBuilder descriptorSetLayoutBuilder) Parameters descriptorSetName string The slot name given to the Descriptor Set layout in the Effect / Shader. descriptorSetLayoutBuilder DescriptorSetLayoutBuilder A DescriptorSetLayoutBuilder that describes the Graphics Resource bindings and their associated metadata and layout. GetLayout(string) Gets the layout of the Descriptor Set with the given name. public DescriptorSetLayoutBuilder? GetLayout(string name) Parameters name string The name of the Descriptor Set. Returns DescriptorSetLayoutBuilder A DescriptorSetLayoutBuilder object that describes the Graphics Resource bindings and their layout in the Descriptor Set with the provided name, or null if no Descriptor Set with that name exists. GetLayoutIndex(string) Gets the index of the Descriptor Set with the given name. public int GetLayoutIndex(string name) Parameters name string The name of the Descriptor Set. Returns int The zero-based index of the Descriptor Set with the provided name, or -1 if no Descriptor Set with that name exists. New(GraphicsDevice, EffectBytecode, List<string>, string) Creates a new Effect Descriptor Set reflection object. public static EffectDescriptorSetReflection New(GraphicsDevice graphicsDevice, EffectBytecode effectBytecode, List<string> effectDescriptorSetSlots, string defaultSetSlot) Parameters graphicsDevice GraphicsDevice The Graphics Device used to create Sampler States and manage bindings. effectBytecode EffectBytecode The Effect / Shader bytecode containing reflection data for resource bindings and Sampler States. effectDescriptorSetSlots List<string> A list of Descriptor Set slot names to be processed. This usually comes from the resource groups (rgroups) in the Effects / Shaders, plus a \"Globals\" slot for those Descriptor Set layouts that have no specified a slot / group name. defaultSetSlot string The default Descriptor Set slot name used for the Graphics Resources in this Effect / Shader when no slot name is specified. Usually, this is \"Globals\". Returns EffectDescriptorSetReflection The new instance of EffectDescriptorSetReflection containing the Descriptor Set layouts and default set slot information."
  },
  "api/Stride.Graphics.FastTextRenderer.html": {
    "href": "api/Stride.Graphics.FastTextRenderer.html",
    "title": "Class FastTextRenderer | Stride API",
    "summary": "Class FastTextRenderer Namespace Stride.Graphics Assembly Stride.Graphics.dll Renders text with a fixed size font. public class FastTextRenderer : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase FastTextRenderer Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors FastTextRenderer(GraphicsContext, int) public FastTextRenderer(GraphicsContext graphicsContext, int maxCharacterCount = 7000) Parameters graphicsContext GraphicsContext maxCharacterCount int Properties DebugSpriteFont Sets or gets the sprite font texture to use when drawing the text. The sprite font must have fixed size of DebugSpriteWidth and DebugSpriteHeight and each glyph should have uniform size of GlyphWidth and GlyphHeight public Texture DebugSpriteFont { get; set; } Property Value Texture DebugSpriteHeight Height of font Texture DebugSpriteFont. public int DebugSpriteHeight { get; set; } Property Value int DebugSpriteWidth Width of font Texture DebugSpriteFont. public int DebugSpriteWidth { get; set; } Property Value int GlyphHeight Height of a single glyph of font DebugSpriteFont. public int GlyphHeight { get; set; } Property Value int GlyphWidth Width of a single glyph of font DebugSpriteFont. public int GlyphWidth { get; set; } Property Value int MatrixTransform A general matrix transformation for the text. Should include view and projection if needed. public Matrix MatrixTransform { get; set; } Property Value Matrix TextColor Sets or gets the color to use when drawing the text. public Color4 TextColor { get; set; } Property Value Color4 Methods Begin(GraphicsContext) Begins text rendering (swaps and maps the vertex buffer to write to). public void Begin(GraphicsContext graphicsContext) Parameters graphicsContext GraphicsContext The current GraphicsContext. Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. DrawString(GraphicsContext, string, int, int) Adds a string to be drawn once End() is called. public void DrawString(GraphicsContext graphicsContext, string text, int x, int y) Parameters graphicsContext GraphicsContext The current GraphicsContext. text string The text to draw. Should not be modified until call to End. x int Position of the text on the X axis (in viewport space). y int Position of the text on the Y axis (in viewport space). End(GraphicsContext) Begins text rendering (swaps and maps the vertex buffer to write to). public void End(GraphicsContext graphicsContext) Parameters graphicsContext GraphicsContext The current GraphicsContext."
  },
  "api/Stride.Graphics.FillMode.html": {
    "href": "api/Stride.Graphics.FillMode.html",
    "title": "Enum FillMode | Stride API",
    "summary": "Enum FillMode Namespace Stride.Graphics Assembly Stride.Graphics.dll Determines the fill mode to use when rendering triangles. [DataContract] public enum FillMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Solid = 3 Fill the triangles formed by the vertices. Wireframe = 2 Draw lines connecting the vertices. Remarks This enumeration is part of a Rasterizer State object description (see RasterizerStateDescription)."
  },
  "api/Stride.Graphics.Font.FontAntiAliasMode.html": {
    "href": "api/Stride.Graphics.Font.FontAntiAliasMode.html",
    "title": "Enum FontAntiAliasMode | Stride API",
    "summary": "Enum FontAntiAliasMode Namespace Stride.Graphics.Font Assembly Stride.Graphics.dll Available antialias mode. [DataContract] public enum FontAntiAliasMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Aliased = 2 Don't use any antialiasing ClearType = 1 Use cleartype antialiasing. Default = 0 The default grayscale anti-aliasing Grayscale = 0 Use grayscale antialiasing"
  },
  "api/Stride.Graphics.Font.FontDataFactory.html": {
    "href": "api/Stride.Graphics.Font.FontDataFactory.html",
    "title": "Class FontDataFactory | Stride API",
    "summary": "Class FontDataFactory Namespace Stride.Graphics.Font Assembly Stride.Graphics.dll A font factory initializing only the data members of font. Used when creating a font in the only purpose use serializing on disk. public class FontDataFactory : IFontFactory Inheritance object FontDataFactory Implements IFontFactory Extension Methods UnsafeUtilities.As<T>(object?) Methods NewDynamic(float, string, FontStyle, FontAntiAliasMode, bool, float, float, char) Create a new instance of a dynamic font. public SpriteFont NewDynamic(float defaultSize, string fontName, FontStyle style, FontAntiAliasMode antiAliasMode, bool useKerning, float extraSpacing, float extraLineSpacing, char defaultCharacter) Parameters defaultSize float The default size of the font in pixels. fontName string The family name of the (TrueType) font. style FontStyle The style for the font. A combinaison of 'regular', 'bold' or 'italic'. antiAliasMode FontAntiAliasMode The anti-aliasing mode to use when rendering the font. By default, font textures are rendered in levels of grey. useKerning bool Specifies whether to use kerning information when rendering the font. Default value is false (NOT SUPPORTED YET) extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created dynamic font NewScalable(float, IList<Glyph>, IList<Image>, float, float, IList<Kerning>, float, float, char) Create a new instance of a scalable font. public SpriteFont NewScalable(float size, IList<Glyph> glyphs, IList<Image> images, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs images IList<Image> The list of images containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided glyphs information. Provided glyphs should not be modified after the creation of the font. NewScalable(float, IList<Glyph>, IList<Texture>, float, float, IList<Kerning>, float, float, char) Create a new instance of a scalable font. public SpriteFont NewScalable(float size, IList<Glyph> glyphs, IList<Texture> textures, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs textures IList<Texture> The list of textures containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided textures, glyphs information. Provided data should not be modified after the creation of the font. The textures should be disposed manually (if useless) after that the sprite font is not used anymore. NewStatic(float, IList<Glyph>, IList<Image>, float, float, IList<Kerning>, float, float, char) Create a new instance of a static font. public SpriteFont NewStatic(float size, IList<Glyph> glyphs, IList<Image> images, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs images IList<Image> The list of images containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided glyphs information. Provided glyphs should not be modified after the creation of the font. NewStatic(float, IList<Glyph>, IList<Texture>, float, float, IList<Kerning>, float, float, char) Create a new instance of a static font. public SpriteFont NewStatic(float size, IList<Glyph> glyphs, IList<Texture> textures, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs textures IList<Texture> The list of textures containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided textures, glyphs information. Provided data should not be modified after the creation of the font. The textures should be disposed manually (if useless) after that the sprite font is not used anymore."
  },
  "api/Stride.Graphics.Font.FontHelper.html": {
    "href": "api/Stride.Graphics.Font.FontHelper.html",
    "title": "Class FontHelper | Stride API",
    "summary": "Class FontHelper Namespace Stride.Graphics.Font Assembly Stride.Graphics.dll public static class FontHelper Inheritance object FontHelper Methods GetFontPath(string, FontStyle) Build the path of a font in the database given the name of the font family and the font style. public static string GetFontPath(string fontName, FontStyle style) Parameters fontName string Family name of the font style FontStyle The style of the font Returns string The absolute path of the font in the database Remarks This function does not indicate it the font exists or not in the database."
  },
  "api/Stride.Graphics.Font.FontStyle.html": {
    "href": "api/Stride.Graphics.Font.FontStyle.html",
    "title": "Enum FontStyle | Stride API",
    "summary": "Enum FontStyle Namespace Stride.Graphics.Font Assembly Stride.Graphics.dll Type of a font. [Flags] [DataContract] public enum FontStyle Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) FontStyleExtensions.IsBold(FontStyle) FontStyleExtensions.IsItalic(FontStyle) UnsafeUtilities.As<T>(object?) Fields Bold = 1 A bold font. Italic = 2 An italic font. Regular = 0 A regular font."
  },
  "api/Stride.Graphics.Font.FontStyleExtensions.html": {
    "href": "api/Stride.Graphics.Font.FontStyleExtensions.html",
    "title": "Class FontStyleExtensions | Stride API",
    "summary": "Class FontStyleExtensions Namespace Stride.Graphics.Font Assembly Stride.Graphics.dll Extension methods for type FontStyle. public static class FontStyleExtensions Inheritance object FontStyleExtensions Methods IsBold(FontStyle) Indicate if the style is bold (partially bold). public static bool IsBold(this FontStyle style) Parameters style FontStyle the style Returns bool true if bold, false otherwise IsItalic(FontStyle) Indicate if the style is italic (partially italic). public static bool IsItalic(this FontStyle style) Parameters style FontStyle the style Returns bool true if italic, false otherwise"
  },
  "api/Stride.Graphics.Font.FontSystem.html": {
    "href": "api/Stride.Graphics.Font.FontSystem.html",
    "title": "Class FontSystem | Stride API",
    "summary": "Class FontSystem Namespace Stride.Graphics.Font Assembly Stride.Graphics.dll The system managing the fonts. public class FontSystem : IFontFactory Inheritance object FontSystem Implements IFontFactory Extension Methods UnsafeUtilities.As<T>(object?) Constructors FontSystem() Create a new instance of FontSystem base on the provided GraphicsDevice. public FontSystem() Properties RuntimeFonts Gets the runtime font provider for registering and managing fonts loaded from the file system. public RuntimeFontProvider RuntimeFonts { get; } Property Value RuntimeFontProvider Remarks Use this to register custom fonts at runtime that are not part of the content pipeline via RegisterFont(string, string, FontStyle). Once registered, fonts can be loaded using the LoadRuntimeFont(string, float, FontStyle) method. Methods Draw() public void Draw() Load(GraphicsDevice, IDatabaseFileProviderService) Load this system. public void Load(GraphicsDevice graphicsDevice, IDatabaseFileProviderService fileProviderService) Parameters graphicsDevice GraphicsDevice The graphics device. fileProviderService IDatabaseFileProviderService Exceptions ArgumentNullException graphicsDevice LoadRuntimeFont(string, float, FontStyle) Loads a runtime-registered font by name. This bypasses the content pipeline entirely. public SpriteFont? LoadRuntimeFont(string fontName, float defaultSize = 16, FontStyle style = FontStyle.Regular) Parameters fontName string The registered font name. If the font is not registered, the method returns null. defaultSize float The default font size in pixels. style FontStyle The font style. Returns SpriteFont A SpriteFont instance if the font is registered; otherwise, null. NewDynamic(float, string, FontStyle, FontAntiAliasMode, bool, float, float, char) Create a new instance of a dynamic font. public SpriteFont NewDynamic(float defaultSize, string fontName, FontStyle style, FontAntiAliasMode antiAliasMode = FontAntiAliasMode.Default, bool useKerning = false, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters defaultSize float The default size of the font in pixels. fontName string The family name of the (TrueType) font. style FontStyle The style for the font. A combinaison of 'regular', 'bold' or 'italic'. antiAliasMode FontAntiAliasMode The anti-aliasing mode to use when rendering the font. By default, font textures are rendered in levels of grey. useKerning bool Specifies whether to use kerning information when rendering the font. Default value is false (NOT SUPPORTED YET) extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created dynamic font NewScalable(float, IList<Glyph>, IList<Image>, float, float, IList<Kerning>, float, float, char) Create a new instance of a scalable font. public SpriteFont NewScalable(float size, IList<Glyph> glyphs, IList<Image> images, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs images IList<Image> The list of images containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided glyphs information. Provided glyphs should not be modified after the creation of the font. NewScalable(float, IList<Glyph>, IList<Texture>, float, float, IList<Kerning>, float, float, char) Create a new instance of a scalable font. public SpriteFont NewScalable(float size, IList<Glyph> glyphs, IList<Texture> textures, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs textures IList<Texture> The list of textures containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided textures, glyphs information. Provided data should not be modified after the creation of the font. The textures should be disposed manually (if useless) after that the sprite font is not used anymore. NewStatic(float, IList<Glyph>, IList<Image>, float, float, IList<Kerning>, float, float, char) Create a new instance of a static font. public SpriteFont NewStatic(float size, IList<Glyph> glyphs, IList<Image> images, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs images IList<Image> The list of images containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided glyphs information. Provided glyphs should not be modified after the creation of the font. NewStatic(float, IList<Glyph>, IList<Texture>, float, float, IList<Kerning>, float, float, char) Create a new instance of a static font. public SpriteFont NewStatic(float size, IList<Glyph> glyphs, IList<Texture> textures, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs textures IList<Texture> The list of textures containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided textures, glyphs information. Provided data should not be modified after the creation of the font. The textures should be disposed manually (if useless) after that the sprite font is not used anymore. Unload() public void Unload()"
  },
  "api/Stride.Graphics.Font.Glyph.html": {
    "href": "api/Stride.Graphics.Font.Glyph.html",
    "title": "Class Glyph | Stride API",
    "summary": "Class Glyph Namespace Stride.Graphics.Font Assembly Stride.dll Description of a glyph (a single character) [DataContract] public class Glyph Inheritance object Glyph Extension Methods UnsafeUtilities.As<T>(object?) Fields BitmapIndex Index of the bitmap. public int BitmapIndex Field Value int Character Unicode codepoint. public int Character Field Value int Offset Layout information. public Vector2 Offset Field Value Vector2 Subrect Glyph image data (may only use a portion of a larger bitmap). public Rectangle Subrect Field Value Rectangle XAdvance Advance X public float XAdvance Field Value float"
  },
  "api/Stride.Graphics.Font.IFontFactory.html": {
    "href": "api/Stride.Graphics.Font.IFontFactory.html",
    "title": "Interface IFontFactory | Stride API",
    "summary": "Interface IFontFactory Namespace Stride.Graphics.Font Assembly Stride.Graphics.dll The interface to create and manage fonts. public interface IFontFactory Extension Methods UnsafeUtilities.As<T>(object?) Methods NewDynamic(float, string, FontStyle, FontAntiAliasMode, bool, float, float, char) Create a new instance of a dynamic font. SpriteFont NewDynamic(float defaultSize, string fontName, FontStyle style, FontAntiAliasMode antiAliasMode = FontAntiAliasMode.Default, bool useKerning = false, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters defaultSize float The default size of the font in pixels. fontName string The family name of the (TrueType) font. style FontStyle The style for the font. A combinaison of 'regular', 'bold' or 'italic'. antiAliasMode FontAntiAliasMode The anti-aliasing mode to use when rendering the font. By default, font textures are rendered in levels of grey. useKerning bool Specifies whether to use kerning information when rendering the font. Default value is false (NOT SUPPORTED YET) extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created dynamic font NewScalable(float, IList<Glyph>, IList<Image>, float, float, IList<Kerning>, float, float, char) Create a new instance of a scalable font. SpriteFont NewScalable(float size, IList<Glyph> glyphs, IList<Image> images, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs images IList<Image> The list of images containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided glyphs information. Provided glyphs should not be modified after the creation of the font. NewScalable(float, IList<Glyph>, IList<Texture>, float, float, IList<Kerning>, float, float, char) Create a new instance of a scalable font. SpriteFont NewScalable(float size, IList<Glyph> glyphs, IList<Texture> textures, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs textures IList<Texture> The list of textures containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided textures, glyphs information. Provided data should not be modified after the creation of the font. The textures should be disposed manually (if useless) after that the sprite font is not used anymore. NewStatic(float, IList<Glyph>, IList<Image>, float, float, IList<Kerning>, float, float, char) Create a new instance of a static font. SpriteFont NewStatic(float size, IList<Glyph> glyphs, IList<Image> images, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs images IList<Image> The list of images containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided glyphs information. Provided glyphs should not be modified after the creation of the font. NewStatic(float, IList<Glyph>, IList<Texture>, float, float, IList<Kerning>, float, float, char) Create a new instance of a static font. SpriteFont NewStatic(float size, IList<Glyph> glyphs, IList<Texture> textures, float baseOffset, float defaultLineSpacing, IList<Kerning> kernings = null, float extraSpacing = 0, float extraLineSpacing = 0, char defaultCharacter = ' ') Parameters size float The size of the font in pixels. glyphs IList<Glyph> The list of the font glyphs textures IList<Texture> The list of textures containing the font character data baseOffset float The number of pixels from the absolute top of the line to the base of the characters. defaultLineSpacing float The default line spacing of the font. kernings IList<Kerning> The list of the kerning information of the font extraSpacing float The character extra spacing in pixels. Zero is default spacing, negative closer together, positive further apart. extraLineSpacing float This is the extra distance in pixels to add between each line of text. Zero is default spacing, negative closer together, positive further apart. defaultCharacter char The default character fall-back. Returns SpriteFont The newly created static font Remarks The font does not copy the provided textures, glyphs information. Provided data should not be modified after the creation of the font. The textures should be disposed manually (if useless) after that the sprite font is not used anymore."
  },
  "api/Stride.Graphics.Font.Kerning.html": {
    "href": "api/Stride.Graphics.Font.Kerning.html",
    "title": "Struct Kerning | Stride API",
    "summary": "Struct Kerning Namespace Stride.Graphics.Font Assembly Stride.dll Describes kerning information. [DataContract] public struct Kerning Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields First Unicode for the 1st character. public int First Field Value int Offset X Offsets in pixels to apply between the 1st and 2nd character. public float Offset Field Value float Second Unicode for the 2nd character. public int Second Field Value int"
  },
  "api/Stride.Graphics.Font.RuntimeFontProvider.html": {
    "href": "api/Stride.Graphics.Font.RuntimeFontProvider.html",
    "title": "Class RuntimeFontProvider | Stride API",
    "summary": "Class RuntimeFontProvider Namespace Stride.Graphics.Font Assembly Stride.Graphics.dll Provides runtime registration and loading of fonts from the file system. public class RuntimeFontProvider Inheritance object RuntimeFontProvider Extension Methods UnsafeUtilities.As<T>(object?) Remarks This provider allows loading custom TrueType fonts (.ttf) at runtime without going through the content pipeline. Fonts registered through this provider are immediately available for use with LoadRuntimeFont(string, float, FontStyle). Memory Management: All registered fonts remain in memory for the lifetime of the application. There is no mechanism to unload individual fonts once registered. For applications with dynamic font requirements or memory constraints, consider the total memory footprint of all registered fonts. Methods IsRegistered(string, FontStyle) Checks if a font is registered for runtime loading. public bool IsRegistered(string fontName, FontStyle style = FontStyle.Regular) Parameters fontName string The font name. style FontStyle The font style. Returns bool True if registered, false otherwise. RegisterFont(string, string, FontStyle) Registers a font file for runtime loading. public void RegisterFont(string fontName, string filePath, FontStyle style = FontStyle.Regular) Parameters fontName string The name to use when loading the font (e.g., \"MyFont\"). filePath string The absolute or relative path to the .ttf file. style FontStyle The font style. Remarks Once registered, fonts are loaded into memory and cached for the lifetime of the font system. Individual fonts cannot be unregistered or unloaded - they remain in memory until the application exits or the font system is disposed. Attempting to register the same font name and style with a different file path will throw an exception. Exceptions ArgumentNullException Thrown when fontName is null or empty. FileNotFoundException Thrown when the font file does not exist. InvalidOperationException Thrown when attempting to register the same font name and style with a different file path."
  },
  "api/Stride.Graphics.Font.html": {
    "href": "api/Stride.Graphics.Font.html",
    "title": "Namespace Stride.Graphics.Font | Stride API",
    "summary": "Namespace Stride.Graphics.Font Classes FontDataFactory A font factory initializing only the data members of font. Used when creating a font in the only purpose use serializing on disk. FontHelper FontStyleExtensions Extension methods for type FontStyle. FontSystem The system managing the fonts. Glyph Description of a glyph (a single character) RuntimeFontProvider Provides runtime registration and loading of fonts from the file system. Structs Kerning Describes kerning information. Interfaces IFontFactory The interface to create and manage fonts. Enums FontAntiAliasMode Available antialias mode. FontStyle Type of a font."
  },
  "api/Stride.Graphics.FormatSupport.html": {
    "href": "api/Stride.Graphics.FormatSupport.html",
    "title": "Enum FormatSupport | Stride API",
    "summary": "Enum FormatSupport Namespace Stride.Graphics Assembly Stride.Graphics.dll Flags specifying which resources and features are supported for a given PixelFormat for a GraphicsDevice. [Flags] public enum FormatSupport Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BackBufferCast = 16777216 The format can be cast to a Back-Buffer. Blendable = 32768 The format supports blending as a Render Target. Buffer = 1 The format can be used as a Buffer resource. CastWithinBitLayout = 1048576 The format can be cast within a bit layout. CpuLockable = 131072 The format can be locked for CPU access. DecoderOutput = 134217728 The format can be used as a decoder output. DepthStencil = 65536 The format can be used as a Depth-Stencil Buffer. Display = 524288 The format can be used for display scan-out (to present to the screen). InputAssemblyIndexBuffer = 4 The format can be used as an Index Buffer in input assembly. InputAssemblyVertexBuffer = 2 The format can be used as a Vertex Buffer in input assembly. Mip = 4096 The format supports mipmaps. MipAutogen = 8192 The format supports automatic mipmap generation. MultisampleLoad = 4194304 The format supports multisample load operations. MultisampleRendertarget = 2097152 The format can be used as a multisample Render Target. MultisampleResolve = 262144 The format supports multisample resolve operations. None = 0 RenderTarget = 16384 The format can be used as a Render Target. ShaderGather = 8388608 The format supports gather operations in a Shader. ShaderGatherComparison = 67108864 The format supports gather comparison operations in a Shader. ShaderLoad = 256 The format can be loaded in a Shader. ShaderSample = 512 The format can be sampled in a Shader. ShaderSampleComparison = 1024 The format can be used for comparison sampling in a Shader. ShaderSampleMonoText = 2048 The format can be used for monochrome text sampling in a Shader. StreamOutputBuffer = 8 The format can be used as a Stream-output Buffer. Texture1D = 16 The format can be used as a 1D Texture. Texture2D = 32 The format can be used as a 2D Texture. Texture3D = 64 The format can be used as a 3D Texture. TextureCube = 128 The format can be used as a Cube Texture. TypedUnorderedAccessView = 33554432 The format supports typed Unordered Access Views. VideoEncoder = 1073741824 The format can be used as a video encoder. VideoProcessorInput = 536870912 The format can be used as a video processor input. VideoProcessorOutput = 268435456 The format can be used as a video processor output. Remarks For more information, see Features."
  },
  "api/Stride.Graphics.GeometricMeshData-1.html": {
    "href": "api/Stride.Graphics.GeometricMeshData-1.html",
    "title": "Class GeometricMeshData<T> | Stride API",
    "summary": "Class GeometricMeshData<T> Namespace Stride.Graphics Assembly Stride.Graphics.dll A geometric data. public class GeometricMeshData<T> : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder where T : struct, IVertex Type Parameters T Inheritance object DisposeBase ComponentBase GeometricMeshData<T> Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors GeometricMeshData(T[], int[], bool) public GeometricMeshData(T[] vertices, int[] indices, bool isLeftHanded) Parameters vertices T[] indices int[] isLeftHanded bool Properties Indices Gets or sets the indices. public int[] Indices { get; set; } Property Value int[] The indices. IsLeftHanded Gets or sets a value indicating whether this instance is left handed. public bool IsLeftHanded { get; set; } Property Value bool true if this instance is left handed; otherwise, false. Vertices Gets or sets the vertices. public T[] Vertices { get; set; } Property Value T[] The vertices."
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive-1.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive-1.html",
    "title": "Class GeometricPrimitive<T> | Stride API",
    "summary": "Class GeometricPrimitive<T> Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A geometric primitive used to draw a simple model built from a set of vertices and indices. public class GeometricPrimitive<T> : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder where T : unmanaged, IVertex Type Parameters T Inheritance object DisposeBase ComponentBase GeometricPrimitive<T> Implements IDisposable IComponent IReferencable ICollectorHolder Derived GeometricPrimitive Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) GeometricPrimitiveExtensions.ToMeshDraw<T>(GeometricPrimitive<T>) UnsafeUtilities.As<T>(object?) Constructors GeometricPrimitive(GraphicsDevice, GeometricMeshData<T>) Initializes a new instance of the GeometricPrimitive<T> class. public GeometricPrimitive(GraphicsDevice graphicsDevice, GeometricMeshData<T> geometryMesh) Parameters graphicsDevice GraphicsDevice The graphics device. geometryMesh GeometricMeshData<T> The geometry mesh. Exceptions InvalidOperationException Cannot generate more than 65535 indices on feature level HW <= 9.3 Fields GraphicsDevice The default graphics device. protected readonly GraphicsDevice GraphicsDevice Field Value GraphicsDevice IndexBuffer The index buffer used by this geometric primitive. public readonly Buffer IndexBuffer Field Value Buffer IsIndex32Bits True if the index buffer is a 32 bit index buffer. public readonly bool IsIndex32Bits Field Value bool PipelineState The pipeline state. public readonly MutablePipelineState PipelineState Field Value MutablePipelineState VertexBuffer The vertex buffer used by this geometric primitive. public readonly Buffer VertexBuffer Field Value Buffer VertexBufferBinding The input layout used by this geometric primitive (shared for all geometric primitive). protected readonly VertexBufferBinding VertexBufferBinding Field Value VertexBufferBinding Methods Draw(GraphicsContext, EffectInstance) Draws this GeometricPrimitive. public void Draw(GraphicsContext graphicsContext, EffectInstance effectInstance) Parameters graphicsContext GraphicsContext effectInstance EffectInstance"
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Capsule.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Capsule.html",
    "title": "Class GeometricPrimitive.Capsule | Stride API",
    "summary": "Class GeometricPrimitive.Capsule Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A sphere primitive. public static class GeometricPrimitive.Capsule Inheritance object GeometricPrimitive.Capsule Methods New(GraphicsDevice, float, float, int, float, float, bool) Creates a sphere primitive. public static GeometricPrimitive New(GraphicsDevice device, float length = 1, float radius = 0.5, int tessellation = 8, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters device GraphicsDevice The device. length float The length. That is the distance between the two sphere centers. radius float The radius of the capsule. tessellation int The tessellation. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricPrimitive A sphere primitive. Exceptions ArgumentOutOfRangeException tessellation;Must be >= 3 New(float, float, int, float, float, bool) Creates a sphere primitive. public static GeometricMeshData<VertexPositionNormalTexture> New(float length = 1, float radius = 0.5, int tessellation = 8, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters length float The length of the capsule. That is the distance between the two sphere centers. radius float The radius of the capsule. tessellation int The tessellation. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricMeshData<VertexPositionNormalTexture> A sphere primitive. Exceptions ArgumentOutOfRangeException tessellation;Must be >= 3"
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Cone.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Cone.html",
    "title": "Class GeometricPrimitive.Cone | Stride API",
    "summary": "Class GeometricPrimitive.Cone Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A cone with a circular base and rolled face. public static class GeometricPrimitive.Cone Inheritance object GeometricPrimitive.Cone Methods New(GraphicsDevice, float, float, int, float, float, bool) Creates a cone a circular base and a rolled face. public static GeometricPrimitive New(GraphicsDevice device, float radius = 0.5, float height = 1, int tessellation = 16, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters device GraphicsDevice The device. radius float The radius or the base height float The height of the cone tessellation int The number of segments composing the base uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricPrimitive A cone. New(float, float, int, float, float, bool) Creates a cone a circular base and a rolled face. public static GeometricMeshData<VertexPositionNormalTexture> New(float radius = 0.5, float height = 1, int tessellation = 16, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters radius float The radius or the base height float The height of the cone tessellation int The number of segments composing the base uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricMeshData<VertexPositionNormalTexture> A cone."
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Cube.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Cube.html",
    "title": "Class GeometricPrimitive.Cube | Stride API",
    "summary": "Class GeometricPrimitive.Cube Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A cube has six faces, each one pointing in a different direction. public static class GeometricPrimitive.Cube Inheritance object GeometricPrimitive.Cube Methods New(Vector3, float, float, bool) Creates a cube with six faces each one pointing in a different direction. public static GeometricMeshData<VertexPositionNormalTexture> New(Vector3 size, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters size Vector3 The size. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricMeshData<VertexPositionNormalTexture> A cube. New(GraphicsDevice, Vector3, float, float, bool) Creates a cube with six faces each one pointing in a different direction. public static GeometricPrimitive New(GraphicsDevice device, Vector3 size, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters device GraphicsDevice The device. size Vector3 The size. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricPrimitive A cube. New(GraphicsDevice, float, float, float, bool) Creates a cube with six faces each one pointing in a different direction. public static GeometricPrimitive New(GraphicsDevice device, float size = 1, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters device GraphicsDevice The device. size float The size. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricPrimitive A cube. New(float, float, float, bool) Creates a cube with six faces each one pointing in a different direction. public static GeometricMeshData<VertexPositionNormalTexture> New(float size = 1, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters size float The size. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricMeshData<VertexPositionNormalTexture> A cube."
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Cylinder.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Cylinder.html",
    "title": "Class GeometricPrimitive.Cylinder | Stride API",
    "summary": "Class GeometricPrimitive.Cylinder Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A Cylinder primitive. public static class GeometricPrimitive.Cylinder Inheritance object GeometricPrimitive.Cylinder Methods New(GraphicsDevice, float, float, int, float, float, bool) Creates a cylinder primitive. public static GeometricPrimitive New(GraphicsDevice device, float height = 1, float radius = 0.5, int tessellation = 32, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters device GraphicsDevice The device. height float The height. radius float The radius. tessellation int The tessellation. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricPrimitive A cylinder primitive. Exceptions ArgumentOutOfRangeException tessellation;tessellation must be >= 3 New(float, float, int, float, float, bool) Creates a cylinder primitive. public static GeometricMeshData<VertexPositionNormalTexture> New(float height = 1, float radius = 0.5, int tessellation = 32, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters height float The height. radius float The radius. tessellation int The tessellation. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricMeshData<VertexPositionNormalTexture> A cylinder primitive. Exceptions ArgumentOutOfRangeException tessellation;tessellation must be >= 3"
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Disc.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Disc.html",
    "title": "Class GeometricPrimitive.Disc | Stride API",
    "summary": "Class GeometricPrimitive.Disc Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A disc - a circular base, or a circular sector. public static class GeometricPrimitive.Disc Inheritance object GeometricPrimitive.Disc Methods New(GraphicsDevice, float, float, int, float, float, bool) Creates a disc. public static GeometricPrimitive New(GraphicsDevice device, float radius = 0.5, float angle = 6.2831855, int tessellation = 16, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters device GraphicsDevice The device. radius float The radius of the base angle float The angle of the circular sector tessellation int The number of segments composing the base uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricPrimitive A disc. New(float, float, int, float, float, bool) Creates a disc. public static GeometricMeshData<VertexPositionNormalTexture> New(float radius = 0.5, float sectorAngle = 6.2831855, int tessellation = 16, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters radius float The radius of the base sectorAngle float The angle of the circular sector tessellation int The number of segments composing the base uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricMeshData<VertexPositionNormalTexture> A cone."
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.GeoSphere.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.GeoSphere.html",
    "title": "Class GeometricPrimitive.GeoSphere | Stride API",
    "summary": "Class GeometricPrimitive.GeoSphere Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A Geodesic sphere. public static class GeometricPrimitive.GeoSphere Inheritance object GeometricPrimitive.GeoSphere Methods New(GraphicsDevice, float, int, float, float, bool) Creates a Geodesic sphere. public static GeometricPrimitive New(GraphicsDevice graphicsDevice, float radius = 0.5, int tessellation = 3, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters graphicsDevice GraphicsDevice The graphics device. radius float The radius. tessellation int The tessellation. uScale float vScale float toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricPrimitive A Geodesic sphere. New(float, int, float, float, bool) Creates a Geodesic sphere. public static GeometricMeshData<VertexPositionNormalTexture> New(float radius = 0.5, int tessellation = 3, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters radius float The radius. tessellation int The tessellation. uScale float vScale float toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricMeshData<VertexPositionNormalTexture> A Geodesic sphere."
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Plane.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Plane.html",
    "title": "Class GeometricPrimitive.Plane | Stride API",
    "summary": "Class GeometricPrimitive.Plane Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A plane primitive. public static class GeometricPrimitive.Plane Inheritance object GeometricPrimitive.Plane Methods New(GraphicsDevice, float, float, int, int, float, float, bool, bool, NormalDirection) Creates a Plane primitive on the X/Y plane with a normal equal to -UnitZ. public static GeometricPrimitive New(GraphicsDevice device, float sizeX = 1, float sizeY = 1, int tessellationX = 1, int tessellationY = 1, float uFactor = 1, float vFactor = 1, bool generateBackFace = false, bool toLeftHanded = false, NormalDirection normalDirection = NormalDirection.UpZ) Parameters device GraphicsDevice The device. sizeX float The size X. sizeY float The size Y. tessellationX int The tessellation, as the number of quads per X axis. tessellationY int The tessellation, as the number of quads per Y axis. uFactor float Scale U coordinates between 0 and the values of this parameter. vFactor float Scale V coordinates 0 and the values of this parameter. generateBackFace bool Add a back face to the plane toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. normalDirection NormalDirection The direction of the plane normal Returns GeometricPrimitive A Plane primitive. Exceptions ArgumentOutOfRangeException tessellation;tessellation must be > 0 New(float, float, int, int, float, float, bool, bool, NormalDirection) Creates a Plane primitive on the X/Y plane with a normal equal to -UnitZ. public static GeometricMeshData<VertexPositionNormalTexture> New(float sizeX = 1, float sizeY = 1, int tessellationX = 1, int tessellationY = 1, float uFactor = 1, float vFactor = 1, bool generateBackFace = false, bool toLeftHanded = false, NormalDirection normalDirection = NormalDirection.UpZ) Parameters sizeX float The size X. sizeY float The size Y. tessellationX int The tessellation, as the number of quads per X axis. tessellationY int The tessellation, as the number of quads per Y axis. uFactor float Scale U coordinates between 0 and the values of this parameter. vFactor float Scale V coordinates 0 and the values of this parameter. generateBackFace bool Add a back face to the plane toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. normalDirection NormalDirection The direction of the plane normal Returns GeometricMeshData<VertexPositionNormalTexture> A Plane primitive. Exceptions ArgumentOutOfRangeException tessellation;tessellation must be > 0"
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Sphere.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Sphere.html",
    "title": "Class GeometricPrimitive.Sphere | Stride API",
    "summary": "Class GeometricPrimitive.Sphere Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A sphere primitive. public static class GeometricPrimitive.Sphere Inheritance object GeometricPrimitive.Sphere Methods New(GraphicsDevice, float, int, float, float, bool) Creates a sphere primitive. public static GeometricPrimitive New(GraphicsDevice device, float radius = 0.5, int tessellation = 16, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters device GraphicsDevice The device. radius float The radius. tessellation int The tessellation. uScale float The u scale. vScale float The v scale. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricPrimitive A sphere primitive. Exceptions ArgumentOutOfRangeException tessellation;Must be >= 3 New(float, int, float, float, bool) Creates a sphere primitive. public static GeometricMeshData<VertexPositionNormalTexture> New(float radius = 0.5, int tessellation = 16, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters radius float The radius. tessellation int The tessellation. uScale float The u scale. vScale float The v scale. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricMeshData<VertexPositionNormalTexture> A sphere primitive. Exceptions ArgumentOutOfRangeException tessellation;Must be >= 3"
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Teapot.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Teapot.html",
    "title": "Class GeometricPrimitive.Teapot | Stride API",
    "summary": "Class GeometricPrimitive.Teapot Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A Teapot primitive. public static class GeometricPrimitive.Teapot Inheritance object GeometricPrimitive.Teapot Methods CubicInterpolate(ref Vector3, ref Vector3, ref Vector3, ref Vector3, float) public static Vector3 CubicInterpolate(ref Vector3 p1, ref Vector3 p2, ref Vector3 p3, ref Vector3 p4, float t) Parameters p1 Vector3 p2 Vector3 p3 Vector3 p4 Vector3 t float Returns Vector3 New(GraphicsDevice, float, int, float, float, bool) Creates a teapot primitive. public static GeometricPrimitive New(GraphicsDevice device, float size = 1, int tessellation = 8, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters device GraphicsDevice The device. size float The size. tessellation int The tessellation. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricPrimitive GeometricPrimitive. Exceptions ArgumentOutOfRangeException tessellation;tessellation must be > 0 New(float, int, float, float, bool) Creates a teapot primitive. public static GeometricMeshData<VertexPositionNormalTexture> New(float size = 1, int tessellation = 8, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters size float The size. tessellation int The tessellation. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricMeshData<VertexPositionNormalTexture> GeometricPrimitive. Exceptions ArgumentOutOfRangeException tessellation;tessellation must be > 0"
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Torus.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.Torus.html",
    "title": "Class GeometricPrimitive.Torus | Stride API",
    "summary": "Class GeometricPrimitive.Torus Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A Torus primitive. public static class GeometricPrimitive.Torus Inheritance object GeometricPrimitive.Torus Methods New(GraphicsDevice, float, float, int, float, float, bool) Creates a torus primitive. public static GeometricPrimitive New(GraphicsDevice device, float majorRadius = 0.5, float minorRadius = 0.16666, int tessellation = 32, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters device GraphicsDevice The device. majorRadius float The majorRadius. minorRadius float The minorRadius. tessellation int The tessellation. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricPrimitive A Torus primitive. Exceptions ArgumentOutOfRangeException tessellation;tessellation parameter out of range New(float, float, int, float, float, bool) Creates a torus primitive. public static GeometricMeshData<VertexPositionNormalTexture> New(float majorRadius = 0.5, float minorRadius = 0.16666, int tessellation = 32, float uScale = 1, float vScale = 1, bool toLeftHanded = false) Parameters majorRadius float The major radius of the torus. minorRadius float The minor radius of the torus. tessellation int The tessellation. uScale float Scale U coordinates between 0 and the values of this parameter. vScale float Scale V coordinates 0 and the values of this parameter. toLeftHanded bool if set to true vertices and indices will be transformed to left handed. Default is false. Returns GeometricMeshData<VertexPositionNormalTexture> A Torus primitive. Exceptions ArgumentOutOfRangeException tessellation;tessellation parameter out of range"
  },
  "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.GeometricPrimitive.html",
    "title": "Class GeometricPrimitive | Stride API",
    "summary": "Class GeometricPrimitive Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll A geometric primitive. Use GeometricPrimitive.Cube, GeometricPrimitive.Cylinder, GeometricPrimitive.GeoSphere, GeometricPrimitive.Plane, GeometricPrimitive.Sphere, GeometricPrimitive.Teapot, GeometricPrimitive.Torus. See Draw vertices to learn how to use it. public class GeometricPrimitive : GeometricPrimitive<VertexPositionNormalTexture>, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GeometricPrimitive<VertexPositionNormalTexture> GeometricPrimitive Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GeometricPrimitive<VertexPositionNormalTexture>.PipelineState GeometricPrimitive<VertexPositionNormalTexture>.IndexBuffer GeometricPrimitive<VertexPositionNormalTexture>.VertexBuffer GeometricPrimitive<VertexPositionNormalTexture>.GraphicsDevice GeometricPrimitive<VertexPositionNormalTexture>.VertexBufferBinding GeometricPrimitive<VertexPositionNormalTexture>.IsIndex32Bits GeometricPrimitive<VertexPositionNormalTexture>.Draw(GraphicsContext, EffectInstance) ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) GeometricPrimitiveExtensions.ToMeshDraw<T>(GeometricPrimitive<T>) UnsafeUtilities.As<T>(object?) Constructors GeometricPrimitive(GraphicsDevice, GeometricMeshData<VertexPositionNormalTexture>) public GeometricPrimitive(GraphicsDevice graphicsDevice, GeometricMeshData<VertexPositionNormalTexture> geometryMesh) Parameters graphicsDevice GraphicsDevice geometryMesh GeometricMeshData<VertexPositionNormalTexture>"
  },
  "api/Stride.Graphics.GeometricPrimitives.NormalDirection.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.NormalDirection.html",
    "title": "Enum NormalDirection | Stride API",
    "summary": "Enum NormalDirection Namespace Stride.Graphics.GeometricPrimitives Assembly Stride.Graphics.dll Enumerates the different possible direction of a plane normal. public enum NormalDirection Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields UpX = 2 UpY = 1 UpZ = 0"
  },
  "api/Stride.Graphics.GeometricPrimitives.html": {
    "href": "api/Stride.Graphics.GeometricPrimitives.html",
    "title": "Namespace Stride.Graphics.GeometricPrimitives | Stride API",
    "summary": "Namespace Stride.Graphics.GeometricPrimitives Classes GeometricPrimitive A geometric primitive. Use GeometricPrimitive.Cube, GeometricPrimitive.Cylinder, GeometricPrimitive.GeoSphere, GeometricPrimitive.Plane, GeometricPrimitive.Sphere, GeometricPrimitive.Teapot, GeometricPrimitive.Torus. See Draw vertices to learn how to use it. GeometricPrimitive.Capsule A sphere primitive. GeometricPrimitive.Cone A cone with a circular base and rolled face. GeometricPrimitive.Cube A cube has six faces, each one pointing in a different direction. GeometricPrimitive.Cylinder A Cylinder primitive. GeometricPrimitive.Disc A disc - a circular base, or a circular sector. GeometricPrimitive.GeoSphere A Geodesic sphere. GeometricPrimitive.Plane A plane primitive. GeometricPrimitive.Sphere A sphere primitive. GeometricPrimitive.Teapot A Teapot primitive. GeometricPrimitive.Torus A Torus primitive. GeometricPrimitive<T> A geometric primitive used to draw a simple model built from a set of vertices and indices. Enums NormalDirection Enumerates the different possible direction of a plane normal."
  },
  "api/Stride.Graphics.GraphicsAdapter.html": {
    "href": "api/Stride.Graphics.GraphicsAdapter.html",
    "title": "Class GraphicsAdapter | Stride API",
    "summary": "Class GraphicsAdapter Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents a display subsystem (including one or more GPUs, DACs and video memory). A display subsystem is often referred to as a video card, however, on some machines the display subsystem is part of the motherboard. public sealed class GraphicsAdapter : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsAdapter Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks To enumerate the GraphicsAdapters that are available in the system, see GraphicsAdapterFactory. Properties AdapterUid Gets the unique identifier of this GraphicsAdapter. public long AdapterUid { get; } Property Value long DedicatedSystemMemory Gets the amount of system RAM, in bytes, that is reserved exclusively for use by the adapter. This memory is not available to other applications. public ulong DedicatedSystemMemory { get; } Property Value ulong Remarks Common in systems with integrated or hybrid graphics solutions. It provides the GPU with guaranteed access to a portion of system memory for graphics tasks. DedicatedVideoMemory Gets the amount of memory, in bytes, on the graphics card (GPU) that is exclusively reserved for graphics operations. This is physical video memory dedicated to the adapter. public ulong DedicatedVideoMemory { get; } Property Value ulong Remarks Typically used for storing Textures, Frame Buffers, and other GPU-specific resources. High-performance discrete GPUs usually have a large amount of dedicated video memory. Description Gets the description of this adapter. public string Description { get; } Property Value string IsDefaultAdapter Determines if this GraphicsAdapter is the default adapter. public bool IsDefaultAdapter { get; } Property Value bool Outputs Gets the GraphicsOutputs attached to this adapter. public ReadOnlySpan<GraphicsOutput> Outputs { get; } Property Value ReadOnlySpan<GraphicsOutput> SharedSystemMemory Gets the amount of system RAM, in bytes, that can be shared between the adapter and the CPU. This memory is dynamically allocated and can be used by both graphics and general system tasks. public ulong SharedSystemMemory { get; } Property Value ulong Remarks Used when the GPU needs additional memory beyond its dedicated resources. Integrated GPUs rely heavily on shared system memory, while discrete GPUs use it as a fallback. VendorId Gets the vendor identifier of this adapter. public int VendorId { get; } Property Value int Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. IsProfileSupported(GraphicsProfile) Checks if the graphics adapter supports the requested profile. public bool IsProfileSupported(GraphicsProfile graphicsProfile) Parameters graphicsProfile GraphicsProfile The graphics profile to check. Returns bool true if the graphics profile is supported; false otherwise. ToString() Returns the description of this GraphicsAdapter. public override string ToString() Returns string"
  },
  "api/Stride.Graphics.GraphicsAdapterFactory.html": {
    "href": "api/Stride.Graphics.GraphicsAdapterFactory.html",
    "title": "Class GraphicsAdapterFactory | Stride API",
    "summary": "Class GraphicsAdapterFactory Namespace Stride.Graphics Assembly Stride.Graphics.dll Static factory for obtaining the available GraphicsAdapters in the system. public static class GraphicsAdapterFactory Inheritance object GraphicsAdapterFactory Properties Adapters Gets a collection of the available GraphicsAdapters on the system. public static ReadOnlySpan<GraphicsAdapter> Adapters { get; } Property Value ReadOnlySpan<GraphicsAdapter> DefaultAdapter Gets the default GraphicsAdapter. public static GraphicsAdapter DefaultAdapter { get; } Property Value GraphicsAdapter The default GraphicsAdapter. This property can be null. Methods Dispose() Dispose all statically cached adapter information in the GraphicsAdapterFactory. public static void Dispose() Initialize() Initializes the GraphicsAdapterFactory. On Desktop and WinRT, this is done statically. public static void Initialize() Reset() Dispose()s and Initialize()s the GraphicsAdapterFactory to re-initialize all adapters informations. public static void Reset()"
  },
  "api/Stride.Graphics.GraphicsContext.html": {
    "href": "api/Stride.Graphics.GraphicsContext.html",
    "title": "Class GraphicsContext | Stride API",
    "summary": "Class GraphicsContext Namespace Stride.Graphics Assembly Stride.Graphics.dll A graphics command context. You should usually stick to one per rendering thread. public class GraphicsContext Inheritance object GraphicsContext Extension Methods GraphicsDeviceExtensions.DrawQuad(GraphicsContext, EffectInstance) GraphicsDeviceExtensions.DrawTexture(GraphicsContext, Texture, Color4, BlendStateDescription?) GraphicsDeviceExtensions.DrawTexture(GraphicsContext, Texture, SamplerState, Color4, BlendStateDescription?) GraphicsDeviceExtensions.DrawTexture(GraphicsContext, Texture, SamplerState, BlendStateDescription?) GraphicsDeviceExtensions.DrawTexture(GraphicsContext, Texture, BlendStateDescription?) UnsafeUtilities.As<T>(object?) Constructors GraphicsContext(GraphicsDevice, GraphicsResourceAllocator, CommandList) public GraphicsContext(GraphicsDevice graphicsDevice, GraphicsResourceAllocator allocator = null, CommandList commandList = null) Parameters graphicsDevice GraphicsDevice allocator GraphicsResourceAllocator commandList CommandList Properties Allocator public GraphicsResourceAllocator Allocator { get; } Property Value GraphicsResourceAllocator CommandList Gets the current command list. public CommandList CommandList { get; set; } Property Value CommandList ResourceGroupAllocator Gets the current resource group allocator. public ResourceGroupAllocator ResourceGroupAllocator { get; } Property Value ResourceGroupAllocator"
  },
  "api/Stride.Graphics.GraphicsDevice.CreateSharedData-1.html": {
    "href": "api/Stride.Graphics.GraphicsDevice.CreateSharedData-1.html",
    "title": "Delegate GraphicsDevice.CreateSharedData<T> | Stride API",
    "summary": "Delegate GraphicsDevice.CreateSharedData<T> Namespace Stride.Graphics Assembly Stride.Graphics.dll A delegate called to create shareable data. public delegate T GraphicsDevice.CreateSharedData<out T>(GraphicsDevice device) where T : class, IDisposable Parameters device GraphicsDevice A delegate called to create shareable data. Returns T A new instance of the data to share. Type Parameters T Type of the data to create. Extension Methods UnsafeUtilities.As<T>(object?) Remarks Because this method is being called from a lock region, this method should not be time consuming."
  },
  "api/Stride.Graphics.GraphicsDevice.GraphicsDeviceInfoMessageHandler.html": {
    "href": "api/Stride.Graphics.GraphicsDevice.GraphicsDeviceInfoMessageHandler.html",
    "title": "Delegate GraphicsDevice.GraphicsDeviceInfoMessageHandler | Stride API",
    "summary": "Delegate GraphicsDevice.GraphicsDeviceInfoMessageHandler Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents a method that handles messages related to Graphics Device information. public delegate void GraphicsDevice.GraphicsDeviceInfoMessageHandler(ref readonly Message message, string? description) Parameters message Message A reference to the message containing graphics device information. This parameter is read-only. description string An optional description providing additional context about the message. Can be null. Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.GraphicsDevice.html": {
    "href": "api/Stride.Graphics.GraphicsDevice.html",
    "title": "Class GraphicsDevice | Stride API",
    "summary": "Class GraphicsDevice Namespace Stride.Graphics Assembly Stride.Graphics.dll A virtual adapter that can be used for creating GPU resources (buffers, textures, states, shaders, etc), and to manipulate CommandLists. public class GraphicsDevice : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsDevice Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) GraphicsDeviceExtensions.GetSharedWhiteTexture(GraphicsDevice) UnsafeUtilities.As<T>(object?) Constructors GraphicsDevice(GraphicsAdapter, GraphicsProfile[], DeviceCreationFlags, WindowHandle) Initializes a new instance of the GraphicsDevice class. protected GraphicsDevice(GraphicsAdapter adapter, GraphicsProfile[] graphicsProfiles, DeviceCreationFlags creationFlags, WindowHandle windowHandle) Parameters adapter GraphicsAdapter The physical Graphics Adapter for which to create a Graphics Device. graphicsProfiles GraphicsProfile[] A list of the graphics profiles to try, in order of preference. This parameter cannot be null, but if an empty array is passed, the default fallback profiles will be used. The default fallback profiles are: Level_11_0, Level_10_1, Level_10_0, Level_9_3, Level_9_2, and Level_9_1. creationFlags DeviceCreationFlags A combination of DeviceCreationFlags flags that determines how the Graphics Device will be created. windowHandle WindowHandle The WindowHandle specifying the window the Graphics Device will present to, or null if the device should not depend on a window. Exceptions ArgumentNullException adapter is null. ArgumentNullException graphicsProfiles is null. Fields FrameDrawCalls The number of draw calls made in the last frame. public uint FrameDrawCalls Field Value uint FrameTriangleCount The number of triangles drawn in the last frame. public uint FrameTriangleCount Field Value uint Properties Adapter Gets the physical Graphics Adapter the Graphics Device is attached to. public GraphicsAdapter Adapter { get; } Property Value GraphicsAdapter BuffersMemory Gets the amount of GPU memory currently allocated to Buffers, in bytes. public long BuffersMemory { get; } Property Value long ColorSpace Gets or sets the default color space of the Graphics Device. public ColorSpace ColorSpace { get; set; } Property Value ColorSpace Features Gets the features supported by the Graphics Device. public ref readonly GraphicsDeviceFeatures Features { get; } Property Value GraphicsDeviceFeatures GraphicsDeviceStatus Gets the current status of the Graphics Device. public GraphicsDeviceStatus GraphicsDeviceStatus { get; } Property Value GraphicsDeviceStatus IsDebugMode Gets a value indicating whether the Graphics Device is in \"Debug mode\". public bool IsDebugMode { get; } Property Value bool true if the Graphics Device is initialized in \"Debug mode\"; otherwise, false. IsDeferred Gets a value indicating wether the Graphics Device allows for concurrent building and deferred submission of CommandLists. public bool IsDeferred { get; } Property Value bool true if the Graphics Device allows deferred execution; otherwise, false. IsProfilingSupported Gets a value indicating whether the Graphics Device supports GPU markers and profiling. public bool IsProfilingSupported { get; } Property Value bool true if the Graphics Device allows profiling and creating GPU markers; otherwise, false. NativeDevice Gets the internal Direct3D 11 Device. public ComPtr<ID3D11Device> NativeDevice { get; } Property Value ComPtr<ID3D11Device> Remarks If the reference is going to be kept, use ComPtr<T>.AddRef() to increment the internal reference count, and Silk.NET.Core.Native.ComPtr<T>.Dispose() when no longer needed to release the object. Platform Gets the graphics platform (and the graphics API) the Graphics Device is using. public static GraphicsPlatform Platform { get; } Property Value GraphicsPlatform Presenter Gets or sets the current presenter used to display frames with the Graphics Device. public virtual GraphicsPresenter Presenter { get; set; } Property Value GraphicsPresenter RendererName Gets a string that identifies the underlying device used by the Graphics Device to render. public string RendererName { get; } Property Value string Remarks In the case of Direct3D and Vulkan, for example, this will return the name of the Graphics Adapter (e.g. \"nVIDIA GeForce RTX 2080\"). Other platforms may return a different string. SamplerStates Gets the factory that can be used to retrieve commonly used Sampler States. public SamplerStateFactory SamplerStates { get; } Property Value SamplerStateFactory TextureMemory Gets the amount of GPU memory currently allocated to Textures, in bytes. public long TextureMemory { get; } Property Value long TimestampFrequency Gets the tick frquency of timestamp queries, in hertz. public long TimestampFrequency { get; } Property Value long Methods Begin() Marks the Graphics Device Context as active on the current thread. public void Begin() Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. DestroyPlatformDevice() Releases the platform-specific Graphics Device and all its associated resources. protected void DestroyPlatformDevice() EnableProfile(bool) Enables or disables profiling. public void EnableProfile(bool enabledFlag) Parameters enabledFlag bool true to enable profiling; false to disable it. End() Marks the Graphics Device Context as inactive on the current thread. public void End() ExecuteCommandList(CompiledCommandList) Executes a Compiled Command List. public void ExecuteCommandList(CompiledCommandList commandList) Parameters commandList CompiledCommandList The Compiled Command List to execute. Remarks A Compiled Command List is a list of commands that have been recorded for execution on the Graphics Device at a later time. This method executes the commands in the list. This is known as deferred execution. Exceptions NotImplementedException Deferred CommandList execution is not implemented for Direct3D 11. ExecuteCommandLists(int, CompiledCommandList[]) Executes multiple Compiled Command Lists. public void ExecuteCommandLists(int count, CompiledCommandList[] commandLists) Parameters count int The number of Compiled Command Lists to execute. commandLists CompiledCommandList[] The Compiled Command Lists to execute. Remarks A Compiled Command List is a list of commands that have been recorded for execution on the Graphics Device at a later time. This method executes the commands in the list. This is known as deferred execution. Exceptions NotImplementedException Deferred CommandList execution is not implemented for Direct3D 11. GetOrCreateSharedData<T>(object, CreateSharedData<T>) Gets a shared data object for the Graphics Device context with a delegate to create the shared data if it is not present. public T GetOrCreateSharedData<T>(object key, GraphicsDevice.CreateSharedData<T> sharedDataCreator) where T : class, IDisposable Parameters key object The key that identifies the shared data. sharedDataCreator GraphicsDevice.CreateSharedData<T> A delegate that will be called to create the shared data. Returns T An instance of the shared data. It will be disposed by this GraphicsDevice instance. Type Parameters T Type of the shared data to get or create. New(DeviceCreationFlags, params GraphicsProfile[]) Creates a new GraphicsDevice. public static GraphicsDevice New(DeviceCreationFlags creationFlags = DeviceCreationFlags.None, params GraphicsProfile[] graphicsProfiles) Parameters creationFlags DeviceCreationFlags A combination of DeviceCreationFlags flags that determines how the Graphics Device will be created. graphicsProfiles GraphicsProfile[] A list of the graphics profiles to try, in order of preference. This parameter cannot be null, but if an empty array is passed, the default fallback profiles will be used. The default fallback profiles are: Level_11_0, Level_10_1, Level_10_0, Level_9_3, Level_9_2, and Level_9_1. Returns GraphicsDevice The new instance of GraphicsDevice. Exceptions ArgumentNullException graphicsProfiles is null. New(GraphicsAdapter, DeviceCreationFlags, params GraphicsProfile[]) Creates a new GraphicsDevice. public static GraphicsDevice New(GraphicsAdapter adapter, DeviceCreationFlags creationFlags = DeviceCreationFlags.None, params GraphicsProfile[] graphicsProfiles) Parameters adapter GraphicsAdapter The Graphics Adapter the new device will use, or null to use the system's default adapter. creationFlags DeviceCreationFlags A combination of DeviceCreationFlags flags that determines how the Graphics Device will be created. graphicsProfiles GraphicsProfile[] A list of the graphics profiles to try, in order of preference. This parameter cannot be null, but if an empty array is passed, the default fallback profiles will be used. The default fallback profiles are: Level_11_0, Level_10_1, Level_10_0, Level_9_3, Level_9_2, and Level_9_1. Returns GraphicsDevice The new instance of GraphicsDevice. Exceptions ArgumentNullException adapter is null. ArgumentNullException graphicsProfiles is null. New(GraphicsAdapter, DeviceCreationFlags, WindowHandle, params GraphicsProfile[]) Creates a new GraphicsDevice. public static GraphicsDevice New(GraphicsAdapter adapter, DeviceCreationFlags creationFlags = DeviceCreationFlags.None, WindowHandle windowHandle = null, params GraphicsProfile[] graphicsProfiles) Parameters adapter GraphicsAdapter The Graphics Adapter the new device will use, or null to use the system's default adapter. creationFlags DeviceCreationFlags A combination of DeviceCreationFlags flags that determines how the Graphics Device will be created. windowHandle WindowHandle The WindowHandle specifying the window the Graphics Device will present to, or null if the device should not depend on a window. graphicsProfiles GraphicsProfile[] A list of the graphics profiles to try, in order of preference. This parameter cannot be null, but if an empty array is passed, the default fallback profiles will be used. The default fallback profiles are: Level_11_0, Level_10_1, Level_10_0, Level_9_3, Level_9_2, and Level_9_1. Returns GraphicsDevice The new instance of GraphicsDevice. Exceptions ArgumentNullException adapter is null. ArgumentNullException graphicsProfiles is null. Recreate(GraphicsAdapter, GraphicsProfile[], DeviceCreationFlags, WindowHandle) Tries to create or reinitialize the Graphics Device. public void Recreate(GraphicsAdapter adapter, GraphicsProfile[] graphicsProfiles, DeviceCreationFlags creationFlags, WindowHandle windowHandle) Parameters adapter GraphicsAdapter The physical Graphics Adapter for which to recreate the Graphics Device. graphicsProfiles GraphicsProfile[] A list of the graphics profiles to try, in order of preference. This parameter cannot be null, but if an empty array is passed, the default fallback profiles will be used. The default fallback profiles are: Level_11_0, Level_10_1, Level_10_0, Level_9_3, Level_9_2, and Level_9_1. creationFlags DeviceCreationFlags A combination of DeviceCreationFlags flags that determines how the Graphics Device will be created. windowHandle WindowHandle The WindowHandle specifying the window the Graphics Device will present to, or null if the device should not depend on a window. Exceptions ArgumentNullException adapter is null. ArgumentNullException graphicsProfiles is null. SimulateReset() Sets the Graphics Device to simulate a situation in which the device is lost and then reset. public void SimulateReset() Events DeviceInfoQueueMessage Occurs when a message is received in the Graphics Device information queue. public event GraphicsDevice.GraphicsDeviceInfoMessageHandler? DeviceInfoQueueMessage Event Type GraphicsDevice.GraphicsDeviceInfoMessageHandler Remarks This event is triggered when the Direct3D 11 InfoQueue receives a message. This only happens if the Graphics Device was created with the Debug flag. Subscribe to this event to handle messages related to Graphics Device information. The event handler receives an argument of type Silk.NET.Direct3D11.Message, which contains the message data. Disposing Occurs while this component is disposing but before it is disposed. public event EventHandler<EventArgs> Disposing Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Graphics.GraphicsDeviceException.html": {
    "href": "api/Stride.Graphics.GraphicsDeviceException.html",
    "title": "Class GraphicsDeviceException | Stride API",
    "summary": "Class GraphicsDeviceException Namespace Stride.Graphics Assembly Stride.Graphics.dll An exception that is thrown when a Graphics Device operation fails. public class GraphicsDeviceException : GraphicsException, ISerializable Inheritance object Exception GraphicsException GraphicsDeviceException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState Extension Methods UnsafeUtilities.As<T>(object?) Constructors GraphicsDeviceException() Initializes a new instance of the GraphicsException class with a default message and status. public GraphicsDeviceException() GraphicsDeviceException(string?, GraphicsDeviceStatus) Initializes a new instance of the GraphicsException class with a specified error message and status. public GraphicsDeviceException(string? message, GraphicsDeviceStatus status = GraphicsDeviceStatus.Normal) Parameters message string The error message that explains the reason for the exception. Specify null to use the default message. status GraphicsDeviceStatus The status of the Graphics Device when the exception occurred. GraphicsDeviceException(string?, Exception?, GraphicsDeviceStatus) Initializes a new instance of the GraphicsException class with a specified error message, status, and a reference to the inner exception that is the cause of this exception. public GraphicsDeviceException(string? message, Exception? innerException, GraphicsDeviceStatus status = GraphicsDeviceStatus.Normal) Parameters message string The error message that explains the reason for the exception. Specify null to use the default message. innerException Exception The exception that is the cause of the current exception, or a null reference if no inner exception is specified. status GraphicsDeviceStatus Properties Status Gets the status of the Graphics Device when the exception occurred. public GraphicsDeviceStatus Status { get; } Property Value GraphicsDeviceStatus See Also GraphicsDevice"
  },
  "api/Stride.Graphics.GraphicsDeviceExtensions.html": {
    "href": "api/Stride.Graphics.GraphicsDeviceExtensions.html",
    "title": "Class GraphicsDeviceExtensions | Stride API",
    "summary": "Class GraphicsDeviceExtensions Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines a set of extension methods for the GraphicsDevice class. public static class GraphicsDeviceExtensions Inheritance object GraphicsDeviceExtensions Methods DrawQuad(CommandList) Draws a full-screen triangle with the currently applied Effect. public static void DrawQuad(this CommandList commandList) Parameters commandList CommandList The Command List to use to draw the full-screen triangle. DrawQuad(GraphicsContext, EffectInstance) Draws a full-screen triangle with the specified effect. public static void DrawQuad(this GraphicsContext graphicsContext, EffectInstance effectInstance) Parameters graphicsContext GraphicsContext The graphics context used for drawing. effectInstance EffectInstance The Effect instance to apply when drawing the triangle. Exceptions ArgumentNullException effectInstance is null. DrawTexture(GraphicsContext, Texture, Color4, BlendStateDescription?) Draws a full-screen tinted Texture using a LinearClamp Sampler. public static void DrawTexture(this GraphicsContext graphicsContext, Texture texture, Color4 color, BlendStateDescription? blendState = null) Parameters graphicsContext GraphicsContext The graphics context used for drawing. texture Texture The Texture to draw. color Color4 The color to tint the Texture with. The final color will be the texture color multiplied by the specified color. blendState BlendStateDescription? An optional Blend State to use when drawing the Texture. Specify null to use Default. DrawTexture(GraphicsContext, Texture, SamplerState, Color4, BlendStateDescription?) Draws a full-screen tinted Texture using the specified Sampler. public static void DrawTexture(this GraphicsContext graphicsContext, Texture texture, SamplerState samplerState, Color4 color, BlendStateDescription? blendState = null) Parameters graphicsContext GraphicsContext The graphics context used for drawing. texture Texture The Texture to draw. samplerState SamplerState The Sampler State to use for sampling the texture. Specify null to use the default Sampler State LinearClamp. color Color4 The color to tint the Texture with. The final color will be the texture color multiplied by the specified color. blendState BlendStateDescription? An optional Blend State to use when drawing the Texture. Specify null to use Default. DrawTexture(GraphicsContext, Texture, SamplerState, BlendStateDescription?) Draws a full-screen Texture using the specified sampler. public static void DrawTexture(this GraphicsContext graphicsContext, Texture texture, SamplerState samplerState, BlendStateDescription? blendState = null) Parameters graphicsContext GraphicsContext The graphics context used for drawing. texture Texture The Texture to draw. samplerState SamplerState The Sampler State to use for sampling the texture. Specify null to use the default Sampler State LinearClamp. blendState BlendStateDescription? An optional Blend State to use when drawing the Texture. Specify null to use Default. DrawTexture(GraphicsContext, Texture, BlendStateDescription?) Draws a full-screen Texture using a LinearClamp Sampler. public static void DrawTexture(this GraphicsContext graphicsContext, Texture texture, BlendStateDescription? blendState = null) Parameters graphicsContext GraphicsContext The graphics context used for drawing. texture Texture The Texture to draw. blendState BlendStateDescription? An optional Blend State to use when drawing the Texture. Specify null to use Default. GetSharedWhiteTexture(GraphicsDevice) Gets or creates a shared 2x2 white Texture for the specified Graphics Device. public static Texture GetSharedWhiteTexture(this GraphicsDevice device) Parameters device GraphicsDevice The Graphics Device for which to retrieve the shared white Texture. Returns Texture A Texture consisting of 2x2 white pixels."
  },
  "api/Stride.Graphics.GraphicsDeviceFeatures.FeaturesPerFormat.html": {
    "href": "api/Stride.Graphics.GraphicsDeviceFeatures.FeaturesPerFormat.html",
    "title": "Struct GraphicsDeviceFeatures.FeaturesPerFormat | Stride API",
    "summary": "Struct GraphicsDeviceFeatures.FeaturesPerFormat Namespace Stride.Graphics Assembly Stride.Graphics.dll Contains information about the features a GraphicsDevice supports for a particular PixelFormat. public readonly struct GraphicsDeviceFeatures.FeaturesPerFormat Inherited Members ValueType.Equals(object) ValueType.GetHashCode() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ComputeShaderFormatSupport The unordered resource support options for a Compute Shader resource using the Format. public readonly ComputeShaderFormatSupport ComputeShaderFormatSupport Field Value ComputeShaderFormatSupport Format The pixel format. public readonly PixelFormat Format Field Value PixelFormat FormatSupport The support flags for a particular Format. public readonly FormatSupport FormatSupport Field Value FormatSupport MultisampleCountMax The maximum sample count when multisampling for a particular Format. public readonly MultisampleCount MultisampleCountMax Field Value MultisampleCount Methods ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name."
  },
  "api/Stride.Graphics.GraphicsDeviceFeatures.html": {
    "href": "api/Stride.Graphics.GraphicsDeviceFeatures.html",
    "title": "Struct GraphicsDeviceFeatures | Stride API",
    "summary": "Struct GraphicsDeviceFeatures Namespace Stride.Graphics Assembly Stride.Graphics.dll Contains information about the general features supported by a GraphicsDevice, as well as supported features specific to a particular pixel format or data format. public struct GraphicsDeviceFeatures Inherited Members ValueType.Equals(object) ValueType.GetHashCode() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks To obtain information about the supported features for a particular format, use the indexer. Fields CurrentProfile The current profile of the current GraphicsDevice, which determines its supported features. public readonly GraphicsProfile CurrentProfile Field Value GraphicsProfile Remarks This may differ from RequestedProfile if the GraphicsDevice could not be created with that requested profile. This one represents the closest supported profile. See Also GraphicsProfile HasComputeShaders A value indicating if the GraphicsDevice supports Compute Shaders, unordered access on Structured Buffers, and Raw Structured Buffers. public readonly bool HasComputeShaders Field Value bool See Also Buffer.Structured Buffer.Raw HasDepthAsReadOnlyRT A value indicating if the Depth Buffer can directly be used as a read-only Render Target. public readonly bool HasDepthAsReadOnlyRT Field Value bool See Also Texture HasDepthAsSRV A value indicating if the Depth Buffer can also be used as a Shader Resource View and bound for shader passes. public readonly bool HasDepthAsSRV Field Value bool See Also Texture HasDoublePrecision A value indicating if the GraphicsDevice supports double precision operations in shaders. public readonly bool HasDoublePrecision Field Value bool HasDriverCommandLists A value indicating if the GraphicsDevice supports Command Lists in multi-threading scenarios. public readonly bool HasDriverCommandLists Field Value bool See Also CommandList HasMultiSampleDepthAsSRV A value indicating if a multi-sampled Depth Buffer can directly be used as a Shader Resource View. public readonly bool HasMultiSampleDepthAsSRV Field Value bool See Also Texture HasMultiThreadingConcurrentResources A value indicating if the GraphicsDevice supports concurrent Resources in multi-threading scenarios. public readonly bool HasMultiThreadingConcurrentResources Field Value bool HasResourceRenaming A value indicating if the graphics API supports resource renaming (with either WriteDiscard or UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) with full size). public readonly bool HasResourceRenaming Field Value bool HasSRgb A value indicating if the GraphicsDevice supports sRGB Textures and Render Targets. public readonly bool HasSRgb Field Value bool See Also Texture MaximumMipLevels The maximum number of miplevels a Texture can have. public readonly int MaximumMipLevels Field Value int See Also Texture MaximumTexture1DArraySize The maximum number of slices/array elements for a one-dimensional (1D) Texture Array. public readonly int MaximumTexture1DArraySize Field Value int See Also Texture MaximumTexture1DSize The maximum size in texels for a one-dimensional (1D) Texture. public readonly int MaximumTexture1DSize Field Value int See Also Texture MaximumTexture2DArraySize The maximum number of slices/array elements for a two-dimensional (2D) Texture Array. public readonly int MaximumTexture2DArraySize Field Value int See Also Texture MaximumTexture2DSize The maximum size (width or height) in texels for a two-dimensional (2D) Texture. public readonly int MaximumTexture2DSize Field Value int See Also Texture MaximumTexture3DSize The maximum size (width, height, or depth) in texels for a three-dimensional (3D) Texture. public readonly int MaximumTexture3DSize Field Value int See Also Texture MaximumTextureCubeSize The maximum size (width or height) in texels for a Texture Cube. public readonly int MaximumTextureCubeSize Field Value int See Also Texture RequestedProfile The requested profile when the GraphicsDevice was created. public readonly GraphicsProfile RequestedProfile Field Value GraphicsProfile See Also GraphicsProfile ResourceSizeInMegabytes The maximum size of a resource, in megabytes. public readonly int ResourceSizeInMegabytes Field Value int See Also GraphicsResource Properties this[PixelFormat] Queries the features the GraphicsDevice supports for the specified PixelFormat. public readonly GraphicsDeviceFeatures.FeaturesPerFormat this[PixelFormat pixelFormat] { get; } Parameters pixelFormat PixelFormat The pixel format. Property Value GraphicsDeviceFeatures.FeaturesPerFormat A GraphicsDeviceFeatures.FeaturesPerFormat structure indicating the features supported for pixelFormat. Methods ToString() Returns the fully qualified type name of this instance. public override readonly string ToString() Returns string The fully qualified type name."
  },
  "api/Stride.Graphics.GraphicsDeviceServiceLocal.html": {
    "href": "api/Stride.Graphics.GraphicsDeviceServiceLocal.html",
    "title": "Class GraphicsDeviceServiceLocal | Stride API",
    "summary": "Class GraphicsDeviceServiceLocal Namespace Stride.Graphics Assembly Stride.Graphics.dll A default simple implementation of IGraphicsDeviceService that is used by some systems that only need quick access to the GraphicsDevice. public class GraphicsDeviceServiceLocal : IGraphicsDeviceService Inheritance object GraphicsDeviceServiceLocal Implements IGraphicsDeviceService Extension Methods UnsafeUtilities.As<T>(object?) Remarks For a full-fledged implementation of IGraphicsDeviceService that manages correctly the device life-cycle and provides many more features, see GraphicsDeviceManager in the Stride.Games namespace. Constructors GraphicsDeviceServiceLocal(IServiceRegistry, GraphicsDevice) Initializes a new instance of the GraphicsDeviceServiceLocal class. public GraphicsDeviceServiceLocal(IServiceRegistry registry, GraphicsDevice graphicsDevice) Parameters registry IServiceRegistry The registry of registered services. graphicsDevice GraphicsDevice The graphics device. GraphicsDeviceServiceLocal(GraphicsDevice) Initializes a new instance of the GraphicsDeviceServiceLocal class. public GraphicsDeviceServiceLocal(GraphicsDevice graphicsDevice) Parameters graphicsDevice GraphicsDevice The graphics device. Properties GraphicsDevice Gets the current Graphcs Device. public GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice Events DeviceCreated Occurs when a device is created. public event EventHandler<EventArgs> DeviceCreated Event Type EventHandler<EventArgs> DeviceDisposing Occurs when a device is being disposed. public event EventHandler<EventArgs> DeviceDisposing Event Type EventHandler<EventArgs> DeviceReset Occurs when a device has been reset. public event EventHandler<EventArgs> DeviceReset Event Type EventHandler<EventArgs> DeviceResetting Occurs when a device is going to be reset. public event EventHandler<EventArgs> DeviceResetting Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Graphics.GraphicsDeviceStatus.html": {
    "href": "api/Stride.Graphics.GraphicsDeviceStatus.html",
    "title": "Enum GraphicsDeviceStatus | Stride API",
    "summary": "Enum GraphicsDeviceStatus Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes the current status of a GraphicsDevice. public enum GraphicsDeviceStatus Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Hung = 2 The application's Graphics Device failed due to badly formed commands sent by the application. This is an design-time issue that should be investigated and fixed. InternalError = 4 The driver encountered a problem and was put into the Graphics Device removed state. InvalidCall = 5 The application provided invalid parameter data; this must be debugged and fixed before the application is released. Normal = 0 The Graphics Device is running normally. Removed = 1 The video card has been physically removed from the system, or a driver upgrade for the video card has occurred. The application should destroy and recreate the Graphics Device. Reset = 3 The Graphics Device failed due to a badly formed command. This is a run-time issue; The application should destroy and recreate the Graphics Device."
  },
  "api/Stride.Graphics.GraphicsException.html": {
    "href": "api/Stride.Graphics.GraphicsException.html",
    "title": "Class GraphicsException | Stride API",
    "summary": "Class GraphicsException Namespace Stride.Graphics Assembly Stride.Graphics.dll An exception that is thrown when a graphics operation fails. public class GraphicsException : Exception, ISerializable Inheritance object Exception GraphicsException Implements ISerializable Derived GraphicsDeviceException Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState Extension Methods UnsafeUtilities.As<T>(object?) Remarks This is the base class for all exceptions related to graphics operations. Look at more specific exceptions to better understand the nature of the error. Constructors GraphicsException() Initializes a new instance of the GraphicsException class with a default message. public GraphicsException() GraphicsException(string) Initializes a new instance of the GraphicsException class with a specified error message. public GraphicsException(string message) Parameters message string The error message that explains the reason for the exception. GraphicsException(string?, Exception?) Initializes a new instance of the GraphicsException class with a specified error message and a reference to the inner exception that is the cause of this exception. public GraphicsException(string? message, Exception? innerException) Parameters message string The error message that explains the reason for the exception. Specify null to use the default message. innerException Exception The exception that is the cause of the current exception, or a null reference if no inner exception is specified."
  },
  "api/Stride.Graphics.GraphicsMarshal.html": {
    "href": "api/Stride.Graphics.GraphicsMarshal.html",
    "title": "Class GraphicsMarshal | Stride API",
    "summary": "Class GraphicsMarshal Namespace Stride.Graphics Assembly Stride.Graphics.dll An unsafe class that provides a set of methods to access the underlying native DXGI and Direct3D devices and resources from its Stride counterparts. public static class GraphicsMarshal Inheritance object GraphicsMarshal Methods CreateTextureFromNative(GraphicsDevice, ID3D11Texture2D*, bool, bool) Creates a Texture from a Direct3D 11 texture. public static Texture CreateTextureFromNative(GraphicsDevice device, ID3D11Texture2D* dxTexture2D, bool takeOwnership, bool isSRgb = false) Parameters device GraphicsDevice The GraphicsDevice in use. dxTexture2D ID3D11Texture2D* The Direct3D 11 texture. takeOwnership bool false to call Silk.NET.Direct3D11.ID3D11Resource.AddRef() on the texture; true to not call it, effectively taking ownership of the texture. isSRgb bool A value indicating whether to set the format of the Texture to sRGB. Returns Texture A Stride Texture. GetNativeDevice(GraphicsDevice) Gets the underlying Direct3D 11 native device. public static ComPtr<ID3D11Device> GetNativeDevice(GraphicsDevice device) Parameters device GraphicsDevice The Stride Graphics Device. Returns ComPtr<ID3D11Device> A COM pointer to a Silk.NET.Direct3D11.ID3D11Device instance representing the native Direct3D 11 device. GetNativeDeviceContext(GraphicsDevice) Gets the underlying Direct3D 11 native device context. public static ComPtr<ID3D11DeviceContext> GetNativeDeviceContext(GraphicsDevice device) Parameters device GraphicsDevice The Stride Graphics Device. Returns ComPtr<ID3D11DeviceContext> A COM pointer to a Silk.NET.Direct3D11.ID3D11DeviceContext instance representing the native Direct3D 11 command queue. GetNativeRenderTargetView(Texture) Gets the underlying Direct3D 11 native render target view. public static ComPtr<ID3D11RenderTargetView> GetNativeRenderTargetView(Texture texture) Parameters texture Texture Returns ComPtr<ID3D11RenderTargetView> A COM pointer to a Silk.NET.Direct3D11.ID3D11RenderTargetView instance representing the native Direct3D 11 render target view on the Texture. GetNativeResource(GraphicsResource) Gets the underlying Direct3D 11 native resource. public static ComPtr<ID3D11Resource> GetNativeResource(GraphicsResource resource) Parameters resource GraphicsResource The Stride Graphics Resource. Returns ComPtr<ID3D11Resource> A COM pointer to a Silk.NET.Direct3D11.ID3D11Resource instance representing the native Direct3D 11 resource. GetNativeShaderResourceView(GraphicsResource) Gets the underlying Direct3D 11 native shader resource view. public static ComPtr<ID3D11ShaderResourceView> GetNativeShaderResourceView(GraphicsResource resource) Parameters resource GraphicsResource The Stride Graphics Resource. Returns ComPtr<ID3D11ShaderResourceView> A COM pointer to a Silk.NET.Direct3D11.ID3D11ShaderResourceView instance representing the native Direct3D 11 shader resource view on the resource. GetNativeSwapChain(GraphicsPresenter) Gets the underlying DXGI swap-chain. public static ComPtr<IDXGISwapChain1>? GetNativeSwapChain(GraphicsPresenter presenter) Parameters presenter GraphicsPresenter The Stride Graphics Presenter. Returns ComPtr<IDXGISwapChain1>? A COM pointer to a Silk.NET.DXGI.IDXGISwapChain instance representing the native DirectX swap-chain, or null if the presenter does not encapsulate a DXGI swap-chain."
  },
  "api/Stride.Graphics.GraphicsOutput.html": {
    "href": "api/Stride.Graphics.GraphicsOutput.html",
    "title": "Class GraphicsOutput | Stride API",
    "summary": "Class GraphicsOutput Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents an output (such as a monitor) attached to a GraphicsAdapter. public sealed class GraphicsOutput : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsOutput Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties Adapter Gets the GraphicsAdapter this output is attached to. public GraphicsAdapter Adapter { get; } Property Value GraphicsAdapter BitsPerChannel Gets the number of bits per color channel for the active wire format of the display attached to this output. public int BitsPerChannel { get; } Property Value int BluePrimary Gets the blue color primary, in XY coordinates, of the display attached to this output. public Vector2 BluePrimary { get; } Property Value Vector2 ColorSpace Gets the advanced color capabilities of the display attached to this output. public ColorSpaceType ColorSpace { get; } Property Value ColorSpaceType The advanced color space of the output. Specifically, whether it's capable of reproducing color and luminance values outside of the sRGB color space. A value of Rgb_Full_G22_None_P709 indicates that the display is limited to SDR / sRGB. A value of Rgb_Full_G2084_None_P2020 indicates that the display supports advanced color capabilities. CurrentDisplayMode Gets the current display mode of this GraphicsOutput. public DisplayMode? CurrentDisplayMode { get; } Property Value DisplayMode? Description Gets a description or friendly name of the output. public string Description { get; } Property Value string DesktopBounds Gets the desktop bounds of the current GraphicsOutput. public Rectangle DesktopBounds { get; } Property Value Rectangle GreenPrimary Gets the green color primary, in XY coordinates, of the display attached to this output. public Vector2 GreenPrimary { get; } Property Value Vector2 IsAttached Gets a value indicating whether the output (monitor) is currently attached to the Windows desktop. public bool IsAttached { get; } Property Value bool true if the output (monitor) is part of the visible workspace, meaning the device is connected and has valid desktop coordinates; false if it is known but disconnected or disabled, and thus not part of the desktop. MaxFullFrameLuminance Gets the maximum luminance, in nits, that the display attached to this output is capable of rendering when a color fills the entire area of the panel. public float MaxFullFrameLuminance { get; } Property Value float Remarks Content should not exceed this value across the entire panel for optimal rendering. MaxLuminance Gets the maximum luminance, in nits, that the display attached to this output is capable of rendering. public float MaxLuminance { get; } Property Value float Remarks This value is likely only valid for a small area of the panel. Content should not exceed this maximum value for optimal rendering. MinLuminance Gets the minimum luminance, in nits, that the display attached to this output is capable of rendering. public float MinLuminance { get; } Property Value float Remarks Content should not exceed this minimum value for optimal rendering. MonitorHandle Gets the handle of the monitor associated with this GraphicsOutput. public nint MonitorHandle { get; } Property Value nint RedPrimary Gets the red color primary, in XY coordinates, of the display attached to this output. public Vector2 RedPrimary { get; } Property Value Vector2 Rotation Gets the rotation of the display attached to this output. public DisplayRotation Rotation { get; } Property Value DisplayRotation Remarks This value indicates how the Back-Buffers should be rotated to fit the physical rotation of a monitor. SupportedDisplayModes Returns a collection of the supported display modes for this GraphicsOutput. public ReadOnlySpan<DisplayMode> SupportedDisplayModes { get; } Property Value ReadOnlySpan<DisplayMode> SupportsHDR Gets a value indicating whether High Dynamic Range (HDR) is supported by the current device or display configuration. public bool SupportsHDR { get; } Property Value bool WhitePoint Gets the white point, in XY coordinates, of the display attached to this output. public Vector2 WhitePoint { get; } Property Value Vector2 Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. FindClosestMatchingDisplayMode(ReadOnlySpan<GraphicsProfile>, DisplayMode) Finds the display mode that most closely matches the requested display mode. public DisplayMode FindClosestMatchingDisplayMode(ReadOnlySpan<GraphicsProfile> targetProfiles, DisplayMode modeToMatch) Parameters targetProfiles ReadOnlySpan<GraphicsProfile> The target profiles, as available formats differ depending on the graphics profile. modeToMatch DisplayMode The desired display mode. Members of DisplayMode can be unspecified indicating no preference for that member. A value of 0 for Width or Height indicates the value is unspecified. If either Width or Height are 0, both must be 0. A numerator and denominator of 0 in RefreshRate indicate it is unspecified. A value of None for DisplayMode indicates the pixel format is unspecified. Returns DisplayMode Returns the mode that most closely matches modeToMatch. Remarks Direct3D devices require UNORM pixel formats. Unspecified fields are lower priority than specified fields and will be resolved later than specified fields. Similarly ranked fields (i.e. all specified, or all unspecified, etc.) are resolved in the following order: Format, Width, Height, RefreshRate. When determining the closest value for a particular field, previously matched fields are used to filter the display mode list choices, and other fields are ignored. For example, when matching resolution, the display mode list will have already been filtered by a certain pixel format, while the refresh rate is ignored. This ordering doesn't define the absolute ordering for every usage scenario of FindClosestMatchingDisplayMode(ReadOnlySpan<GraphicsProfile>, DisplayMode), because the application can choose some values initially, effectively changing the order that fields are chosen. Fields of the display mode are matched one at a time, generally in a specified order. If a field is unspecified, this method gravitates toward the values for the desktop related to this output. If this output is not part of the desktop, then the default desktop output is used to find values. If an application uses a fully unspecified display mode, FindClosestMatchingDisplayMode(ReadOnlySpan<GraphicsProfile>, DisplayMode) will typically return a display mode that matches the desktop settings for this output. Exceptions ArgumentNullException targetProfiles is empty and does not specify any graphics profile to test."
  },
  "api/Stride.Graphics.GraphicsPlatform.html": {
    "href": "api/Stride.Graphics.GraphicsPlatform.html",
    "title": "Enum GraphicsPlatform | Stride API",
    "summary": "Enum GraphicsPlatform Namespace Stride.Graphics Assembly Stride.dll The graphics platform. [DataContract(\"GraphicsPlatform\")] public enum GraphicsPlatform Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Direct3D11 = 1 HLSL Direct3D Shader. Direct3D12 = 2 HLSL Direct3D Shader. Null = 0 The Null Shader. OpenGL = 3 GLSL OpenGL Shader. OpenGLES = 4 GLSL OpenGL ES Shader. Vulkan = 5 GLSL/SPIR-V Shader."
  },
  "api/Stride.Graphics.GraphicsPresenter.html": {
    "href": "api/Stride.Graphics.GraphicsPresenter.html",
    "title": "Class GraphicsPresenter | Stride API",
    "summary": "Class GraphicsPresenter Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents an abstraction over a Swap-Chain. public abstract class GraphicsPresenter : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsPresenter Implements IDisposable IComponent IReferencable ICollectorHolder Derived RenderTargetGraphicsPresenter SwapChainGraphicsPresenter Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks A Swap-Chain is a collection of same-sized buffers (one front-buffer, one or more -usually one- Back-Buffer, and an optional Depth-Stencil Buffer) that are used to present the final rendered image to the screen. In order to create a new GraphicsPresenter, a GraphicsDevice should have been initialized first. Constructors GraphicsPresenter(GraphicsDevice, PresentationParameters) Initializes a new instance of the GraphicsPresenter class. protected GraphicsPresenter(GraphicsDevice device, PresentationParameters presentationParameters) Parameters device GraphicsDevice The Graphics Device. presentationParameters PresentationParameters The parameters describing the buffers the device will present to. Exceptions ArgumentNullException device is null. ArgumentNullException presentationParameters is null. NotSupportedException The Depth-Stencil format specified is not supported. Properties BackBuffer Gets the default Back-Buffer for the Graphics Presenter. public abstract Texture BackBuffer { get; } Property Value Texture The Texture where rendering will happen, which will then be presented to the front-buffer. DepthStencilBuffer Gets the default Depth-Stencil Buffer for the Graphics Presenter. public Texture DepthStencilBuffer { get; protected set; } Property Value Texture The Texture where depth (Z) values will be written, and optionally also stencil masking values. Remarks If the Depth-Stencil Buffer is the one created by this Graphics Presenter, it is attached to it its lifetime is managed by this instance. If a derived class needs to set a custom Depth-Stencil Buffer, it should first call DetachDepthStencilBuffer() to release the current one. Description Gets the parameters describing the Resources and behavior of the Graphics Presenter. public PresentationParameters Description { get; } Property Value PresentationParameters GraphicsDevice Gets the Graphics Device the Graphics Presenter is associated to. public GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice The Graphics Device that will be used for managing the Buffers and Textures, and starting/ending a frame. IsFullScreen Gets or sets a value indicating if the Graphics Presenter is in full-screen mode. public abstract bool IsFullScreen { get; set; } Property Value bool A value indicating whether the presentation will be in full screen. true if the presentation will be in full screen. false if the presentation will be in a window. Remarks This property is only valid on desktop Windows. It has no effect on UWP. NativePresenter Gets the underlying native presenter. public abstract object NativePresenter { get; } Property Value object The native presenter. Depending on platform, for exmaple, it can be a Silk.NET.DXGI.IDXGISwapChain or Silk.NET.DXGI.IDXGISwapChain1 or null. PresentInterval Gets or sets the presentation interval of the Graphics Presenter. public PresentInterval PresentInterval { get; set; } Property Value PresentInterval A value of PresentInterval indicating how often the display should be updated. The default value is Default, which is to wait for one vertical blanking. Methods BeginDraw(CommandList) Marks the beginning of a frame that will be presented later by the Graphics Presenter. public virtual void BeginDraw(CommandList commandList) Parameters commandList CommandList The Command List where rendering commands will be registered. Remarks When overriden in a derived class, this method should prepare the Graphics Presenter to receive graphics commands to be executed at the beginning of the current frame. CreateDepthStencilBuffer() Creates the Depth-Stencil Buffer. protected virtual void CreateDepthStencilBuffer() Remarks When overriden in a derived class, this method allows to create a custom Depth-Stencil Buffer when initializing the Graphics Presenter. By default, if a depth format has been specified, a Depth-Stencil Buffer is created with the same size as the Back-Buffer. Exceptions NotSupportedException The Depth-Stencil format specified is not supported. Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. DestroyChildrenTextures(Texture) Calls OnDestroyed(bool) for all children of the specified Texture. protected List<Texture> DestroyChildrenTextures(Texture parentTexture) Parameters parentTexture Texture The parent Texture whose children are to be destroyed. Returns List<Texture> A list of the children Textures which were destroyed. DetachDepthStencilBuffer() Detaches the current Depth-Stencil Buffer from the Graphics Presenter. protected void DetachDepthStencilBuffer() Remarks If DepthStencilBuffer is the Depth-Stencil Buffer created by this Graphics Presenter, it is attached to it its lifetime is managed by this instance. If a derived class needs to set a custom Depth-Stencil Buffer, it should first call this method to detach the current one. EndDraw(CommandList, bool) Marks the end of a frame that will be presented later by the Graphics Presenter. public virtual void EndDraw(CommandList commandList, bool present) Parameters commandList CommandList The Command List where rendering commands will be registered. present bool A value indicating whether the frame will be presented, i.e. if the Back-Buffer will be shown to the screen. Remarks When overriden in a derived class, this method should prepare the Graphics Presenter to receive graphics commands to be executed at the end of the current frame. OnDestroyed(bool) Called when the Graphics Presenter has been destroyed. protected virtual void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the resources used by the Graphics Presenter should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). Remarks When overriden in a derived class, this method allows to perform additional cleanup and release of associated resources. OnRecreated() Called when the Graphics Presenter has been reinitialized. public virtual void OnRecreated() Remarks When overriden in a derived class, this method allows to perform additional resource creation, configuration, and initialization. Exceptions InvalidOperationException DeviceWindowHandle is null or the Handle is invalid or zero. Present() Presents the Back-Buffer to the screen. public abstract void Present() Exceptions GraphicsDeviceException An unexpected error occurred while presenting. Check the status of the Graphics Device for more information (Status). ProcessPresentationParameters() Processes and adjusts the Presentation Parameters before initializing the Graphics Presenter. protected virtual void ProcessPresentationParameters() Remarks When overriden in a derived class, this method allows to modify the specified Presentation Parameters before initializing the internal buffers and resources. Resize(int, int, PixelFormat) Resizes the Back-Buffer and the Depth-Stencil Buffer. public void Resize(int width, int height, PixelFormat format) Parameters width int The new width of the buffers of the Graphics Presenter, in pixels. height int The new height of the buffers of the Graphics Presenter, in pixels. format PixelFormat The new preferred pixel format for the Back-Buffer. The specified format may be overriden depending on Graphics Device features and configuration (for example, to use sRGB when appropriate). Exceptions NotSupportedException The specified pixel format or size is not supported by the Graphics Device. ResizeBackBuffer(int, int, PixelFormat) Resizes the Back-Buffer. protected abstract void ResizeBackBuffer(int width, int height, PixelFormat format) Parameters width int The new width of the Back-Buffer, in pixels. height int The new height of the Back-Buffer, in pixels. format PixelFormat The new pixel format for the Back-Buffer. Remarks When implementing this method, the derived class should resize the Back-Buffer to the specified size and format. Exceptions NotSupportedException The specified pixel format or size is not supported by the Graphics Device. ResizeDepthStencilBuffer(int, int, PixelFormat) Resizes the Depth-Stencil Buffer. protected abstract void ResizeDepthStencilBuffer(int width, int height, PixelFormat format) Parameters width int The new width of the Depth-Stencil Buffer, in pixels. height int The new height of the Depth-Stencil Buffer, in pixels. format PixelFormat The new pixel format for the Depth-Stencil Buffer. Remarks When implementing this method, the derived class should resize the Depth-Stencil Buffer to the specified size and format. Exceptions NotSupportedException The specified depth format or size is not supported by the Graphics Device. SetOutputColorSpace(ColorSpaceType, PixelFormat) Sets the output color space of the Graphics Presenter and the pixel format to use for the Back-Buffer. public void SetOutputColorSpace(ColorSpaceType colorSpace, PixelFormat format) Parameters colorSpace ColorSpaceType The output color space the Graphics Presenter should use. format PixelFormat The pixel format to use for the Back-Buffer. Remarks The output color space can be used to render to HDR monitors. Use the following combinations: For rendering to a SDR display with gamma 2.2 Set a color space of ColorSpaceType.RgbFullG22NoneP709 with a Back-Buffer format R8G8B8A8_UNorm, R8G8B8A8_UNorm_SRgb, B8G8R8A8_UNorm, or B8G8R8A8_UNorm. For rendering to a HDR display in scRGB (standard linear), and letting the Windows DWM do the color conversion Set a color space of ColorSpaceType.RgbFullG10NoneP709 with a Back-Buffer format R16G16B16A16_Float. For rendering to a HDR display in HDR10 / BT.2100, with no color conversion by the Windows DWM, rendering needs to happen in the same color space as the display. Set a color space of ColorSpaceType.RgbFullG2084NoneP2020 with a Back-Buffer format R10G10B10A2_UNorm. Note that this is currently only supported in Stride when using the Direct3D Graphics API. For more information about High Dynamic Range (HDR) rendering, see https://learn.microsoft.com/en-us/windows/win32/direct3darticles/high-dynamic-range. Exceptions NotSupportedException The specified pixel format or size is not supported by the Graphics Device. See Also SwapChainGraphicsPresenter RenderTargetGraphicsPresenter"
  },
  "api/Stride.Graphics.GraphicsProfile.html": {
    "href": "api/Stride.Graphics.GraphicsProfile.html",
    "title": "Enum GraphicsProfile | Stride API",
    "summary": "Enum GraphicsProfile Namespace Stride.Graphics Assembly Stride.dll Identifies the base set of capabilities a Graphics Device supports. [DataContract(\"GraphicsProfile\")] public enum GraphicsProfile Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"Level 10.0 ~ like Direct3D 10.0 / OpenGL ES 3.0 / Vulkan 1.0\", null)] Level_10_0 = 40960 Identifies Graphics Devices with capabilities roughly at the level of DirectX 10 (HLSL 4.0, Geometry Shaders), OpenGL ES 3.0, or Vulkan 1.0. [Display(\"Level 10.1 ~ like Direct3D 10.1 / OpenGL ES 3.0 / Vulkan 1.0\", null)] Level_10_1 = 41216 Identifies Graphics Devices with capabilities roughly at the level of DirectX 10.1 (HLSL 4.1, Geometry Shaders), OpenGL ES 3.0, or Vulkan 1.0. [Display(\"Level 11.0 ~ like Direct3D 11.0 / OpenGL ES 3.1 / Vulkan 1.1\", null)] Level_11_0 = 45056 Identifies Graphics Devices with capabilities roughly at the level of DirectX 11 (HLSL 5.0, Compute Shaders, Domain Shaders, Hull Shaders), OpenGL ES 3.1, or Vulkan 1.1. [Display(\"Level 11.1 ~ like Direct3D 11.1 / OpenGL ES 3.1 / Vulkan 1.1\", null)] Level_11_1 = 45312 Identifies Graphics Devices with capabilities roughly at the level of DirectX 11.1 (HLSL 5.0, Compute Shaders, Domain Shaders, Hull Shaders), OpenGL ES 3.1, or Vulkan 1.1. [Display(\"Level 11.2 ~ like Direct3D 11.2 / OpenGL ES 3.1 / Vulkan 1.1\", null)] Level_11_2 = 45568 Identifies Graphics Devices with capabilities roughly at the level of DirectX 11.2 (HLSL 5.0, Compute Shaders, Domain Shaders, Hull Shaders), OpenGL ES 3.1, or Vulkan 1.1. [Display(\"Level 9.1 ~ like Direct3D 9.0 / OpenGL ES 2.0 / Vulkan 1.0\", null)] Level_9_1 = 37120 Identifies Graphics Devices with capabilities roughly at the level of DirectX 9.0a (HLSL 3.0), OpenGL ES 2.0, or Vulkan 1.0. [Display(\"Level 9.2 ~ like Direct3D 9.0b / OpenGL ES 2.0 / Vulkan 1.0\", null)] Level_9_2 = 37376 Identifies Graphics Devices with capabilities roughly at the level of DirectX 9.0b (HLSL 3.0), OpenGL ES 2.0, or Vulkan 1.0. [Display(\"Level 9.3 ~ like Direct3D 9.0c / OpenGL ES 2.0 / Vulkan 1.0\", null)] Level_9_3 = 37632 Identifies Graphics Devices with capabilities roughly at the level of DirectX 9.0c (HLSL 3.0), OpenGL ES 2.0, or Vulkan 1.0. Remarks The graphics profile only indicates which capabilities are available on the device, not which graphics API is used. For example, a Graphics Device with a Level_10_0 supports Direct3D 10.0, Direct3D 10.1, and Direct3D 11.0 APIs, as well as OpenGL ES 3.0. Some platforms may not support all graphics profiles, or may have additional restrictions. Also, some graphics APIs may not support all features of a given profile, or may need to enable specific extensions to access certain features (OpenGL, Vulkan)."
  },
  "api/Stride.Graphics.GraphicsResource.html": {
    "href": "api/Stride.Graphics.GraphicsResource.html",
    "title": "Class GraphicsResource | Stride API",
    "summary": "Class GraphicsResource Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents an abstract resource that depends on a GraphicsDevice. public abstract class GraphicsResource : GraphicsResourceBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase GraphicsResource Implements IDisposable IComponent IReferencable ICollectorHolder Derived Buffer Texture Inherited Members GraphicsResourceBase.NativeResource GraphicsResourceBase.NativeDeviceChild GraphicsResourceBase.UnsetNativeDeviceChild() GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) GraphicsResourceBase.NativeDevice GraphicsResourceBase.IsDebugMode GraphicsResourceBase.OnRecreate() GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed GraphicsResourceBase.OnPause() GraphicsResourceBase.OnResume() GraphicsResourceBase.Destroy() ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors GraphicsResource() Initializes a new instance of the GraphicsResource class. protected GraphicsResource() GraphicsResource(GraphicsDevice) Initializes a new instance of the GraphicsResource class attached to a graphics device. protected GraphicsResource(GraphicsDevice device) Parameters device GraphicsDevice The GraphicsDevice this resource belongs to. GraphicsResource(GraphicsDevice, string?) Initializes a new instance of the GraphicsResource class attached to a graphics device. protected GraphicsResource(GraphicsDevice device, string? name) Parameters device GraphicsDevice The GraphicsDevice this resource belongs to. name string A string to use as a name for identifying the resource. Useful when debugging. Specify null to use the type's name instead. Properties NativeShaderResourceView Gets or sets the Silk.NET.Direct3D11.ID3D11ShaderResourceView attached to the Graphics Resource. protected ComPtr<ID3D11ShaderResourceView> NativeShaderResourceView { get; set; } Property Value ComPtr<ID3D11ShaderResourceView> The Shader Resource View associated with the Graphics Resource. Remarks Only Textures are using this Shader Resource View. If the reference is going to be kept, use ComPtr<T>.AddRef() to increment the internal reference count, and Silk.NET.Core.Native.ComPtr<T>.Dispose() when no longer needed to release the object. NativeUnorderedAccessView Gets or sets the Silk.NET.Direct3D11.ID3D11UnorderedAccessView attached to the Graphics Resource. protected ComPtr<ID3D11UnorderedAccessView> NativeUnorderedAccessView { get; set; } Property Value ComPtr<ID3D11UnorderedAccessView> The Unordered Access View associated with the Graphics Resource. Remarks If the reference is going to be kept, use ComPtr<T>.AddRef() to increment the internal reference count, and Silk.NET.Core.Native.ComPtr<T>.Dispose() when no longer needed to release the object. Methods OnDestroyed(bool) Called when the GraphicsDevice has been detected to be internally destroyed, or when the Destroy() methad has been called. Raises the Destroyed event. protected override void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the resource should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). Remarks This method releases the underlying native resources (Silk.NET.Direct3D11.ID3D11Resource and Silk.NET.Direct3D11.ID3D11DeviceChild). OnNameChanged() Called when the Name property has changed. protected override void OnNameChanged()"
  },
  "api/Stride.Graphics.GraphicsResourceAllocator.CreateResourceDelegate-2.html": {
    "href": "api/Stride.Graphics.GraphicsResourceAllocator.CreateResourceDelegate-2.html",
    "title": "Delegate GraphicsResourceAllocator.CreateResourceDelegate<TResource, TDescription> | Stride API",
    "summary": "Delegate GraphicsResourceAllocator.CreateResourceDelegate<TResource, TDescription> Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents a method that creates a Graphics Resource of type TResource based on the specified description and pixel format. protected delegate TResource GraphicsResourceAllocator.CreateResourceDelegate<TResource, TDescription>(TDescription description, PixelFormat viewFormat) Parameters description TDescription The description that specifies the details of the Graphics Resource to be created. viewFormat PixelFormat The data format to be used for SRVs on the Graphics Resource. Returns TResource A new instance of TResource created based on the provided description and SRV data format. Type Parameters TResource The type of the Graphics Resource to be created. TDescription The type of the description used to define the Graphics Resource. Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.GraphicsResourceAllocator.GetDescriptionDelegate-2.html": {
    "href": "api/Stride.Graphics.GraphicsResourceAllocator.GetDescriptionDelegate-2.html",
    "title": "Delegate GraphicsResourceAllocator.GetDescriptionDelegate<TResource, TDescription> | Stride API",
    "summary": "Delegate GraphicsResourceAllocator.GetDescriptionDelegate<TResource, TDescription> Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents a method that retrieves a description of a Graphics Resource. protected delegate TDescription GraphicsResourceAllocator.GetDescriptionDelegate<TResource, TDescription>(TResource resource) Parameters resource TResource The Graphics Resource for which the description is to be retrieved. Returns TDescription The description of the specified Graphics Resource. Type Parameters TResource The type of the Graphics Resource for which the description is retrieved. TDescription The type of the description returned for the Graphics Resource. Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.GraphicsResourceAllocator.QueryPoolDescription.html": {
    "href": "api/Stride.Graphics.GraphicsResourceAllocator.QueryPoolDescription.html",
    "title": "Struct GraphicsResourceAllocator.QueryPoolDescription | Stride API",
    "summary": "Struct GraphicsResourceAllocator.QueryPoolDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll A description of a GPU queries pool. protected record struct GraphicsResourceAllocator.QueryPoolDescription : IEquatable<GraphicsResourceAllocator.QueryPoolDescription> Implements IEquatable<GraphicsResourceAllocator.QueryPoolDescription> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors QueryPoolDescription(QueryType, int) A description of a GPU queries pool. public QueryPoolDescription(QueryType QueryType, int QueryCount) Parameters QueryType QueryType The type of the pooled GPU queries. QueryCount int The number of queries in the pool. Properties QueryCount The number of queries in the pool. public int QueryCount { readonly get; set; } Property Value int QueryType The type of the pooled GPU queries. public QueryType QueryType { readonly get; set; } Property Value QueryType"
  },
  "api/Stride.Graphics.GraphicsResourceAllocator.ResourceCache-1.html": {
    "href": "api/Stride.Graphics.GraphicsResourceAllocator.ResourceCache-1.html",
    "title": "Class GraphicsResourceAllocator.ResourceCache<TResourceDesc> | Stride API",
    "summary": "Class GraphicsResourceAllocator.ResourceCache<TResourceDesc> Namespace Stride.Graphics Assembly Stride.Graphics.dll Internal type for a cache of Graphics Resources associated with their description. protected sealed class GraphicsResourceAllocator.ResourceCache<TResourceDesc> : Dictionary<TResourceDesc, List<GraphicsResourceLink>>, IDictionary<TResourceDesc, List<GraphicsResourceLink>>, ICollection<KeyValuePair<TResourceDesc, List<GraphicsResourceLink>>>, IReadOnlyDictionary<TResourceDesc, List<GraphicsResourceLink>>, IReadOnlyCollection<KeyValuePair<TResourceDesc, List<GraphicsResourceLink>>>, IEnumerable<KeyValuePair<TResourceDesc, List<GraphicsResourceLink>>>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable Type Parameters TResourceDesc The type of an object that describes the characteristics of the cached Graphics Resource. Inheritance object Dictionary<TResourceDesc, List<GraphicsResourceLink>> GraphicsResourceAllocator.ResourceCache<TResourceDesc> Implements IDictionary<TResourceDesc, List<GraphicsResourceLink>> ICollection<KeyValuePair<TResourceDesc, List<GraphicsResourceLink>>> IReadOnlyDictionary<TResourceDesc, List<GraphicsResourceLink>> IReadOnlyCollection<KeyValuePair<TResourceDesc, List<GraphicsResourceLink>>> IEnumerable<KeyValuePair<TResourceDesc, List<GraphicsResourceLink>>> IDictionary ICollection IEnumerable IDeserializationCallback ISerializable Inherited Members Dictionary<TResourceDesc, List<GraphicsResourceLink>>.Add(TResourceDesc, List<GraphicsResourceLink>) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.Clear() Dictionary<TResourceDesc, List<GraphicsResourceLink>>.ContainsKey(TResourceDesc) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.ContainsValue(List<GraphicsResourceLink>) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.EnsureCapacity(int) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.GetAlternateLookup<TAlternateKey>() Dictionary<TResourceDesc, List<GraphicsResourceLink>>.GetEnumerator() Dictionary<TResourceDesc, List<GraphicsResourceLink>>.OnDeserialization(object) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.Remove(TResourceDesc) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.Remove(TResourceDesc, out List<GraphicsResourceLink>) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.TrimExcess() Dictionary<TResourceDesc, List<GraphicsResourceLink>>.TrimExcess(int) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.TryAdd(TResourceDesc, List<GraphicsResourceLink>) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.TryGetAlternateLookup<TAlternateKey>(out Dictionary<TResourceDesc, List<GraphicsResourceLink>>.AlternateLookup<TAlternateKey>) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.TryGetValue(TResourceDesc, out List<GraphicsResourceLink>) Dictionary<TResourceDesc, List<GraphicsResourceLink>>.Comparer Dictionary<TResourceDesc, List<GraphicsResourceLink>>.Count Dictionary<TResourceDesc, List<GraphicsResourceLink>>.Capacity Dictionary<TResourceDesc, List<GraphicsResourceLink>>.this[TResourceDesc] Dictionary<TResourceDesc, List<GraphicsResourceLink>>.Keys Dictionary<TResourceDesc, List<GraphicsResourceLink>>.Values Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.GraphicsResourceAllocator.html": {
    "href": "api/Stride.Graphics.GraphicsResourceAllocator.html",
    "title": "Class GraphicsResourceAllocator | Stride API",
    "summary": "Class GraphicsResourceAllocator Namespace Stride.Graphics Assembly Stride.Graphics.dll A GraphicsResource allocator tracking usage references and allowing to recycle unused resources based on a recycle policy. public class GraphicsResourceAllocator : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceAllocator Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) GraphicsResourceAllocatorExtensions.GetTemporaryTexture2D(GraphicsResourceAllocator, TextureDescription) GraphicsResourceAllocatorExtensions.GetTemporaryTexture2D(GraphicsResourceAllocator, int, int, PixelFormat, MipMapCount, TextureFlags, int) GraphicsResourceAllocatorExtensions.GetTemporaryTexture2D(GraphicsResourceAllocator, int, int, PixelFormat, TextureFlags, int) UnsafeUtilities.As<T>(object?) Remarks This class is thread-safe. Accessing any member will acquire a global lock on this instance. Constructors GraphicsResourceAllocator(GraphicsDevice) Initializes a new instance of the GraphicsResourceAllocator class. public GraphicsResourceAllocator(GraphicsDevice graphicsDevice) Parameters graphicsDevice GraphicsDevice The Graphics Device. Exceptions ArgumentNullException graphicsDevice is null. Properties RecyclePolicy Gets or sets the default recycle policy. public GraphicsResourceRecyclePolicyDelegate RecyclePolicy { get; set; } Property Value GraphicsResourceRecyclePolicyDelegate The recycle policy to apply by default by the Graphics Resource Allocator. Remarks A recycle policy is a delegate that inspects a Graphics Resource and some allocation and access information, and determines if it should be recycled (disposed) or not. The default recycle policy (DefaultRecyclePolicy(GraphicsResourceLink)) is to always recycle a Graphics Resource irrespective of its state. Services Gets the services registry. public IServiceRegistry Services { get; } Property Value IServiceRegistry Methods AddReference(GraphicsResource) Adds a reference to a Graphics Resource tracked by this allocator. public void AddReference(GraphicsResource resource) Parameters resource GraphicsResource The Graphics Resource. It's internal reference count will be increased. Exceptions ArgumentException Thrown if resource was not allocated by this allocator. CreateBuffer(BufferDescription, PixelFormat) Creates a Buffer. protected virtual Buffer CreateBuffer(BufferDescription description, PixelFormat viewFormat) Parameters description BufferDescription A description of the needed characteristics of the Buffer. viewFormat PixelFormat The data format for the View that will be seen by Shaders. Specify None to use the default format of the Buffer. Returns Buffer A Buffer with the specified description. CreateQueryPool(QueryPoolDescription, PixelFormat) Creates a Query Pool for a specific number of GPU Queries of a given type. protected virtual QueryPool CreateQueryPool(GraphicsResourceAllocator.QueryPoolDescription description, PixelFormat viewFormat) Parameters description GraphicsResourceAllocator.QueryPoolDescription A description of the needed characteristics of the Query Pool, like the number of GPU Queries and their type. viewFormat PixelFormat Ignored for Query Pools, as they do not have a format. Returns QueryPool A Query Pool with the specified types and count. CreateTexture(TextureDescription, PixelFormat) Creates a Texture. protected virtual Texture CreateTexture(TextureDescription description, PixelFormat viewFormat) Parameters description TextureDescription A description of the needed characteristics of the Texture. viewFormat PixelFormat The pixel format for the View that will be seen by Shaders. Specify None to use the default format of the Texture. Returns Texture A Texture with the specified description. Destroy() Disposes the current Graphics Resource allocator by disposing all the associated resources and clearing all the caches. protected override void Destroy() GetQueryPool(QueryType, int) Gets a Query Pool for a specific number of GPU Queries of a given type. public QueryPool GetQueryPool(QueryType queryType, int queryCount) Parameters queryType QueryType The type of the Queries. queryCount int The needed number of Queries. Returns QueryPool A temporary Query Pool with the specified types and count. GetTemporaryBuffer(BufferDescription, PixelFormat) Gets a temporary Buffer with the specified description. public Buffer GetTemporaryBuffer(BufferDescription description, PixelFormat viewFormat = PixelFormat.None) Parameters description BufferDescription A description of the needed characteristics of the Buffer. viewFormat PixelFormat The data format for the View that will be seen by Shaders. Specify None to use the default format of the Buffer. Returns Buffer A temporary Buffer with the specified description. GetTemporaryTexture(TextureDescription) Gets a temporary Texture with the specified description. public Texture GetTemporaryTexture(TextureDescription description) Parameters description TextureDescription A description of the needed characteristics of the Texture. Returns Texture A temporary Texture with the specified description. Recycle() Recycles unused resources (those with a ReferenceCount of 0) with the RecyclePolicy. public void Recycle() Remarks If no recycle policy is set (it is null), this method does not recycle anything. Recycle(GraphicsResourceRecyclePolicyDelegate) Recycles unused resources (those with a ReferenceCount of 0) with the specified recycle policy. public void Recycle(GraphicsResourceRecyclePolicyDelegate recyclePolicy) Parameters recyclePolicy GraphicsResourceRecyclePolicyDelegate The recycle policy. Exceptions ArgumentNullException recyclePolicy is null. ReleaseReference(GraphicsResourceBase) Removes a reference to a Graphics Resource tracked by this allocator. public void ReleaseReference(GraphicsResourceBase resource) Parameters resource GraphicsResourceBase The Graphics Resource. It's internal reference count will be decreased. Exceptions ArgumentException Thrown if resource was not allocated by this allocator."
  },
  "api/Stride.Graphics.GraphicsResourceAllocatorExtensions.html": {
    "href": "api/Stride.Graphics.GraphicsResourceAllocatorExtensions.html",
    "title": "Class GraphicsResourceAllocatorExtensions | Stride API",
    "summary": "Class GraphicsResourceAllocatorExtensions Namespace Stride.Graphics Assembly Stride.Graphics.dll Extensions for the GraphicsResourceAllocator. public static class GraphicsResourceAllocatorExtensions Inheritance object GraphicsResourceAllocatorExtensions Methods GetTemporaryTexture2D(GraphicsResourceAllocator, TextureDescription) Gets a Texture output for the specified description. public static Texture GetTemporaryTexture2D(this GraphicsResourceAllocator allocator, TextureDescription description) Parameters allocator GraphicsResourceAllocator The allocator. description TextureDescription The description. Returns Texture A new instance of Texture class. GetTemporaryTexture2D(GraphicsResourceAllocator, int, int, PixelFormat, MipMapCount, TextureFlags, int) Gets a Texture output for the specified description. public static Texture GetTemporaryTexture2D(this GraphicsResourceAllocator allocator, int width, int height, PixelFormat format, MipMapCount mipCount, TextureFlags flags = TextureFlags.ShaderResource | TextureFlags.RenderTarget, int arraySize = 1) Parameters allocator GraphicsResourceAllocator The allocator. width int The width. height int The height. format PixelFormat Describes the format to use. mipCount MipMapCount Number of mipmaps, set to true to have all mipmaps, set to an int >=1 for a particular mipmap count. flags TextureFlags Sets the texture flags (for unordered access...etc.) arraySize int Size of the texture 2D array, default to 1. Returns Texture A new instance of Texture class. GetTemporaryTexture2D(GraphicsResourceAllocator, int, int, PixelFormat, TextureFlags, int) Gets a Texture output for the specified description with a single mipmap. public static Texture GetTemporaryTexture2D(this GraphicsResourceAllocator allocator, int width, int height, PixelFormat format, TextureFlags flags = TextureFlags.ShaderResource | TextureFlags.RenderTarget, int arraySize = 1) Parameters allocator GraphicsResourceAllocator The allocator. width int The width. height int The height. format PixelFormat Describes the format to use. flags TextureFlags Sets the texture flags (for unordered access...etc.) arraySize int Size of the texture 2D array, default to 1. Returns Texture A new instance of Texture class."
  },
  "api/Stride.Graphics.GraphicsResourceBase.html": {
    "href": "api/Stride.Graphics.GraphicsResourceBase.html",
    "title": "Class GraphicsResourceBase | Stride API",
    "summary": "Class GraphicsResourceBase Namespace Stride.Graphics Assembly Stride.Graphics.dll Base class for a Graphics Resource. public abstract class GraphicsResourceBase : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase Implements IDisposable IComponent IReferencable ICollectorHolder Derived CommandList DescriptorPool DescriptorSetLayout GraphicsResource PipelineState QueryPool RootSignature SamplerState VideoInstance Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors GraphicsResourceBase() Initializes a new instance of the GraphicsResourceBase class. protected GraphicsResourceBase() GraphicsResourceBase(GraphicsDevice) Initializes a new instance of the GraphicsResourceBase class. protected GraphicsResourceBase(GraphicsDevice device) Parameters device GraphicsDevice The graphics device. GraphicsResourceBase(GraphicsDevice, string?) Initializes a new instance of the GraphicsResourceBase class. protected GraphicsResourceBase(GraphicsDevice device, string? name) Parameters device GraphicsDevice The graphics device. name string A name that can be used to identify the Graphics Resource. Specify null to use the type's name instead. Fields Reload A delegate that will be invoked when the GraphicsDevice is reset and the Graphics Resource needs to be created / loaded again. public Action<GraphicsResourceBase, IServiceRegistry> Reload Field Value Action<GraphicsResourceBase, IServiceRegistry> Properties GraphicsDevice Gets the GraphicsDevice the Graphics Resource depends on. public GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice IsDebugMode Gets a value indicating whether the Graphics Resource is in \"Debug mode\". protected bool IsDebugMode { get; } Property Value bool true if the Graphics Resource is initialized in \"Debug mode\"; otherwise, false. NativeDevice Gets the internal Direct3D 11 device (Silk.NET.Direct3D11.ID3D11Device) if the resource is attached to a GraphicsDevice, or null if not. protected ComPtr<ID3D11Device> NativeDevice { get; } Property Value ComPtr<ID3D11Device> Remarks If the reference is going to be kept, use ComPtr<T>.AddRef() to increment the internal reference count, and Silk.NET.Core.Native.ComPtr<T>.Dispose() when no longer needed to release the object. NativeDeviceChild Gets or sets the internal Silk.NET.Direct3D11.ID3D11DeviceChild. protected ComPtr<ID3D11DeviceChild> NativeDeviceChild { get; set; } Property Value ComPtr<ID3D11DeviceChild> Remarks If the reference is going to be kept, use ComPtr<T>.AddRef() to increment the internal reference count, and Silk.NET.Core.Native.ComPtr<T>.Dispose() when no longer needed to release the object. NativeResource Gets the internal Direct3D 11 Resource. protected ComPtr<ID3D11Resource> NativeResource { get; } Property Value ComPtr<ID3D11Resource> Remarks If the reference is going to be kept, use ComPtr<T>.AddRef() to increment the internal reference count, and Silk.NET.Core.Native.ComPtr<T>.Dispose() when no longer needed to release the object. Methods Destroy() Disposes the resources associated with the Graphics Resource, removes itself from the GraphicsDevice's resource registry, and transitions to the Destroyed state. protected override void Destroy() OnDestroyed(bool) Called when the GraphicsDevice has been detected to be internally destroyed, or when the Destroy() methad has been called. Raises the Destroyed event. protected virtual void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the resource should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). Remarks This method releases the underlying native resources (Silk.NET.Direct3D11.ID3D11Resource and Silk.NET.Direct3D11.ID3D11DeviceChild). OnPause() Called when the GraphicsDevice is inactive (put in the background and rendering is paused). By default, it does nothing. protected virtual bool OnPause() Returns bool true if the Graphics Resource has transitioned to the Paused state. Remarks This method may be overriden in derived classes to voluntarily release objects that can be easily recreated, such as Dynamic Buffers and Frame Buffers / Render Targets. OnRecreate() Called when the GraphicsDevice has been recreated. protected virtual bool OnRecreate() Returns bool true if resource has transitioned to the Active state. OnResume() Called when the GraphicsDevice has resumed from either a paused or destroyed state. By default, it does nothing. protected virtual void OnResume() Remarks This method may be overriden in derived classes to recreate the Graphics Resource if possible. SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) Internal method to set the internal Silk.NET.Direct3D11.ID3D11DeviceChild without incrementing or decrementing the reference count. protected void SetNativeDeviceChild(ComPtr<ID3D11DeviceChild> deviceChild) Parameters deviceChild ComPtr<ID3D11DeviceChild> UnsetNativeDeviceChild() Internal method to detach the internal Silk.NET.Direct3D11.ID3D11DeviceChild without incrementing or decrementing the reference count. protected void UnsetNativeDeviceChild() Events Destroyed Raised when the internal Graphics Resource gets destroyed. public event EventHandler<EventArgs> Destroyed Event Type EventHandler<EventArgs> Remarks This event is useful when user-allocated handles associated with the internal resource need to be released."
  },
  "api/Stride.Graphics.GraphicsResourceFactoryBase.html": {
    "href": "api/Stride.Graphics.GraphicsResourceFactoryBase.html",
    "title": "Class GraphicsResourceFactoryBase | Stride API",
    "summary": "Class GraphicsResourceFactoryBase Namespace Stride.Graphics Assembly Stride.Graphics.dll Base class for all Graphics Resource factories. public abstract class GraphicsResourceFactoryBase : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceFactoryBase Implements IDisposable IComponent IReferencable ICollectorHolder Derived SamplerStateFactory Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors GraphicsResourceFactoryBase(GraphicsDevice) Initializes a new instance of the GraphicsResourceFactoryBase class. protected GraphicsResourceFactoryBase(GraphicsDevice device) Parameters device GraphicsDevice The Graphics Device. Properties GraphicsDevice Gets or sets the Graphics Device the created resources depend on. protected GraphicsDevice GraphicsDevice { get; set; } Property Value GraphicsDevice"
  },
  "api/Stride.Graphics.GraphicsResourceLifetimeState.html": {
    "href": "api/Stride.Graphics.GraphicsResourceLifetimeState.html",
    "title": "Enum GraphicsResourceLifetimeState | Stride API",
    "summary": "Enum GraphicsResourceLifetimeState Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes the lifetime state of a graphics resource. public enum GraphicsResourceLifetimeState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Active = 0 The resource is active and available for use. Destroyed = 2 The resource has been destroyed due to the graphics device being destroyed. It will need to be recreated or reloaded when rendering resumes. Paused = 1 The resource is in a reduced state (partially or completely destroyed) because application is in the background. Context should still be alive. This is useful for freeing dynamic resources such as Frame Buffers / Render Targets, that could be easily restored when application is resumed."
  },
  "api/Stride.Graphics.GraphicsResourceLink.html": {
    "href": "api/Stride.Graphics.GraphicsResourceLink.html",
    "title": "Class GraphicsResourceLink | Stride API",
    "summary": "Class GraphicsResourceLink Namespace Stride.Graphics Assembly Stride.Graphics.dll An object linking a Graphics Resource allocated by a GraphicsResourceAllocator and providing allocation information. public sealed class GraphicsResourceLink Inheritance object GraphicsResourceLink Extension Methods UnsafeUtilities.As<T>(object?) Properties AccessCountSinceLastRecycle Gets the number of times the Graphics Resource has been accessed since the last recycle policy was run. public long AccessCountSinceLastRecycle { get; } Property Value long AccessTotalCount Gets the total number of times the Graphics Resource has been accessed (including Increment and Decrement). public long AccessTotalCount { get; } Property Value long LastAccessTime Gets the last time the Graphics Resource was accessed. public DateTime LastAccessTime { get; } Property Value DateTime ReferenceCount Gets the number of active references to the Graphics Resource. public int ReferenceCount { get; } Property Value int Resource Gets the allocated Graphics Resource. public GraphicsResourceBase Resource { get; } Property Value GraphicsResourceBase"
  },
  "api/Stride.Graphics.GraphicsResourceRecyclePolicyDelegate.html": {
    "href": "api/Stride.Graphics.GraphicsResourceRecyclePolicyDelegate.html",
    "title": "Delegate GraphicsResourceRecyclePolicyDelegate | Stride API",
    "summary": "Delegate GraphicsResourceRecyclePolicyDelegate Namespace Stride.Graphics Assembly Stride.Graphics.dll A recycle policy to check whether a Graphics Resource tracked by a GraphicsResourceAllocator must be disposed / recycled. public delegate bool GraphicsResourceRecyclePolicyDelegate(GraphicsResourceLink resourceLink) Parameters resourceLink GraphicsResourceLink The Graphics Resource link. Returns bool true if the specified Graphics Resource must be disposed and removed from its allocator; false otherwise. Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.GraphicsResourceState.html": {
    "href": "api/Stride.Graphics.GraphicsResourceState.html",
    "title": "Enum GraphicsResourceState | Stride API",
    "summary": "Enum GraphicsResourceState Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines constants that specify the state of a Graphics Resource regarding how the resource is being used. [Flags] public enum GraphicsResourceState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AllShaderResource = NonPixelShaderResource | PixelShaderResource The Graphics Resource can be used in both Pixel and non-Pixel Shaders. This value is a combination of the NonPixelShaderResource and PixelShaderResource flags, allowing it to be used in scenarios where both types of Shader Resources are required. Common = 0 The application should transition to this state only for accessing a Graphics Resource across different graphics engine types. Specifically, a Graphics Resource must be in the Common state before being used on a Copy Queue (when previously used on a Direct / Compute Queue), and before being used on a Direct / Compute Queue (when previously used on Copy Queue). This restriction doesn't exist when accessing data between Direct and Compute queues. The Common state can be used for all usages on a Copy Queue using the implicit state transitions. For more information, read about Multi-engine synchronization. Additionally, Textures must be in the Common state for CPU access to be legal, assuming the Texture was created in a CPU-visible heap in the first place. CopyDestination = 1024 The Graphics Resource is used as the destination in a copy operation. Graphics Sub-Resources must be in this state when they are used as the destination of a copy operation, or a blt operation. This is a write-only state. CopySource = 2048 The Graphics Resource is used as the source in a copy operation. Graphics Sub-Resources must be in this state when they are used as the source of a copy operation, or a blt operation. This is a read-only state. DepthRead = 32 This state should be used when the Graphics Sub-Resource is in a read-only Depth-Stencil View, or when depth write is disabled (see DepthBufferWriteEnable). It can be combined with other read states (for example, PixelShaderResource), such that the Graphics Resource can be used for the Depth or Stencil test, and accessed by a Shader within the same draw call. Using it when depth will be written by a draw call or clear command is invalid. DepthWrite = 16 This state should be used for Clear(Texture, DepthStencilClearOptions, float, byte) when the flags (see DepthStencilClearOptions) indicate a given Graphics Sub-Resource should be cleared (otherwise the Graphics Sub-Resource state doesn't matter), or when using it in a writable Depth-Stencil View when the Pipeline State has depth write enabled (see DepthBufferWriteEnable). This state is mutually exclusive with other states. GenericRead = VertexAndConstantBuffer | IndexBuffer | AllShaderResource | IndirectArgument | CopySource This state is the required starting state for an upload heap. It is a combination of other read-state bits. The application should generally avoid transitioning to GenericRead when possible, since that can result in premature cache flushes, or Graphics Resource layout changes (for example, compress / decompress), causing unnecessary pipeline stalls. You should instead transition resources only to the actually-used states. IndexBuffer = 2 A Graphics Sub-Resource must be in this state when it is accessed by the 3D pipeline as an Index Buffer. This is a read-only state. IndirectArgument = 512 The Graphics Resource is used as an Indirect Argument. Graphics Sub-Resources must be in this state when they are used as the Argument Buffer passed to a indirect drawing method like DrawInstanced(Buffer, int) or DrawIndexedInstanced(Buffer, int). This is a read-only state. NonPixelShaderResource = 64 The Graphics Resource is used with a Shader other than the Pixel Shader. A Graphics Sub-Resource must be in this state before being read by any stage (except for the Pixel Shader stage) via a Shader Resource View. You can still use the Graphics Resource in a Pixel Shader with this flag as long as it also has the flag PixelShaderResource set. This is a read-only state. PixelShaderResource = 128 The Graphics Resource is used with a Pixel Shader. A Graphics Sub-Resource must be in this state before being read by the Pixel Shader via a Shader Resource View. This is a read-only state. Predication = 512 The Graphics Resource is used for Predication. Predication is a feature that enables the GPU rather than the CPU to determine to not draw, copy, or dispatch an object. The typical use of predication is with occlusion; if a bounding box is drawn and is occluded, there is obviously no point in drawing the object itself. In this situation, the drawing of the object can be \"predicated\", enabling its removal from actual rendering by the GPU. Present = 0 Synonymous with the Common flag. RenderTarget = 4 The Graphics Resource is used as a Render Target. A Graphics Sub-Resource must be in this state when it is rendered to, or when it is cleared with Clear(Texture, Color4). This is a write-only state. To read from a Render Target as a Shader Resource, the Graphics Resource must be in either NonPixelShaderResource or PixelShaderResource state. ResolveDestination = 4096 The Graphics Resource is used as the destination in a resolve operation. ResolveSource = 8192 The Graphics Resource is used as the source in a resolve operation. StreamOut = 256 The Graphics Resource is used with Stream Output. A Graphics Sub-Resource must be in this state when it is accessed by the 3D pipeline as a Stream-Out target. This is a write-only state. UnorderedAccess = 8 The Graphics Resource is used for Unordered Access. A Graphics Sub-Resource must be in this state when it is accessed by the GPU via an Unordered Access View. A Graphics Sub-Resource must also be in this state when it is cleared with ClearReadWrite(Buffer, Vector4). This is a read / write state. VertexAndConstantBuffer = 1 A Graphics Sub-Resource must be in this state when it is accessed by the GPU as a Vertex Buffer or Constant Buffer. This is a read-only state."
  },
  "api/Stride.Graphics.GraphicsResourceUsage.html": {
    "href": "api/Stride.Graphics.GraphicsResourceUsage.html",
    "title": "Enum GraphicsResourceUsage | Stride API",
    "summary": "Enum GraphicsResourceUsage Namespace Stride.Graphics Assembly Stride.Graphics.dll Identifies the intended use of a resource during rendering. The usage directly reflects whether a resource is accessible by the CPU and/or the GPU. [DataContract] public enum GraphicsResourceUsage Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Default = 0 A resource that requires read and write access by the GPU. This is likely to be the most common usage choice. Dynamic = 2 A resource that is accessible by both the GPU (read-only) and the CPU (write-only). A dynamic resource is a good choice for a resource that will be updated by the CPU at least once per frame. To update a dynamic resource, use a Map method. Immutable = 1 A resource that can only be read by the GPU. It cannot be written by the GPU, and cannot be accessed at all by the CPU. This type of resource must be initialized when it is created, since it cannot be changed after creation. Staging = 3 A resource that supports data transfer (copy) from the GPU to the CPU."
  },
  "api/Stride.Graphics.IGraphicsDeviceService.html": {
    "href": "api/Stride.Graphics.IGraphicsDeviceService.html",
    "title": "Interface IGraphicsDeviceService | Stride API",
    "summary": "Interface IGraphicsDeviceService Namespace Stride.Graphics Assembly Stride.Graphics.dll Service providing access to the GraphicsDevice and events that can be subscribed to be notified of when the device is created, reset, or disposed. public interface IGraphicsDeviceService Extension Methods UnsafeUtilities.As<T>(object?) Properties GraphicsDevice Gets the current Graphcs Device. GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice Events DeviceCreated Occurs when a device is created. event EventHandler<EventArgs> DeviceCreated Event Type EventHandler<EventArgs> DeviceDisposing Occurs when a device is being disposed. event EventHandler<EventArgs> DeviceDisposing Event Type EventHandler<EventArgs> DeviceReset Occurs when a device has been reset. event EventHandler<EventArgs> DeviceReset Event Type EventHandler<EventArgs> DeviceResetting Occurs when a device is going to be reset. event EventHandler<EventArgs> DeviceResetting Event Type EventHandler<EventArgs>"
  },
  "api/Stride.Graphics.IVertex.html": {
    "href": "api/Stride.Graphics.IVertex.html",
    "title": "Interface IVertex | Stride API",
    "summary": "Interface IVertex Namespace Stride.Graphics Assembly Stride.Graphics.dll The base interface for all the vertex data structure. public interface IVertex Extension Methods UnsafeUtilities.As<T>(object?) Methods FlipWinding() Flip the vertex winding. void FlipWinding() GetLayout() Gets the layout of the vertex. VertexDeclaration GetLayout() Returns VertexDeclaration"
  },
  "api/Stride.Graphics.Image.ImageLoadDelegate.html": {
    "href": "api/Stride.Graphics.Image.ImageLoadDelegate.html",
    "title": "Delegate Image.ImageLoadDelegate | Stride API",
    "summary": "Delegate Image.ImageLoadDelegate Namespace Stride.Graphics Assembly Stride.dll public delegate Image Image.ImageLoadDelegate(nint dataPointer, int dataSize, bool makeACopy, GCHandle? handle) Parameters dataPointer nint dataSize int makeACopy bool handle GCHandle? Returns Image Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Image.ImageSaveDelegate.html": {
    "href": "api/Stride.Graphics.Image.ImageSaveDelegate.html",
    "title": "Delegate Image.ImageSaveDelegate | Stride API",
    "summary": "Delegate Image.ImageSaveDelegate Namespace Stride.Graphics Assembly Stride.dll public delegate void Image.ImageSaveDelegate(PixelBuffer[] pixelBuffers, int count, ImageDescription description, Stream imageStream) Parameters pixelBuffers PixelBuffer[] count int description ImageDescription imageStream Stream Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Image.html": {
    "href": "api/Stride.Graphics.Image.html",
    "title": "Class Image | Stride API",
    "summary": "Class Image Namespace Stride.Graphics Assembly Stride.dll Provides method to instantiate an image 1D/2D/3D supporting TextureArray and mipmaps on the CPU or to load/save an image from the disk. [ContentSerializer(typeof(ImageSerializer))] public sealed class Image : IDisposable Inheritance object Image Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) GraphicsSerializerExtensions.ToSerializableVersion(Image) UnsafeUtilities.As<T>(object?) Fields Description Description of this image. public ImageDescription Description Field Value ImageDescription Properties DataPointer Gets a pointer to the image buffer in memory. public nint DataPointer { get; } Property Value nint A pointer to the image buffer in memory. PixelBuffer Provides access to all pixel buffers. public PixelBufferArray PixelBuffer { get; } Property Value PixelBufferArray Remarks For Texture3D, each z slice of the Texture3D has a pixelBufferArray * by the number of mipmaps. For other textures, there is Description.MipLevels * Description.ArraySize pixel buffers. TotalSizeInBytes Gets the total number of bytes occupied by this image in memory. public int TotalSizeInBytes { get; } Property Value int Methods CalculateMipLevels(int, MipMapCount) Calculates the number of miplevels for a Texture 1D. public static int CalculateMipLevels(int width, MipMapCount mipLevels) Parameters width int The width of the texture. mipLevels MipMapCount A MipMapCount, set to true to calculates all mipmaps, to false to calculate only 1 miplevel, or > 1 to calculate a specific amount of levels. Returns int The number of miplevels. CalculateMipLevels(int, int, MipMapCount) Calculates the number of miplevels for a Texture 2D. public static int CalculateMipLevels(int width, int height, MipMapCount mipLevels) Parameters width int The width of the texture. height int The height of the texture. mipLevels MipMapCount A MipMapCount, set to true to calculates all mipmaps, to false to calculate only 1 miplevel, or > 1 to calculate a specific amount of levels. Returns int The number of miplevels. CalculateMipLevels(int, int, int, MipMapCount) Calculates the number of miplevels for a Texture 2D. public static int CalculateMipLevels(int width, int height, int depth, MipMapCount mipLevels) Parameters width int The width of the texture. height int The height of the texture. depth int The depth of the texture. mipLevels MipMapCount A MipMapCount, set to true to calculates all mipmaps, to false to calculate only 1 miplevel, or > 1 to calculate a specific amount of levels. Returns int The number of miplevels. CalculateMipSize(int, int) public static int CalculateMipSize(int width, int mipLevel) Parameters width int mipLevel int Returns int Clear() Reset the buffer (by default it is not cleared) public void Clear() ConvertFormatToNonSRgb() Converts the format of the description and the pixel buffers to non sRGB. public void ConvertFormatToNonSRgb() ConvertFormatToSRgb() Converts the format of the description and the pixel buffers to sRGB. public void ConvertFormatToSRgb() CountMips(int) public static int CountMips(int width) Parameters width int Returns int CountMips(int, int) public static int CountMips(int width, int height) Parameters width int height int Returns int CountMips(int, int, int) public static int CountMips(int width, int height, int depth) Parameters width int height int depth int Returns int Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() GetMipMapDescription(int) Gets the mipmap description of this instance for the specified mipmap level. public MipMapDescription GetMipMapDescription(int mipmap) Parameters mipmap int The mipmap. Returns MipMapDescription A description of a particular mipmap for this texture. GetPixelBuffer(int, int) Gets the pixel buffer for the specified array/z slice and mipmap level. public PixelBuffer GetPixelBuffer(int arrayOrZSliceIndex, int mipmap) Parameters arrayOrZSliceIndex int For 3D image, the parameter is the Z slice, otherwise it is an index into the texture array. mipmap int The mipmap. Returns PixelBuffer A PixelBuffer. Exceptions ArgumentException If arrayOrZSliceIndex or mipmap are out of range. GetPixelBuffer(int, int, int) Gets the pixel buffer for the specified array/z slice and mipmap level. public PixelBuffer GetPixelBuffer(int arrayIndex, int zIndex, int mipmap) Parameters arrayIndex int Index into the texture array. Must be set to 0 for 3D images. zIndex int Z index for 3D image. Must be set to 0 for all 1D/2D images. mipmap int The mipmap. Returns PixelBuffer A PixelBuffer. Exceptions ArgumentException If arrayIndex, zIndex or mipmap are out of range. Load(DataPointer, bool, bool) Loads an image from an unmanaged memory pointer. [Obsolete(\"Use span instead\")] public static Image Load(DataPointer dataBuffer, bool makeACopy = false, bool loadAsSRGB = false) Parameters dataBuffer DataPointer Pointer to an unmanaged memory. If makeACopy is false, this buffer must be allocated with Allocate(int, int). makeACopy bool True to copy the content of the buffer to a new allocated buffer, false otherwise. loadAsSRGB bool Indicate if the image should be loaded as an sRGB texture Returns Image An new image. Remarks If makeACopy is set to false, the returned image is now the holder of the unmanaged pointer and will release it on Dispose. Load(byte[], bool) Loads an image from a managed buffer. public static Image Load(byte[] buffer, bool loadAsSRGB = false) Parameters buffer byte[] Reference to a managed buffer. loadAsSRGB bool Indicate if the image should be loaded as an sRGB texture Returns Image An new image. Remarks This method support the following format: dds, bmp, jpg, png, gif, tiff, wmp, tga. Load(Stream, bool) Loads the specified image from a stream. public static Image Load(Stream imageStream, bool loadAsSRGB = false) Parameters imageStream Stream The image stream. loadAsSRGB bool Indicate if the image should be loaded as an sRGB texture. If false, the image is loaded in its default format. Returns Image An new image. Remarks This method support the following format: dds, bmp, jpg, png, gif, tiff, wmp, tga. Load(nint, int, bool, bool) Loads an image from an unmanaged memory pointer. public static Image Load(nint dataPointer, int dataSize, bool makeACopy = false, bool loadAsSRGB = false) Parameters dataPointer nint Pointer to an unmanaged memory. If makeACopy is false, this buffer must be allocated with Allocate(int, int). dataSize int Size of the unmanaged buffer. makeACopy bool True to copy the content of the buffer to a new allocated buffer, false otherwise. loadAsSRGB bool Indicate if the image should be loaded as an sRGB texture Returns Image An new image. Remarks If makeACopy is set to false, the returned image is now the holder of the unmanaged pointer and will release it on Dispose. Load(Span<byte>, bool, bool) Loads an image from an unmanaged memory pointer. public static Image Load(Span<byte> dataBuffer, bool makeACopy = false, bool loadAsSRGB = false) Parameters dataBuffer Span<byte> Pointer to an unmanaged memory. If makeACopy is false, this buffer must be allocated with Allocate(int, int). makeACopy bool True to copy the content of the buffer to a new allocated buffer, false otherwise. loadAsSRGB bool Indicate if the image should be loaded as an sRGB texture Returns Image An new image. Remarks If makeACopy is set to false, the returned image is now the holder of the unmanaged pointer and will release it on Dispose. New(ImageDescription) Creates a new instance of Image from an image description. public static Image New(ImageDescription description) Parameters description ImageDescription The image description. Returns Image A new image. New(ImageDescription, nint) Creates a new instance of Image from an image description. public static Image New(ImageDescription description, nint dataPointer) Parameters description ImageDescription The image description. dataPointer nint Pointer to an existing buffer. Returns Image A new image. New(ImageDescription, nint, int, GCHandle?, bool) Initializes a new instance of the Image class. public static Image New(ImageDescription description, nint dataPointer, int offset, GCHandle? handle, bool bufferIsDisposable) Parameters description ImageDescription The image description. dataPointer nint The pointer to the data buffer. offset int The offset from the beginning of the data buffer. handle GCHandle? The handle (optionnal). bufferIsDisposable bool if set to true [buffer is disposable]. Returns Image Exceptions InvalidOperationException If the format is invalid, or width/height/depth/arraysize is invalid with respect to the dimension. New1D(int, MipMapCount, PixelFormat, int) Creates a new instance of a 1D Image. public static Image New1D(int width, MipMapCount mipMapCount, PixelFormat format, int arraySize = 1) Parameters width int The width. mipMapCount MipMapCount The mip map count. format PixelFormat The format. arraySize int Size of the array. Returns Image A new image. New1D(int, MipMapCount, PixelFormat, int, nint) Creates a new instance of a 1D Image. public static Image New1D(int width, MipMapCount mipMapCount, PixelFormat format, int arraySize, nint dataPointer) Parameters width int The width. mipMapCount MipMapCount The mip map count. format PixelFormat The format. arraySize int Size of the array. dataPointer nint Pointer to an existing buffer. Returns Image A new image. New2D(int, int, MipMapCount, PixelFormat, int, int) Creates a new instance of a 2D Image. public static Image New2D(int width, int height, MipMapCount mipMapCount, PixelFormat format, int arraySize = 1, int rowStride = 0) Parameters width int The width. height int The height. mipMapCount MipMapCount The mip map count. format PixelFormat The format. arraySize int Size of the array. rowStride int Returns Image A new image. New2D(int, int, MipMapCount, PixelFormat, int, nint, int) Creates a new instance of a 2D Image. public static Image New2D(int width, int height, MipMapCount mipMapCount, PixelFormat format, int arraySize, nint dataPointer, int rowStride = 0) Parameters width int The width. height int The height. mipMapCount MipMapCount The mip map count. format PixelFormat The format. arraySize int Size of the array. dataPointer nint Pointer to an existing buffer. rowStride int Specify a specific rowStride, only valid when mipMapCount == 1 and pixel format is not compressed. Returns Image A new image. New3D(int, int, int, MipMapCount, PixelFormat) Creates a new instance of a 3D Image. public static Image New3D(int width, int height, int depth, MipMapCount mipMapCount, PixelFormat format) Parameters width int The width. height int The height. depth int The depth. mipMapCount MipMapCount The mip map count. format PixelFormat The format. Returns Image A new image. New3D(int, int, int, MipMapCount, PixelFormat, nint) Creates a new instance of a 3D Image. public static Image New3D(int width, int height, int depth, MipMapCount mipMapCount, PixelFormat format, nint dataPointer) Parameters width int The width. height int The height. depth int The depth. mipMapCount MipMapCount The mip map count. format PixelFormat The format. dataPointer nint Pointer to an existing buffer. Returns Image A new image. NewCube(int, MipMapCount, PixelFormat) Creates a new instance of a Cube Image. public static Image NewCube(int width, MipMapCount mipMapCount, PixelFormat format) Parameters width int The width. mipMapCount MipMapCount The mip map count. format PixelFormat The format. Returns Image A new image. NewCube(int, MipMapCount, PixelFormat, nint) Creates a new instance of a Cube Image. public static Image NewCube(int width, MipMapCount mipMapCount, PixelFormat format, nint dataPointer) Parameters width int The width. mipMapCount MipMapCount The mip map count. format PixelFormat The format. dataPointer nint Pointer to an existing buffer. Returns Image A new image. Register(ImageFileType, ImageLoadDelegate?, ImageSaveDelegate?) Registers a loader / saver for a specified Image file type. public static void Register(ImageFileType type, Image.ImageLoadDelegate? loader, Image.ImageSaveDelegate? saver) Parameters type ImageFileType The file type. Use an integer and explicit casting to ImageFileType to register other file formats. loader Image.ImageLoadDelegate A delegate that will be invoked to load an Image of the specified type. Specify null to register no loading delegate for this type. saver Image.ImageSaveDelegate A delegate that will be invoked to save an Image of the specified type. Specify null to register no saving delegate for this type. Remarks Not both loader and saver have to be specified. But at least one of them must be (i.e. not both of them can be null). Exceptions ArgumentNullException The application can register a loader (and set the saver to null), or a saver (and set the loader to null), or both, but cannot set both of them to null. Save(Stream, ImageFileType) Saves this instance to a stream. public void Save(Stream imageStream, ImageFileType fileType) Parameters imageStream Stream The destination stream. fileType ImageFileType Specify the output format. Remarks This method support the following format: dds, bmp, jpg, png, gif, tiff, wmp, tga. ToDataBox() Gets the databox from this image. public DataBox[] ToDataBox() Returns DataBox[] The databox of this image."
  },
  "api/Stride.Graphics.ImageDescription.html": {
    "href": "api/Stride.Graphics.ImageDescription.html",
    "title": "Struct ImageDescription | Stride API",
    "summary": "Struct ImageDescription Namespace Stride.Graphics Assembly Stride.dll A description for Image. [DataContract] public struct ImageDescription : IEquatable<ImageDescription> Implements IEquatable<ImageDescription> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ArraySize Number of textures in the array. The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture1DArraySize (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks. public int ArraySize Field Value int Remarks This field is only valid for Texture1D, Texture2D and TextureCube Depth Texture depth (in texels). The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture3DSize (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks. public int Depth Field Value int Remarks This field is only valid for Texture3D. Dimension The dimension of a texture. public TextureDimension Dimension Field Value TextureDimension Format Texture format (see SharpDX.DXGI.Format). public PixelFormat Format Field Value PixelFormat Height Texture height (in texels). The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture3DSize (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks. public int Height Field Value int Remarks This field is only valid for Texture2D, Texture3D and TextureCube. MipLevels The maximum number of mipmap levels in the texture. See the remarks in SharpDX.Direct3D11.ShaderResourceViewDescription.Texture1DResource. Use 1 for a multisampled texture; or 0 to generate a full set of subtextures. public int MipLevels Field Value int Width Texture width (in texels). The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture1DSize (16384). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks. public int Width Field Value int Remarks This field is valid for all textures: Texture1D, Texture2D, Texture3D and TextureCube. Methods Equals(ImageDescription) Indicates whether the current object is equal to another object of the same type. public bool Equals(ImageDescription other) Parameters other ImageDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(ImageDescription, ImageDescription) public static bool operator ==(ImageDescription left, ImageDescription right) Parameters left ImageDescription right ImageDescription Returns bool operator !=(ImageDescription, ImageDescription) public static bool operator !=(ImageDescription left, ImageDescription right) Parameters left ImageDescription right ImageDescription Returns bool"
  },
  "api/Stride.Graphics.ImageFileType.html": {
    "href": "api/Stride.Graphics.ImageFileType.html",
    "title": "Enum ImageFileType | Stride API",
    "summary": "Enum ImageFileType Namespace Stride.Graphics Assembly Stride.dll Image file format used by Save(Stream, ImageFileType) public enum ImageFileType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) ImageFileTypeExtensions.ToFileExtension(ImageFileType) UnsafeUtilities.As<T>(object?) Fields Bmp = 5 A BMP file. Dds = 1 A DDS file. Gif = 3 A GIF file. Jpg = 4 A JPG file. Png = 2 A PNG file. Stride = 0 Stride image file. Tga = 8 A TGA File. Tiff = 6 A TIFF file. Wmp = 7 A WMP file."
  },
  "api/Stride.Graphics.ImageFileTypeExtensions.html": {
    "href": "api/Stride.Graphics.ImageFileTypeExtensions.html",
    "title": "Class ImageFileTypeExtensions | Stride API",
    "summary": "Class ImageFileTypeExtensions Namespace Stride.Graphics Assembly Stride.dll public static class ImageFileTypeExtensions Inheritance object ImageFileTypeExtensions Methods ToFileExtension(ImageFileType) Return the file extension corresponding to the image file type. public static string ToFileExtension(this ImageFileType fileType) Parameters fileType ImageFileType The file type Returns string The file extension (for example \".png\")."
  },
  "api/Stride.Graphics.ImageHelper.html": {
    "href": "api/Stride.Graphics.ImageHelper.html",
    "title": "Class ImageHelper | Stride API",
    "summary": "Class ImageHelper Namespace Stride.Graphics Assembly Stride.dll public class ImageHelper Inheritance object ImageHelper Extension Methods UnsafeUtilities.As<T>(object?) Methods LoadFromMemory(nint, int, bool, GCHandle?) public static Image LoadFromMemory(nint pSource, int size, bool makeACopy, GCHandle? handle) Parameters pSource nint size int makeACopy bool handle GCHandle? Returns Image SaveFromMemory(PixelBuffer[], int, ImageDescription, Stream) public static void SaveFromMemory(PixelBuffer[] pixelBuffers, int count, ImageDescription description, Stream imageStream) Parameters pixelBuffers PixelBuffer[] count int description ImageDescription imageStream Stream"
  },
  "api/Stride.Graphics.ImageOrientation.html": {
    "href": "api/Stride.Graphics.ImageOrientation.html",
    "title": "Enum ImageOrientation | Stride API",
    "summary": "Enum ImageOrientation Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines the possible rotations to apply on image regions. public enum ImageOrientation Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AsIs = 0 The image region is taken as is. Rotated90 = 1 The image is rotated of the 90 degrees (clockwise) in the source texture."
  },
  "api/Stride.Graphics.IndexBufferBinding.html": {
    "href": "api/Stride.Graphics.IndexBufferBinding.html",
    "title": "Class IndexBufferBinding | Stride API",
    "summary": "Class IndexBufferBinding Namespace Stride.Graphics Assembly Stride.Graphics.dll Binding structure that specifies an Index Buffer for a Graphics Device. [DataSerializer(typeof(IndexBufferBinding.Serializer))] public class IndexBufferBinding : IEquatable<IndexBufferBinding> Inheritance object IndexBufferBinding Implements IEquatable<IndexBufferBinding> Extension Methods SimpleExtensions.IsSimple(IndexBufferBinding) MeshExtension.AsReadable(IndexBufferBinding, IServiceRegistry, out IndexBufferHelper, out int) UnsafeUtilities.As<T>(object?) Constructors IndexBufferBinding(Buffer, bool, int, int) Initializes a new instance of the IndexBufferBinding class. public IndexBufferBinding(Buffer indexBuffer, bool is32Bit, int indexCount, int indexOffset = 0) Parameters indexBuffer Buffer The Index Buffer to bind. is32Bit bool A value indicating if the indices are 16-bit (false), or 32-bit (true). indexCount int The number of indices in the Buffer to use. indexOffset int Exceptions ArgumentNullException indexBuffer is null. Properties Buffer Gets the Index Buffer to bind. public Buffer Buffer { get; } Property Value Buffer Count Gets the number of indices in the Buffer to use. public int Count { get; } Property Value int Is32Bit Gets a value indicating if the Buffer contains 32-bit indices. public bool Is32Bit { get; } Property Value bool true if the Buffer contains 32-bit indices; false if the Buffer contains 16-bit indices. Offset Gets the offset (in number of indices) from the beginning of the Buffer to the first index to use. public int Offset { get; } Property Value int Methods Equals(IndexBufferBinding) Indicates whether the current object is equal to another object of the same type. public bool Equals(IndexBufferBinding other) Parameters other IndexBufferBinding An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Determines whether the specified object is equal to the current object. public override bool Equals(object obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Operators operator ==(IndexBufferBinding, IndexBufferBinding) public static bool operator ==(IndexBufferBinding left, IndexBufferBinding right) Parameters left IndexBufferBinding right IndexBufferBinding Returns bool operator !=(IndexBufferBinding, IndexBufferBinding) public static bool operator !=(IndexBufferBinding left, IndexBufferBinding right) Parameters left IndexBufferBinding right IndexBufferBinding Returns bool"
  },
  "api/Stride.Graphics.IndexBufferHelper.html": {
    "href": "api/Stride.Graphics.IndexBufferHelper.html",
    "title": "Struct IndexBufferHelper | Stride API",
    "summary": "Struct IndexBufferHelper Namespace Stride.Graphics Assembly Stride.Graphics.dll public readonly struct IndexBufferHelper Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Examples Reading the indices of a mesh: Model.Meshes[0].Draw.IndexBuffer.AsReadable(Services, out IndexBufferHelper helper, out int count) var indices = helper.To32Bit(); Constructors IndexBufferHelper(IndexBufferBinding, IServiceRegistry, out int) Fetch this buffer and create a helper to read from it. public IndexBufferHelper(IndexBufferBinding binding, IServiceRegistry services, out int count) Parameters binding IndexBufferBinding The bindings for this buffer services IServiceRegistry The service used to retrieve the buffer from disk/GPU if it wasn't found through other means count int The amount of indices this buffer holds Examples Reading the indices of a mesh: Model.Meshes[0].Draw.IndexBuffer.AsReadable(Services, out IndexBufferHelper helper, out int count) var indices = helper.To32Bit(); Remarks This operation loads the buffer from disk, or directly from the gpu. It is very slow, avoid calling this too often if at all possible. IndexBufferHelper(IndexBufferBinding, byte[], out int) Fetch this buffer and create a helper to read from it. public IndexBufferHelper(IndexBufferBinding binding, byte[] dataOuter, out int count) Parameters binding IndexBufferBinding The bindings for this buffer dataOuter byte[] count int The amount of indices this buffer holds Examples Reading the indices of a mesh: Model.Meshes[0].Draw.IndexBuffer.AsReadable(Services, out IndexBufferHelper helper, out int count) var indices = helper.To32Bit(); Remarks This operation loads the buffer from disk, or directly from the gpu. It is very slow, avoid calling this too often if at all possible. Fields Binding public readonly IndexBufferBinding Binding Field Value IndexBufferBinding DataOuter Full index buffer, does not account for the binding offset or length public readonly byte[] DataOuter Field Value byte[] Properties DataInner Effective index buffer, handles the binding offset public Span<byte> DataInner { get; } Property Value Span<byte> Methods CopyTo(Span<int>) public void CopyTo(Span<int> dest) Parameters dest Span<int> CopyTo(Span<ushort>) public void CopyTo(Span<ushort> dest) Parameters dest Span<ushort> Is32Bit(out Span<int>, out Span<ushort>) Branch to read the buffer as a 16 or 32 bit buffer, does not allocate public bool Is32Bit(out Span<int> data32, out Span<ushort> data16) Parameters data32 Span<int> data16 Span<ushort> Returns bool Examples if (Is32Bit(out var d32, out var d16)) { foreach (var value in d32) { // Your logic for 32 bit } } else { foreach (var value in d16) { // Your logic for 16bit } } To16Bit() Does not allocate if the buffer is already 16 bit, otherwise allocates a new ushort[] and copies the data into it public Span<ushort> To16Bit() Returns Span<ushort> To32Bit() Does not allocate if the buffer is already 32 bit, otherwise allocates a new int[] and copies the data into it public Span<int> To32Bit() Returns Span<int>"
  },
  "api/Stride.Graphics.IndexElementSize.html": {
    "href": "api/Stride.Graphics.IndexElementSize.html",
    "title": "Enum IndexElementSize | Stride API",
    "summary": "Enum IndexElementSize Namespace Stride.Graphics Assembly Stride.Graphics.dll Specifies the size of indices in an Index Buffer. public enum IndexElementSize Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Int16 = 2 The indices are 16-bit integers (2 bytes). Int32 = 4 The indices are 32-bit integers (4 bytes)."
  },
  "api/Stride.Graphics.InputClassification.html": {
    "href": "api/Stride.Graphics.InputClassification.html",
    "title": "Enum InputClassification | Stride API",
    "summary": "Enum InputClassification Namespace Stride.Graphics Assembly Stride.Graphics.dll Specifies whether the data of a Input Element is per-vertex or per-instance. public enum InputClassification Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Instance = 1 The data is per-instance, meaning it represents information about a particular geometry instance in an instancing scenario. Vertex = 0 The data is per-vertex, meaning it represents a standard vertex attribute."
  },
  "api/Stride.Graphics.InputElementDescription.html": {
    "href": "api/Stride.Graphics.InputElementDescription.html",
    "title": "Struct InputElementDescription | Stride API",
    "summary": "Struct InputElementDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a single input element for the definition of a vertex format layout. public struct InputElementDescription : IEquatable<InputElementDescription> Implements IEquatable<InputElementDescription> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks Each input element defines how a portion of a vertex or instance is read from a Vertex Buffer and mapped to a shader input. This structure is typically used to define the layout of vertex data when creating an input layout object. Fields AlignedByteOffset The byte offset from the start of the vertex to this element. public int AlignedByteOffset Field Value int Remarks Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Format The data format of the element, such as R32G32B32_Float or R8G8B8A8_UNorm. public PixelFormat Format Field Value PixelFormat Remarks This must match the format expected by the Shader and the layout of the Vertex Buffer. InputSlot The input slot index from which this element is read. public int InputSlot Field Value int Remarks Multiple Vertex Buffers can be bound to different input slots. This value selects which one to use for this element. InputSlotClass Specifies whether the data is per-vertex or per-instance. public InputClassification InputSlotClass Field Value InputClassification Remarks Use Vertex for standard vertex attributes, or Instance for instancing. InstanceDataStepRate The number of instances to draw using the same per-instance data before advancing to the next element. public int InstanceDataStepRate Field Value int Remarks This must be 0 for per-vertex data. For instanced data, a value of 1 means the data advances every instance. SemanticIndex The semantic index for the element, used when multiple elements share the same semantic name. public int SemanticIndex Field Value int Remarks For example, a 4x4 matrix might be passed as four \"TEXCOORD\" elements with indices 0 through 3. SemanticName The semantic name associated with this element, such as \"POSITION\", \"TEXCOORD\", or \"NORMAL\". public string SemanticName Field Value string Remarks This name must match the semantic used in the Vertex Shader input signature. Methods Equals(InputElementDescription) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(InputElementDescription other) Parameters other InputElementDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(InputElementDescription, InputElementDescription) public static bool operator ==(InputElementDescription left, InputElementDescription right) Parameters left InputElementDescription right InputElementDescription Returns bool operator !=(InputElementDescription, InputElementDescription) public static bool operator !=(InputElementDescription left, InputElementDescription right) Parameters left InputElementDescription right InputElementDescription Returns bool"
  },
  "api/Stride.Graphics.Interop.Byte4.html": {
    "href": "api/Stride.Graphics.Interop.Byte4.html",
    "title": "Struct Byte4 | Stride API",
    "summary": "Struct Byte4 Namespace Stride.Graphics.Interop Assembly Stride.Graphics.dll public struct Byte4 Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Byte4(byte, byte, byte, byte) public Byte4(byte x, byte y, byte z, byte w) Parameters x byte y byte z byte w byte Fields W public byte W Field Value byte X public byte X Field Value byte Y public byte Y Field Value byte Z public byte Z Field Value byte"
  },
  "api/Stride.Graphics.Interop.UShort4.html": {
    "href": "api/Stride.Graphics.Interop.UShort4.html",
    "title": "Struct UShort4 | Stride API",
    "summary": "Struct UShort4 Namespace Stride.Graphics.Interop Assembly Stride.Graphics.dll public struct UShort4 Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors UShort4(ushort, ushort, ushort, ushort) public UShort4(ushort x, ushort y, ushort z, ushort w) Parameters x ushort y ushort z ushort w ushort Fields W public ushort W Field Value ushort X public ushort X Field Value ushort Y public ushort Y Field Value ushort Z public ushort Z Field Value ushort"
  },
  "api/Stride.Graphics.Interop.html": {
    "href": "api/Stride.Graphics.Interop.html",
    "title": "Namespace Stride.Graphics.Interop | Stride API",
    "summary": "Namespace Stride.Graphics.Interop Structs Byte4 UShort4"
  },
  "api/Stride.Graphics.MapMode.html": {
    "href": "api/Stride.Graphics.MapMode.html",
    "title": "Enum MapMode | Stride API",
    "summary": "Enum MapMode Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes how the CPU is accessing a GraphicsResource with the MapSubResource(GraphicsResource, int, MapMode, bool, int, int) method. public enum MapMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Read = 1 The Graphics Resource is mapped for reading. The Graphics Resource must have been created with Staging. ReadWrite = 3 The Graphics Resource is mapped for reading and writing. The Graphics Resource must have been created with Staging. Write = 2 The Graphics Resource is mapped for writing. The Graphics Resource must have been created with Dynamic or Staging. WriteDiscard = 4 The Graphics Resource is mapped for writing, making the previous contents of the resource undefined. The Graphics Resource must have been created with Dynamic. WriteNoOverwrite = 5 The Graphics Resource is mapped for writing, ensuring the existing contents of the resource cannot be overwritten. This flag is only valid on Vertex Buffers and Index Buffers."
  },
  "api/Stride.Graphics.MappedResource.html": {
    "href": "api/Stride.Graphics.MappedResource.html",
    "title": "Struct MappedResource | Stride API",
    "summary": "Struct MappedResource Namespace Stride.Graphics Assembly Stride.Graphics.dll A GPU resource mapped for CPU access. This is returned by using MapSubResource(GraphicsResource, int, MapMode, bool, int, int). public readonly struct MappedResource Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields DataBox The data box specifying how the data is laid out in memory. public readonly DataBox DataBox Field Value DataBox OffsetInBytes The offset of the mapped resource since the beginning of the buffer, in bytes. public readonly int OffsetInBytes Field Value int Resource The resource mapped for CPU access. public readonly GraphicsResource Resource Field Value GraphicsResource SizeInBytes The size of the mapped resource, in bytes. public readonly int SizeInBytes Field Value int SubResourceIndex The sub-resource index. public readonly int SubResourceIndex Field Value int"
  },
  "api/Stride.Graphics.MeshExtension.html": {
    "href": "api/Stride.Graphics.MeshExtension.html",
    "title": "Class MeshExtension | Stride API",
    "summary": "Class MeshExtension Namespace Stride.Graphics Assembly Stride.Graphics.dll public static class MeshExtension Inheritance object MeshExtension Methods AsReadable(IndexBufferBinding, IServiceRegistry, out IndexBufferHelper, out int) Fetch this buffer and create a helper to read from it. public static void AsReadable(this IndexBufferBinding binding, IServiceRegistry services, out IndexBufferHelper helper, out int count) Parameters binding IndexBufferBinding The bindings for this buffer services IServiceRegistry The service used to retrieve the buffer from disk/GPU if it wasn't found through other means helper IndexBufferHelper The helper class to interact with the loaded buffer count int The amount of indices this buffer holds Examples Reading the indices of a mesh: Model.Meshes[0].Draw.IndexBuffer.AsReadable(Services, out IndexBufferHelper helper, out int count) var indices = helper.To32Bit(); Remarks This operation loads the buffer from disk, or directly from the gpu. It is very slow, avoid calling this too often if at all possible. AsReadable(VertexBufferBinding, IServiceRegistry, out VertexBufferHelper, out int) Fetch this buffer and create a helper to read from it. public static void AsReadable(this VertexBufferBinding binding, IServiceRegistry services, out VertexBufferHelper helper, out int count) Parameters binding VertexBufferBinding The bindings for this buffer services IServiceRegistry The service used to retrieve the buffer from disk/GPU if it wasn't found through other means helper VertexBufferHelper The helper class to interact with the loaded buffer count int The amount of vertices this buffer holds Examples Reading the vertex positions of a mesh: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); var vertexPositions = new Vector3[count]; helper.Copy<PositionSemantic, Vector3>(vertexPositions); Remarks This operation loads the buffer from disk, or directly from the gpu. It is very slow, avoid calling this too often if at all possible. TryGetElement(VertexDeclaration, string, int, out VertexElementWithOffset) Given a semantic and its index, returns its offset and size in the given vertex buffer. Similar to EnumerateWithOffsets() public static bool TryGetElement(this VertexDeclaration declaration, string vertexElementUsage, int semanticIndex, out VertexElementWithOffset result) Parameters declaration VertexDeclaration vertexElementUsage string semanticIndex int result VertexElementWithOffset Returns bool"
  },
  "api/Stride.Graphics.MipMapCount.html": {
    "href": "api/Stride.Graphics.MipMapCount.html",
    "title": "Struct MipMapCount | Stride API",
    "summary": "Struct MipMapCount Namespace Stride.Graphics Assembly Stride.dll Describes the number of mipmap levels of a Texture. public readonly struct MipMapCount : IEquatable<MipMapCount> Implements IEquatable<MipMapCount> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks MipMapCount allows implicit conversion from several types of values: Set to true to specify all mipmaps (i.e. the whole mipchain). This is equivalent to Auto. Set to false to specify a single mipmap. This is equivalent to One. Set to any positive non-zero integer to indicate a specific number of mipmaps. Constructors MipMapCount(bool) Initializes a new instance of the MipMapCount struct. public MipMapCount(bool allMipMaps) Parameters allMipMaps bool true to indicate that all mipmap levels should be generated; false to indicate only a single level. MipMapCount(int) Initializes a new instance of the MipMapCount struct. public MipMapCount(int count) Parameters count int The mipmap count. Fields Auto Automatic mipmap count based on the size of the Texture (i.e. the whole mipchain). public static readonly MipMapCount Auto Field Value MipMapCount Count The number of mipmaps. public readonly int Count Field Value int Remarks A value of zero (0) means that all mipmaps (the whole mipchain) will be generated. A value of one (1) means only a single mipmap is generated. Any other number indicates the number of mipmaps to generate. One Just a single mipmap. public static readonly MipMapCount One Field Value MipMapCount Methods Equals(MipMapCount) Indicates whether the current object is equal to another object of the same type. public bool Equals(MipMapCount other) Parameters other MipMapCount An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(MipMapCount, MipMapCount) public static bool operator ==(MipMapCount left, MipMapCount right) Parameters left MipMapCount right MipMapCount Returns bool implicit operator bool(MipMapCount) Performs an implicit conversion from MipMapCount to bool. public static implicit operator bool(MipMapCount mipMap) Parameters mipMap MipMapCount The value to convert. Returns bool true if all mipmap levels should be generated; false a single level or more should be generated. implicit operator int(MipMapCount) Performs an implicit conversion from MipMapCount to int. public static implicit operator int(MipMapCount mipMap) Parameters mipMap MipMapCount The value to convert. Returns int The number of mipmaps. A value of zero (0) means all mipmaps. implicit operator MipMapCount(bool) Performs an implicit conversion from bool to MipMapCount. public static implicit operator MipMapCount(bool allMipMaps) Parameters allMipMaps bool true to indicate that all mipmap levels should be generated; false to indicate only a single level. Returns MipMapCount The result of the conversion. implicit operator MipMapCount(int) Performs an implicit conversion from int to MipMapCount. public static implicit operator MipMapCount(int mipMapCount) Parameters mipMapCount int The number of mipmaps. A value of zero (0) means all mipmaps. Returns MipMapCount The result of the conversion. operator !=(MipMapCount, MipMapCount) public static bool operator !=(MipMapCount left, MipMapCount right) Parameters left MipMapCount right MipMapCount Returns bool"
  },
  "api/Stride.Graphics.MipMapDescription.html": {
    "href": "api/Stride.Graphics.MipMapDescription.html",
    "title": "Struct MipMapDescription | Stride API",
    "summary": "Struct MipMapDescription Namespace Stride.Graphics Assembly Stride.dll Describes a mipmap image. public readonly struct MipMapDescription : IEquatable<MipMapDescription> Implements IEquatable<MipMapDescription> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks Mipmaps are a sequence of precomputed textures, each of which is a progressively smaller version of the original texture. These are used in 3D graphics to improve rendering performance and reduce aliasing artifacts. Each of the images in the sequence is called a mipmap level. This structure describes one of those. Constructors MipMapDescription(int, int, int, int, int, int, int) Describes a mipmap image. public MipMapDescription(int width, int height, int depth, int rowStride, int depthStride, int widthPacked, int heightPacked) Parameters width int The width of the mipmap, in texels. height int The height of the mipmap, in texels. depth int The depth of the mipmap, in texels. rowStride int The row stride of the mipmap, in bytes. depthStride int The depth stride of the mipmap, in bytes. widthPacked int The width of the mipmap in \"blocks\". If the pixel format is not a block-compressed format (like BC1, BC2, etc.), this will be the same as width. Otherwise, if the format is block-compressed, this parameter represents the number of blocks across the width (usually ~1/4 the width). heightPacked int The height of the mipmap in \"blocks\". If the pixel format is not a block-compressed format (like BC1, BC2, etc.), this will be the same as height. Otherwise, if the format is block-compressed, this parameter represents the number of blocks across the height (usually ~1/4 the height). Remarks Mipmaps are a sequence of precomputed textures, each of which is a progressively smaller version of the original texture. These are used in 3D graphics to improve rendering performance and reduce aliasing artifacts. Each of the images in the sequence is called a mipmap level. This structure describes one of those. Fields Depth Depth of the mipmap, in texels. public readonly int Depth Field Value int DepthStride Depth stride of the mipmap (i.e. number of bytes per depth slice). public readonly int DepthStride Field Value int Height Height of the mipmap, in texels. public readonly int Height Field Value int HeightPacked Height of the mipmap, in blocks. public readonly int HeightPacked Field Value int Remarks If the pixel format is not a block-compressed format (like BC1, BC2, etc.), this will be the same as Height. Otherwise, if the format is block-compressed, this parameter represents the number of blocks across the height (usually ~1/4 the height). MipmapSize Size of the whole mipmap, in bytes. public readonly int MipmapSize Field Value int RowStride Row stride of the mipmap (i.e. number of bytes per row). public readonly int RowStride Field Value int Width Width of the mipmap, in texels. public readonly int Width Field Value int WidthPacked Width of the mipmap, in blocks. public readonly int WidthPacked Field Value int Remarks If the pixel format is not a block-compressed format (like BC1, BC2, etc.), this will be the same as Width. Otherwise, if the format is block-compressed, this parameter represents the number of blocks across the width (usually ~1/4 the width). Methods Equals(MipMapDescription) Indicates whether the current object is equal to another object of the same type. public bool Equals(MipMapDescription other) Parameters other MipMapDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(MipMapDescription, MipMapDescription) public static bool operator ==(MipMapDescription left, MipMapDescription right) Parameters left MipMapDescription right MipMapDescription Returns bool operator !=(MipMapDescription, MipMapDescription) public static bool operator !=(MipMapDescription left, MipMapDescription right) Parameters left MipMapDescription right MipMapDescription Returns bool"
  },
  "api/Stride.Graphics.MultisampleCount.html": {
    "href": "api/Stride.Graphics.MultisampleCount.html",
    "title": "Enum MultisampleCount | Stride API",
    "summary": "Enum MultisampleCount Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines the level of multisampling. public enum MultisampleCount Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields None = 1 No multisampling. X2 = 2 Multisampling using two samples per pixel. X4 = 4 Multisampling using four samples per pixel. X8 = 8 Multisampling using eight samples per pixel."
  },
  "api/Stride.Graphics.MutablePipelineState.html": {
    "href": "api/Stride.Graphics.MutablePipelineState.html",
    "title": "Class MutablePipelineState | Stride API",
    "summary": "Class MutablePipelineState Namespace Stride.Graphics Assembly Stride.Graphics.dll A convenience class that allows to compose a Pipeline State by modifying its configuration (as PipelineState objects are immutable once compiled), and only compile it into a Pipeline State object when needed. public class MutablePipelineState Inheritance object MutablePipelineState Extension Methods UnsafeUtilities.As<T>(object?) Remarks To minimize the creation of PipelineState objects, they are cached internally per Graphics Device based on their description, so subsequent uses of a Pipeline State with the same description uses the same instance instead of allocating a new one. Constructors MutablePipelineState(GraphicsDevice) Initializes a new instance of the MutablePipelineState class. public MutablePipelineState(GraphicsDevice graphicsDevice) Parameters graphicsDevice GraphicsDevice The Graphics Device. Properties CurrentState Gets the current compiled Pipeline State. public PipelineState? CurrentState { get; } Property Value PipelineState The current compiled Pipeline State. If this instance have not compiled any Pipeline State, the value will be null. State Gets the description of the current Pipeline State. public PipelineStateDescription State { get; } Property Value PipelineStateDescription Methods Update() Determines if the mutable Pipeline State has changed, and updates the CurrentState. public void Update() Remarks This method uses the current mutable Pipeline State to look for a cached PipelineState with the same description. If found, it is returned. If not, a new Pipeline State object is compiled from the current description (State), and cached for subsequent uses."
  },
  "api/Stride.Graphics.ParameterCollectionLayoutExtensions.html": {
    "href": "api/Stride.Graphics.ParameterCollectionLayoutExtensions.html",
    "title": "Class ParameterCollectionLayoutExtensions | Stride API",
    "summary": "Class ParameterCollectionLayoutExtensions Namespace Stride.Graphics Assembly Stride.Graphics.dll Provides extension methods for updating ParameterCollectionLayout instances. public static class ParameterCollectionLayoutExtensions Inheritance object ParameterCollectionLayoutExtensions Methods ProcessConstantBuffer(ParameterCollectionLayout, EffectConstantBufferDescription) Updates a parameter collection layout with a description of an Effect's Constant Buffer. public static void ProcessConstantBuffer(this ParameterCollectionLayout parameterCollectionLayout, EffectConstantBufferDescription constantBuffer) Parameters parameterCollectionLayout ParameterCollectionLayout The ParameterCollectionLayout to be updated with resource information. constantBuffer EffectConstantBufferDescription The description of an Effect's Constant Buffer containing members to process. Remarks This method iterates over the members of the provided Constant Buffer, creating and adding ParameterKeyInfo instances to the layout. It also updates the buffer size of the parameter collection layout by adding the size of the Constant Buffer. ProcessResources(ParameterCollectionLayout, DescriptorSetLayoutBuilder) Updates a parameter collection layout with information from a Descriptor Set layout. public static void ProcessResources(this ParameterCollectionLayout parameterCollectionLayout, DescriptorSetLayoutBuilder layout) Parameters parameterCollectionLayout ParameterCollectionLayout The ParameterCollectionLayout to be updated with resource information. layout DescriptorSetLayoutBuilder The DescriptorSetLayoutBuilder containing the resource entries to process. Remarks This method iterates over the entries in the provided layout and adds corresponding ParameterKeyInfo objects to the parameterCollectionLayout. The resource count in parameterCollectionLayout is incremented for each entry processed."
  },
  "api/Stride.Graphics.PipelineState.html": {
    "href": "api/Stride.Graphics.PipelineState.html",
    "title": "Class PipelineState | Stride API",
    "summary": "Class PipelineState Namespace Stride.Graphics Assembly Stride.Graphics.dll A Pipeline State object encapsulates the complete pipeline configuration, including Shaders, input layout, Render States, and output settings. It represents an atomic, immutable collection of states that can be efficiently bound and unbound as a single unit during rendering operations. An instance of this class can represent either the state of the graphics pipeline, or the state of the compute pipeline (in the platforms that support compute). public class PipelineState : GraphicsResourceBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase PipelineState Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsResourceBase.NativeResource GraphicsResourceBase.NativeDeviceChild GraphicsResourceBase.UnsetNativeDeviceChild() GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) GraphicsResourceBase.NativeDevice GraphicsResourceBase.IsDebugMode GraphicsResourceBase.OnRecreate() GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed GraphicsResourceBase.OnPause() GraphicsResourceBase.OnResume() GraphicsResourceBase.Destroy() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties InputBindingCount public int InputBindingCount { get; } Property Value int Methods New(GraphicsDevice, PipelineStateDescription) Creates a new Pipeline State object from the provided description. public static PipelineState New(GraphicsDevice graphicsDevice, PipelineStateDescription pipelineStateDescription) Parameters graphicsDevice GraphicsDevice The Graphics Device. pipelineStateDescription PipelineStateDescription A description of the desired graphics pipeline configuration. Returns PipelineState A new instance of PipelineState. OnDestroyed(bool) Called when the GraphicsDevice has been detected to be internally destroyed, or when the Destroy() methad has been called. Raises the Destroyed event. protected override void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the resource should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). Remarks This method releases the underlying native resources (Silk.NET.Direct3D11.ID3D11Resource and Silk.NET.Direct3D11.ID3D11DeviceChild)."
  },
  "api/Stride.Graphics.PipelineStateDescription.html": {
    "href": "api/Stride.Graphics.PipelineStateDescription.html",
    "title": "Class PipelineStateDescription | Stride API",
    "summary": "Class PipelineStateDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes the configuration of the graphics pipeline that will be encapsulated by a PipelineState object. This includes Shaders, input layout, Render States, and output settings. public sealed class PipelineStateDescription : IEquatable<PipelineStateDescription> Inheritance object PipelineStateDescription Implements IEquatable<PipelineStateDescription> Extension Methods UnsafeUtilities.As<T>(object?) Fields BlendState A description of the Blend State, which controls how the output color and alpha values of rendered pixels are blended with existing pixels in the bound Render Targets. public BlendStateDescription BlendState Field Value BlendStateDescription DepthStencilState A description of the Depth-Stencil State, which controls how Depth and Stencil Buffers are used during rendering, including comparison functions, write masks, and stencil operations. public DepthStencilStateDescription DepthStencilState Field Value DepthStencilStateDescription EffectBytecode Compiled Shader programs (vertex, pixel, geometry, etc.) that define the programmable stages of the graphics pipeline. public EffectBytecode? EffectBytecode Field Value EffectBytecode InputElements A description of the input layout for the Vertex Buffer, which defines how vertex data is structured. The array describes per-vertex attributes such as position, normal, texture coordinates, and their respective formats. public InputElementDescription[]? InputElements Field Value InputElementDescription[] Output A description of the output configuration for the graphics pipeline, such as the format and count of Render Targets, along with the Depth-Stencil Buffer format used for rendering output. public RenderOutputDescription Output Field Value RenderOutputDescription PrimitiveType Specifies how vertices should be interpreted to form primitives (points, lines, triangles, etc.) public PrimitiveType PrimitiveType Field Value PrimitiveType RasterizerState A description of the Rasterizer State, which controls how primitives are rasterized into pixels, including settings for culling, fill mode, depth bias, and scissor testing. public RasterizerStateDescription RasterizerState Field Value RasterizerStateDescription RootSignature A definition of the Shader resources and their bindings, including Constant Buffers, Textures, and Samplers that will be accessed by the Shader programs. public RootSignature? RootSignature Field Value RootSignature SampleMask A 32-bit mask that determines which samples in a multi-sampled Render Target are updated during rendering operations. public uint SampleMask Field Value uint Methods Clone() Creates a new object that is a copy of the current instance. public PipelineStateDescription Clone() Returns PipelineStateDescription A new object that is a copy of this instance. Equals(PipelineStateDescription?) Indicates whether the current object is equal to another object of the same type. public bool Equals(PipelineStateDescription? other) Parameters other PipelineStateDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object?) Determines whether the specified object is equal to the current object. public override bool Equals(object? obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. SetDefaults() Sets default values for this Pipeline State Description. public void SetDefaults() Remarks For more information about the default values, see the individual state descriptions: Default, Default, and Default. Operators operator ==(PipelineStateDescription, PipelineStateDescription) public static bool operator ==(PipelineStateDescription left, PipelineStateDescription right) Parameters left PipelineStateDescription right PipelineStateDescription Returns bool operator !=(PipelineStateDescription, PipelineStateDescription) public static bool operator !=(PipelineStateDescription left, PipelineStateDescription right) Parameters left PipelineStateDescription right PipelineStateDescription Returns bool See Also PipelineState"
  },
  "api/Stride.Graphics.PixelBuffer.html": {
    "href": "api/Stride.Graphics.PixelBuffer.html",
    "title": "Class PixelBuffer | Stride API",
    "summary": "Class PixelBuffer Namespace Stride.Graphics Assembly Stride.dll An unmanaged buffer of pixels. public sealed class PixelBuffer Inheritance object PixelBuffer Extension Methods UnsafeUtilities.As<T>(object?) Constructors PixelBuffer(int, int, PixelFormat, int, int, nint) Initializes a new instance of the PixelBuffer struct. public PixelBuffer(int width, int height, PixelFormat format, int rowStride, int bufferStride, nint dataPointer) Parameters width int The width. height int The height. format PixelFormat The format. rowStride int The row pitch. bufferStride int The slice pitch. dataPointer nint The pixels. Properties BufferStride Gets the total size in bytes of this pixel buffer. public int BufferStride { get; } Property Value int The size in bytes of the pixel buffer. DataPointer Gets the pointer to the pixel buffer. public nint DataPointer { get; } Property Value nint The pointer to the pixel buffer. Format Gets the format. public PixelFormat Format { get; } Property Value PixelFormat The format. Height Gets the height. public int Height { get; } Property Value int The height. PixelSize Gets the pixel size in bytes. public int PixelSize { get; } Property Value int The pixel size in bytes. RowStride Gets the row stride in number of bytes. public int RowStride { get; } Property Value int The row stride in number of bytes. Width Gets the width. public int Width { get; } Property Value int The width. Methods ConvertFormatToNonSRgb() Converts the format to non sRGB. public void ConvertFormatToNonSRgb() ConvertFormatToSRgb() Converts the format to sRGB. public void ConvertFormatToSRgb() CopyTo(PixelBuffer) Copies this pixel buffer to a destination pixel buffer. public void CopyTo(PixelBuffer pixelBuffer) Parameters pixelBuffer PixelBuffer The destination pixel buffer. Remarks The destination pixel buffer must have exactly the same dimensions (width, height) and format than this instance. Destination buffer can have different row stride. GetPixel<T>(int, int) Gets the pixel value at a specified position. public T GetPixel<T>(int x, int y) where T : struct Parameters x int The x-coordinate. y int The y-coordinate. Returns T The pixel value. Type Parameters T Type of the pixel data Remarks Caution, this method doesn't check bounding. GetPixels<T>(int) Gets scanline pixels from the buffer. public T[] GetPixels<T>(int yOffset = 0) where T : struct Parameters yOffset int The y line offset. Returns T[] Scanline pixels from the buffer Type Parameters T Type of the pixel data Remarks This method is working on a row basis. The yOffset is specifying the first row to get the pixels from. Exceptions ArgumentException If the sizeof(T) is an invalid size GetPixels<T>(T[], int) Gets scanline pixels from the buffer. public void GetPixels<T>(T[] pixels, int yOffset = 0) where T : struct Parameters pixels T[] An allocated scanline pixel buffer yOffset int The y line offset. Type Parameters T Type of the pixel data Remarks This method is working on a row basis. The yOffset is specifying the first row to get the pixels from. Exceptions ArgumentException If the sizeof(T) is an invalid size GetPixels<T>(T[], int, int, int) Gets scanline pixels from the buffer. public void GetPixels<T>(T[] pixels, int yOffset, int pixelIndex, int pixelCount) where T : struct Parameters pixels T[] An allocated scanline pixel buffer yOffset int The y line offset. pixelIndex int Offset into the destination pixels buffer. pixelCount int Number of pixels to write into the destination pixels buffer. Type Parameters T Type of the pixel data Remarks This method is working on a row basis. The yOffset is specifying the first row to get the pixels from. Exceptions ArgumentException If the sizeof(T) is an invalid size Save(Stream, ImageFileType) Saves this pixel buffer to a stream. public void Save(Stream imageStream, ImageFileType fileType) Parameters imageStream Stream The destination stream. fileType ImageFileType Specify the output format. Remarks This method support the following format: dds, bmp, jpg, png, gif, tiff, wmp, tga. SetPixel<T>(int, int, T) Gets the pixel value at a specified position. public void SetPixel<T>(int x, int y, T value) where T : struct Parameters x int The x-coordinate. y int The y-coordinate. value T The pixel value. Type Parameters T Type of the pixel data Remarks Caution, this method doesn't check bounding. SetPixels<T>(T[], int) Sets scanline pixels to the buffer. public void SetPixels<T>(T[] sourcePixels, int yOffset = 0) where T : struct Parameters sourcePixels T[] Source pixel buffer yOffset int The y line offset. Type Parameters T Type of the pixel data Remarks This method is working on a row basis. The yOffset is specifying the first row to get the pixels from. Exceptions ArgumentException If the sizeof(T) is an invalid size SetPixels<T>(T[], int, int, int) Sets scanline pixels to the buffer. public void SetPixels<T>(T[] sourcePixels, int yOffset, int pixelIndex, int pixelCount) where T : struct Parameters sourcePixels T[] Source pixel buffer yOffset int The y line offset. pixelIndex int Offset into the source sourcePixels buffer. pixelCount int Number of pixels to write into the source sourcePixels buffer. Type Parameters T Type of the pixel data Remarks This method is working on a row basis. The yOffset is specifying the first row to get the pixels from. Exceptions ArgumentException If the sizeof(T) is an invalid size"
  },
  "api/Stride.Graphics.PixelBufferArray.html": {
    "href": "api/Stride.Graphics.PixelBufferArray.html",
    "title": "Class PixelBufferArray | Stride API",
    "summary": "Class PixelBufferArray Namespace Stride.Graphics Assembly Stride.dll Used by Image to provide a selector to a PixelBuffer. public sealed class PixelBufferArray Inheritance object PixelBufferArray Extension Methods UnsafeUtilities.As<T>(object?) Properties Count Gets the total number of pixel buffers. public int Count { get; } Property Value int The total number of pixel buffers. this[int] Gets the pixel buffer. public PixelBuffer this[int bufferIndex] { get; } Parameters bufferIndex int Property Value PixelBuffer A PixelBuffer. this[int, int] Gets the pixel buffer for the specified array/z slice and mipmap level. public PixelBuffer this[int arrayOrDepthSlice, int mipIndex] { get; } Parameters arrayOrDepthSlice int For 3D image, the parameter is the Z slice, otherwise it is an index into the texture array. mipIndex int The mip map slice index. Property Value PixelBuffer A PixelBuffer. this[int, int, int] Gets the pixel buffer for the specified array/z slice and mipmap level. public PixelBuffer this[int arrayIndex, int zIndex, int mipIndex] { get; } Parameters arrayIndex int Index into the texture array. Must be set to 0 for 3D images. zIndex int Z index for 3D image. Must be set to 0 for all 1D/2D images. mipIndex int The mip map slice index. Property Value PixelBuffer A PixelBuffer."
  },
  "api/Stride.Graphics.PixelFormat.html": {
    "href": "api/Stride.Graphics.PixelFormat.html",
    "title": "Enum PixelFormat | Stride API",
    "summary": "Enum PixelFormat Namespace Stride.Graphics Assembly Stride.dll Defines various types of pixel formats. [DataContract] public enum PixelFormat Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields A8_UNorm = 65 A single-component, 8-bit unsigned normalized integer format for alpha only. B5G5R5A1_UNorm = 86 A four-component, 16-bit unsigned normalized integer format that supports 5 bits for each color channel and 1-bit alpha. B5G6R5_UNorm = 85 A three-component, 16-bit unsigned normalized integer format that supports 5 bits for blue, 6 bits for green, and 5 bits for red. B8G8R8A8_Typeless = 90 A four-component, 32-bit format that supports 8 bits for each color channel and 8-bit alpha. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. B8G8R8A8_UNorm = 87 A four-component, 32-bit unsigned normalized integer format that supports 8 bits for each color channel and 8-bit alpha. B8G8R8A8_UNorm_SRgb = 91 A four-component, 32-bit unsigned normalized integer format that supports 8 bits for each color channel and 8-bit alpha, where the data is stored in sRGB color space, and the GPU will automatically convert it to linear space when sampling in a shader. B8G8R8X8_Typeless = 92 A four-component, 32-bit format that supports 8 bits for each color channel, and 8 bits are unused. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. B8G8R8X8_UNorm = 88 A four-component, 32-bit unsigned normalized integer format that supports 8 bits for each color channel and a remaining unused 8-bit part. B8G8R8X8_UNorm_SRgb = 93 A four-component, 32-bit unsigned-normalized standard RGB format that supports 8 bits for each color channel, and 8 bits are unused. , where the data is stored in sRGB color space, and the GPU will automatically convert it to linear space when sampling in a shader. BC1_Typeless = 70 A four-component, 64-bit block-compression format using the BC1 encoding, where the alpha channel is optionally encoded in 1 bit (either fully opaque or fully transparent), and the RGB color is encoded in 2 bits per pixel to select from a 4-color (or 3-color + transparent) color palette. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC1 format is tipically used for diffuse maps that do not require alpha transparency or where the alpha channel is not important. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. BC1_UNorm = 71 A four-component, 64-bit unsigned normalized integer block-compression format using the BC1 encoding, where the alpha channel is optionally encoded in 1 bit (either fully opaque or fully transparent), and the RGB color is encoded in 2 bits per pixel to select from a 4-color (or 3-color + transparent) color palette. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC1 format is tipically used for diffuse maps that do not require alpha transparency or where the alpha channel is not important. BC1_UNorm_SRgb = 72 A four-component, 64-bit unsigned normalized integer block-compression format for sRGB data using the BC1 encoding, where the alpha channel is optionally encoded in 1 bit (either fully opaque or fully transparent), and the RGB color is encoded in 2 bits per pixel to select from a 4-color (or 3-color + transparent) color palette. The data is stored in sRGB color space, and the GPU will automatically convert it to linear space when sampling in a shader. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC1 format is tipically used for diffuse maps that do not require alpha transparency or where the alpha channel is not important. BC2_Typeless = 73 A four-component, 128-bit block-compression format using the BC2 encoding, where the alpha channel is encoded in 4 bits (for 16 levels of transparency, quantized, not interpolated), and the RGB color is encoded in 2 bits per pixel to select from a 4-color color palette. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC2 format is tipically used for UI, decals, or sharp masks, although it is now considered somewhat outdated. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. BC2_UNorm = 74 A four-component, 128-bit unsigned normalized integer block-compression format using the BC2 encoding, where the alpha channel is encoded in 4 bits (for 16 levels of transparency, quantized, not interpolated), and the RGB color is encoded in 2 bits per pixel to select from a 4-color color palette. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC2 format is tipically used for UI, decals, or sharp masks, although it is now considered somewhat outdated. BC2_UNorm_SRgb = 75 A four-component, 128-bit unsigned normalized integer block-compression format for sRGB data using the BC2 encoding, where the alpha channel is encoded in 4 bits (for 16 levels of transparency, quantized, not interpolated), and the RGB color is encoded in 2 bits per pixel to select from a 4-color color palette. The data is stored in sRGB color space, and the GPU will automatically convert it to linear space when sampling in a shader. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC2 format is tipically used for UI, decals, or sharp masks, although it is now considered somewhat outdated. BC3_Typeless = 76 A four-component, 128-bit block-compression format using the BC3 encoding, where the alpha channel is encoded as two 8-bit alpha endpoints and 3 bits per pixel to select from 6 interpolated alpha values, and the RGB color is encoded in 2 bits per pixel to select from a 4-color color palette. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC3 format is tipically used for smooth and soft transparency, like foliage, shadows, hair, or smoke. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. BC3_UNorm = 77 A four-component, 128-bit unsigned normalized integer block-compression format using the BC3 encoding, where the alpha channel is encoded as two 8-bit alpha endpoints and 3 bits per pixel to select from 6 interpolated alpha values, and the RGB color is encoded in 2 bits per pixel to select from a 4-color color palette. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC3 format is tipically used for smooth and soft transparency, like foliage, shadows, hair, or smoke. BC3_UNorm_SRgb = 78 A four-component, 128-bit unsigned normalized integer block-compression format for sRGB data using the BC3 encoding, where the alpha channel is encoded as two 8-bit alpha endpoints and 3 bits per pixel to select from 6 interpolated alpha values, and the RGB color is encoded in 2 bits per pixel to select from a 4-color color palette. The data is stored in sRGB color space, and the GPU will automatically convert it to linear space when sampling in a shader. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC3 format is tipically used for smooth and soft transparency, like foliage, shadows, hair, or smoke. BC4_SNorm = 81 A single-component, 64-bit signed normalized integer block-compression format using the BC4 encoding, where the data is encoded as two 8-bit endpoints and 3 bits per pixel to select from 6 interpolated values. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC4 format is tipically used for grayscale Textures, smooth masks, or heightmaps. BC4_Typeless = 79 A single-component, 64-bit block-compression format using the BC4 encoding, where the data is encoded as two 8-bit endpoints and 3 bits per pixel to select from 6 interpolated values. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC4 format is tipically used for grayscale Textures, smooth masks, or heightmaps. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. BC4_UNorm = 80 A single-component, 64-bit unsigned normalized integer block-compression format using the BC4 encoding, where the data is encoded as two 8-bit endpoints and 3 bits per pixel to select from 6 interpolated values. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC4 format is tipically used for grayscale Textures, smooth masks, or heightmaps. BC5_SNorm = 84 A two-component, 128-bit signed normalized integer block-compression format using the BC5 encoding, where for each channel the data is encoded as two 8-bit endpoints and 3 bits per pixel to select from 6 interpolated values. This is essentially a BC4 format for each channel. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC5 format is tipically used for dual-channel data like normal maps (X and Y) or vector fields. BC5_Typeless = 82 A two-component, 128-bit block-compression format using the BC5 encoding, where for each channel the data is encoded as two 8-bit endpoints and 3 bits per pixel to select from 6 interpolated values. This is essentially a BC4 format for each channel. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC5 format is tipically used for dual-channel data like normal maps (X and Y) or vector fields. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. BC5_UNorm = 83 A two-component, 128-bit unsigned normalized integer block-compression format using the BC5 encoding, where for each channel the data is encoded as two 8-bit endpoints and 3 bits per pixel to select from 6 interpolated values. This is essentially a BC4 format for each channel. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC5 format is tipically used for dual-channel data like normal maps (X and Y) or vector fields. BC6H_Sf16 = 96 A three-component, 128-bit signed floating-point block-compression format for full-range HDR data using the BC6H encoding, where the color channels are encoded as 16-bit Half values and selected and interpolated according to the BC6H algorithm. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC6H format is best used for HDR environment maps, lightprobes, or any Texture with values beyond the [0,1] range. BC6H_Typeless = 94 A three-component, 128-bit block-compression format for HDR data using the BC6H encoding, where the color channels are encoded as 16-bit Half values and selected and interpolated according to the BC6H algorithm. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC6H format is best used for HDR environment maps, lightprobes, or any Texture with values beyond the [0,1] range. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. BC6H_Uf16 = 95 A three-component, 128-bit unsigned floating-point block-compression format for positive-only HDR data using the BC6H encoding, where the color channels are encoded as 16-bit Half values and selected and interpolated according to the BC6H algorithm. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC6H format is best used for HDR environment maps, lightprobes, or any Texture with values beyond the [0,1] range. BC7_Typeless = 97 A three- or four-component, 128-bit block-compression format using the BC7 encoding, where it can encode the RGB channels and an optional 1-8-bit alpha channel according to the BC7 algorithm. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC7 format is best for high-quality color Textures, like albedo maps, UI, or detailed color surfaces. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. BC7_UNorm = 98 A three- or four-component, 128-bit unsigned normalized integer block-compression format using the BC7 encoding, where it can encode the RGB channels and an optional 1-8-bit alpha channel according to the BC7 algorithm. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC7 format is best for high-quality color Textures, like albedo maps, UI, or detailed color surfaces. BC7_UNorm_SRgb = 99 A three- or four-component, 128-bit unsigned normalized integer block-compression format for sRGB data using the BC7 encoding, where it can encode the RGB channels and an optional 1-8-bit alpha channel according to the BC7 algorithm. The data is stored in sRGB color space, and the GPU will automatically convert it to linear space when sampling in a shader. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. The BC7 format is best for high-quality color Textures, like albedo maps, UI, or detailed color surfaces. D16_UNorm = 55 A single-component, 16-bit unsigned normalized integer format that supports 16 bits for depth. D24_UNorm_S8_UInt = 45 A two-component, 32-bit format consisting of a 24-bit unsigned normalized integer component for depth and a 8-bit unsigned integer component for stencil. D32_Float = 40 A single-component, 32-bit floating-point format that supports 32 bits for depth. D32_Float_S8X24_UInt = 20 A composite format consisting of a 32-bit floating-point component intended for depth, plus a 8-bit unsigned-integer component intended for stencil values in an additional 32-bit part where the last 24 bits are unused (for padding). EAC_R11_Signed = 1093 A single-component, 64-bit block-compression format using the EAC R11 signed encoding, where the red channel is encoded as a signed 11-bit value per pixel. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. Typically used for single-channel signed data such as normal maps or vector fields (reconstructing the second component). EAC_R11_Unsigned = 1092 A single-component, 64-bit block-compression format using the EAC R11 unsigned encoding, where the red channel is encoded as an unsigned 11-bit value per pixel. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. Typically used for single-channel data such as heightmaps or masks. EAC_RG11_Signed = 1095 A two-component, 128-bit block-compression format using the EAC RG11 signed encoding, where the red and green channels are encoded as signed 11-bit values per pixel. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. Used for dual-channel signed data such as normal maps or vector fields. EAC_RG11_Unsigned = 1094 A two-component, 128-bit block-compression format using the EAC RG11 unsigned encoding, where the red and green channels are encoded as unsigned 11-bit values per pixel. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. Used for dual-channel data such as normal maps or vector fields. ETC1 = 1088 A three-component, 64-bit block-compression format using the ETC1 encoding, where the RGB color is encoded in 4 bits per pixel. Does not support alpha. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. Commonly used for opaque textures on mobile devices. ETC2_RGB = 1089 A three-component, 64-bit block-compression format using the ETC2 RGB encoding, where the RGB color is encoded in 4 bits per pixel. Does not support alpha. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. Widely supported on modern mobile and embedded GPUs for general color data. ETC2_RGBA = 1090 A four-component, 128-bit block-compression format using the ETC2 RGBA encoding, where the RGB color is encoded in 4 bits per pixel and the alpha channel is encoded in 4 bits per pixel. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. Used for Textures requiring full alpha support on mobile and embedded devices. ETC2_RGBA_SRgb = 1096 A four-component, 128-bit block-compression format using the ETC2 RGBA encoding for sRGB data, where the RGB color is encoded in 4 bits per pixel and the alpha channel is encoded in 4 bits per pixel. The data is stored in sRGB color space, and the GPU will automatically convert it to linear space when sampling in a shader. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. Tipically used for color textures with transparency on mobile and embedded devices. ETC2_RGB_A1 = 1091 A four-component, 64-bit block-compression format using the ETC2 RGB+A1 encoding, where the RGB color is encoded in 4 bits per pixel and the alpha channel is encoded as a single bit (1-bit alpha mask). The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. Suitable for Textures with simple transparency (fully opaque or fully transparent pixels). ETC2_RGB_SRgb = 1097 A three-component, 64-bit block-compression format using the ETC2 RGB encoding for sRGB data, where the RGB color is encoded in 4 bits per pixel. The data is stored in sRGB color space, and the GPU will automatically convert it to linear space when sampling in a shader. The block-compression formats operate only on 4x4 blocks, so Textures using this format must have dimensions that are multiples of 4. Tipically used for color textures without alpha on mobile and embedded devices. G8R8_G8B8_UNorm = 69 A four-component, 32-bit unsigned normalized integer format packed in a form analogous to the YUY2 format. Each 32-bit block describes a pair of pixels (RGB, RGB) with 8-bit RGB components where the R/B values are repeated, and the G values are unique to each pixel. None = 0 The format is not known. R10G10B10A2_Typeless = 23 A four-component, 32-bit format that supports 10 bits for each color and 2 bits for alpha. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R10G10B10A2_UInt = 25 A four-component, 32-bit unsigned integer format that supports 10 bits for each color and 2 bits for alpha. R10G10B10A2_UNorm = 24 A four-component, 32-bit unsigned normalized integer format that supports 10 bits for each color and 2 bits for alpha. R10G10B10_Xr_Bias_A2_UNorm = 89 A four-component, 32-bit format consisting of 10 bits for each of the red, green, and blue channels encoded as 2.8-biased fixed-point numbers and 2-bit alpha channel. The XR bias applies a fixed scale and offset to the red channel to better represent HDR luminance. This is useful when tone mapping has already been applied and the image is ready for display. This format is intended for use as a presentation format, particularly for High Dynamic Range (HDR) content. It is read-only for shaders and not renderable directly. Instead, it is typically converted from a compatible format (like R10G10B10A2_UNorm). R11G11B10_Float = 26 A three-component, 32-bit partial-precision floating-point format that supports 11 bits for the red and green channels and 10 bits for the blue channel. It uses a variant of s10e5 (sign bit, 10-bit mantissa, and 5-bit biased (15) exponent), but there are no sign bits, and there is a 5-bit biased (15) exponent for each channel, 6-bit mantissa for R and G, and a 5-bit mantissa for B. R16G16B16A16_Float = 10 A four-component, 64-bit floating-point format that supports 16 bits per channel including alpha. R16G16B16A16_SInt = 14 A four-component, 64-bit signed integer format that supports 16 bits per channel including alpha. R16G16B16A16_SNorm = 13 A four-component, 64-bit signed normalized integer format that supports 16 bits per channel including alpha. R16G16B16A16_Typeless = 9 A four-component, 64-bit format that supports 16 bits per channel including alpha. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R16G16B16A16_UInt = 12 A four-component, 64-bit unsigned integer format that supports 16 bits per channel including alpha. R16G16B16A16_UNorm = 11 A four-component, 64-bit unsigned normalized integer format that supports 16 bits per channel including alpha. R16G16_Float = 34 A two-component, 32-bit floating-point format that supports 16 bits for the red channel and 16 bits for the green channel. R16G16_SInt = 38 A two-component, 32-bit signed integer format that supports 16 bits for the red channel and 16 bits for the green channel. R16G16_SNorm = 37 A two-component, 32-bit signed normalized integer format that supports 16 bits for the red channel and 16 bits for the green channel. R16G16_Typeless = 33 A two-component, 32-bit format that supports 16 bits for the red channel and 16 bits for the green channel. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R16G16_UInt = 36 A two-component, 32-bit unsigned integer format that supports 16 bits for the red channel and 16 bits for the green channel. R16G16_UNorm = 35 A two-component, 32-bit unsigned normalized integer format that supports 16 bits for the red channel and 16 bits for the green channel. R16_Float = 54 A single-component, 16-bit floating-point format that supports 16 bits for the red channel. R16_SInt = 59 A single-component, 16-bit signed integer format that supports 16 bits for the red channel. R16_SNorm = 58 A single-component, 16-bit signed normalized integer format that supports 16 bits for the red channel. R16_Typeless = 53 A single-component, 16-bit format that supports 16 bits for the red channel. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R16_UInt = 57 A single-component, 16-bit unsigned integer format that supports 16 bits for the red channel. R16_UNorm = 56 A single-component, 16-bit unsigned normalized integer format that supports 16 bits for the red channel. R1_UNorm = 66 A single-component, 1-bit unsigned normalized integer format that supports 1 bit for the red channel. R24G8_Typeless = 44 A two-component, 32-bit format that supports 24 bits for the red channel and 8 bits for the green channel. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R24_UNorm_X8_Typeless = 46 A two-component, 32-bit format consisting of a 24-bit unsigned normalized integer red component and a 8-bit typeless component. This format has a typeless component, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R32G32B32A32_Float = 2 A four-component, 128-bit floating-point format that supports 32 bits per channel including alpha. R32G32B32A32_SInt = 4 A four-component, 128-bit signed integer format that supports 32 bits per channel including alpha. R32G32B32A32_Typeless = 1 A four-component, 128-bit format that supports 32 bits per channel including alpha. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R32G32B32A32_UInt = 3 A four-component, 128-bit unsigned integer format that supports 32 bits per channel including alpha. R32G32B32_Float = 6 A three-component, 96-bit floating-point format that supports 32 bits per channel. R32G32B32_SInt = 8 A three-component, 96-bit signed integer format that supports 32 bits per channel. R32G32B32_Typeless = 5 A three-component, 96-bit format that supports 32 bits per channel. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R32G32B32_UInt = 7 A three-component, 96-bit unsigned integer format that supports 32 bits per channel. R32G32_Float = 16 A two-component, 64-bit floating-point format that supports 32 bits for the red channel and 32 bits for the green channel. R32G32_SInt = 18 A two-component, 64-bit signed integer format that supports 32 bits for the red channel and 32 bits for the green channel. R32G32_Typeless = 15 A two-component, 64-bit format that supports 32 bits for the red channel and 32 bits for the green channel. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R32G32_UInt = 17 A two-component, 64-bit unsigned integer format that supports 32 bits for the red channel and 32 bits for the green channel. R32G8X24_Typeless = 19 A two-component, 64-bit format that supports 32 bits for the red channel, 8 bits for the green channel, and 24 bits are unused. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R32_Float = 41 A single-component, 32-bit floating-point format that supports 32 bits for the red channel. R32_Float_X8X24_Typeless = 21 A composite format consisting of a 32-bit floating-point component for the red channel, and two typeless components (8-bit and 24-bit respectively) in an additional 32-bit part. This is commonly used to create Views for Depth-Stencil Buffers where a shader needs to access the depth. This format has typeless components, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R32_SInt = 43 A single-component, 32-bit signed integer format that supports 32 bits for the red channel. R32_Typeless = 39 A single-component, 32-bit format that supports 32 bits for the red channel. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R32_UInt = 42 A single-component, 32-bit unsigned integer format that supports 32 bits for the red channel. R8G8B8A8_SInt = 32 A four-component, 32-bit signed integer format that supports 8 bits per channel including alpha. R8G8B8A8_SNorm = 31 A four-component, 32-bit signed normalized integer format that supports 8 bits per channel including alpha. R8G8B8A8_Typeless = 27 A four-component, 32-bit format that supports 8 bits per channel including alpha. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R8G8B8A8_UInt = 30 A four-component, 32-bit unsigned integer format that supports 8 bits per channel including alpha. R8G8B8A8_UNorm = 28 A four-component, 32-bit unsigned normalized integer format that supports 8 bits per channel including alpha. R8G8B8A8_UNorm_SRgb = 29 A four-component, 32-bit unsigned normalized integer format that supports 8 bits per channel including alpha, where the data is stored in sRGB color space, and the GPU will automatically convert it to linear space when sampling in a shader. R8G8_B8G8_UNorm = 68 A four-component, 32-bit unsigned normalized integer format packed in a form analogous to the UYVY format. Each 32-bit block describes a pair of pixels (RGB, RGB) with 8-bit RGB components where the R/B values are repeated, and the G values are unique to each pixel. R8G8_SInt = 52 A two-component, 16-bit signed integer format that supports 8 bits for the red channel and 8 bits for the green channel. R8G8_SNorm = 51 A two-component, 16-bit signed normalized integer format that supports 8 bits for the red channel and 8 bits for the green channel. R8G8_Typeless = 48 A two-component, 16-bit format that supports 8 bits for the red channel and 8 bits for the green channel. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R8G8_UInt = 50 A two-component, 16-bit unsigned integer format that supports 8 bits for the red channel and 8 bits for the green channel. R8G8_UNorm = 49 A two-component, 16-bit unsigned normalized integer format that supports 8 bits for the red channel and 8 bits for the green channel. R8_SInt = 64 A single-component, 8-bit signed integer format that supports 8 bits for the red channel. R8_SNorm = 63 A single-component, 8-bit signed normalized integer format that supports 8 bits for the red channel. R8_Typeless = 60 A single-component, 8-bit format that supports 8 bits for the red channel. This format is typeless, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. R8_UInt = 62 A single-component, 8-bit unsigned integer format that supports 8 bits for the red channel. R8_UNorm = 61 A single-component, 8-bit unsigned normalized integer format that supports 8 bits for the red channel. R9G9B9E5_Sharedexp = 67 A three-component, 32-bit partial-precision floating-point format that supports 9 bits per channel with the same 5-bit shared exponent. It uses a variant of s10e5 (sign bit, 10-bit mantissa, and 5-bit biased (15) exponent), but there are no sign bits, and the exponent is shared. X24_Typeless_G8_UInt = 47 A two-component, 32-bit format consisting of a 24-bit typeless component and a 8-bit unsigned integer green component. This format has a typeless component, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. X32_Typeless_G8X24_UInt = 22 A composite format consisting of an unused 32-bit typeless component, plus an 8-bit unsigned-integer component in an additional 32-bit part where the last 24 bits are unused (for padding). This is commonly used to create Views for Depth-Stencil Buffers where a shader needs to access the stencil values. This format has typeless components, i.e. it just specifies the memory layout, but can be used for different types of data, such as floating-point, unsigned-integer, or signed-integer. Remarks Pixel formats describe the layout and type of data stored in a pixel, including the number of channels, bits per channel, and whether the data is normalized or typeless. The suffixes in the names indicate the type of data: UNorm (Unsigned Normalized) Values are stored as unsigned integers, but interpreted as floating-point values between 0.0 and 1.0. For example, R8G8B8A8_UNorm stores 8-bit values per channel, where 0 maps to 0.0 and 255 maps to 1.0. Common for color Textures and Render Targets. SNorm (Signed Normalized) Values are stored as signed integers, but interpreted as floating-point values between -1.0 and 1.0. For example, R8G8_SNorm stores 8-bit values per channel, where -128 to -1.0 and 127 to ~1.0. Useful for storing normals or vectors. Typeless The format is not fully defined —it’s just a memory layout. Multiple Views (e.g., Shader Resource Views, Render Target Views) can be created over a Graphics Resource with a typeless format with different interpretations. For example, R8G8B8A8_Typeless can be viewed as UNorm, UNorm_SRgb, or UInt, depending on how the resource is bound. Great for flexibility, like rendering in linear space and sampling in sRGB. UInt / SInt Unsigned (UInt) or signed (SInt) integer values. No normalization —values are used as-is. Often used for IDs, masks, or counters. Float Stores values as IEEE floating-point numbers. Used when precision and range are important, like Depth Buffers or HDR color. SRgb Stores color data in the sRGB color space. When sampling, the GPU automatically converts it to linear space, and when writing the data, it converts it back to sRGB (applies gamma correction). It is typically used for textures that represent colors."
  },
  "api/Stride.Graphics.PixelFormatExtensions.html": {
    "href": "api/Stride.Graphics.PixelFormatExtensions.html",
    "title": "Class PixelFormatExtensions | Stride API",
    "summary": "Class PixelFormatExtensions Namespace Stride.Graphics Assembly Stride.dll Provides extensions for PixelFormat to help in conversions between formats, querying format information, calculating sizes, pitches, etc. public static class PixelFormatExtensions Inheritance object PixelFormatExtensions"
  },
  "api/Stride.Graphics.PreferredGraphicsPlatform.html": {
    "href": "api/Stride.Graphics.PreferredGraphicsPlatform.html",
    "title": "Enum PreferredGraphicsPlatform | Stride API",
    "summary": "Enum PreferredGraphicsPlatform Namespace Stride.Graphics Assembly Stride.Graphics.dll public enum PreferredGraphicsPlatform Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Default = 0 Direct3D11 = 1 Direct3D11. Direct3D12 = 2 Direct3D12. OpenGL = 3 OpenGL. [Display(\"OpenGL ES\", null)] OpenGLES = 4 OpenGL ES. Vulkan = 5 Vulkan"
  },
  "api/Stride.Graphics.PresentInterval.html": {
    "href": "api/Stride.Graphics.PresentInterval.html",
    "title": "Enum PresentInterval | Stride API",
    "summary": "Enum PresentInterval Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines the relationship between the GraphicsOutput's refresh rate and the rate at which Present operations are completed. public enum PresentInterval Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Default = 1 The default value. Equivalent to setting One. Immediate = 0 The runtime updates the window client area immediately, and might do so more than once during the adapter refresh period. Present operations might be affected immediately. This option is always available for both windowed and full-screen swap chains. One = 1 The driver waits for the vertical retrace period (the runtime will beam trace to prevent tearing). This is commonly known as V-Sync. Present operations are not affected more frequently than the screen refresh rate; the runtime completes one Present operation per adapter refresh period, at most. This option is always available for both windowed and full-screen swap chains. Two = 2 The driver waits for the vertical retrace period. Present operations are not affected more frequently than every second screen refresh."
  },
  "api/Stride.Graphics.PresentationParameters.html": {
    "href": "api/Stride.Graphics.PresentationParameters.html",
    "title": "Class PresentationParameters | Stride API",
    "summary": "Class PresentationParameters Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes how a GraphicsDevice will display to the screen. public sealed class PresentationParameters : IEquatable<PresentationParameters> Inheritance object PresentationParameters Implements IEquatable<PresentationParameters> Extension Methods UnsafeUtilities.As<T>(object?) Constructors PresentationParameters() Initializes a new instance of the PresentationParameters class with default values. public PresentationParameters() Remarks The returned instance will be configured with the following default values: A back buffer resolution of 800x480 pixels, with a 32-bits-per-pixel integer format (R8G8B8A8_UNorm). A 24-bit integer depth buffer with an additional 8-bit stencil buffer (D24_UNorm_S8_UInt). No multi-sampling. Assuming a linear color space (Linear) and an output color space ColorSpaceType.RgbFullG22NoneP709, which is the default RGB output for monitors with a standard gamma of 2.2. A windowed presentation at 60 Hz with no V-Sync (Immediate). PresentationParameters(int, int, WindowHandle) Initializes a new instance of the PresentationParameters class with default values, but with the specified back buffer size, using R8G8B8A8_UNorm, and window handle. public PresentationParameters(int backBufferWidth, int backBufferHeight, WindowHandle windowHandle) Parameters backBufferWidth int The width of the back buffer, in pixels. backBufferHeight int The height of the back buffer, in pixels. windowHandle WindowHandle The window handle. See Also PresentationParameters() PresentationParameters(int, int, WindowHandle, PixelFormat) Initializes a new instance of the PresentationParameters class with default values, but with the specified back buffer size, pixel format, and window handle. public PresentationParameters(int backBufferWidth, int backBufferHeight, WindowHandle windowHandle, PixelFormat backBufferFormat) Parameters backBufferWidth int The width of the back buffer, in pixels. backBufferHeight int The height of the back buffer, in pixels. windowHandle WindowHandle The window handle. backBufferFormat PixelFormat The back buffer format. See Also PresentationParameters() Fields BackBufferFormat A PixelFormat specifying the display format. public PixelFormat BackBufferFormat Field Value PixelFormat BackBufferHeight The height of the back-buffer, in pixels. public int BackBufferHeight Field Value int Remarks Both BackBufferWidth and BackBufferHeight determine both the screen resolution (if in full-screen mode) or the window size (if in windowed-mode). BackBufferWidth The width of the back-buffer, in pixels. public int BackBufferWidth Field Value int Remarks Both BackBufferWidth and BackBufferHeight determine both the screen resolution (if in full-screen mode) or the window size (if in windowed-mode). ColorSpace The color space to use for presenting the frame to the screen. public ColorSpace ColorSpace Field Value ColorSpace Remarks The Color Space defines how colors are represented and displayed on the screen. Common values include: Gamma It usually represents sRGB, the standard RGB color space used in most monitors and applications. It offers a limited range of colors suitable for general purposes. Linear A linear color space suitable for high-dynamic-range color values like HDR10, supporting a wider range of brightness and colors. This is commonly used in modern HDR displays for enhanced image quality. Choosing the appropriate color space affects the visual quality of your application. For example, sRGB is recommended for compatibility, while HDR10 may enhance visuals in games or applications designed for HDR content. DepthStencilFormat A PixelFormat specifying the depth-stencil format. public PixelFormat DepthStencilFormat Field Value PixelFormat Remarks The Depth Buffer (also known as Z-buffer) is used to determine the depth of each pixel so close geometry correctly occludes farther geometry. The format determines the precission of the depth buffer. The Stencil Buffer is used to store additional information for each pixel, such as marking or discarding specific pixels for different effects. This format determines both because usually the stencil buffer is a part of the depth buffer reserved for other uses. Some examples are D24_UNorm_S8_UInt, where the depth buffer uses 24 bits and the stencil buffer uses 8 bits, for a total of 32 bits per pixel, or D32_Float, which uses 32 bits for the depth buffer and no bits for the stencil buffer. DeviceWindowHandle The window object or handle where the presentation will occur. public WindowHandle DeviceWindowHandle Field Value WindowHandle Remarks A window object is platform-dependent: Windows Desktop This could be a low-level window/control handle (nint), or directly a Windows Forms' Form or Control object. Windows Metro This could be a SwapChainBackgroundPanel or SwapChainPanel object. IsFullScreen A value indicating whether the application must render in full-screen mode (true) or inside a window (false). public bool IsFullScreen Field Value bool MultisampleCount A MultisampleCount indicating the number of sample locations during multi-sampling. public MultisampleCount MultisampleCount Field Value MultisampleCount Remarks The multi-sampling is applied to the back-buffer to reduce the aliasing artifacts. This is known as Multi-Sampling Anti-Aliasing (MSAA). The higher the number of samples, the aliasing patterns will be less visible, but it will result in more memory being consumed, and costlier rasterization. If None is selected, no multi-sampling will be applied. Common values include X2 (minimal anti-aliasing) and X8 (high-quality anti-aliasing). Higher values increase GPU workload. OutputColorSpace The color space type used for the Graphics Presenter output. public ColorSpaceType OutputColorSpace Field Value ColorSpaceType Remarks The output color space can be used to render to HDR monitors. Consult the documentation of the ColorSpaceType enum for more details. Note that this is currently only supported in Stride when using the Direct3D Graphics API. For more information about High Dynamic Range (HDR) rendering, see https://learn.microsoft.com/en-us/windows/win32/direct3darticles/high-dynamic-range. PreferredFullScreenOutputIndex The index of the preferred output (monitor) to use when switching to full-screen mode. public int PreferredFullScreenOutputIndex Field Value int Remarks This parameter does not have any effect when windowed mode is used (IsFullScreen is false). PresentationInterval A value of PresentationInterval determining the maximum rate at which the Swap Chain's back buffers can be presented to the front buffer. public PresentInterval PresentationInterval Field Value PresentInterval RefreshRate The refresh rate of the screen, in hertz. public Rational RefreshRate Field Value Rational Remarks The Refresh Rate is the number of times per second the screen is refreshed, i.e. the number of frames per second the monitor can display. The value is represented as a Rational, so it can represent both usual integer refresh rates (e.g. 60Hz) and fractional refresh rates (e.g. 59.94Hz). Usually, the refresh rate is only respected when rendering in full-screen mode (i.e. when IsFullScreen is set to true). Common refresh rates include 60Hz, 120Hz, and 144Hz, depending on monitor capabilities. Methods Clone() Creates a new PresentationParameters object that is a copy of the current instance. public PresentationParameters Clone() Returns PresentationParameters A new PresentationParameters object that is a copy of this instance. Equals(PresentationParameters) Indicates whether the current object is equal to another object of the same type. public bool Equals(PresentationParameters other) Parameters other PresentationParameters An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Determines whether the specified object is equal to the current object. public override bool Equals(object obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Operators operator ==(PresentationParameters, PresentationParameters) public static bool operator ==(PresentationParameters left, PresentationParameters right) Parameters left PresentationParameters right PresentationParameters Returns bool operator !=(PresentationParameters, PresentationParameters) public static bool operator !=(PresentationParameters left, PresentationParameters right) Parameters left PresentationParameters right PresentationParameters Returns bool"
  },
  "api/Stride.Graphics.PrimitiveQuad.html": {
    "href": "api/Stride.Graphics.PrimitiveQuad.html",
    "title": "Class PrimitiveQuad | Stride API",
    "summary": "Class PrimitiveQuad Namespace Stride.Graphics Assembly Stride.Graphics.dll A primitive triangle that can be used to draw a Texture or an Effect, commonly used to draw full-screen. This is directly accessible from the DrawQuad(GraphicsContext, EffectInstance) method. public class PrimitiveQuad : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase PrimitiveQuad Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors PrimitiveQuad(GraphicsDevice) Initializes a new instance of the PrimitiveQuad class. public PrimitiveQuad(GraphicsDevice graphicsDevice) Parameters graphicsDevice GraphicsDevice The Graphics Device. Fields PrimitiveType The type of primitives used to draw the triangle. public static readonly PrimitiveType PrimitiveType Field Value PrimitiveType VertexDeclaration The definition of the layout of the vertices used to draw the triangle. public static readonly VertexDeclaration VertexDeclaration Field Value VertexDeclaration Properties GraphicsDevice Gets the Graphics Device. public GraphicsDevice GraphicsDevice { get; } Property Value GraphicsDevice Parameters Gets the parameters used by the default Effect used to draw. public ParameterCollection Parameters { get; } Property Value ParameterCollection Methods Draw(CommandList) Draws a full-screen triangle. public void Draw(CommandList commandList) Parameters commandList CommandList The Command List to use for drawing. Remarks An Effect with a Pixel Shader having the signature float2 : TEXCOORD must have been applied before calling this method. Draw(GraphicsContext, Texture, SamplerState, Color4, BlendStateDescription?) Draws a full-screen triangle with a tinted Texture. public void Draw(GraphicsContext graphicsContext, Texture texture, SamplerState samplerState, Color4 color, BlendStateDescription? blendState = null) Parameters graphicsContext GraphicsContext The graphics context to use for drawing. texture Texture The Texture to draw. samplerState SamplerState The Sampler State to use for sampling the texture. Specify null to use the default Sampler State LinearClamp. color Color4 The color to tint the Texture with. The final color will be the texture color multiplied by the specified color. blendState BlendStateDescription? An optional Blend State to use when drawing the Texture. Specify null to use Default. Draw(GraphicsContext, Texture, BlendStateDescription?) Draws a full-screen triangle with a Texture. public void Draw(GraphicsContext graphicsContext, Texture texture, BlendStateDescription? blendState = null) Parameters graphicsContext GraphicsContext The graphics context to use for drawing. texture Texture The Texture to draw. blendState BlendStateDescription? An optional Blend State to use when drawing the Texture. Specify null to use Default. Remarks The Texture will be sampled using the default Sampler State LinearClamp. Draw(GraphicsContext, EffectInstance) Draws a full-screen triangle. public void Draw(GraphicsContext graphicsContext, EffectInstance effectInstance) Parameters graphicsContext GraphicsContext The graphics context to use for drawing. effectInstance EffectInstance The Effect instance to use for drawing. It must define a Pixel Shader having the signature float2 : TEXCOORD."
  },
  "api/Stride.Graphics.PrimitiveType.html": {
    "href": "api/Stride.Graphics.PrimitiveType.html",
    "title": "Enum PrimitiveType | Stride API",
    "summary": "Enum PrimitiveType Namespace Stride.Graphics Assembly Stride.Graphics.dll Values that indicate how the graphics pipeline interprets input vertex data. [DataContract] public enum PrimitiveType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) PrimitiveTypeExtensions.ControlPointCount(PrimitiveType, int) UnsafeUtilities.As<T>(object?) Fields LineList = 2 The data is ordered as a sequence of line segments; each line segment is described by two new vertices. The count may be any positive even integer. LineListWithAdjacency = 10 The data is ordered as a sequence of line segments, the same as LineList, but including adjacency information that can be useful for Geometry Shaders; each line segment is described by two new vertices. The count may be any positive even integer. LineStrip = 3 The data is ordered as a sequence of line segments; each line segment is described by one new vertex and the last vertex from the previous line seqment. The count may be any positive integer greater than 2. LineStripWithAdjacency = 11 The data is ordered as a sequence of line segments, the same as LineStrip, but including adjacency information that can be useful for Geometry Shaders; each line segment is described by one new vertex and the last vertex from the previous line seqment. The count may be any positive integer greater than 2. PatchList = 33 The data is ordered as a sequence of patches, each one being a group of control points. This is used for tessellation, where the Hull Shader processes each patch and determines tesselation factors, optionally outputting more control point data. To indicate the number of control points in each patch, you can use the helper method ControlPointCount(PrimitiveType, int). These topologies unlock a lot of flexibility for surfaces like terrain, curved surfaces, or even animation rigs. PointList = 1 The data is ordered as a sequence of points, with no connectivity between them. This is useful for rendering particles or point clouds. The count may be any positive integer. TriangleList = 4 The data is ordered as a sequence of triangles; each triangle is described by three new vertices. Most commonly used for rendering 3D models. The count may be any positive integer multiple of 3. Back-face culling is affected by the current winding-order Render State. TriangleListWithAdjacency = 12 The data is ordered as a sequence of triangles, the same as TriangleList, but including adjacency information that can be useful for Geometry Shaders; each triangle is described by three new vertices. Most commonly used for rendering 3D models. The count may be any positive integer multiple of 3. Back-face culling is affected by the current winding-order Render State. TriangleStrip = 5 The data is ordered as a sequence of triangles; each triangle is described by two new vertices and one vertex from the previous triangle. It is usually more space-efficient than a triangle list due to reduced vertex redundancy. The back-face culling flag is flipped automatically on even-numbered triangles. TriangleStripWithAdjacency = 13 The data is ordered as a sequence of triangles, the same as TriangleStrip, but including adjacency information that can be useful for Geometry Shaders; each triangle is described by two new vertices and one vertex from the previous triangle. It is usually more space-efficient than a triangle list due to reduced vertex redundancy. The back-face culling flag is flipped automatically on even-numbered triangles. Undefined = 0 The graphics pipeline has not been initialized with a specific primitive topology. The Input-Assembler stage will not function properly unless a primitive type is defined."
  },
  "api/Stride.Graphics.PrimitiveTypeExtensions.html": {
    "href": "api/Stride.Graphics.PrimitiveTypeExtensions.html",
    "title": "Class PrimitiveTypeExtensions | Stride API",
    "summary": "Class PrimitiveTypeExtensions Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines extensions and helpers for PrimitiveType. public static class PrimitiveTypeExtensions Inheritance object PrimitiveTypeExtensions Methods ControlPointCount(PrimitiveType, int) Interpret the input vertex data type as a patch list for tesselation with a specific number of control points. public static PrimitiveType ControlPointCount(this PrimitiveType primitiveType, int controlPoints) Parameters primitiveType PrimitiveType controlPoints int The number of control points. It must be a value in the range 1 to 32, inclusive. Returns PrimitiveType A PrimitiveType value that represents a patch list with the specified number of control points. Exceptions ArgumentException Control points apply only to PatchList. ArgumentOutOfRangeException controlPoints must be in the range 1 to 32, inclusive."
  },
  "api/Stride.Graphics.QueryPool.html": {
    "href": "api/Stride.Graphics.QueryPool.html",
    "title": "Class QueryPool | Stride API",
    "summary": "Class QueryPool Namespace Stride.Graphics Assembly Stride.Graphics.dll A pool holding asynchronous GPU Queries of a specific type. public class QueryPool : GraphicsResourceBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase QueryPool Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsResourceBase.NativeResource GraphicsResourceBase.NativeDeviceChild GraphicsResourceBase.UnsetNativeDeviceChild() GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) GraphicsResourceBase.NativeDevice GraphicsResourceBase.IsDebugMode GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed GraphicsResourceBase.OnPause() GraphicsResourceBase.OnResume() GraphicsResourceBase.Destroy() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors QueryPool(GraphicsDevice, QueryType, int) Initializes a new instance of the QueryPool class. protected QueryPool(GraphicsDevice graphicsDevice, QueryType queryType, int queryCount) Parameters graphicsDevice GraphicsDevice The Graphics Device. queryType QueryType The type of GPU Queries to contain in the pool. queryCount int The capacity of the pool. Properties QueryCount Gets the capacity of the pool. public int QueryCount { get; } Property Value int QueryType Gets the types of asynchronous GPU Queries in the pool. public QueryType QueryType { get; } Property Value QueryType Methods New(GraphicsDevice, QueryType, int) Creates a new QueryPool. public static QueryPool New(GraphicsDevice graphicsDevice, QueryType queryType, int queryCount) Parameters graphicsDevice GraphicsDevice The Graphics Device. queryType QueryType The type of GPU Queries to contain in the pool. queryCount int The capacity of the pool. Returns QueryPool An new instance of QueryPool of the specified queryType. OnDestroyed(bool) Called when the GraphicsDevice has been detected to be internally destroyed, or when the Destroy() methad has been called. Raises the Destroyed event. protected override void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the resource should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). Remarks This method releases the underlying native resources (Silk.NET.Direct3D11.ID3D11Resource and Silk.NET.Direct3D11.ID3D11DeviceChild). OnRecreate() Called when the GraphicsDevice has been recreated. protected override bool OnRecreate() Returns bool true if resource has transitioned to the Active state. TryGetData(long[]) Attempts to retrieve data from the in-flight GPU queries. public bool TryGetData(long[] dataArray) Parameters dataArray long[] An array of long values to be populated with the retrieved data. The array must have a length equal to the number of queries performed (QueryCount). Returns bool true if all data queries succeed; otherwise, false. Remarks This method tries to perform reads for the multiple GPU queries in the pool and populates the provided array with the results. If any query fails, the method returns false and the array may contain partial or uninitialized data. See Also QueryType"
  },
  "api/Stride.Graphics.QueryType.html": {
    "href": "api/Stride.Graphics.QueryType.html",
    "title": "Enum QueryType | Stride API",
    "summary": "Enum QueryType Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines the types of a GPU query. public enum QueryType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Timestamp = 0 Represents a timestamp value, typically used to indicate a point in time. Used for measuring the time taken by GPU operations."
  },
  "api/Stride.Graphics.RasterizerStateDescription.html": {
    "href": "api/Stride.Graphics.RasterizerStateDescription.html",
    "title": "Struct RasterizerStateDescription | Stride API",
    "summary": "Struct RasterizerStateDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll A description of a Rasterizer State, which defines how primitives are rasterized to the Render Targets. [DataContract] public struct RasterizerStateDescription : IEquatable<RasterizerStateDescription> Implements IEquatable<RasterizerStateDescription> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks This structure controls fill mode, primitive culling, multisampling, depth bias, and clipping. Constructors RasterizerStateDescription() Initializes a new instance of the RasterizerStateDescription structure with default values. public RasterizerStateDescription() Remarks The default values are: <ul><li><xref href=\"Stride.Graphics.RasterizerStateDescription.FillMode\" data-throw-if-not-resolved=\"false\"></xref>: Rasterize filled triangles (<xref href=\"Stride.Graphics.FillMode.Solid\" data-throw-if-not-resolved=\"false\"></xref>).</li><li><xref href=\"Stride.Graphics.RasterizerStateDescription.CullMode\" data-throw-if-not-resolved=\"false\"></xref>: Cull back-facing primitives (<xref href=\"Stride.Graphics.CullMode.Back\" data-throw-if-not-resolved=\"false\"></xref>).</li><li><xref href=\"Stride.Graphics.RasterizerStateDescription.FrontFaceCounterClockwise\" data-throw-if-not-resolved=\"false\"></xref>: Consider front-facing the primitives whose vertices are ordered clockwise (<a href=\"https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool\">false</a>).</li><li><xref href=\"Stride.Graphics.RasterizerStateDescription.DepthClipEnable\" data-throw-if-not-resolved=\"false\"></xref>: Clip primitives outside the near and far clipping planes (<a href=\"https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool\">true</a>).</li><li>Scissor testing disabled.</li><li>No multisampling (<xref href=\"Stride.Graphics.MultisampleCount.None\" data-throw-if-not-resolved=\"false\"></xref>) and no antialiased lines.</li><li>No <xref href=\"Stride.Graphics.RasterizerStateDescription.DepthBias\" data-throw-if-not-resolved=\"false\"></xref>, <xref href=\"Stride.Graphics.RasterizerStateDescription.DepthBiasClamp\" data-throw-if-not-resolved=\"false\"></xref>, or <xref href=\"Stride.Graphics.RasterizerStateDescription.SlopeScaleDepthBias\" data-throw-if-not-resolved=\"false\"></xref>.</li></ul> </remarks> RasterizerStateDescription(CullMode) Initializes a new instance of the RasterizerStateDescription structure with default values, and with the specified culling mode. public RasterizerStateDescription(CullMode cullMode) Parameters cullMode CullMode The cull mode. Remarks The default values are: <ul><li><xref href=\"Stride.Graphics.RasterizerStateDescription.FillMode\" data-throw-if-not-resolved=\"false\"></xref>: Rasterize filled triangles (<xref href=\"Stride.Graphics.FillMode.Solid\" data-throw-if-not-resolved=\"false\"></xref>).</li><li><xref href=\"Stride.Graphics.RasterizerStateDescription.CullMode\" data-throw-if-not-resolved=\"false\"></xref>: Cull back-facing primitives (<xref href=\"Stride.Graphics.CullMode.Back\" data-throw-if-not-resolved=\"false\"></xref>).</li><li><xref href=\"Stride.Graphics.RasterizerStateDescription.FrontFaceCounterClockwise\" data-throw-if-not-resolved=\"false\"></xref>: Consider front-facing the primitives whose vertices are ordered clockwise (<a href=\"https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool\">false</a>).</li><li><xref href=\"Stride.Graphics.RasterizerStateDescription.DepthClipEnable\" data-throw-if-not-resolved=\"false\"></xref>: Clip primitives outside the near and far clipping planes (<a href=\"https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool\">true</a>).</li><li>Scissor testing disabled.</li><li>No multisampling (<xref href=\"Stride.Graphics.MultisampleCount.None\" data-throw-if-not-resolved=\"false\"></xref>) and no antialiased lines.</li><li>No <xref href=\"Stride.Graphics.RasterizerStateDescription.DepthBias\" data-throw-if-not-resolved=\"false\"></xref>, <xref href=\"Stride.Graphics.RasterizerStateDescription.DepthBiasClamp\" data-throw-if-not-resolved=\"false\"></xref>, or <xref href=\"Stride.Graphics.RasterizerStateDescription.SlopeScaleDepthBias\" data-throw-if-not-resolved=\"false\"></xref>.</li></ul> </remarks> Fields CullMode Specifies which triangle facing direction should be culled (not rendered) during rasterization. The facing direction is determined by the FrontFaceCounterClockwise setting. public CullMode CullMode Field Value CullMode Remarks This property determines whether front-facing or back-facing triangles are culled. A triangle's facing is defined by the winding order of its vertices and the value of FrontFaceCounterClockwise. For example, if FrontFaceCounterClockwise is false (clockwise is front-facing), and CullMode is set to Back, then counter-clockwise triangles will be culled. Default A Rasterizer State description with default values. public static readonly RasterizerStateDescription Default Field Value RasterizerStateDescription Remarks The default values are: FillMode: Rasterize filled triangles (Solid). CullMode: Cull back-facing primitives (Back). FrontFaceCounterClockwise: Consider front-facing the primitives whose vertices are ordered clockwise (false). DepthClipEnable: Clip primitives outside the near and far clipping planes (true). Scissor testing disabled. No multisampling (None) and no antialiased lines. No DepthBias, DepthBiasClamp, or SlopeScaleDepthBias. DefaultCullMode The default value for CullMode. public const CullMode DefaultCullMode = Back Field Value CullMode DefaultDepthBias The default value for DepthBias. public const int DefaultDepthBias = 0 Field Value int DefaultDepthBiasClamp The default value for DepthBiasClamp. public const float DefaultDepthBiasClamp = 0 Field Value float DefaultDepthClipEnable The default value for DepthClipEnable. public const bool DefaultDepthClipEnable = true Field Value bool DefaultFillMode The default value for FillMode. public const FillMode DefaultFillMode = Solid Field Value FillMode DefaultFrontFaceCounterClockwise The default value for FrontFaceCounterClockwise. public const bool DefaultFrontFaceCounterClockwise = false Field Value bool DefaultMultisampleAntiAliasLine The default value for MultisampleAntiAliasLine. public const bool DefaultMultisampleAntiAliasLine = false Field Value bool DefaultMultisampleCount The default value for MultisampleCount. public const MultisampleCount DefaultMultisampleCount = None Field Value MultisampleCount DefaultScissorTestEnable The default value for ScissorTestEnable. public const bool DefaultScissorTestEnable = false Field Value bool DefaultSlopeScaleDepthBias The default value for SlopeScaleDepthBias. public const float DefaultSlopeScaleDepthBias = 0 Field Value float DepthBias Constant depth bias added to each pixel's depth value. public int DepthBias Field Value int Remarks This value is added to the depth of each pixel and is typically used to resolve Z-fighting, such as when rendering decals or wireframe overlays on top of solid geometry. The actual depth offset depends on the Depth Buffer format and the slope of the primitive. DepthBiasClamp Maximum depth bias that can be applied to a pixel. public float DepthBiasClamp Field Value float Remarks Clamps the total depth bias applied to a pixel, after combining DepthBias and SlopeScaleDepthBias. This is useful to prevent excessive biasing on steep slopes or when using large bias values. DepthClipEnable Enables or disables clipping of geometry based on the depth (Z) value. When enabled, primitives outside the near and far clip planes are discarded. public bool DepthClipEnable Field Value bool Remarks When enabled, geometry outside the near and far clip planes is discarded. Disabling this can be useful for special effects like infinite projection or stencil shadows, but may lead to incorrect depth ordering if not handled carefully. FillMode Specifies how primitives are filled during rasterization (e.g., solid or wireframe). public FillMode FillMode Field Value FillMode Remarks Common values include Solid for standard rendering and Wireframe for debugging geometry. Wireframe mode is especially useful for visualizing mesh topology or detecting overdraw. FrontFaceCounterClockwise Determines the winding order used to identify front-facing triangles. If true, triangles with vertices ordered counter-clockwise on the render target are considered front-facing. If false, triangles with clockwise winding are considered front-facing. This setting affects how CullMode determines which triangles to cull. public bool FrontFaceCounterClockwise Field Value bool Remarks This setting defines the convention for front-facing triangles. Combined with the CullMode value, it determines whether front-facing or back-facing triangles are culled during rasterization. For example, if FrontFaceCounterClockwise is false (the default in Direct3D), and CullMode is set to Front, then triangles with clockwise winding will be culled. MultisampleAntiAliasLine Enables antialiasing for lines when MSAA is disabled. Only affects line rendering. public bool MultisampleAntiAliasLine Field Value bool Remarks This only affects line primitives, and has no effect when MultisampleCount is greater than 1. MultisampleCount Specifies the number of samples used for multisample anti-aliasing (MSAA). public MultisampleCount MultisampleCount Field Value MultisampleCount Remarks Higher sample counts improve edge smoothness but increase memory and processing cost. ScissorTestEnable Enables scissor testing. Pixels outside the active scissor rectangle are culled. public bool ScissorTestEnable Field Value bool Remarks When enabled, only pixels inside the active scissor rectangle are rendered. This is commonly used for UI rendering, partial redraws, or performance optimization. SlopeScaleDepthBias Scalar applied to a primitive's slope to compute a variable depth bias. Helps offset depth values based on surface angle. public float SlopeScaleDepthBias Field Value float Remarks This value is multiplied by the maximum slope of the primitive to compute a variable depth bias. It helps reduce Z-fighting on surfaces that are nearly parallel to the view direction. Often used in conjunction with DepthBias for shadow mapping or coplanar geometry. Methods Equals(RasterizerStateDescription) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(RasterizerStateDescription other) Parameters other RasterizerStateDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(RasterizerStateDescription, RasterizerStateDescription) public static bool operator ==(RasterizerStateDescription left, RasterizerStateDescription right) Parameters left RasterizerStateDescription right RasterizerStateDescription Returns bool operator !=(RasterizerStateDescription, RasterizerStateDescription) public static bool operator !=(RasterizerStateDescription left, RasterizerStateDescription right) Parameters left RasterizerStateDescription right RasterizerStateDescription Returns bool See Also RasterizerStates"
  },
  "api/Stride.Graphics.RasterizerStates.html": {
    "href": "api/Stride.Graphics.RasterizerStates.html",
    "title": "Class RasterizerStates | Stride API",
    "summary": "Class RasterizerStates Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines a set of built-in RasterizerStateDescriptions for common rasterizer configurations. public static class RasterizerStates Inheritance object RasterizerStates Fields CullBack A built-in Rasterizer State object with settings for culling primitives with counter-clockwise winding order. public static readonly RasterizerStateDescription CullBack Field Value RasterizerStateDescription CullFront A built-in Rasterizer State object with settings for culling primitives with clockwise winding order. public static readonly RasterizerStateDescription CullFront Field Value RasterizerStateDescription CullNone A built-in Rasterizer State object with settings for not culling any primitives. public static readonly RasterizerStateDescription CullNone Field Value RasterizerStateDescription Default A built-in Rasterizer State object with default settings. public static readonly RasterizerStateDescription Default Field Value RasterizerStateDescription Remarks The default values are: FillMode: Rasterize filled triangles (Solid). CullMode: Cull back-facing primitives (Back). FrontFaceCounterClockwise: Consider front-facing the primitives whose vertices are ordered clockwise (false). DepthClipEnable: Clip primitives outside the near and far clipping planes (true). Scissor testing disabled. No multisampling (None) and no antialiased lines. No DepthBias, DepthBiasClamp, or SlopeScaleDepthBias. Wireframe A built-in Rasterizer State object for wireframe with settings for not culling any primitives. public static readonly RasterizerStateDescription Wireframe Field Value RasterizerStateDescription WireframeCullBack A built-in Rasterizer State object for wireframe with settings for culling primitives with counter-clockwise winding order. public static readonly RasterizerStateDescription WireframeCullBack Field Value RasterizerStateDescription WireframeCullFront A built-in Rasterizer State object for wireframe rendering with settings for culling primitives with clockwise winding order. public static readonly RasterizerStateDescription WireframeCullFront Field Value RasterizerStateDescription"
  },
  "api/Stride.Graphics.Rational.html": {
    "href": "api/Stride.Graphics.Rational.html",
    "title": "Struct Rational | Stride API",
    "summary": "Struct Rational Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents a rational number. public struct Rational : IEquatable<Rational> Implements IEquatable<Rational> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks The Rational structure operates under the following rules: 0/0 is legal and will be interpreted as 0/1. 0/anything is interpreted as zero. If you are representing a whole number, the denominator should be 1. Constructors Rational(int, int) Represents a rational number. public Rational(int numerator, int denominator) Parameters numerator int The numerator (top) of the rational number. denominator int The denominator (bottom) of the rational number. Remarks The Rational structure operates under the following rules: 0/0 is legal and will be interpreted as 0/1. 0/anything is interpreted as zero. If you are representing a whole number, the denominator should be 1. Fields Denominator An value representing the bottom of the rational number. public int Denominator Field Value int Numerator An value representing the top of the rational number. public int Numerator Field Value int Methods Equals(Rational) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(Rational other) Parameters other Rational An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the string representation of this Rational, including its approximate real value. public override string ToString() Returns string The string representation of this Rational. Operators operator ==(Rational, Rational) public static bool operator ==(Rational left, Rational right) Parameters left Rational right Rational Returns bool implicit operator Rational(int) Returns a new Rational from an integer value. public static implicit operator Rational(int value) Parameters value int The integer value. Returns Rational The integer value as a rational number with denominator 1. operator !=(Rational, Rational) public static bool operator !=(Rational left, Rational right) Parameters left Rational right Rational Returns bool"
  },
  "api/Stride.Graphics.RenderOutputDescription.html": {
    "href": "api/Stride.Graphics.RenderOutputDescription.html",
    "title": "Struct RenderOutputDescription | Stride API",
    "summary": "Struct RenderOutputDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes the output formats of the Render Targets and the Depth-Stencil Buffer. [DataContract] public struct RenderOutputDescription : IEquatable<RenderOutputDescription> Implements IEquatable<RenderOutputDescription> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors RenderOutputDescription(PixelFormat, PixelFormat, MultisampleCount) Initializes a new instance of the RenderOutputDescription structure. public RenderOutputDescription(PixelFormat renderTargetFormat, PixelFormat depthStencilFormat = PixelFormat.None, MultisampleCount multisampleCount = MultisampleCount.None) Parameters renderTargetFormat PixelFormat The pixel format of the Render Target. Specify None to disable the Render Targets. depthStencilFormat PixelFormat The depth format of the Depth-Stencil Buffer. Specify None to disable the Depth-Stencil Buffer. multisampleCount MultisampleCount The number of samples to use when multi-sampling. Specify None to disable multi-sampling. RenderOutputDescription(ReadOnlySpan<PixelFormat>, PixelFormat, MultisampleCount) Initializes a new instance of the RenderOutputDescription structure. public RenderOutputDescription(ReadOnlySpan<PixelFormat> renderTargetFormats, PixelFormat depthStencilFormat = PixelFormat.None, MultisampleCount multisampleCount = MultisampleCount.None) Parameters renderTargetFormats ReadOnlySpan<PixelFormat> The pixel formats for up to 8 Render Targets. If a Render Target is set to None, it is considered disabled. Specify an empty span or all set to None to disable the Render Targets. depthStencilFormat PixelFormat The depth format of the Depth-Stencil Buffer. Specify None to disable the Depth-Stencil Buffer. multisampleCount MultisampleCount The number of samples to use when multi-sampling. Specify None to disable multi-sampling. Exceptions ArgumentOutOfRangeException Cannot specify the format for more than 8 Render Targets in renderTargetFormats. Fields DefaultDepthStencilFormat Default value for DepthStencilFormat. public const PixelFormat DefaultDepthStencilFormat = None Field Value PixelFormat DefaultMultiSampleCount Default value for MultisampleCount. public const MultisampleCount DefaultMultiSampleCount = None Field Value MultisampleCount DefaultRenderTargetCount Default value for RenderTargetCount. public const int DefaultRenderTargetCount = 0 Field Value int DefaultRenderTargetFormat Default value for the Render Targets pixel formats (RenderTargetFormat0 to RenderTargetFormat7). public const PixelFormat DefaultRenderTargetFormat = None Field Value PixelFormat DefaultScissorTestEnable Default value for ScissorTestEnable. public const bool DefaultScissorTestEnable = false Field Value bool DepthStencilFormat The depth format of the Depth-Stencil Buffer. public PixelFormat DepthStencilFormat Field Value PixelFormat Remarks Specify None to disable the Depth-Stencil Buffer. MaximumRenderTargetCount The maximum number of Render Targets configurable by the graphics pipeline. public const int MaximumRenderTargetCount = 8 Field Value int MultisampleCount The number of samples to use when multi-sampling. public MultisampleCount MultisampleCount Field Value MultisampleCount Remarks Specify None to disable multi-sampling. RenderTargetCount The number of Render Targets. public int RenderTargetCount Field Value int RenderTargetFormat0 The pixel format of the Render Target at index 0. public PixelFormat RenderTargetFormat0 Field Value PixelFormat RenderTargetFormat1 The pixel format of the Render Target at index 1. public PixelFormat RenderTargetFormat1 Field Value PixelFormat RenderTargetFormat2 The pixel format of the Render Target at index 2. public PixelFormat RenderTargetFormat2 Field Value PixelFormat RenderTargetFormat3 The pixel format of the Render Target at index 3. public PixelFormat RenderTargetFormat3 Field Value PixelFormat RenderTargetFormat4 The pixel format of the Render Target at index 4. public PixelFormat RenderTargetFormat4 Field Value PixelFormat RenderTargetFormat5 The pixel format of the Render Target at index 5. public PixelFormat RenderTargetFormat5 Field Value PixelFormat RenderTargetFormat6 The pixel format of the Render Target at index 6. public PixelFormat RenderTargetFormat6 Field Value PixelFormat RenderTargetFormat7 The pixel format of the Render Target at index 7. public PixelFormat RenderTargetFormat7 Field Value PixelFormat ScissorTestEnable A value indicating whether to enable scissor-rectangle culling. All pixels ouside an active scissor rectangle are culled. public bool ScissorTestEnable Field Value bool Properties RenderTargetFormats Gets the pixel formats of the Render Targets. public readonly Span<PixelFormat> RenderTargetFormats { get; } Property Value Span<PixelFormat> Remarks There is a maximum of eight Render Targets. If a Render Target is set to None, it is considered disabled. Methods CaptureState(CommandList) Captures the description of the pipeline render output from a Command List. public void CaptureState(CommandList commandList) Parameters commandList CommandList The Command List from which to capture the pipeline render output configuration. Equals(RenderOutputDescription) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(RenderOutputDescription other) Parameters other RenderOutputDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(RenderOutputDescription, RenderOutputDescription) public static bool operator ==(RenderOutputDescription left, RenderOutputDescription right) Parameters left RenderOutputDescription right RenderOutputDescription Returns bool operator !=(RenderOutputDescription, RenderOutputDescription) public static bool operator !=(RenderOutputDescription left, RenderOutputDescription right) Parameters left RenderOutputDescription right RenderOutputDescription Returns bool"
  },
  "api/Stride.Graphics.RenderTargetGraphicsPresenter.html": {
    "href": "api/Stride.Graphics.RenderTargetGraphicsPresenter.html",
    "title": "Class RenderTargetGraphicsPresenter | Stride API",
    "summary": "Class RenderTargetGraphicsPresenter Namespace Stride.Graphics Assembly Stride.Graphics.dll A simple GraphicsPresenter wrapping a Render-Target Texture where drawing will occur but no actual presentation will happen. public class RenderTargetGraphicsPresenter : GraphicsPresenter, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsPresenter RenderTargetGraphicsPresenter Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsPresenter.GraphicsDevice GraphicsPresenter.Description GraphicsPresenter.DepthStencilBuffer GraphicsPresenter.PresentInterval GraphicsPresenter.BeginDraw(CommandList) GraphicsPresenter.EndDraw(CommandList, bool) GraphicsPresenter.Resize(int, int, PixelFormat) GraphicsPresenter.SetOutputColorSpace(ColorSpaceType, PixelFormat) GraphicsPresenter.DestroyChildrenTextures(Texture) GraphicsPresenter.DetachDepthStencilBuffer() GraphicsPresenter.Destroy() GraphicsPresenter.OnDestroyed(bool) GraphicsPresenter.OnRecreated() GraphicsPresenter.ProcessPresentationParameters() GraphicsPresenter.CreateDepthStencilBuffer() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks This class is useful when configuring an application that will be rendering to a Texture instead of the screen. Constructors RenderTargetGraphicsPresenter(GraphicsDevice, Texture, PixelFormat) Initializes a new instance of the RenderTargetGraphicsPresenter class. public RenderTargetGraphicsPresenter(GraphicsDevice device, Texture renderTarget, PixelFormat depthFormat = PixelFormat.None) Parameters device GraphicsDevice The Graphics Device. renderTarget Texture A two-dimensional Texture that serves as a Render Target to draw into. depthFormat PixelFormat The format of the Depth-Stencil buffer Properties BackBuffer Gets the default Back-Buffer for the Graphics Presenter. public override Texture BackBuffer { get; } Property Value Texture The Texture where rendering will happen, which will then be presented to the front-buffer. IsFullScreen Gets or sets a value indicating if the Graphics Presenter is in full-screen mode. public override bool IsFullScreen { get; set; } Property Value bool A RenderTargetGraphicsPresenter always returns true for this property, and this value cannot be modified. NativePresenter Gets the underlying native presenter. public override object NativePresenter { get; } Property Value object The native presenter. Depending on platform, for exmaple, it can be a Silk.NET.DXGI.IDXGISwapChain or Silk.NET.DXGI.IDXGISwapChain1 or null. Methods Present() Presents the Back-Buffer to the screen. public override void Present() Remarks A RenderTargetGraphicsPresenter does nothing for this method; it wraps an internal Render-Target Texture to draw to, and not a swap-chain buffer. ResizeBackBuffer(int, int, PixelFormat) Resizes the Back-Buffer. protected override void ResizeBackBuffer(int width, int height, PixelFormat format) Parameters width int The new width of the Back-Buffer, in pixels. height int The new height of the Back-Buffer, in pixels. format PixelFormat The new pixel format for the Back-Buffer. Remarks When implementing this method, the derived class should resize the Back-Buffer to the specified size and format. Exceptions NotSupportedException The specified pixel format or size is not supported by the Graphics Device. ResizeDepthStencilBuffer(int, int, PixelFormat) Resizes the Depth-Stencil Buffer. protected override void ResizeDepthStencilBuffer(int width, int height, PixelFormat format) Parameters width int The new width of the Depth-Stencil Buffer, in pixels. height int The new height of the Depth-Stencil Buffer, in pixels. format PixelFormat The new pixel format for the Depth-Stencil Buffer. Remarks When implementing this method, the derived class should resize the Depth-Stencil Buffer to the specified size and format. Exceptions NotSupportedException The specified depth format or size is not supported by the Graphics Device. SetBackBuffer(Texture) Sets the Back-Buffer where the frame must be rendered. public void SetBackBuffer(Texture backBuffer) Parameters backBuffer Texture The Render Target to use as Back-Buffer."
  },
  "api/Stride.Graphics.RenderingSettings.html": {
    "href": "api/Stride.Graphics.RenderingSettings.html",
    "title": "Class RenderingSettings | Stride API",
    "summary": "Class RenderingSettings Namespace Stride.Graphics Assembly Stride.Graphics.dll [DataContract] [Display(\"Rendering\", null)] public class RenderingSettings : Configuration Inheritance object Configuration RenderingSettings Inherited Members Configuration.OfflineOnly Extension Methods UnsafeUtilities.As<T>(object?) Fields AdaptBackBufferToScreen Gets or sets a value that if true will make sure that the aspect ratio of screen is kept. [DataMember(15)] public bool AdaptBackBufferToScreen Field Value bool ColorSpace Gets or sets the colorspace. [DataMember(30)] public ColorSpace ColorSpace Field Value ColorSpace The colorspace. DefaultBackBufferHeight Gets or sets the height of the back buffer. [DataMember(10)] public int DefaultBackBufferHeight Field Value int DefaultBackBufferWidth Gets or sets the width of the back buffer. [DataMember(0)] public int DefaultBackBufferWidth Field Value int DefaultGraphicsProfile Gets or sets the default graphics profile. [DataMember(20)] public GraphicsProfile DefaultGraphicsProfile Field Value GraphicsProfile DisplayOrientation Gets or sets the display orientation. [DataMember(40)] public RequiredDisplayOrientation DisplayOrientation Field Value RequiredDisplayOrientation"
  },
  "api/Stride.Graphics.RequiredDisplayOrientation.html": {
    "href": "api/Stride.Graphics.RequiredDisplayOrientation.html",
    "title": "Enum RequiredDisplayOrientation | Stride API",
    "summary": "Enum RequiredDisplayOrientation Namespace Stride.Graphics Assembly Stride.Graphics.dll public enum RequiredDisplayOrientation Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Default = 0 The default value for the orientation. [Display(\"Landscape Left\", null)] LandscapeLeft = 1 Displays in landscape mode to the left. [Display(\"Landscape Right\", null)] LandscapeRight = 2 Displays in landscape mode to the right. Portrait = 4 Displays in portrait mode."
  },
  "api/Stride.Graphics.ResourceGroup.html": {
    "href": "api/Stride.Graphics.ResourceGroup.html",
    "title": "Class ResourceGroup | Stride API",
    "summary": "Class ResourceGroup Namespace Stride.Graphics Assembly Stride.Graphics.dll Groups bound Graphics Resources and a Constant Buffer, that usually change at a given frequency. public class ResourceGroup Inheritance object ResourceGroup Extension Methods LogicalGroupExtensions.UpdateLogicalGroup(ResourceGroup, ref LogicalGroup, ParameterCollection, int, int) UnsafeUtilities.As<T>(object?) Fields ConstantBuffer The Constant Buffer containing data and values associated with the group. public BufferPoolAllocationResult ConstantBuffer Field Value BufferPoolAllocationResult DescriptorSet The Descriptor Set containing the bound Graphics Resources (i.e. Textures, Buffers, SamplerStates, etc.) public DescriptorSet DescriptorSet Field Value DescriptorSet"
  },
  "api/Stride.Graphics.ResourceGroupAllocator.html": {
    "href": "api/Stride.Graphics.ResourceGroupAllocator.html",
    "title": "Class ResourceGroupAllocator | Stride API",
    "summary": "Class ResourceGroupAllocator Namespace Stride.Graphics Assembly Stride.Graphics.dll Allocator for resource groups. public class ResourceGroupAllocator : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase ResourceGroupAllocator Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ResourceGroupAllocator(GraphicsResourceAllocator, CommandList) public ResourceGroupAllocator(GraphicsResourceAllocator allocator, CommandList commandList) Parameters allocator GraphicsResourceAllocator commandList CommandList Methods AllocateResourceGroup() public ResourceGroup AllocateResourceGroup() Returns ResourceGroup Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. Flush() public void Flush() PrepareResourceGroup(ResourceGroupLayout, BufferPoolAllocationType, ResourceGroup) public void PrepareResourceGroup(ResourceGroupLayout resourceGroupLayout, BufferPoolAllocationType constantBufferAllocationType, ResourceGroup resourceGroup) Parameters resourceGroupLayout ResourceGroupLayout constantBufferAllocationType BufferPoolAllocationType resourceGroup ResourceGroup Reset(CommandList) public void Reset(CommandList commandList) Parameters commandList CommandList"
  },
  "api/Stride.Graphics.ResourceGroupBufferUploader.html": {
    "href": "api/Stride.Graphics.ResourceGroupBufferUploader.html",
    "title": "Struct ResourceGroupBufferUploader | Stride API",
    "summary": "Struct ResourceGroupBufferUploader Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes how a Descriptor Set maps to real resource bindings. public struct ResourceGroupBufferUploader Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks This might become a core part of Effect at some point. Methods Apply(CommandList, ResourceGroup[], int) Applies the specified resource groups to the given Command List, binding their Graphics Resources and uploading Constant Buffers as needed. public readonly void Apply(CommandList commandList, ResourceGroup[] resourceGroups, int resourceGroupsOffset) Parameters commandList CommandList The Command List to which the resource groups will be applied. resourceGroups ResourceGroup[] An array of resource groups containing the resources to be bound. Each resource group may include Constant Buffers, Textures, or other GPU resources. resourceGroupsOffset int The starting index in the resourceGroups array from which to begin applying resource groups. Remarks If a resource group contains a Constant Buffer that has not yet been uploaded, the Buffer is uploaded before being bound. Clear() Releases all pre-allocated Constant Buffers associated with the current resource group bindings and clears the bindings. public void Clear() Compile(GraphicsDevice, EffectDescriptorSetReflection, EffectBytecode) Compiles a set of Constant Buffers to bind for an Effect, pre-allocating them as needed. public void Compile(GraphicsDevice graphicsDevice, EffectDescriptorSetReflection descriptorSetLayouts, EffectBytecode effectBytecode) Parameters graphicsDevice GraphicsDevice The Graphics Device used to create and manage GPU resources. descriptorSetLayouts EffectDescriptorSetReflection The Descriptor Set layouts that define the structure of resource bindings for the Effect. effectBytecode EffectBytecode The bytecode of the Effect, including reflection data used to resolve Constant Buffers and other resources. See Also ResourceGroup"
  },
  "api/Stride.Graphics.ResourceGroupDescription.html": {
    "href": "api/Stride.Graphics.ResourceGroupDescription.html",
    "title": "Struct ResourceGroupDescription | Stride API",
    "summary": "Struct ResourceGroupDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents a description of a resource group, including the layout of its Graphics Resources and Constant Buffers. public readonly struct ResourceGroupDescription Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks A resource group is a collection of resources (e.g., Textures, Buffers) that are grouped together for use in rendering or compute operations, and that are usually updated at a specific frequency. Constructors ResourceGroupDescription(DescriptorSetLayoutBuilder, EffectConstantBufferDescription) Initializes a new instance of the ResourceGroupDescription structure. public ResourceGroupDescription(DescriptorSetLayoutBuilder descriptorSetLayout, EffectConstantBufferDescription constantBufferReflection) Parameters descriptorSetLayout DescriptorSetLayoutBuilder A description of the layout of the Descriptor Set for the resource group. constantBufferReflection EffectConstantBufferDescription A desription of the Constant Buffer used by this resource group, if any. Can be null if no Constant Buffer is used. Fields ConstantBufferReflection A description of the Constant Buffer used by this resource group, if any. public readonly EffectConstantBufferDescription ConstantBufferReflection Field Value EffectConstantBufferDescription DescriptorSetLayout A description of the layout of the Descriptor Set for the resource group. public readonly DescriptorSetLayoutBuilder DescriptorSetLayout Field Value DescriptorSetLayoutBuilder Hash A hash value identifying the resource group description. public readonly ObjectId Hash Field Value ObjectId"
  },
  "api/Stride.Graphics.ResourceGroupLayout.html": {
    "href": "api/Stride.Graphics.ResourceGroupLayout.html",
    "title": "Class ResourceGroupLayout | Stride API",
    "summary": "Class ResourceGroupLayout Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents the layout of the Graphics Resources and parameter values which form a resource group. public class ResourceGroupLayout Inheritance object ResourceGroupLayout Derived RenderSystemResourceGroupLayout Extension Methods UnsafeUtilities.As<T>(object?) Fields ConstantBufferHash A hash value identifying the Constant Buffer, used to track changes and updates. public ObjectId ConstantBufferHash Field Value ObjectId ConstantBufferReflection A description of the Constant Buffer associated with the resource group layout, including the values and types of its parameters. public EffectConstantBufferDescription ConstantBufferReflection Field Value EffectConstantBufferDescription ConstantBufferSize The size of the Constant Buffer associated with the resource group layout. public int ConstantBufferSize Field Value int DescriptorSetLayout The Descriptor Set layout that defines the structure of the resource group. public DescriptorSetLayout DescriptorSetLayout Field Value DescriptorSetLayout DescriptorSetLayoutBuilder The Descriptor Set layout builder used to describe the Descriptors for the resource group. public DescriptorSetLayoutBuilder DescriptorSetLayoutBuilder Field Value DescriptorSetLayoutBuilder Hash A hash value identifying the resource group layout. public ObjectId Hash Field Value ObjectId Methods New(GraphicsDevice, ResourceGroupDescription) Creates a new instance of a ResourceGroupLayout. public static ResourceGroupLayout New(GraphicsDevice graphicsDevice, ResourceGroupDescription resourceGroupDescription) Parameters graphicsDevice GraphicsDevice The Graphics Device to use to manage GPU resources. Cannot be null. resourceGroupDescription ResourceGroupDescription A description of the resource group, specifying its layout and resources. Cannot be null. Returns ResourceGroupLayout A new instance of ResourceGroupLayout. New<TLayout>(GraphicsDevice, ResourceGroupDescription) Creates a new instance of a ResourceGroupLayout. public static ResourceGroupLayout New<TLayout>(GraphicsDevice graphicsDevice, ResourceGroupDescription resourceGroupDescription) where TLayout : ResourceGroupLayout, new() Parameters graphicsDevice GraphicsDevice The Graphics Device to use to manage GPU resources. Cannot be null. resourceGroupDescription ResourceGroupDescription A description of the resource group, specifying its layout and resources. Cannot be null. Returns ResourceGroupLayout A new instance of ResourceGroupLayout. Type Parameters TLayout The type of resource group layout to create."
  },
  "api/Stride.Graphics.ResourceRegion.html": {
    "href": "api/Stride.Graphics.ResourceRegion.html",
    "title": "Struct ResourceRegion | Stride API",
    "summary": "Struct ResourceRegion Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines a 3D box with integer coordinates, represented as the coordinates of its minimum (left, top, front) and maximum (right, bottom, back) corners. public struct ResourceRegion Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks The values for Right, Bottom, and Back are each one pixel past the end of the pixels that are included in the box region. That is, the values for Left, Top, and Front are included in the box region while the values for Right, Bottom, and Back are excluded from the box region. For example, for a box that is one pixel wide, where (Right - Left) == 1, the box region includes the left pixel but not the right pixel. Constructors ResourceRegion(int, int, int, int, int, int) Defines a 3D box with integer coordinates, represented as the coordinates of its minimum (left, top, front) and maximum (right, bottom, back) corners. public ResourceRegion(int left, int top, int front, int right, int bottom, int back) Parameters left int The X position of the left hand side of the box. top int The Y position of the top of the box. front int The Z position of the front of the box. right int The X position of the right hand side of the box. bottom int The Y position of the bottom of the box. back int The Z position of the back of the box. Remarks The values for Right, Bottom, and Back are each one pixel past the end of the pixels that are included in the box region. That is, the values for Left, Top, and Front are included in the box region while the values for Right, Bottom, and Back are excluded from the box region. For example, for a box that is one pixel wide, where (Right - Left) == 1, the box region includes the left pixel but not the right pixel. Fields Back The Z position of the back of the box. public int Back Field Value int Bottom The Y position of the bottom of the box. public int Bottom Field Value int Front The Z position of the front of the box. public int Front Field Value int Left The X position of the left hand side of the box. public int Left Field Value int Right The X position of the right hand side of the box. public int Right Field Value int Top The Y position of the top of the box. public int Top Field Value int Properties Depth Gets the depth of the box (i.e. Back - Front). public readonly int Depth { get; } Property Value int Height Gets the height of the box (i.e. Bottom - Top). public readonly int Height { get; } Property Value int Width Gets the width of the box (i.e. Right - Left). public readonly int Width { get; } Property Value int"
  },
  "api/Stride.Graphics.ResumeManager.html": {
    "href": "api/Stride.Graphics.ResumeManager.html",
    "title": "Class ResumeManager | Stride API",
    "summary": "Class ResumeManager Namespace Stride.Graphics Assembly Stride.Graphics.dll public class ResumeManager Inheritance object ResumeManager Extension Methods UnsafeUtilities.As<T>(object?) Constructors ResumeManager(IServiceRegistry) public ResumeManager(IServiceRegistry services) Parameters services IServiceRegistry Methods OnDestroyed(bool) Called when the Resume Manager is being destroyed. public void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the resources used by the Resume Manager should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). OnRecreate() public void OnRecreate() OnReload() public void OnReload() OnRender() public void OnRender() OnResume() public void OnResume() Pause() public void Pause()"
  },
  "api/Stride.Graphics.RootSignature.html": {
    "href": "api/Stride.Graphics.RootSignature.html",
    "title": "Class RootSignature | Stride API",
    "summary": "Class RootSignature Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents a Root Signature, used to specify how Graphics Resources, such as Textures and Buffers, are bound to the graphics pipeline (i.e. how DescriptorSet will be bound together). public class RootSignature : GraphicsResourceBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase RootSignature Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsResourceBase.NativeResource GraphicsResourceBase.NativeDeviceChild GraphicsResourceBase.UnsetNativeDeviceChild() GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) GraphicsResourceBase.NativeDevice GraphicsResourceBase.IsDebugMode GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed GraphicsResourceBase.OnPause() GraphicsResourceBase.OnResume() GraphicsResourceBase.Destroy() GraphicsResourceBase.OnDestroyed(bool) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks A Root Signature links Command Lists to the Graphics Resources the Shaders require. It is similar to a function signature, it determines the types of data the Shaders should expect, but does not define the actual memory or data. The Graphics Resources are described by Descriptors and bundled in DescriptorSets. An EffectDescriptorSetReflection defines the layout of the Graphics Resources, bind slot names, and other metadata. Methods New(GraphicsDevice, EffectDescriptorSetReflection) Creates a new Root Signature from the given EffectDescriptorSetReflection. public static RootSignature New(GraphicsDevice graphicsDevice, EffectDescriptorSetReflection effectDescriptorSetReflection) Parameters graphicsDevice GraphicsDevice The GraphicsDevice. effectDescriptorSetReflection EffectDescriptorSetReflection A description of the layout of the Graphics Resources to bind. Returns RootSignature The new Root Signature. OnRecreate() Called when the GraphicsDevice has been recreated. protected override bool OnRecreate() Returns bool true if resource has transitioned to the Active state."
  },
  "api/Stride.Graphics.SDL.Application.html": {
    "href": "api/Stride.Graphics.SDL.Application.html",
    "title": "Class Application | Stride API",
    "summary": "Class Application Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public static class Application Inheritance object Application Properties Clipboard public static string Clipboard { get; set; } Property Value string MousePosition Screen coordinate of the mouse. public static Point MousePosition { get; set; } Property Value Point WindowWithFocus Window that currently has the focus. public static Window WindowWithFocus { get; } Property Value Window Windows List of windows managed by the application. public static List<Window> Windows { get; } Property Value List<Window> Methods ProcessEvent(Event) Process a single event and dispatch it to the right window. public static void ProcessEvent(Event e) Parameters e Event ProcessEvents() Process all available events. public static void ProcessEvents() RegisterWindow(Window) Register c to the list of available windows. public static void RegisterWindow(Window c) Parameters c Window Window to register UnregisterWindow(Window) Unregister c from the list of available windows. public static void UnregisterWindow(Window c) Parameters c Window Window to unregister"
  },
  "api/Stride.Graphics.SDL.Cursor.html": {
    "href": "api/Stride.Graphics.SDL.Cursor.html",
    "title": "Class Cursor | Stride API",
    "summary": "Class Cursor Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll Basic operations to show, hide and load a cursor. public class Cursor Inheritance object Cursor Extension Methods UnsafeUtilities.As<T>(object?) Constructors Cursor(byte[], byte[], int, int, int, int) Initialize a cursor with data and mask. For more details, see https://wiki.libsdl.org/SDL_CreateCursor. public Cursor(byte[] data, byte[] mask, int w, int h, int hot_x, int hot_y) Parameters data byte[] Actual cursor image mask byte[] Mask for data w int Width of cursor h int Height of cursor hot_x int Hotspot X coordinate of cursor hot_y int Hotspot Y coordinate of cursor Properties Handle Access to low level pointer to the SDL_Cursor struct. public nint Handle { get; } Property Value nint Position Position of cursor on screen. public static Point Position { get; set; } Property Value Point Methods Hide() Hide cursor. public static void Hide() SetCursor(Cursor) Set cursor with cur. public static void SetCursor(Cursor cur) Parameters cur Cursor New cursor to show. Show() Show cursor. public static void Show()"
  },
  "api/Stride.Graphics.SDL.FormBorderStyle.html": {
    "href": "api/Stride.Graphics.SDL.FormBorderStyle.html",
    "title": "Enum FormBorderStyle | Stride API",
    "summary": "Enum FormBorderStyle Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll Set of border style to mimic the Windows forms one. We actually only show FixedSingle and Sizable as the other values don't make sense in a purely SDL context. public enum FormBorderStyle Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields FixedSingle = 1 Borders but not resizeable None = 0 Borderless Sizable = 4 Borders and resizeable"
  },
  "api/Stride.Graphics.SDL.FormWindowState.html": {
    "href": "api/Stride.Graphics.SDL.FormWindowState.html",
    "title": "Enum FormWindowState | Stride API",
    "summary": "Enum FormWindowState Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll Set of window states to mimic the Windows forms one. public enum FormWindowState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Fullscreen = 3 Maximized = 2 Minimized = 1 Normal = 0"
  },
  "api/Stride.Graphics.SDL.Window.DropEventDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.DropEventDelegate.html",
    "title": "Delegate Window.DropEventDelegate | Stride API",
    "summary": "Delegate Window.DropEventDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.DropEventDelegate(string content) Parameters content string Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.JoystickDeviceChangedDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.JoystickDeviceChangedDelegate.html",
    "title": "Delegate Window.JoystickDeviceChangedDelegate | Stride API",
    "summary": "Delegate Window.JoystickDeviceChangedDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.JoystickDeviceChangedDelegate(int which) Parameters which int Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.KeyDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.KeyDelegate.html",
    "title": "Delegate Window.KeyDelegate | Stride API",
    "summary": "Delegate Window.KeyDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.KeyDelegate(KeyboardEvent e) Parameters e KeyboardEvent Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.MouseButtonDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.MouseButtonDelegate.html",
    "title": "Delegate Window.MouseButtonDelegate | Stride API",
    "summary": "Delegate Window.MouseButtonDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.MouseButtonDelegate(MouseButtonEvent e) Parameters e MouseButtonEvent Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.MouseMoveDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.MouseMoveDelegate.html",
    "title": "Delegate Window.MouseMoveDelegate | Stride API",
    "summary": "Delegate Window.MouseMoveDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.MouseMoveDelegate(MouseMotionEvent e) Parameters e MouseMotionEvent Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.MouseWheelDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.MouseWheelDelegate.html",
    "title": "Delegate Window.MouseWheelDelegate | Stride API",
    "summary": "Delegate Window.MouseWheelDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.MouseWheelDelegate(MouseWheelEvent e) Parameters e MouseWheelEvent Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.NotificationDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.NotificationDelegate.html",
    "title": "Delegate Window.NotificationDelegate | Stride API",
    "summary": "Delegate Window.NotificationDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.NotificationDelegate() Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.TextEditingDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.TextEditingDelegate.html",
    "title": "Delegate Window.TextEditingDelegate | Stride API",
    "summary": "Delegate Window.TextEditingDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.TextEditingDelegate(TextEditingEvent e) Parameters e TextEditingEvent Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.TextInputDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.TextInputDelegate.html",
    "title": "Delegate Window.TextInputDelegate | Stride API",
    "summary": "Delegate Window.TextInputDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.TextInputDelegate(TextInputEvent e) Parameters e TextInputEvent Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.TouchFingerDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.TouchFingerDelegate.html",
    "title": "Delegate Window.TouchFingerDelegate | Stride API",
    "summary": "Delegate Window.TouchFingerDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.TouchFingerDelegate(TouchFingerEvent e) Parameters e TouchFingerEvent Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.WindowEventDelegate.html": {
    "href": "api/Stride.Graphics.SDL.Window.WindowEventDelegate.html",
    "title": "Delegate Window.WindowEventDelegate | Stride API",
    "summary": "Delegate Window.WindowEventDelegate Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public delegate void Window.WindowEventDelegate(WindowEvent e) Parameters e WindowEvent Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.SDL.Window.html": {
    "href": "api/Stride.Graphics.SDL.Window.html",
    "title": "Class Window | Stride API",
    "summary": "Class Window Namespace Stride.Graphics.SDL Assembly Stride.Graphics.dll public class Window : IDisposable Inheritance object Window Implements IDisposable Derived GameFormSDL Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors Window(string) Initializes a new instance of the Window class with title as the title of the Window. public Window(string title) Parameters title string Title of the window, see Text property. Window(string, nint) Initializes a new instance of the Window class with title as the title of the Window. public Window(string title, nint parent) Parameters title string Title of the window, see Text property. parent nint Parent window handle Fields SDL public static Sdl SDL Field Value Sdl Properties ClientRectangle Size of client area expressed as a rectangle. public Rectangle ClientRectangle { get; set; } Property Value Rectangle ClientSize Size of the client area of a window. public Size2 ClientSize { get; set; } Property Value Size2 Display Display of current Window (valid only for Unix for X11). public nint Display { get; } Property Value nint Exists Is the Window still alive? public bool Exists { get; } Property Value bool Focused Is current window focused? public bool Focused { get; } Property Value bool FormBorderStyle Style of border. Currently can only be Sizable or FixedSingle. public FormBorderStyle FormBorderStyle { get; set; } Property Value FormBorderStyle FullscreenIsBorderlessWindow Gets or sets a value indicating whether fullscreen mode should be a borderless window matching the desktop size. Decides whether to set the SDL_WINDOW_FULLSCREEN_DESKTOP (fake fullscreen) or SDL_WINDOW_FULLSCREEN (real fullscreen) flag. public bool FullscreenIsBorderlessWindow { get; set; } Property Value bool Handle Platform specific handle for Window. public nint Handle { get; } Property Value nint Remarks On Windows: the HWND of the window On Unix: the Window ID (XID). Note that on Unix, the value is 32-bit (See X11/X.h for the typedef of XID). IsDisposed Have we already disposed of the current object? public bool IsDisposed { get; } Property Value bool IsFullScreen Are we showing the window in full screen mode? public bool IsFullScreen { get; set; } Property Value bool Location Coordinates of the top-left corner of the window in screen coordinate. public Point Location { get; set; } Property Value Point MaximizeBox Does current window offer a maximize button? public bool MaximizeBox { get; set; } Property Value bool Remarks Setter is not implemented on SDL, since we do have callers, for the time being, the code does nothing instead of throwing an exception. MinimizeOnFocusLoss Minimize the window when focus is lost in fullscreen, default is false. public bool MinimizeOnFocusLoss { get; set; } Property Value bool MousePosition Get the mouse position on screen. public static Point MousePosition { get; } Property Value Point Opacity The opacity of the window. public float Opacity { get; set; } Property Value float Remarks The value should be between 0.0f and 1.0f. It will automatically be clamped to this range. RelativeCursorPosition Get the coordinate of the mouse in Window coordinates public Point RelativeCursorPosition { get; set; } Property Value Point SdlHandle The SDL window handle. public nint SdlHandle { get; } Property Value nint Size Size of window. public Size2 Size { get; set; } Property Value Size2 Surface Surface of current Window (valid only for Android). public nint Surface { get; } Property Value nint Text Text of the title of the Window. public string Text { get; set; } Property Value string TopMost Make the window topmost public bool TopMost { get; set; } Property Value bool Visible Is current window visible? public bool Visible { get; set; } Property Value bool WindowState State of the window which can be either of Normal, Maximized or Minimized. public FormWindowState WindowState { get; set; } Property Value FormWindowState Methods BringToFront() Move window to front. public virtual void BringToFront() Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Dispose of current Window. protected virtual void Dispose(bool disposing) Parameters disposing bool If false we are being called from the Finalizer. ~Window() protected ~Window() ProcessEvent(Event) Process events for the current window public virtual void ProcessEvent(Event e) Parameters e Event SendToBack() Move window to back. public virtual void SendToBack() SetRelativeMouseMode(bool) public void SetRelativeMouseMode(bool enabled) Parameters enabled bool Show() Show window. The first time a window is shown we execute any actions from 'HandleCreated' />. public void Show() Events ActivateActions public event Window.WindowEventDelegate ActivateActions Event Type Window.WindowEventDelegate CloseActions public event Window.NotificationDelegate CloseActions Event Type Window.NotificationDelegate DeActivateActions public event Window.WindowEventDelegate DeActivateActions Event Type Window.WindowEventDelegate Disposed Actions to be called when we dispose of current. public event EventHandler Disposed Event Type EventHandler DropFileActions public event Window.DropEventDelegate DropFileActions Event Type Window.DropEventDelegate FingerMoveActions public event Window.TouchFingerDelegate FingerMoveActions Event Type Window.TouchFingerDelegate FingerPressActions public event Window.TouchFingerDelegate FingerPressActions Event Type Window.TouchFingerDelegate FingerReleaseActions public event Window.TouchFingerDelegate FingerReleaseActions Event Type Window.TouchFingerDelegate FocusGainedActions public event Window.WindowEventDelegate FocusGainedActions Event Type Window.WindowEventDelegate FocusLostActions public event Window.WindowEventDelegate FocusLostActions Event Type Window.WindowEventDelegate JoystickDeviceAdded public event Window.JoystickDeviceChangedDelegate JoystickDeviceAdded Event Type Window.JoystickDeviceChangedDelegate JoystickDeviceRemoved public event Window.JoystickDeviceChangedDelegate JoystickDeviceRemoved Event Type Window.JoystickDeviceChangedDelegate KeyDownActions public event Window.KeyDelegate KeyDownActions Event Type Window.KeyDelegate KeyUpActions public event Window.KeyDelegate KeyUpActions Event Type Window.KeyDelegate MaximizedActions public event Window.WindowEventDelegate MaximizedActions Event Type Window.WindowEventDelegate MinimizedActions public event Window.WindowEventDelegate MinimizedActions Event Type Window.WindowEventDelegate MouseEnterActions public event Window.WindowEventDelegate MouseEnterActions Event Type Window.WindowEventDelegate MouseLeaveActions public event Window.WindowEventDelegate MouseLeaveActions Event Type Window.WindowEventDelegate MouseMoveActions public event Window.MouseMoveDelegate MouseMoveActions Event Type Window.MouseMoveDelegate MouseWheelActions public event Window.MouseWheelDelegate MouseWheelActions Event Type Window.MouseWheelDelegate PointerButtonPressActions public event Window.MouseButtonDelegate PointerButtonPressActions Event Type Window.MouseButtonDelegate PointerButtonReleaseActions public event Window.MouseButtonDelegate PointerButtonReleaseActions Event Type Window.MouseButtonDelegate RestoredActions public event Window.WindowEventDelegate RestoredActions Event Type Window.WindowEventDelegate SizeChangedActions public event Window.WindowEventDelegate SizeChangedActions Event Type Window.WindowEventDelegate TextEditingActions public event Window.TextEditingDelegate TextEditingActions Event Type Window.TextEditingDelegate TextInputActions public event Window.TextInputDelegate TextInputActions Event Type Window.TextInputDelegate UserResizedActions public event Window.WindowEventDelegate UserResizedActions Event Type Window.WindowEventDelegate"
  },
  "api/Stride.Graphics.SDL.html": {
    "href": "api/Stride.Graphics.SDL.html",
    "title": "Namespace Stride.Graphics.SDL | Stride API",
    "summary": "Namespace Stride.Graphics.SDL Classes Application Cursor Basic operations to show, hide and load a cursor. Window Enums FormBorderStyle Set of border style to mimic the Windows forms one. We actually only show FixedSingle and Sizable as the other values don't make sense in a purely SDL context. FormWindowState Set of window states to mimic the Windows forms one. Delegates Window.DropEventDelegate Window.JoystickDeviceChangedDelegate Window.KeyDelegate Window.MouseButtonDelegate Window.MouseMoveDelegate Window.MouseWheelDelegate Window.NotificationDelegate Window.TextEditingDelegate Window.TextInputDelegate Window.TouchFingerDelegate Window.WindowEventDelegate"
  },
  "api/Stride.Graphics.SamplerState.html": {
    "href": "api/Stride.Graphics.SamplerState.html",
    "title": "Class SamplerState | Stride API",
    "summary": "Class SamplerState Namespace Stride.Graphics Assembly Stride.Graphics.dll A graphics object that describes a Sampler State, which determines how to sample Texture data. public class SamplerState : GraphicsResourceBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase SamplerState Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsResourceBase.NativeResource GraphicsResourceBase.NativeDeviceChild GraphicsResourceBase.UnsetNativeDeviceChild() GraphicsResourceBase.SetNativeDeviceChild(ComPtr<ID3D11DeviceChild>) GraphicsResourceBase.NativeDevice GraphicsResourceBase.IsDebugMode GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed GraphicsResourceBase.OnPause() GraphicsResourceBase.OnResume() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields Description The description of the Sampler State. public readonly SamplerStateDescription Description Field Value SamplerStateDescription Methods Destroy() Disposes the resources associated with the Graphics Resource, removes itself from the GraphicsDevice's resource registry, and transitions to the Destroyed state. protected override void Destroy() New(GraphicsDevice, ref readonly SamplerStateDescription, string?) Creates a new SamplerState. public static SamplerState New(GraphicsDevice device, ref readonly SamplerStateDescription description, string? name = null) Parameters device GraphicsDevice The GraphicsDevice. description SamplerStateDescription A SamplerStateDescription structure describing the Sampler State object to create. name string An optional name that can be used to identify the Sampler State. Returns SamplerState A new Sampler State object. NewFake(SamplerStateDescription) Creates a new fake SamplerState for serialization. public static SamplerState NewFake(SamplerStateDescription description) Parameters description SamplerStateDescription A SamplerStateDescription structure describing the Sampler State object to create. Returns SamplerState A new fake Sampler State object. OnDestroyed(bool) Called when the GraphicsDevice has been detected to be internally destroyed, or when the Destroy() methad has been called. Raises the Destroyed event. protected override void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the resource should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). Remarks This method releases the underlying native resources (Silk.NET.Direct3D11.ID3D11Resource and Silk.NET.Direct3D11.ID3D11DeviceChild). OnRecreate() Called when the GraphicsDevice has been recreated. protected override bool OnRecreate() Returns bool true if resource has transitioned to the Active state."
  },
  "api/Stride.Graphics.SamplerStateDescription.html": {
    "href": "api/Stride.Graphics.SamplerStateDescription.html",
    "title": "Struct SamplerStateDescription | Stride API",
    "summary": "Struct SamplerStateDescription Namespace Stride.Graphics Assembly Stride.dll Describes a Sampler State object, which determines how to sample Texture data. [DataContract] public struct SamplerStateDescription : IEquatable<SamplerStateDescription> Implements IEquatable<SamplerStateDescription> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors SamplerStateDescription() Initializes a new instance of the SamplerStateDescription structure with default values. public SamplerStateDescription() Remarks The default values are: <ul><li>Linear filtering (<xref href=\"Stride.Graphics.TextureFilter.Linear\" data-throw-if-not-resolved=\"false\"></xref>).</li><li><xref href=\"Stride.Graphics.TextureAddressMode.Clamp\" data-throw-if-not-resolved=\"false\"></xref> for <code>U</code>, <code>V</code>, and <code>W</code> Texture coordinates.</li><li>No Mip LOD bias (<code>0.0</code>).</li><li>A default maximum anisotropy of <code>16x</code>.</li><li>A comparison function that never passes (<xref href=\"Stride.Graphics.CompareFunction.Never\" data-throw-if-not-resolved=\"false\"></xref>).</li><li>A border color of black (<code>(0,0,0,0)</code>).</li><li> No clamping on Mip-levels (<xref href=\"Stride.Graphics.SamplerStateDescription.MinMipLevel\" data-throw-if-not-resolved=\"false\"></xref> is <code>-<xref href=\"System.Single.MaxValue\" data-throw-if-not-resolved=\"false\"></xref></code> and <xref href=\"Stride.Graphics.SamplerStateDescription.MaxMipLevel\" data-throw-if-not-resolved=\"false\"></xref> is <code><xref href=\"System.Single.MaxValue\" data-throw-if-not-resolved=\"false\"></xref></code>). </li></ul> </remarks> SamplerStateDescription(TextureFilter, TextureAddressMode) Initializes a new instance of the SamplerStateDescription structure with default values, and a specific Texture filtering and addressing mode. public SamplerStateDescription(TextureFilter filter, TextureAddressMode addressMode) Parameters filter TextureFilter The Texture filtering mode. addressMode TextureAddressMode The Texture addressing mode for U, V, and W coordinates. Remarks The default values are: <ul><li>Linear filtering (<xref href=\"Stride.Graphics.TextureFilter.Linear\" data-throw-if-not-resolved=\"false\"></xref>).</li><li><xref href=\"Stride.Graphics.TextureAddressMode.Clamp\" data-throw-if-not-resolved=\"false\"></xref> for <code>U</code>, <code>V</code>, and <code>W</code> Texture coordinates.</li><li>No Mip LOD bias (<code>0.0</code>).</li><li>A default maximum anisotropy of <code>16x</code>.</li><li>A comparison function that never passes (<xref href=\"Stride.Graphics.CompareFunction.Never\" data-throw-if-not-resolved=\"false\"></xref>).</li><li>A border color of black (<code>(0,0,0,0)</code>).</li><li> No clamping on Mip-levels (<xref href=\"Stride.Graphics.SamplerStateDescription.MinMipLevel\" data-throw-if-not-resolved=\"false\"></xref> is <code>-<xref href=\"System.Single.MaxValue\" data-throw-if-not-resolved=\"false\"></xref></code> and <xref href=\"Stride.Graphics.SamplerStateDescription.MaxMipLevel\" data-throw-if-not-resolved=\"false\"></xref> is <code><xref href=\"System.Single.MaxValue\" data-throw-if-not-resolved=\"false\"></xref></code>). </li></ul> </remarks> Fields AddressU The method to use for resolving a U texture coordinate that is outside the [0, 1] range. public TextureAddressMode AddressU Field Value TextureAddressMode AddressV The method to use for resolving a V texture coordinate that is outside the [0, 1] range. public TextureAddressMode AddressV Field Value TextureAddressMode AddressW The method to use for resolving a W texture coordinate that is outside the [0, 1] range. public TextureAddressMode AddressW Field Value TextureAddressMode BorderColor The border color to use if Border is specified for AddressU, AddressV, or AddressW. public Color4 BorderColor Field Value Color4 CompareFunction A function that compares sampled data against existing sampled data. public CompareFunction CompareFunction Field Value CompareFunction Remarks This function will be used when specifying one of the comparison filtering modes in Filter. DefaultAddressU Default value for AddressU. public const TextureAddressMode DefaultAddressU = Clamp Field Value TextureAddressMode DefaultAddressV Default value for AddressV. public const TextureAddressMode DefaultAddressV = Clamp Field Value TextureAddressMode DefaultAddressW Default value for AddressW. public const TextureAddressMode DefaultAddressW = Clamp Field Value TextureAddressMode DefaultBorderColor Default value for BorderColor (black). public static readonly Color4 DefaultBorderColor Field Value Color4 DefaultCompareFunction Default value for CompareFunction. public const CompareFunction DefaultCompareFunction = Never Field Value CompareFunction DefaultFilter Default value for Filter. public const TextureFilter DefaultFilter = Linear Field Value TextureFilter DefaultMaxAnisotropy Default value for MaxAnisotropy. public const int DefaultMaxAnisotropy = 16 Field Value int DefaultMaxMipLevel Default value for MaxMipLevel. public const float DefaultMaxMipLevel = 3.4028235E+38 Field Value float DefaultMinMipLevel Default value for MinMipLevel. public const float DefaultMinMipLevel = -3.4028235E+38 Field Value float DefaultMipMapLevelOfDetailBias Default value for MipMapLevelOfDetailBias. public const float DefaultMipMapLevelOfDetailBias = 0 Field Value float Filter The filtering method to use when sampling a Texture. public TextureFilter Filter Field Value TextureFilter MaxAnisotropy The clamping value used if Anisotropic or ComparisonAnisotropic is specified in Filter. Valid values are between 1 and 16. public int MaxAnisotropy Field Value int MaxMipLevel The upper end of the mipmap range to clamp access to, where 0 is the largest and most detailed mipmap level and any level higher than that is less detailed. public float MaxMipLevel Field Value float Remarks This value must be greater than or equal to MinMipLevel. To have no upper limit set this to a large value such as MaxValue. MinMipLevel The lower end of the mipmap range to clamp access to, where 0 is the largest and most detailed mipmap level and any level higher than that is less detailed. public float MinMipLevel Field Value float MipMapLevelOfDetailBias The offset to apply from the calculated mipmap level. public float MipMapLevelOfDetailBias Field Value float Remarks For example, if a Texture should be sampled at mipmap level 3 and MipMapLevelOfDetailBias is 2, then the Texture will be sampled at mipmap level 5. Properties Default Returns a SamplerStateDescription with default values. public static SamplerStateDescription Default { get; } Property Value SamplerStateDescription Remarks The default values are: Linear filtering (Linear). Clamp for U, V, and W Texture coordinates. No Mip LOD bias (0.0). A default maximum anisotropy of 16x. A comparison function that never passes (Never). A border color of black ((0,0,0,0)). No clamping on Mip-levels (MinMipLevel is -MaxValue and MaxMipLevel is MaxValue). Methods Equals(SamplerStateDescription) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(SamplerStateDescription other) Parameters other SamplerStateDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the fully qualified type name of this instance. public override readonly string ToString() Returns string The fully qualified type name. Operators operator ==(SamplerStateDescription, SamplerStateDescription) public static bool operator ==(SamplerStateDescription left, SamplerStateDescription right) Parameters left SamplerStateDescription right SamplerStateDescription Returns bool operator !=(SamplerStateDescription, SamplerStateDescription) public static bool operator !=(SamplerStateDescription left, SamplerStateDescription right) Parameters left SamplerStateDescription right SamplerStateDescription Returns bool"
  },
  "api/Stride.Graphics.SamplerStateFactory.html": {
    "href": "api/Stride.Graphics.SamplerStateFactory.html",
    "title": "Class SamplerStateFactory | Stride API",
    "summary": "Class SamplerStateFactory Namespace Stride.Graphics Assembly Stride.Graphics.dll A factory for creating SamplerState instances. Contains pre-created Sampler States for commonly used configurations. public class SamplerStateFactory : GraphicsResourceFactoryBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceFactoryBase SamplerStateFactory Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsResourceFactoryBase.GraphicsDevice ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks To access these default Sampler States, you can access them through SamplerStates. Fields AnisotropicClamp Default Sampler State for anisotropic filtering with texture coordinate clamping. public readonly SamplerState AnisotropicClamp Field Value SamplerState AnisotropicWrap Default Sampler State for anisotropic filtering with texture coordinate wrapping. public readonly SamplerState AnisotropicWrap Field Value SamplerState LinearClamp Default Sampler State for linear filtering with texture coordinate clamping. public readonly SamplerState LinearClamp Field Value SamplerState LinearWrap Default Sampler State for linear filtering with texture coordinate wrapping. public readonly SamplerState LinearWrap Field Value SamplerState PointClamp Default Sampler State for point filtering with texture coordinate clamping. public readonly SamplerState PointClamp Field Value SamplerState PointWrap Default Sampler State for point filtering with texture coordinate wrapping. public readonly SamplerState PointWrap Field Value SamplerState"
  },
  "api/Stride.Graphics.SamplerStateSerializer.html": {
    "href": "api/Stride.Graphics.SamplerStateSerializer.html",
    "title": "Class SamplerStateSerializer | Stride API",
    "summary": "Class SamplerStateSerializer Namespace Stride.Graphics Assembly Stride.Graphics.dll Serializer for SamplerState. [DataSerializerGlobal(typeof(SamplerStateSerializer), null, DataSerializerGenericMode.None, false, false)] public class SamplerStateSerializer : DataSerializer<SamplerState> Inheritance object DataSerializer DataSerializer<SamplerState> SamplerStateSerializer Inherited Members DataSerializer<SamplerState>.SerializationType DataSerializer<SamplerState>.IsBlittable DataSerializer<SamplerState>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<SamplerState>.Serialize(SamplerState, SerializationStream) DataSerializer<SamplerState>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<SamplerState>.PreSerialize(ref SamplerState, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref SamplerState, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref SamplerState samplerState, ArchiveMode mode, SerializationStream stream) Parameters samplerState SamplerState mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Graphics.Semantics.B4B4.html": {
    "href": "api/Stride.Graphics.Semantics.B4B4.html",
    "title": "Interface B4B4 | Stride API",
    "summary": "Interface B4B4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface B4B4 : IConverter<Byte4, Byte4> Inherited Members IConverter<Byte4, Byte4>.Convert(in Byte4, out Byte4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.B4COLOR.html": {
    "href": "api/Stride.Graphics.Semantics.B4COLOR.html",
    "title": "Interface B4COLOR | Stride API",
    "summary": "Interface B4COLOR Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface B4COLOR : IConverter<Byte4, Color> Inherited Members IConverter<Byte4, Color>.Convert(in Byte4, out Color) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.B4H2.html": {
    "href": "api/Stride.Graphics.Semantics.B4H2.html",
    "title": "Interface B4H2 | Stride API",
    "summary": "Interface B4H2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface B4H2 : IConverter<Byte4, Half2> Inherited Members IConverter<Byte4, Half2>.Convert(in Byte4, out Half2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.B4H3.html": {
    "href": "api/Stride.Graphics.Semantics.B4H3.html",
    "title": "Interface B4H3 | Stride API",
    "summary": "Interface B4H3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface B4H3 : IConverter<Byte4, Half3> Inherited Members IConverter<Byte4, Half3>.Convert(in Byte4, out Half3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.B4H4.html": {
    "href": "api/Stride.Graphics.Semantics.B4H4.html",
    "title": "Interface B4H4 | Stride API",
    "summary": "Interface B4H4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface B4H4 : IConverter<Byte4, Half4> Inherited Members IConverter<Byte4, Half4>.Convert(in Byte4, out Half4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.B4U4.html": {
    "href": "api/Stride.Graphics.Semantics.B4U4.html",
    "title": "Interface B4U4 | Stride API",
    "summary": "Interface B4U4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface B4U4 : IConverter<Byte4, UShort4> Inherited Members IConverter<Byte4, UShort4>.Convert(in Byte4, out UShort4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.B4V2.html": {
    "href": "api/Stride.Graphics.Semantics.B4V2.html",
    "title": "Interface B4V2 | Stride API",
    "summary": "Interface B4V2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface B4V2 : IConverter<Byte4, Vector2> Inherited Members IConverter<Byte4, Vector2>.Convert(in Byte4, out Vector2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.B4V3.html": {
    "href": "api/Stride.Graphics.Semantics.B4V3.html",
    "title": "Interface B4V3 | Stride API",
    "summary": "Interface B4V3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface B4V3 : IConverter<Byte4, Vector3> Inherited Members IConverter<Byte4, Vector3>.Convert(in Byte4, out Vector3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.B4V4.html": {
    "href": "api/Stride.Graphics.Semantics.B4V4.html",
    "title": "Interface B4V4 | Stride API",
    "summary": "Interface B4V4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface B4V4 : IConverter<Byte4, Vector4> Inherited Members IConverter<Byte4, Vector4>.Convert(in Byte4, out Vector4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.BiTangentSemantic.html": {
    "href": "api/Stride.Graphics.Semantics.BiTangentSemantic.html",
    "title": "Struct BiTangentSemantic | Stride API",
    "summary": "Struct BiTangentSemantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public struct BiTangentSemantic : IFloat4Semantic, ISemantic<Vector4>, ISemantic, V4V2, IConverter<Vector4, Vector2>, V2V4, IConverter<Vector2, Vector4>, V4V3, IConverter<Vector4, Vector3>, V3V4, IConverter<Vector3, Vector4>, V4V4, IConverter<Vector4, Vector4>, V4B4, IConverter<Vector4, Byte4>, B4V4, IConverter<Byte4, Vector4>, V4U4, IConverter<Vector4, UShort4>, U4V4, IConverter<UShort4, Vector4>, V4H2, IConverter<Vector4, Half2>, H2V4, IConverter<Half2, Vector4>, V4H3, IConverter<Vector4, Half3>, H3V4, IConverter<Half3, Vector4>, V4H4, IConverter<Vector4, Half4>, H4V4, IConverter<Half4, Vector4>, V4COLOR, IConverter<Vector4, Color>, COLORV4, IConverter<Color, Vector4> Implements IFloat4Semantic ISemantic<Vector4> ISemantic V4V2 IConverter<Vector4, Vector2> V2V4 IConverter<Vector2, Vector4> V4V3 IConverter<Vector4, Vector3> V3V4 IConverter<Vector3, Vector4> V4V4 IConverter<Vector4, Vector4> V4B4 IConverter<Vector4, Byte4> B4V4 IConverter<Byte4, Vector4> V4U4 IConverter<Vector4, UShort4> U4V4 IConverter<UShort4, Vector4> V4H2 IConverter<Vector4, Half2> H2V4 IConverter<Half2, Vector4> V4H3 IConverter<Vector4, Half3> H3V4 IConverter<Half3, Vector4> V4H4 IConverter<Vector4, Half4> H4V4 IConverter<Half4, Vector4> V4COLOR IConverter<Vector4, Color> COLORV4 IConverter<Color, Vector4> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Name public static string Name { get; } Property Value string"
  },
  "api/Stride.Graphics.Semantics.BlendIndicesSemantic.html": {
    "href": "api/Stride.Graphics.Semantics.BlendIndicesSemantic.html",
    "title": "Struct BlendIndicesSemantic | Stride API",
    "summary": "Struct BlendIndicesSemantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public struct BlendIndicesSemantic : IUShort4Semantic, ISemantic<UShort4>, ISemantic, U4V2, IConverter<UShort4, Vector2>, V2U4, IConverter<Vector2, UShort4>, U4V3, IConverter<UShort4, Vector3>, V3U4, IConverter<Vector3, UShort4>, U4V4, IConverter<UShort4, Vector4>, V4U4, IConverter<Vector4, UShort4>, U4B4, IConverter<UShort4, Byte4>, B4U4, IConverter<Byte4, UShort4>, U4U4, IConverter<UShort4, UShort4>, U4H2, IConverter<UShort4, Half2>, H2U4, IConverter<Half2, UShort4>, U4H3, IConverter<UShort4, Half3>, H3U4, IConverter<Half3, UShort4>, U4H4, IConverter<UShort4, Half4>, H4U4, IConverter<Half4, UShort4>, U4COLOR, IConverter<UShort4, Color>, COLORU4, IConverter<Color, UShort4> Implements IUShort4Semantic ISemantic<UShort4> ISemantic U4V2 IConverter<UShort4, Vector2> V2U4 IConverter<Vector2, UShort4> U4V3 IConverter<UShort4, Vector3> V3U4 IConverter<Vector3, UShort4> U4V4 IConverter<UShort4, Vector4> V4U4 IConverter<Vector4, UShort4> U4B4 IConverter<UShort4, Byte4> B4U4 IConverter<Byte4, UShort4> U4U4 IConverter<UShort4, UShort4> U4H2 IConverter<UShort4, Half2> H2U4 IConverter<Half2, UShort4> U4H3 IConverter<UShort4, Half3> H3U4 IConverter<Half3, UShort4> U4H4 IConverter<UShort4, Half4> H4U4 IConverter<Half4, UShort4> U4COLOR IConverter<UShort4, Color> COLORU4 IConverter<Color, UShort4> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Name public static string Name { get; } Property Value string"
  },
  "api/Stride.Graphics.Semantics.BlendWeightSemantic.html": {
    "href": "api/Stride.Graphics.Semantics.BlendWeightSemantic.html",
    "title": "Struct BlendWeightSemantic | Stride API",
    "summary": "Struct BlendWeightSemantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public struct BlendWeightSemantic : IFloat4Semantic, ISemantic<Vector4>, ISemantic, V4V2, IConverter<Vector4, Vector2>, V2V4, IConverter<Vector2, Vector4>, V4V3, IConverter<Vector4, Vector3>, V3V4, IConverter<Vector3, Vector4>, V4V4, IConverter<Vector4, Vector4>, V4B4, IConverter<Vector4, Byte4>, B4V4, IConverter<Byte4, Vector4>, V4U4, IConverter<Vector4, UShort4>, U4V4, IConverter<UShort4, Vector4>, V4H2, IConverter<Vector4, Half2>, H2V4, IConverter<Half2, Vector4>, V4H3, IConverter<Vector4, Half3>, H3V4, IConverter<Half3, Vector4>, V4H4, IConverter<Vector4, Half4>, H4V4, IConverter<Half4, Vector4>, V4COLOR, IConverter<Vector4, Color>, COLORV4, IConverter<Color, Vector4> Implements IFloat4Semantic ISemantic<Vector4> ISemantic V4V2 IConverter<Vector4, Vector2> V2V4 IConverter<Vector2, Vector4> V4V3 IConverter<Vector4, Vector3> V3V4 IConverter<Vector3, Vector4> V4V4 IConverter<Vector4, Vector4> V4B4 IConverter<Vector4, Byte4> B4V4 IConverter<Byte4, Vector4> V4U4 IConverter<Vector4, UShort4> U4V4 IConverter<UShort4, Vector4> V4H2 IConverter<Vector4, Half2> H2V4 IConverter<Half2, Vector4> V4H3 IConverter<Vector4, Half3> H3V4 IConverter<Half3, Vector4> V4H4 IConverter<Vector4, Half4> H4V4 IConverter<Half4, Vector4> V4COLOR IConverter<Vector4, Color> COLORV4 IConverter<Color, Vector4> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Name public static string Name { get; } Property Value string"
  },
  "api/Stride.Graphics.Semantics.COLORB4.html": {
    "href": "api/Stride.Graphics.Semantics.COLORB4.html",
    "title": "Interface COLORB4 | Stride API",
    "summary": "Interface COLORB4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface COLORB4 : IConverter<Color, Byte4> Inherited Members IConverter<Color, Byte4>.Convert(in Color, out Byte4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.COLORCOLOR.html": {
    "href": "api/Stride.Graphics.Semantics.COLORCOLOR.html",
    "title": "Interface COLORCOLOR | Stride API",
    "summary": "Interface COLORCOLOR Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface COLORCOLOR : IConverter<Color, Color> Inherited Members IConverter<Color, Color>.Convert(in Color, out Color) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.COLORH2.html": {
    "href": "api/Stride.Graphics.Semantics.COLORH2.html",
    "title": "Interface COLORH2 | Stride API",
    "summary": "Interface COLORH2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface COLORH2 : IConverter<Color, Half2> Inherited Members IConverter<Color, Half2>.Convert(in Color, out Half2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.COLORH3.html": {
    "href": "api/Stride.Graphics.Semantics.COLORH3.html",
    "title": "Interface COLORH3 | Stride API",
    "summary": "Interface COLORH3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface COLORH3 : IConverter<Color, Half3> Inherited Members IConverter<Color, Half3>.Convert(in Color, out Half3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.COLORH4.html": {
    "href": "api/Stride.Graphics.Semantics.COLORH4.html",
    "title": "Interface COLORH4 | Stride API",
    "summary": "Interface COLORH4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface COLORH4 : IConverter<Color, Half4> Inherited Members IConverter<Color, Half4>.Convert(in Color, out Half4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.COLORU4.html": {
    "href": "api/Stride.Graphics.Semantics.COLORU4.html",
    "title": "Interface COLORU4 | Stride API",
    "summary": "Interface COLORU4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface COLORU4 : IConverter<Color, UShort4> Inherited Members IConverter<Color, UShort4>.Convert(in Color, out UShort4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.COLORV2.html": {
    "href": "api/Stride.Graphics.Semantics.COLORV2.html",
    "title": "Interface COLORV2 | Stride API",
    "summary": "Interface COLORV2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface COLORV2 : IConverter<Color, Vector2> Inherited Members IConverter<Color, Vector2>.Convert(in Color, out Vector2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.COLORV3.html": {
    "href": "api/Stride.Graphics.Semantics.COLORV3.html",
    "title": "Interface COLORV3 | Stride API",
    "summary": "Interface COLORV3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface COLORV3 : IConverter<Color, Vector3> Inherited Members IConverter<Color, Vector3>.Convert(in Color, out Vector3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.COLORV4.html": {
    "href": "api/Stride.Graphics.Semantics.COLORV4.html",
    "title": "Interface COLORV4 | Stride API",
    "summary": "Interface COLORV4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface COLORV4 : IConverter<Color, Vector4> Inherited Members IConverter<Color, Vector4>.Convert(in Color, out Vector4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.ColorSemantic.html": {
    "href": "api/Stride.Graphics.Semantics.ColorSemantic.html",
    "title": "Struct ColorSemantic | Stride API",
    "summary": "Struct ColorSemantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public struct ColorSemantic : IFloat4Semantic, ISemantic<Vector4>, ISemantic, V4V2, IConverter<Vector4, Vector2>, V2V4, IConverter<Vector2, Vector4>, V4V3, IConverter<Vector4, Vector3>, V3V4, IConverter<Vector3, Vector4>, V4V4, IConverter<Vector4, Vector4>, V4B4, IConverter<Vector4, Byte4>, B4V4, IConverter<Byte4, Vector4>, V4U4, IConverter<Vector4, UShort4>, U4V4, IConverter<UShort4, Vector4>, V4H2, IConverter<Vector4, Half2>, H2V4, IConverter<Half2, Vector4>, V4H3, IConverter<Vector4, Half3>, H3V4, IConverter<Half3, Vector4>, V4H4, IConverter<Vector4, Half4>, H4V4, IConverter<Half4, Vector4>, V4COLOR, IConverter<Vector4, Color>, COLORV4, IConverter<Color, Vector4> Implements IFloat4Semantic ISemantic<Vector4> ISemantic V4V2 IConverter<Vector4, Vector2> V2V4 IConverter<Vector2, Vector4> V4V3 IConverter<Vector4, Vector3> V3V4 IConverter<Vector3, Vector4> V4V4 IConverter<Vector4, Vector4> V4B4 IConverter<Vector4, Byte4> B4V4 IConverter<Byte4, Vector4> V4U4 IConverter<Vector4, UShort4> U4V4 IConverter<UShort4, Vector4> V4H2 IConverter<Vector4, Half2> H2V4 IConverter<Half2, Vector4> V4H3 IConverter<Vector4, Half3> H3V4 IConverter<Half3, Vector4> V4H4 IConverter<Vector4, Half4> H4V4 IConverter<Half4, Vector4> V4COLOR IConverter<Vector4, Color> COLORV4 IConverter<Color, Vector4> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Name public static string Name { get; } Property Value string"
  },
  "api/Stride.Graphics.Semantics.H2B4.html": {
    "href": "api/Stride.Graphics.Semantics.H2B4.html",
    "title": "Interface H2B4 | Stride API",
    "summary": "Interface H2B4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H2B4 : IConverter<Half2, Byte4> Inherited Members IConverter<Half2, Byte4>.Convert(in Half2, out Byte4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H2COLOR.html": {
    "href": "api/Stride.Graphics.Semantics.H2COLOR.html",
    "title": "Interface H2COLOR | Stride API",
    "summary": "Interface H2COLOR Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H2COLOR : IConverter<Half2, Color> Inherited Members IConverter<Half2, Color>.Convert(in Half2, out Color) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H2H2.html": {
    "href": "api/Stride.Graphics.Semantics.H2H2.html",
    "title": "Interface H2H2 | Stride API",
    "summary": "Interface H2H2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H2H2 : IConverter<Half2, Half2> Inherited Members IConverter<Half2, Half2>.Convert(in Half2, out Half2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H2H3.html": {
    "href": "api/Stride.Graphics.Semantics.H2H3.html",
    "title": "Interface H2H3 | Stride API",
    "summary": "Interface H2H3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H2H3 : IConverter<Half2, Half3> Inherited Members IConverter<Half2, Half3>.Convert(in Half2, out Half3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H2H4.html": {
    "href": "api/Stride.Graphics.Semantics.H2H4.html",
    "title": "Interface H2H4 | Stride API",
    "summary": "Interface H2H4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H2H4 : IConverter<Half2, Half4> Inherited Members IConverter<Half2, Half4>.Convert(in Half2, out Half4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H2U4.html": {
    "href": "api/Stride.Graphics.Semantics.H2U4.html",
    "title": "Interface H2U4 | Stride API",
    "summary": "Interface H2U4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H2U4 : IConverter<Half2, UShort4> Inherited Members IConverter<Half2, UShort4>.Convert(in Half2, out UShort4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H2V2.html": {
    "href": "api/Stride.Graphics.Semantics.H2V2.html",
    "title": "Interface H2V2 | Stride API",
    "summary": "Interface H2V2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H2V2 : IConverter<Half2, Vector2> Inherited Members IConverter<Half2, Vector2>.Convert(in Half2, out Vector2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H2V3.html": {
    "href": "api/Stride.Graphics.Semantics.H2V3.html",
    "title": "Interface H2V3 | Stride API",
    "summary": "Interface H2V3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H2V3 : IConverter<Half2, Vector3> Inherited Members IConverter<Half2, Vector3>.Convert(in Half2, out Vector3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H2V4.html": {
    "href": "api/Stride.Graphics.Semantics.H2V4.html",
    "title": "Interface H2V4 | Stride API",
    "summary": "Interface H2V4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H2V4 : IConverter<Half2, Vector4> Inherited Members IConverter<Half2, Vector4>.Convert(in Half2, out Vector4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H3B4.html": {
    "href": "api/Stride.Graphics.Semantics.H3B4.html",
    "title": "Interface H3B4 | Stride API",
    "summary": "Interface H3B4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H3B4 : IConverter<Half3, Byte4> Inherited Members IConverter<Half3, Byte4>.Convert(in Half3, out Byte4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H3COLOR.html": {
    "href": "api/Stride.Graphics.Semantics.H3COLOR.html",
    "title": "Interface H3COLOR | Stride API",
    "summary": "Interface H3COLOR Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H3COLOR : IConverter<Half3, Color> Inherited Members IConverter<Half3, Color>.Convert(in Half3, out Color) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H3H2.html": {
    "href": "api/Stride.Graphics.Semantics.H3H2.html",
    "title": "Interface H3H2 | Stride API",
    "summary": "Interface H3H2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H3H2 : IConverter<Half3, Half2> Inherited Members IConverter<Half3, Half2>.Convert(in Half3, out Half2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H3H3.html": {
    "href": "api/Stride.Graphics.Semantics.H3H3.html",
    "title": "Interface H3H3 | Stride API",
    "summary": "Interface H3H3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H3H3 : IConverter<Half3, Half3> Inherited Members IConverter<Half3, Half3>.Convert(in Half3, out Half3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H3H4.html": {
    "href": "api/Stride.Graphics.Semantics.H3H4.html",
    "title": "Interface H3H4 | Stride API",
    "summary": "Interface H3H4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H3H4 : IConverter<Half3, Half4> Inherited Members IConverter<Half3, Half4>.Convert(in Half3, out Half4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H3U4.html": {
    "href": "api/Stride.Graphics.Semantics.H3U4.html",
    "title": "Interface H3U4 | Stride API",
    "summary": "Interface H3U4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H3U4 : IConverter<Half3, UShort4> Inherited Members IConverter<Half3, UShort4>.Convert(in Half3, out UShort4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H3V2.html": {
    "href": "api/Stride.Graphics.Semantics.H3V2.html",
    "title": "Interface H3V2 | Stride API",
    "summary": "Interface H3V2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H3V2 : IConverter<Half3, Vector2> Inherited Members IConverter<Half3, Vector2>.Convert(in Half3, out Vector2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H3V3.html": {
    "href": "api/Stride.Graphics.Semantics.H3V3.html",
    "title": "Interface H3V3 | Stride API",
    "summary": "Interface H3V3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H3V3 : IConverter<Half3, Vector3> Inherited Members IConverter<Half3, Vector3>.Convert(in Half3, out Vector3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H3V4.html": {
    "href": "api/Stride.Graphics.Semantics.H3V4.html",
    "title": "Interface H3V4 | Stride API",
    "summary": "Interface H3V4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H3V4 : IConverter<Half3, Vector4> Inherited Members IConverter<Half3, Vector4>.Convert(in Half3, out Vector4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H4B4.html": {
    "href": "api/Stride.Graphics.Semantics.H4B4.html",
    "title": "Interface H4B4 | Stride API",
    "summary": "Interface H4B4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H4B4 : IConverter<Half4, Byte4> Inherited Members IConverter<Half4, Byte4>.Convert(in Half4, out Byte4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H4COLOR.html": {
    "href": "api/Stride.Graphics.Semantics.H4COLOR.html",
    "title": "Interface H4COLOR | Stride API",
    "summary": "Interface H4COLOR Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H4COLOR : IConverter<Half4, Color> Inherited Members IConverter<Half4, Color>.Convert(in Half4, out Color) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H4H2.html": {
    "href": "api/Stride.Graphics.Semantics.H4H2.html",
    "title": "Interface H4H2 | Stride API",
    "summary": "Interface H4H2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H4H2 : IConverter<Half4, Half2> Inherited Members IConverter<Half4, Half2>.Convert(in Half4, out Half2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H4H3.html": {
    "href": "api/Stride.Graphics.Semantics.H4H3.html",
    "title": "Interface H4H3 | Stride API",
    "summary": "Interface H4H3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H4H3 : IConverter<Half4, Half3> Inherited Members IConverter<Half4, Half3>.Convert(in Half4, out Half3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H4H4.html": {
    "href": "api/Stride.Graphics.Semantics.H4H4.html",
    "title": "Interface H4H4 | Stride API",
    "summary": "Interface H4H4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H4H4 : IConverter<Half4, Half4> Inherited Members IConverter<Half4, Half4>.Convert(in Half4, out Half4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H4U4.html": {
    "href": "api/Stride.Graphics.Semantics.H4U4.html",
    "title": "Interface H4U4 | Stride API",
    "summary": "Interface H4U4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H4U4 : IConverter<Half4, UShort4> Inherited Members IConverter<Half4, UShort4>.Convert(in Half4, out UShort4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H4V2.html": {
    "href": "api/Stride.Graphics.Semantics.H4V2.html",
    "title": "Interface H4V2 | Stride API",
    "summary": "Interface H4V2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H4V2 : IConverter<Half4, Vector2> Inherited Members IConverter<Half4, Vector2>.Convert(in Half4, out Vector2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H4V3.html": {
    "href": "api/Stride.Graphics.Semantics.H4V3.html",
    "title": "Interface H4V3 | Stride API",
    "summary": "Interface H4V3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H4V3 : IConverter<Half4, Vector3> Inherited Members IConverter<Half4, Vector3>.Convert(in Half4, out Vector3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.H4V4.html": {
    "href": "api/Stride.Graphics.Semantics.H4V4.html",
    "title": "Interface H4V4 | Stride API",
    "summary": "Interface H4V4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface H4V4 : IConverter<Half4, Vector4> Inherited Members IConverter<Half4, Vector4>.Convert(in Half4, out Vector4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.IByte4Semantic.html": {
    "href": "api/Stride.Graphics.Semantics.IByte4Semantic.html",
    "title": "Interface IByte4Semantic | Stride API",
    "summary": "Interface IByte4Semantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface IByte4Semantic : ISemantic<Byte4>, ISemantic, B4V2, IConverter<Byte4, Vector2>, V2B4, IConverter<Vector2, Byte4>, B4V3, IConverter<Byte4, Vector3>, V3B4, IConverter<Vector3, Byte4>, B4V4, IConverter<Byte4, Vector4>, V4B4, IConverter<Vector4, Byte4>, B4B4, IConverter<Byte4, Byte4>, B4U4, IConverter<Byte4, UShort4>, U4B4, IConverter<UShort4, Byte4>, B4H2, IConverter<Byte4, Half2>, H2B4, IConverter<Half2, Byte4>, B4H3, IConverter<Byte4, Half3>, H3B4, IConverter<Half3, Byte4>, B4H4, IConverter<Byte4, Half4>, H4B4, IConverter<Half4, Byte4>, B4COLOR, IConverter<Byte4, Color>, COLORB4, IConverter<Color, Byte4> Inherited Members ISemantic.Name IConverter<Byte4, Vector2>.Convert(in Byte4, out Vector2) IConverter<Vector2, Byte4>.Convert(in Vector2, out Byte4) IConverter<Byte4, Vector3>.Convert(in Byte4, out Vector3) IConverter<Vector3, Byte4>.Convert(in Vector3, out Byte4) IConverter<Byte4, Vector4>.Convert(in Byte4, out Vector4) IConverter<Vector4, Byte4>.Convert(in Vector4, out Byte4) IConverter<Byte4, Byte4>.Convert(in Byte4, out Byte4) IConverter<Byte4, UShort4>.Convert(in Byte4, out UShort4) IConverter<UShort4, Byte4>.Convert(in UShort4, out Byte4) IConverter<Byte4, Half2>.Convert(in Byte4, out Half2) IConverter<Half2, Byte4>.Convert(in Half2, out Byte4) IConverter<Byte4, Half3>.Convert(in Byte4, out Half3) IConverter<Half3, Byte4>.Convert(in Half3, out Byte4) IConverter<Byte4, Half4>.Convert(in Byte4, out Half4) IConverter<Half4, Byte4>.Convert(in Half4, out Byte4) IConverter<Byte4, Color>.Convert(in Byte4, out Color) IConverter<Color, Byte4>.Convert(in Color, out Byte4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.IColorSemantic.html": {
    "href": "api/Stride.Graphics.Semantics.IColorSemantic.html",
    "title": "Interface IColorSemantic | Stride API",
    "summary": "Interface IColorSemantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface IColorSemantic : ISemantic<Color>, ISemantic, COLORV2, IConverter<Color, Vector2>, V2COLOR, IConverter<Vector2, Color>, COLORV3, IConverter<Color, Vector3>, V3COLOR, IConverter<Vector3, Color>, COLORV4, IConverter<Color, Vector4>, V4COLOR, IConverter<Vector4, Color>, COLORB4, IConverter<Color, Byte4>, B4COLOR, IConverter<Byte4, Color>, COLORU4, IConverter<Color, UShort4>, U4COLOR, IConverter<UShort4, Color>, COLORH2, IConverter<Color, Half2>, H2COLOR, IConverter<Half2, Color>, COLORH3, IConverter<Color, Half3>, H3COLOR, IConverter<Half3, Color>, COLORH4, IConverter<Color, Half4>, H4COLOR, IConverter<Half4, Color>, COLORCOLOR, IConverter<Color, Color> Inherited Members ISemantic.Name IConverter<Color, Vector2>.Convert(in Color, out Vector2) IConverter<Vector2, Color>.Convert(in Vector2, out Color) IConverter<Color, Vector3>.Convert(in Color, out Vector3) IConverter<Vector3, Color>.Convert(in Vector3, out Color) IConverter<Color, Vector4>.Convert(in Color, out Vector4) IConverter<Vector4, Color>.Convert(in Vector4, out Color) IConverter<Color, Byte4>.Convert(in Color, out Byte4) IConverter<Byte4, Color>.Convert(in Byte4, out Color) IConverter<Color, UShort4>.Convert(in Color, out UShort4) IConverter<UShort4, Color>.Convert(in UShort4, out Color) IConverter<Color, Half2>.Convert(in Color, out Half2) IConverter<Half2, Color>.Convert(in Half2, out Color) IConverter<Color, Half3>.Convert(in Color, out Half3) IConverter<Half3, Color>.Convert(in Half3, out Color) IConverter<Color, Half4>.Convert(in Color, out Half4) IConverter<Half4, Color>.Convert(in Half4, out Color) IConverter<Color, Color>.Convert(in Color, out Color) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.IConverter-2.html": {
    "href": "api/Stride.Graphics.Semantics.IConverter-2.html",
    "title": "Interface IConverter<TSource, TDest> | Stride API",
    "summary": "Interface IConverter<TSource, TDest> Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface IConverter<TSource, TDest> Type Parameters TSource TDest Extension Methods UnsafeUtilities.As<T>(object?) Methods Convert(in TSource, out TDest) public static abstract void Convert(in TSource source, out TDest dest) Parameters source TSource dest TDest"
  },
  "api/Stride.Graphics.Semantics.IFloat2Semantic.html": {
    "href": "api/Stride.Graphics.Semantics.IFloat2Semantic.html",
    "title": "Interface IFloat2Semantic | Stride API",
    "summary": "Interface IFloat2Semantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface IFloat2Semantic : ISemantic<Vector2>, ISemantic, V2V2, IConverter<Vector2, Vector2>, V2V3, IConverter<Vector2, Vector3>, V3V2, IConverter<Vector3, Vector2>, V2V4, IConverter<Vector2, Vector4>, V4V2, IConverter<Vector4, Vector2>, V2B4, IConverter<Vector2, Byte4>, B4V2, IConverter<Byte4, Vector2>, V2U4, IConverter<Vector2, UShort4>, U4V2, IConverter<UShort4, Vector2>, V2H2, IConverter<Vector2, Half2>, H2V2, IConverter<Half2, Vector2>, V2H3, IConverter<Vector2, Half3>, H3V2, IConverter<Half3, Vector2>, V2H4, IConverter<Vector2, Half4>, H4V2, IConverter<Half4, Vector2>, V2COLOR, IConverter<Vector2, Color>, COLORV2, IConverter<Color, Vector2> Inherited Members ISemantic.Name IConverter<Vector2, Vector2>.Convert(in Vector2, out Vector2) IConverter<Vector2, Vector3>.Convert(in Vector2, out Vector3) IConverter<Vector3, Vector2>.Convert(in Vector3, out Vector2) IConverter<Vector2, Vector4>.Convert(in Vector2, out Vector4) IConverter<Vector4, Vector2>.Convert(in Vector4, out Vector2) IConverter<Vector2, Byte4>.Convert(in Vector2, out Byte4) IConverter<Byte4, Vector2>.Convert(in Byte4, out Vector2) IConverter<Vector2, UShort4>.Convert(in Vector2, out UShort4) IConverter<UShort4, Vector2>.Convert(in UShort4, out Vector2) IConverter<Vector2, Half2>.Convert(in Vector2, out Half2) IConverter<Half2, Vector2>.Convert(in Half2, out Vector2) IConverter<Vector2, Half3>.Convert(in Vector2, out Half3) IConverter<Half3, Vector2>.Convert(in Half3, out Vector2) IConverter<Vector2, Half4>.Convert(in Vector2, out Half4) IConverter<Half4, Vector2>.Convert(in Half4, out Vector2) IConverter<Vector2, Color>.Convert(in Vector2, out Color) IConverter<Color, Vector2>.Convert(in Color, out Vector2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.IFloat3Semantic.html": {
    "href": "api/Stride.Graphics.Semantics.IFloat3Semantic.html",
    "title": "Interface IFloat3Semantic | Stride API",
    "summary": "Interface IFloat3Semantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface IFloat3Semantic : ISemantic<Vector3>, ISemantic, V3V2, IConverter<Vector3, Vector2>, V2V3, IConverter<Vector2, Vector3>, V3V3, IConverter<Vector3, Vector3>, V3V4, IConverter<Vector3, Vector4>, V4V3, IConverter<Vector4, Vector3>, V3B4, IConverter<Vector3, Byte4>, B4V3, IConverter<Byte4, Vector3>, V3U4, IConverter<Vector3, UShort4>, U4V3, IConverter<UShort4, Vector3>, V3H2, IConverter<Vector3, Half2>, H2V3, IConverter<Half2, Vector3>, V3H3, IConverter<Vector3, Half3>, H3V3, IConverter<Half3, Vector3>, V3H4, IConverter<Vector3, Half4>, H4V3, IConverter<Half4, Vector3>, V3COLOR, IConverter<Vector3, Color>, COLORV3, IConverter<Color, Vector3> Inherited Members ISemantic.Name IConverter<Vector3, Vector2>.Convert(in Vector3, out Vector2) IConverter<Vector2, Vector3>.Convert(in Vector2, out Vector3) IConverter<Vector3, Vector3>.Convert(in Vector3, out Vector3) IConverter<Vector3, Vector4>.Convert(in Vector3, out Vector4) IConverter<Vector4, Vector3>.Convert(in Vector4, out Vector3) IConverter<Vector3, Byte4>.Convert(in Vector3, out Byte4) IConverter<Byte4, Vector3>.Convert(in Byte4, out Vector3) IConverter<Vector3, UShort4>.Convert(in Vector3, out UShort4) IConverter<UShort4, Vector3>.Convert(in UShort4, out Vector3) IConverter<Vector3, Half2>.Convert(in Vector3, out Half2) IConverter<Half2, Vector3>.Convert(in Half2, out Vector3) IConverter<Vector3, Half3>.Convert(in Vector3, out Half3) IConverter<Half3, Vector3>.Convert(in Half3, out Vector3) IConverter<Vector3, Half4>.Convert(in Vector3, out Half4) IConverter<Half4, Vector3>.Convert(in Half4, out Vector3) IConverter<Vector3, Color>.Convert(in Vector3, out Color) IConverter<Color, Vector3>.Convert(in Color, out Vector3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.IFloat4Semantic.html": {
    "href": "api/Stride.Graphics.Semantics.IFloat4Semantic.html",
    "title": "Interface IFloat4Semantic | Stride API",
    "summary": "Interface IFloat4Semantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface IFloat4Semantic : ISemantic<Vector4>, ISemantic, V4V2, IConverter<Vector4, Vector2>, V2V4, IConverter<Vector2, Vector4>, V4V3, IConverter<Vector4, Vector3>, V3V4, IConverter<Vector3, Vector4>, V4V4, IConverter<Vector4, Vector4>, V4B4, IConverter<Vector4, Byte4>, B4V4, IConverter<Byte4, Vector4>, V4U4, IConverter<Vector4, UShort4>, U4V4, IConverter<UShort4, Vector4>, V4H2, IConverter<Vector4, Half2>, H2V4, IConverter<Half2, Vector4>, V4H3, IConverter<Vector4, Half3>, H3V4, IConverter<Half3, Vector4>, V4H4, IConverter<Vector4, Half4>, H4V4, IConverter<Half4, Vector4>, V4COLOR, IConverter<Vector4, Color>, COLORV4, IConverter<Color, Vector4> Inherited Members ISemantic.Name IConverter<Vector4, Vector2>.Convert(in Vector4, out Vector2) IConverter<Vector2, Vector4>.Convert(in Vector2, out Vector4) IConverter<Vector4, Vector3>.Convert(in Vector4, out Vector3) IConverter<Vector3, Vector4>.Convert(in Vector3, out Vector4) IConverter<Vector4, Vector4>.Convert(in Vector4, out Vector4) IConverter<Vector4, Byte4>.Convert(in Vector4, out Byte4) IConverter<Byte4, Vector4>.Convert(in Byte4, out Vector4) IConverter<Vector4, UShort4>.Convert(in Vector4, out UShort4) IConverter<UShort4, Vector4>.Convert(in UShort4, out Vector4) IConverter<Vector4, Half2>.Convert(in Vector4, out Half2) IConverter<Half2, Vector4>.Convert(in Half2, out Vector4) IConverter<Vector4, Half3>.Convert(in Vector4, out Half3) IConverter<Half3, Vector4>.Convert(in Half3, out Vector4) IConverter<Vector4, Half4>.Convert(in Vector4, out Half4) IConverter<Half4, Vector4>.Convert(in Half4, out Vector4) IConverter<Vector4, Color>.Convert(in Vector4, out Color) IConverter<Color, Vector4>.Convert(in Color, out Vector4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.IHalf2Semantic.html": {
    "href": "api/Stride.Graphics.Semantics.IHalf2Semantic.html",
    "title": "Interface IHalf2Semantic | Stride API",
    "summary": "Interface IHalf2Semantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface IHalf2Semantic : ISemantic<Half2>, ISemantic, H2V2, IConverter<Half2, Vector2>, V2H2, IConverter<Vector2, Half2>, H2V3, IConverter<Half2, Vector3>, V3H2, IConverter<Vector3, Half2>, H2V4, IConverter<Half2, Vector4>, V4H2, IConverter<Vector4, Half2>, H2B4, IConverter<Half2, Byte4>, B4H2, IConverter<Byte4, Half2>, H2U4, IConverter<Half2, UShort4>, U4H2, IConverter<UShort4, Half2>, H2H2, IConverter<Half2, Half2>, H2H3, IConverter<Half2, Half3>, H3H2, IConverter<Half3, Half2>, H2H4, IConverter<Half2, Half4>, H4H2, IConverter<Half4, Half2>, H2COLOR, IConverter<Half2, Color>, COLORH2, IConverter<Color, Half2> Inherited Members ISemantic.Name IConverter<Half2, Vector2>.Convert(in Half2, out Vector2) IConverter<Vector2, Half2>.Convert(in Vector2, out Half2) IConverter<Half2, Vector3>.Convert(in Half2, out Vector3) IConverter<Vector3, Half2>.Convert(in Vector3, out Half2) IConverter<Half2, Vector4>.Convert(in Half2, out Vector4) IConverter<Vector4, Half2>.Convert(in Vector4, out Half2) IConverter<Half2, Byte4>.Convert(in Half2, out Byte4) IConverter<Byte4, Half2>.Convert(in Byte4, out Half2) IConverter<Half2, UShort4>.Convert(in Half2, out UShort4) IConverter<UShort4, Half2>.Convert(in UShort4, out Half2) IConverter<Half2, Half2>.Convert(in Half2, out Half2) IConverter<Half2, Half3>.Convert(in Half2, out Half3) IConverter<Half3, Half2>.Convert(in Half3, out Half2) IConverter<Half2, Half4>.Convert(in Half2, out Half4) IConverter<Half4, Half2>.Convert(in Half4, out Half2) IConverter<Half2, Color>.Convert(in Half2, out Color) IConverter<Color, Half2>.Convert(in Color, out Half2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.IHalf3Semantic.html": {
    "href": "api/Stride.Graphics.Semantics.IHalf3Semantic.html",
    "title": "Interface IHalf3Semantic | Stride API",
    "summary": "Interface IHalf3Semantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface IHalf3Semantic : ISemantic<Half3>, ISemantic, H3V2, IConverter<Half3, Vector2>, V2H3, IConverter<Vector2, Half3>, H3V3, IConverter<Half3, Vector3>, V3H3, IConverter<Vector3, Half3>, H3V4, IConverter<Half3, Vector4>, V4H3, IConverter<Vector4, Half3>, H3B4, IConverter<Half3, Byte4>, B4H3, IConverter<Byte4, Half3>, H3U4, IConverter<Half3, UShort4>, U4H3, IConverter<UShort4, Half3>, H3H2, IConverter<Half3, Half2>, H2H3, IConverter<Half2, Half3>, H3H3, IConverter<Half3, Half3>, H3H4, IConverter<Half3, Half4>, H4H3, IConverter<Half4, Half3>, H3COLOR, IConverter<Half3, Color>, COLORH3, IConverter<Color, Half3> Inherited Members ISemantic.Name IConverter<Half3, Vector2>.Convert(in Half3, out Vector2) IConverter<Vector2, Half3>.Convert(in Vector2, out Half3) IConverter<Half3, Vector3>.Convert(in Half3, out Vector3) IConverter<Vector3, Half3>.Convert(in Vector3, out Half3) IConverter<Half3, Vector4>.Convert(in Half3, out Vector4) IConverter<Vector4, Half3>.Convert(in Vector4, out Half3) IConverter<Half3, Byte4>.Convert(in Half3, out Byte4) IConverter<Byte4, Half3>.Convert(in Byte4, out Half3) IConverter<Half3, UShort4>.Convert(in Half3, out UShort4) IConverter<UShort4, Half3>.Convert(in UShort4, out Half3) IConverter<Half3, Half2>.Convert(in Half3, out Half2) IConverter<Half2, Half3>.Convert(in Half2, out Half3) IConverter<Half3, Half3>.Convert(in Half3, out Half3) IConverter<Half3, Half4>.Convert(in Half3, out Half4) IConverter<Half4, Half3>.Convert(in Half4, out Half3) IConverter<Half3, Color>.Convert(in Half3, out Color) IConverter<Color, Half3>.Convert(in Color, out Half3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.IHalf4Semantic.html": {
    "href": "api/Stride.Graphics.Semantics.IHalf4Semantic.html",
    "title": "Interface IHalf4Semantic | Stride API",
    "summary": "Interface IHalf4Semantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface IHalf4Semantic : ISemantic<Half4>, ISemantic, H4V2, IConverter<Half4, Vector2>, V2H4, IConverter<Vector2, Half4>, H4V3, IConverter<Half4, Vector3>, V3H4, IConverter<Vector3, Half4>, H4V4, IConverter<Half4, Vector4>, V4H4, IConverter<Vector4, Half4>, H4B4, IConverter<Half4, Byte4>, B4H4, IConverter<Byte4, Half4>, H4U4, IConverter<Half4, UShort4>, U4H4, IConverter<UShort4, Half4>, H4H2, IConverter<Half4, Half2>, H2H4, IConverter<Half2, Half4>, H4H3, IConverter<Half4, Half3>, H3H4, IConverter<Half3, Half4>, H4H4, IConverter<Half4, Half4>, H4COLOR, IConverter<Half4, Color>, COLORH4, IConverter<Color, Half4> Inherited Members ISemantic.Name IConverter<Half4, Vector2>.Convert(in Half4, out Vector2) IConverter<Vector2, Half4>.Convert(in Vector2, out Half4) IConverter<Half4, Vector3>.Convert(in Half4, out Vector3) IConverter<Vector3, Half4>.Convert(in Vector3, out Half4) IConverter<Half4, Vector4>.Convert(in Half4, out Vector4) IConverter<Vector4, Half4>.Convert(in Vector4, out Half4) IConverter<Half4, Byte4>.Convert(in Half4, out Byte4) IConverter<Byte4, Half4>.Convert(in Byte4, out Half4) IConverter<Half4, UShort4>.Convert(in Half4, out UShort4) IConverter<UShort4, Half4>.Convert(in UShort4, out Half4) IConverter<Half4, Half2>.Convert(in Half4, out Half2) IConverter<Half2, Half4>.Convert(in Half2, out Half4) IConverter<Half4, Half3>.Convert(in Half4, out Half3) IConverter<Half3, Half4>.Convert(in Half3, out Half4) IConverter<Half4, Half4>.Convert(in Half4, out Half4) IConverter<Half4, Color>.Convert(in Half4, out Color) IConverter<Color, Half4>.Convert(in Color, out Half4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.ISemantic-1.html": {
    "href": "api/Stride.Graphics.Semantics.ISemantic-1.html",
    "title": "Interface ISemantic<T> | Stride API",
    "summary": "Interface ISemantic<T> Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface ISemantic<T> : ISemantic Type Parameters T Inherited Members ISemantic.Name Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.ISemantic.html": {
    "href": "api/Stride.Graphics.Semantics.ISemantic.html",
    "title": "Interface ISemantic | Stride API",
    "summary": "Interface ISemantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface ISemantic Extension Methods UnsafeUtilities.As<T>(object?) Properties Name public static abstract string Name { get; } Property Value string"
  },
  "api/Stride.Graphics.Semantics.IUShort4Semantic.html": {
    "href": "api/Stride.Graphics.Semantics.IUShort4Semantic.html",
    "title": "Interface IUShort4Semantic | Stride API",
    "summary": "Interface IUShort4Semantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface IUShort4Semantic : ISemantic<UShort4>, ISemantic, U4V2, IConverter<UShort4, Vector2>, V2U4, IConverter<Vector2, UShort4>, U4V3, IConverter<UShort4, Vector3>, V3U4, IConverter<Vector3, UShort4>, U4V4, IConverter<UShort4, Vector4>, V4U4, IConverter<Vector4, UShort4>, U4B4, IConverter<UShort4, Byte4>, B4U4, IConverter<Byte4, UShort4>, U4U4, IConverter<UShort4, UShort4>, U4H2, IConverter<UShort4, Half2>, H2U4, IConverter<Half2, UShort4>, U4H3, IConverter<UShort4, Half3>, H3U4, IConverter<Half3, UShort4>, U4H4, IConverter<UShort4, Half4>, H4U4, IConverter<Half4, UShort4>, U4COLOR, IConverter<UShort4, Color>, COLORU4, IConverter<Color, UShort4> Inherited Members ISemantic.Name IConverter<UShort4, Vector2>.Convert(in UShort4, out Vector2) IConverter<Vector2, UShort4>.Convert(in Vector2, out UShort4) IConverter<UShort4, Vector3>.Convert(in UShort4, out Vector3) IConverter<Vector3, UShort4>.Convert(in Vector3, out UShort4) IConverter<UShort4, Vector4>.Convert(in UShort4, out Vector4) IConverter<Vector4, UShort4>.Convert(in Vector4, out UShort4) IConverter<UShort4, Byte4>.Convert(in UShort4, out Byte4) IConverter<Byte4, UShort4>.Convert(in Byte4, out UShort4) IConverter<UShort4, UShort4>.Convert(in UShort4, out UShort4) IConverter<UShort4, Half2>.Convert(in UShort4, out Half2) IConverter<Half2, UShort4>.Convert(in Half2, out UShort4) IConverter<UShort4, Half3>.Convert(in UShort4, out Half3) IConverter<Half3, UShort4>.Convert(in Half3, out UShort4) IConverter<UShort4, Half4>.Convert(in UShort4, out Half4) IConverter<Half4, UShort4>.Convert(in Half4, out UShort4) IConverter<UShort4, Color>.Convert(in UShort4, out Color) IConverter<Color, UShort4>.Convert(in Color, out UShort4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.NormalSemantic.html": {
    "href": "api/Stride.Graphics.Semantics.NormalSemantic.html",
    "title": "Struct NormalSemantic | Stride API",
    "summary": "Struct NormalSemantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public struct NormalSemantic : IFloat3Semantic, ISemantic<Vector3>, ISemantic, V3V2, IConverter<Vector3, Vector2>, V2V3, IConverter<Vector2, Vector3>, V3V3, IConverter<Vector3, Vector3>, V3V4, IConverter<Vector3, Vector4>, V4V3, IConverter<Vector4, Vector3>, V3B4, IConverter<Vector3, Byte4>, B4V3, IConverter<Byte4, Vector3>, V3U4, IConverter<Vector3, UShort4>, U4V3, IConverter<UShort4, Vector3>, V3H2, IConverter<Vector3, Half2>, H2V3, IConverter<Half2, Vector3>, V3H3, IConverter<Vector3, Half3>, H3V3, IConverter<Half3, Vector3>, V3H4, IConverter<Vector3, Half4>, H4V3, IConverter<Half4, Vector3>, V3COLOR, IConverter<Vector3, Color>, COLORV3, IConverter<Color, Vector3> Implements IFloat3Semantic ISemantic<Vector3> ISemantic V3V2 IConverter<Vector3, Vector2> V2V3 IConverter<Vector2, Vector3> V3V3 IConverter<Vector3, Vector3> V3V4 IConverter<Vector3, Vector4> V4V3 IConverter<Vector4, Vector3> V3B4 IConverter<Vector3, Byte4> B4V3 IConverter<Byte4, Vector3> V3U4 IConverter<Vector3, UShort4> U4V3 IConverter<UShort4, Vector3> V3H2 IConverter<Vector3, Half2> H2V3 IConverter<Half2, Vector3> V3H3 IConverter<Vector3, Half3> H3V3 IConverter<Half3, Vector3> V3H4 IConverter<Vector3, Half4> H4V3 IConverter<Half4, Vector3> V3COLOR IConverter<Vector3, Color> COLORV3 IConverter<Color, Vector3> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Name public static string Name { get; } Property Value string"
  },
  "api/Stride.Graphics.Semantics.PositionSemantic.html": {
    "href": "api/Stride.Graphics.Semantics.PositionSemantic.html",
    "title": "Struct PositionSemantic | Stride API",
    "summary": "Struct PositionSemantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public struct PositionSemantic : IFloat3Semantic, ISemantic<Vector3>, ISemantic, V3V2, IConverter<Vector3, Vector2>, V2V3, IConverter<Vector2, Vector3>, V3V3, IConverter<Vector3, Vector3>, V3V4, IConverter<Vector3, Vector4>, V4V3, IConverter<Vector4, Vector3>, V3B4, IConverter<Vector3, Byte4>, B4V3, IConverter<Byte4, Vector3>, V3U4, IConverter<Vector3, UShort4>, U4V3, IConverter<UShort4, Vector3>, V3H2, IConverter<Vector3, Half2>, H2V3, IConverter<Half2, Vector3>, V3H3, IConverter<Vector3, Half3>, H3V3, IConverter<Half3, Vector3>, V3H4, IConverter<Vector3, Half4>, H4V3, IConverter<Half4, Vector3>, V3COLOR, IConverter<Vector3, Color>, COLORV3, IConverter<Color, Vector3> Implements IFloat3Semantic ISemantic<Vector3> ISemantic V3V2 IConverter<Vector3, Vector2> V2V3 IConverter<Vector2, Vector3> V3V3 IConverter<Vector3, Vector3> V3V4 IConverter<Vector3, Vector4> V4V3 IConverter<Vector4, Vector3> V3B4 IConverter<Vector3, Byte4> B4V3 IConverter<Byte4, Vector3> V3U4 IConverter<Vector3, UShort4> U4V3 IConverter<UShort4, Vector3> V3H2 IConverter<Vector3, Half2> H2V3 IConverter<Half2, Vector3> V3H3 IConverter<Vector3, Half3> H3V3 IConverter<Half3, Vector3> V3H4 IConverter<Vector3, Half4> H4V3 IConverter<Half4, Vector3> V3COLOR IConverter<Vector3, Color> COLORV3 IConverter<Color, Vector3> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Name public static string Name { get; } Property Value string"
  },
  "api/Stride.Graphics.Semantics.Relaxed-1.html": {
    "href": "api/Stride.Graphics.Semantics.Relaxed-1.html",
    "title": "Struct Relaxed<T> | Stride API",
    "summary": "Struct Relaxed<T> Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll A semantic extension to allow users to provide non default destination datatypes public struct Relaxed<T> : IFloat4Semantic, ISemantic<Vector4>, V4V4, IConverter<Vector4, Vector4>, IFloat3Semantic, ISemantic<Vector3>, V3V3, IConverter<Vector3, Vector3>, V3V4, IConverter<Vector3, Vector4>, V4V3, IConverter<Vector4, Vector3>, IFloat2Semantic, ISemantic<Vector2>, V2V2, IConverter<Vector2, Vector2>, V2V3, IConverter<Vector2, Vector3>, V3V2, IConverter<Vector3, Vector2>, V2V4, IConverter<Vector2, Vector4>, V4V2, IConverter<Vector4, Vector2>, IHalf4Semantic, ISemantic<Half4>, H4V2, IConverter<Half4, Vector2>, V2H4, IConverter<Vector2, Half4>, H4V3, IConverter<Half4, Vector3>, V3H4, IConverter<Vector3, Half4>, H4V4, IConverter<Half4, Vector4>, V4H4, IConverter<Vector4, Half4>, H4H4, IConverter<Half4, Half4>, IHalf3Semantic, ISemantic<Half3>, H3V2, IConverter<Half3, Vector2>, V2H3, IConverter<Vector2, Half3>, H3V3, IConverter<Half3, Vector3>, V3H3, IConverter<Vector3, Half3>, H3V4, IConverter<Half3, Vector4>, V4H3, IConverter<Vector4, Half3>, H3H3, IConverter<Half3, Half3>, H3H4, IConverter<Half3, Half4>, H4H3, IConverter<Half4, Half3>, IHalf2Semantic, ISemantic<Half2>, H2V2, IConverter<Half2, Vector2>, V2H2, IConverter<Vector2, Half2>, H2V3, IConverter<Half2, Vector3>, V3H2, IConverter<Vector3, Half2>, H2V4, IConverter<Half2, Vector4>, V4H2, IConverter<Vector4, Half2>, H2H2, IConverter<Half2, Half2>, H2H3, IConverter<Half2, Half3>, H3H2, IConverter<Half3, Half2>, H2H4, IConverter<Half2, Half4>, H4H2, IConverter<Half4, Half2>, IUShort4Semantic, ISemantic<UShort4>, U4V2, IConverter<UShort4, Vector2>, V2U4, IConverter<Vector2, UShort4>, U4V3, IConverter<UShort4, Vector3>, V3U4, IConverter<Vector3, UShort4>, U4V4, IConverter<UShort4, Vector4>, V4U4, IConverter<Vector4, UShort4>, U4U4, IConverter<UShort4, UShort4>, U4H2, IConverter<UShort4, Half2>, H2U4, IConverter<Half2, UShort4>, U4H3, IConverter<UShort4, Half3>, H3U4, IConverter<Half3, UShort4>, U4H4, IConverter<UShort4, Half4>, H4U4, IConverter<Half4, UShort4>, IByte4Semantic, ISemantic<Byte4>, B4V2, IConverter<Byte4, Vector2>, V2B4, IConverter<Vector2, Byte4>, B4V3, IConverter<Byte4, Vector3>, V3B4, IConverter<Vector3, Byte4>, B4V4, IConverter<Byte4, Vector4>, V4B4, IConverter<Vector4, Byte4>, B4B4, IConverter<Byte4, Byte4>, B4U4, IConverter<Byte4, UShort4>, U4B4, IConverter<UShort4, Byte4>, B4H2, IConverter<Byte4, Half2>, H2B4, IConverter<Half2, Byte4>, B4H3, IConverter<Byte4, Half3>, H3B4, IConverter<Half3, Byte4>, B4H4, IConverter<Byte4, Half4>, H4B4, IConverter<Half4, Byte4>, IColorSemantic, ISemantic<Color>, ISemantic, COLORV2, IConverter<Color, Vector2>, V2COLOR, IConverter<Vector2, Color>, COLORV3, IConverter<Color, Vector3>, V3COLOR, IConverter<Vector3, Color>, COLORV4, IConverter<Color, Vector4>, V4COLOR, IConverter<Vector4, Color>, COLORB4, IConverter<Color, Byte4>, B4COLOR, IConverter<Byte4, Color>, COLORU4, IConverter<Color, UShort4>, U4COLOR, IConverter<UShort4, Color>, COLORH2, IConverter<Color, Half2>, H2COLOR, IConverter<Half2, Color>, COLORH3, IConverter<Color, Half3>, H3COLOR, IConverter<Half3, Color>, COLORH4, IConverter<Color, Half4>, H4COLOR, IConverter<Half4, Color>, COLORCOLOR, IConverter<Color, Color> where T : ISemantic Type Parameters T The actual semantic used, for example PositionSemantic Implements IFloat4Semantic ISemantic<Vector4> V4V4 IConverter<Vector4, Vector4> IFloat3Semantic ISemantic<Vector3> V3V3 IConverter<Vector3, Vector3> V3V4 IConverter<Vector3, Vector4> V4V3 IConverter<Vector4, Vector3> IFloat2Semantic ISemantic<Vector2> V2V2 IConverter<Vector2, Vector2> V2V3 IConverter<Vector2, Vector3> V3V2 IConverter<Vector3, Vector2> V2V4 IConverter<Vector2, Vector4> V4V2 IConverter<Vector4, Vector2> IHalf4Semantic ISemantic<Half4> H4V2 IConverter<Half4, Vector2> V2H4 IConverter<Vector2, Half4> H4V3 IConverter<Half4, Vector3> V3H4 IConverter<Vector3, Half4> H4V4 IConverter<Half4, Vector4> V4H4 IConverter<Vector4, Half4> H4H4 IConverter<Half4, Half4> IHalf3Semantic ISemantic<Half3> H3V2 IConverter<Half3, Vector2> V2H3 IConverter<Vector2, Half3> H3V3 IConverter<Half3, Vector3> V3H3 IConverter<Vector3, Half3> H3V4 IConverter<Half3, Vector4> V4H3 IConverter<Vector4, Half3> H3H3 IConverter<Half3, Half3> H3H4 IConverter<Half3, Half4> H4H3 IConverter<Half4, Half3> IHalf2Semantic ISemantic<Half2> H2V2 IConverter<Half2, Vector2> V2H2 IConverter<Vector2, Half2> H2V3 IConverter<Half2, Vector3> V3H2 IConverter<Vector3, Half2> H2V4 IConverter<Half2, Vector4> V4H2 IConverter<Vector4, Half2> H2H2 IConverter<Half2, Half2> H2H3 IConverter<Half2, Half3> H3H2 IConverter<Half3, Half2> H2H4 IConverter<Half2, Half4> H4H2 IConverter<Half4, Half2> IUShort4Semantic ISemantic<UShort4> U4V2 IConverter<UShort4, Vector2> V2U4 IConverter<Vector2, UShort4> U4V3 IConverter<UShort4, Vector3> V3U4 IConverter<Vector3, UShort4> U4V4 IConverter<UShort4, Vector4> V4U4 IConverter<Vector4, UShort4> U4U4 IConverter<UShort4, UShort4> U4H2 IConverter<UShort4, Half2> H2U4 IConverter<Half2, UShort4> U4H3 IConverter<UShort4, Half3> H3U4 IConverter<Half3, UShort4> U4H4 IConverter<UShort4, Half4> H4U4 IConverter<Half4, UShort4> IByte4Semantic ISemantic<Byte4> B4V2 IConverter<Byte4, Vector2> V2B4 IConverter<Vector2, Byte4> B4V3 IConverter<Byte4, Vector3> V3B4 IConverter<Vector3, Byte4> B4V4 IConverter<Byte4, Vector4> V4B4 IConverter<Vector4, Byte4> B4B4 IConverter<Byte4, Byte4> B4U4 IConverter<Byte4, UShort4> U4B4 IConverter<UShort4, Byte4> B4H2 IConverter<Byte4, Half2> H2B4 IConverter<Half2, Byte4> B4H3 IConverter<Byte4, Half3> H3B4 IConverter<Half3, Byte4> B4H4 IConverter<Byte4, Half4> H4B4 IConverter<Half4, Byte4> IColorSemantic ISemantic<Color> ISemantic COLORV2 IConverter<Color, Vector2> V2COLOR IConverter<Vector2, Color> COLORV3 IConverter<Color, Vector3> V3COLOR IConverter<Vector3, Color> COLORV4 IConverter<Color, Vector4> V4COLOR IConverter<Vector4, Color> COLORB4 IConverter<Color, Byte4> B4COLOR IConverter<Byte4, Color> COLORU4 IConverter<Color, UShort4> U4COLOR IConverter<UShort4, Color> COLORH2 IConverter<Color, Half2> H2COLOR IConverter<Half2, Color> COLORH3 IConverter<Color, Half3> H3COLOR IConverter<Half3, Color> COLORH4 IConverter<Color, Half4> H4COLOR IConverter<Half4, Color> COLORCOLOR IConverter<Color, Color> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Examples Reading positions of a mesh into a Half3 array var positions = new Half3[count]; helper.Read<Relaxed<PositionSemantic>, Half3>(positions); Properties Name public static string Name { get; } Property Value string"
  },
  "api/Stride.Graphics.Semantics.TangentSemantic.html": {
    "href": "api/Stride.Graphics.Semantics.TangentSemantic.html",
    "title": "Struct TangentSemantic | Stride API",
    "summary": "Struct TangentSemantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public struct TangentSemantic : IFloat4Semantic, ISemantic<Vector4>, ISemantic, V4V2, IConverter<Vector4, Vector2>, V2V4, IConverter<Vector2, Vector4>, V4V3, IConverter<Vector4, Vector3>, V3V4, IConverter<Vector3, Vector4>, V4V4, IConverter<Vector4, Vector4>, V4B4, IConverter<Vector4, Byte4>, B4V4, IConverter<Byte4, Vector4>, V4U4, IConverter<Vector4, UShort4>, U4V4, IConverter<UShort4, Vector4>, V4H2, IConverter<Vector4, Half2>, H2V4, IConverter<Half2, Vector4>, V4H3, IConverter<Vector4, Half3>, H3V4, IConverter<Half3, Vector4>, V4H4, IConverter<Vector4, Half4>, H4V4, IConverter<Half4, Vector4>, V4COLOR, IConverter<Vector4, Color>, COLORV4, IConverter<Color, Vector4> Implements IFloat4Semantic ISemantic<Vector4> ISemantic V4V2 IConverter<Vector4, Vector2> V2V4 IConverter<Vector2, Vector4> V4V3 IConverter<Vector4, Vector3> V3V4 IConverter<Vector3, Vector4> V4V4 IConverter<Vector4, Vector4> V4B4 IConverter<Vector4, Byte4> B4V4 IConverter<Byte4, Vector4> V4U4 IConverter<Vector4, UShort4> U4V4 IConverter<UShort4, Vector4> V4H2 IConverter<Vector4, Half2> H2V4 IConverter<Half2, Vector4> V4H3 IConverter<Vector4, Half3> H3V4 IConverter<Half3, Vector4> V4H4 IConverter<Vector4, Half4> H4V4 IConverter<Half4, Vector4> V4COLOR IConverter<Vector4, Color> COLORV4 IConverter<Color, Vector4> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Name public static string Name { get; } Property Value string"
  },
  "api/Stride.Graphics.Semantics.TextureCoordinateSemantic.html": {
    "href": "api/Stride.Graphics.Semantics.TextureCoordinateSemantic.html",
    "title": "Struct TextureCoordinateSemantic | Stride API",
    "summary": "Struct TextureCoordinateSemantic Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public struct TextureCoordinateSemantic : IFloat2Semantic, ISemantic<Vector2>, ISemantic, V2V2, IConverter<Vector2, Vector2>, V2V3, IConverter<Vector2, Vector3>, V3V2, IConverter<Vector3, Vector2>, V2V4, IConverter<Vector2, Vector4>, V4V2, IConverter<Vector4, Vector2>, V2B4, IConverter<Vector2, Byte4>, B4V2, IConverter<Byte4, Vector2>, V2U4, IConverter<Vector2, UShort4>, U4V2, IConverter<UShort4, Vector2>, V2H2, IConverter<Vector2, Half2>, H2V2, IConverter<Half2, Vector2>, V2H3, IConverter<Vector2, Half3>, H3V2, IConverter<Half3, Vector2>, V2H4, IConverter<Vector2, Half4>, H4V2, IConverter<Half4, Vector2>, V2COLOR, IConverter<Vector2, Color>, COLORV2, IConverter<Color, Vector2> Implements IFloat2Semantic ISemantic<Vector2> ISemantic V2V2 IConverter<Vector2, Vector2> V2V3 IConverter<Vector2, Vector3> V3V2 IConverter<Vector3, Vector2> V2V4 IConverter<Vector2, Vector4> V4V2 IConverter<Vector4, Vector2> V2B4 IConverter<Vector2, Byte4> B4V2 IConverter<Byte4, Vector2> V2U4 IConverter<Vector2, UShort4> U4V2 IConverter<UShort4, Vector2> V2H2 IConverter<Vector2, Half2> H2V2 IConverter<Half2, Vector2> V2H3 IConverter<Vector2, Half3> H3V2 IConverter<Half3, Vector2> V2H4 IConverter<Vector2, Half4> H4V2 IConverter<Half4, Vector2> V2COLOR IConverter<Vector2, Color> COLORV2 IConverter<Color, Vector2> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Name public static string Name { get; } Property Value string"
  },
  "api/Stride.Graphics.Semantics.U4B4.html": {
    "href": "api/Stride.Graphics.Semantics.U4B4.html",
    "title": "Interface U4B4 | Stride API",
    "summary": "Interface U4B4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface U4B4 : IConverter<UShort4, Byte4> Inherited Members IConverter<UShort4, Byte4>.Convert(in UShort4, out Byte4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.U4COLOR.html": {
    "href": "api/Stride.Graphics.Semantics.U4COLOR.html",
    "title": "Interface U4COLOR | Stride API",
    "summary": "Interface U4COLOR Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface U4COLOR : IConverter<UShort4, Color> Inherited Members IConverter<UShort4, Color>.Convert(in UShort4, out Color) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.U4H2.html": {
    "href": "api/Stride.Graphics.Semantics.U4H2.html",
    "title": "Interface U4H2 | Stride API",
    "summary": "Interface U4H2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface U4H2 : IConverter<UShort4, Half2> Inherited Members IConverter<UShort4, Half2>.Convert(in UShort4, out Half2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.U4H3.html": {
    "href": "api/Stride.Graphics.Semantics.U4H3.html",
    "title": "Interface U4H3 | Stride API",
    "summary": "Interface U4H3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface U4H3 : IConverter<UShort4, Half3> Inherited Members IConverter<UShort4, Half3>.Convert(in UShort4, out Half3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.U4H4.html": {
    "href": "api/Stride.Graphics.Semantics.U4H4.html",
    "title": "Interface U4H4 | Stride API",
    "summary": "Interface U4H4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface U4H4 : IConverter<UShort4, Half4> Inherited Members IConverter<UShort4, Half4>.Convert(in UShort4, out Half4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.U4U4.html": {
    "href": "api/Stride.Graphics.Semantics.U4U4.html",
    "title": "Interface U4U4 | Stride API",
    "summary": "Interface U4U4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface U4U4 : IConverter<UShort4, UShort4> Inherited Members IConverter<UShort4, UShort4>.Convert(in UShort4, out UShort4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.U4V2.html": {
    "href": "api/Stride.Graphics.Semantics.U4V2.html",
    "title": "Interface U4V2 | Stride API",
    "summary": "Interface U4V2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface U4V2 : IConverter<UShort4, Vector2> Inherited Members IConverter<UShort4, Vector2>.Convert(in UShort4, out Vector2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.U4V3.html": {
    "href": "api/Stride.Graphics.Semantics.U4V3.html",
    "title": "Interface U4V3 | Stride API",
    "summary": "Interface U4V3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface U4V3 : IConverter<UShort4, Vector3> Inherited Members IConverter<UShort4, Vector3>.Convert(in UShort4, out Vector3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.U4V4.html": {
    "href": "api/Stride.Graphics.Semantics.U4V4.html",
    "title": "Interface U4V4 | Stride API",
    "summary": "Interface U4V4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface U4V4 : IConverter<UShort4, Vector4> Inherited Members IConverter<UShort4, Vector4>.Convert(in UShort4, out Vector4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V2B4.html": {
    "href": "api/Stride.Graphics.Semantics.V2B4.html",
    "title": "Interface V2B4 | Stride API",
    "summary": "Interface V2B4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V2B4 : IConverter<Vector2, Byte4> Inherited Members IConverter<Vector2, Byte4>.Convert(in Vector2, out Byte4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V2COLOR.html": {
    "href": "api/Stride.Graphics.Semantics.V2COLOR.html",
    "title": "Interface V2COLOR | Stride API",
    "summary": "Interface V2COLOR Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V2COLOR : IConverter<Vector2, Color> Inherited Members IConverter<Vector2, Color>.Convert(in Vector2, out Color) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V2H2.html": {
    "href": "api/Stride.Graphics.Semantics.V2H2.html",
    "title": "Interface V2H2 | Stride API",
    "summary": "Interface V2H2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V2H2 : IConverter<Vector2, Half2> Inherited Members IConverter<Vector2, Half2>.Convert(in Vector2, out Half2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V2H3.html": {
    "href": "api/Stride.Graphics.Semantics.V2H3.html",
    "title": "Interface V2H3 | Stride API",
    "summary": "Interface V2H3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V2H3 : IConverter<Vector2, Half3> Inherited Members IConverter<Vector2, Half3>.Convert(in Vector2, out Half3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V2H4.html": {
    "href": "api/Stride.Graphics.Semantics.V2H4.html",
    "title": "Interface V2H4 | Stride API",
    "summary": "Interface V2H4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V2H4 : IConverter<Vector2, Half4> Inherited Members IConverter<Vector2, Half4>.Convert(in Vector2, out Half4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V2U4.html": {
    "href": "api/Stride.Graphics.Semantics.V2U4.html",
    "title": "Interface V2U4 | Stride API",
    "summary": "Interface V2U4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V2U4 : IConverter<Vector2, UShort4> Inherited Members IConverter<Vector2, UShort4>.Convert(in Vector2, out UShort4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V2V2.html": {
    "href": "api/Stride.Graphics.Semantics.V2V2.html",
    "title": "Interface V2V2 | Stride API",
    "summary": "Interface V2V2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V2V2 : IConverter<Vector2, Vector2> Inherited Members IConverter<Vector2, Vector2>.Convert(in Vector2, out Vector2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V2V3.html": {
    "href": "api/Stride.Graphics.Semantics.V2V3.html",
    "title": "Interface V2V3 | Stride API",
    "summary": "Interface V2V3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V2V3 : IConverter<Vector2, Vector3> Inherited Members IConverter<Vector2, Vector3>.Convert(in Vector2, out Vector3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V2V4.html": {
    "href": "api/Stride.Graphics.Semantics.V2V4.html",
    "title": "Interface V2V4 | Stride API",
    "summary": "Interface V2V4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V2V4 : IConverter<Vector2, Vector4> Inherited Members IConverter<Vector2, Vector4>.Convert(in Vector2, out Vector4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V3B4.html": {
    "href": "api/Stride.Graphics.Semantics.V3B4.html",
    "title": "Interface V3B4 | Stride API",
    "summary": "Interface V3B4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V3B4 : IConverter<Vector3, Byte4> Inherited Members IConverter<Vector3, Byte4>.Convert(in Vector3, out Byte4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V3COLOR.html": {
    "href": "api/Stride.Graphics.Semantics.V3COLOR.html",
    "title": "Interface V3COLOR | Stride API",
    "summary": "Interface V3COLOR Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V3COLOR : IConverter<Vector3, Color> Inherited Members IConverter<Vector3, Color>.Convert(in Vector3, out Color) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V3H2.html": {
    "href": "api/Stride.Graphics.Semantics.V3H2.html",
    "title": "Interface V3H2 | Stride API",
    "summary": "Interface V3H2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V3H2 : IConverter<Vector3, Half2> Inherited Members IConverter<Vector3, Half2>.Convert(in Vector3, out Half2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V3H3.html": {
    "href": "api/Stride.Graphics.Semantics.V3H3.html",
    "title": "Interface V3H3 | Stride API",
    "summary": "Interface V3H3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V3H3 : IConverter<Vector3, Half3> Inherited Members IConverter<Vector3, Half3>.Convert(in Vector3, out Half3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V3H4.html": {
    "href": "api/Stride.Graphics.Semantics.V3H4.html",
    "title": "Interface V3H4 | Stride API",
    "summary": "Interface V3H4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V3H4 : IConverter<Vector3, Half4> Inherited Members IConverter<Vector3, Half4>.Convert(in Vector3, out Half4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V3U4.html": {
    "href": "api/Stride.Graphics.Semantics.V3U4.html",
    "title": "Interface V3U4 | Stride API",
    "summary": "Interface V3U4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V3U4 : IConverter<Vector3, UShort4> Inherited Members IConverter<Vector3, UShort4>.Convert(in Vector3, out UShort4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V3V2.html": {
    "href": "api/Stride.Graphics.Semantics.V3V2.html",
    "title": "Interface V3V2 | Stride API",
    "summary": "Interface V3V2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V3V2 : IConverter<Vector3, Vector2> Inherited Members IConverter<Vector3, Vector2>.Convert(in Vector3, out Vector2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V3V3.html": {
    "href": "api/Stride.Graphics.Semantics.V3V3.html",
    "title": "Interface V3V3 | Stride API",
    "summary": "Interface V3V3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V3V3 : IConverter<Vector3, Vector3> Inherited Members IConverter<Vector3, Vector3>.Convert(in Vector3, out Vector3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V3V4.html": {
    "href": "api/Stride.Graphics.Semantics.V3V4.html",
    "title": "Interface V3V4 | Stride API",
    "summary": "Interface V3V4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V3V4 : IConverter<Vector3, Vector4> Inherited Members IConverter<Vector3, Vector4>.Convert(in Vector3, out Vector4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V4B4.html": {
    "href": "api/Stride.Graphics.Semantics.V4B4.html",
    "title": "Interface V4B4 | Stride API",
    "summary": "Interface V4B4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V4B4 : IConverter<Vector4, Byte4> Inherited Members IConverter<Vector4, Byte4>.Convert(in Vector4, out Byte4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V4COLOR.html": {
    "href": "api/Stride.Graphics.Semantics.V4COLOR.html",
    "title": "Interface V4COLOR | Stride API",
    "summary": "Interface V4COLOR Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V4COLOR : IConverter<Vector4, Color> Inherited Members IConverter<Vector4, Color>.Convert(in Vector4, out Color) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V4H2.html": {
    "href": "api/Stride.Graphics.Semantics.V4H2.html",
    "title": "Interface V4H2 | Stride API",
    "summary": "Interface V4H2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V4H2 : IConverter<Vector4, Half2> Inherited Members IConverter<Vector4, Half2>.Convert(in Vector4, out Half2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V4H3.html": {
    "href": "api/Stride.Graphics.Semantics.V4H3.html",
    "title": "Interface V4H3 | Stride API",
    "summary": "Interface V4H3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V4H3 : IConverter<Vector4, Half3> Inherited Members IConverter<Vector4, Half3>.Convert(in Vector4, out Half3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V4H4.html": {
    "href": "api/Stride.Graphics.Semantics.V4H4.html",
    "title": "Interface V4H4 | Stride API",
    "summary": "Interface V4H4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V4H4 : IConverter<Vector4, Half4> Inherited Members IConverter<Vector4, Half4>.Convert(in Vector4, out Half4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V4U4.html": {
    "href": "api/Stride.Graphics.Semantics.V4U4.html",
    "title": "Interface V4U4 | Stride API",
    "summary": "Interface V4U4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V4U4 : IConverter<Vector4, UShort4> Inherited Members IConverter<Vector4, UShort4>.Convert(in Vector4, out UShort4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V4V2.html": {
    "href": "api/Stride.Graphics.Semantics.V4V2.html",
    "title": "Interface V4V2 | Stride API",
    "summary": "Interface V4V2 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V4V2 : IConverter<Vector4, Vector2> Inherited Members IConverter<Vector4, Vector2>.Convert(in Vector4, out Vector2) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V4V3.html": {
    "href": "api/Stride.Graphics.Semantics.V4V3.html",
    "title": "Interface V4V3 | Stride API",
    "summary": "Interface V4V3 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V4V3 : IConverter<Vector4, Vector3> Inherited Members IConverter<Vector4, Vector3>.Convert(in Vector4, out Vector3) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.V4V4.html": {
    "href": "api/Stride.Graphics.Semantics.V4V4.html",
    "title": "Interface V4V4 | Stride API",
    "summary": "Interface V4V4 Namespace Stride.Graphics.Semantics Assembly Stride.Graphics.dll public interface V4V4 : IConverter<Vector4, Vector4> Inherited Members IConverter<Vector4, Vector4>.Convert(in Vector4, out Vector4) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Graphics.Semantics.html": {
    "href": "api/Stride.Graphics.Semantics.html",
    "title": "Namespace Stride.Graphics.Semantics | Stride API",
    "summary": "Namespace Stride.Graphics.Semantics Structs BiTangentSemantic BlendIndicesSemantic BlendWeightSemantic ColorSemantic NormalSemantic PositionSemantic Relaxed<T> A semantic extension to allow users to provide non default destination datatypes TangentSemantic TextureCoordinateSemantic Interfaces B4B4 B4COLOR B4H2 B4H3 B4H4 B4U4 B4V2 B4V3 B4V4 COLORB4 COLORCOLOR COLORH2 COLORH3 COLORH4 COLORU4 COLORV2 COLORV3 COLORV4 H2B4 H2COLOR H2H2 H2H3 H2H4 H2U4 H2V2 H2V3 H2V4 H3B4 H3COLOR H3H2 H3H3 H3H4 H3U4 H3V2 H3V3 H3V4 H4B4 H4COLOR H4H2 H4H3 H4H4 H4U4 H4V2 H4V3 H4V4 IByte4Semantic IColorSemantic IConverter<TSource, TDest> IFloat2Semantic IFloat3Semantic IFloat4Semantic IHalf2Semantic IHalf3Semantic IHalf4Semantic ISemantic ISemantic<T> IUShort4Semantic U4B4 U4COLOR U4H2 U4H3 U4H4 U4U4 U4V2 U4V3 U4V4 V2B4 V2COLOR V2H2 V2H3 V2H4 V2U4 V2V2 V2V3 V2V4 V3B4 V3COLOR V3H2 V3H3 V3H4 V3U4 V3V2 V3V3 V3V4 V4B4 V4COLOR V4H2 V4H3 V4H4 V4U4 V4V2 V4V3 V4V4"
  },
  "api/Stride.Graphics.Sprite.html": {
    "href": "api/Stride.Graphics.Sprite.html",
    "title": "Class Sprite | Stride API",
    "summary": "Class Sprite Namespace Stride.Graphics Assembly Stride.Graphics.dll A sprite. [DataContract] [ContentSerializer(typeof(DataContentSerializer<Sprite>))] [DataSerializerGlobal(typeof(ReferenceSerializer<Sprite>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public class Sprite Inheritance object Sprite Extension Methods SpriteExtensions.Draw(Sprite, SpriteBatch, Vector2, Color, Vector2, float, float, SpriteEffects) SpriteExtensions.Draw(Sprite, SpriteBatch, Vector2, float, float, SpriteEffects) SpriteExtensions.Draw3D(Sprite, Sprite3DBatch, ref Matrix, ref Color4) UnsafeUtilities.As<T>(object?) Constructors Sprite() Create an instance of Sprite with a unique random name. public Sprite() Sprite(Texture) Create an instance of Sprite from the provided Texture. A unique Id is set as name and the Region is initialized to the size of the whole texture. public Sprite(Texture texture) Parameters texture Texture The texture to use as texture Sprite(string) Creates an empty Sprite having the provided name. public Sprite(string fragmentName) Parameters fragmentName string Name of the fragment Sprite(string, Texture) Creates a Sprite having the provided texture and name. The region size is initialized with the whole size of the texture. public Sprite(string fragmentName, Texture texture) Parameters fragmentName string The name of the sprite texture Texture The texture to use as texture Fields DefaultPixelsPerUnit public const int DefaultPixelsPerUnit = 100 Field Value int Properties Borders Gets or sets size of the unstretchable borders of source sprite in pixels. public Vector4 Borders { get; set; } Property Value Vector4 Remarks Borders size are ordered as follows X->Left, Y->Top, Z->Right, W->Bottom. Center The position of the center of the image in pixels. public Vector2 Center { get; set; } Property Value Vector2 HasBorders Gets the value indicating if the image has unstretchable borders. public bool HasBorders { get; } Property Value bool IsTransparent Gets or sets the value indicating if the fragment contains transparent regions. public bool IsTransparent { get; set; } Property Value bool Name Gets or sets the name of the image fragment. public string Name { get; set; } Property Value string Orientation Gets or sets the rotation to apply to the texture region when rendering the Sprite public virtual ImageOrientation Orientation { get; set; } Property Value ImageOrientation PixelsPerUnit Gets or sets the pixels per scene unit of the sprite. public Vector2 PixelsPerUnit { get; set; } Property Value Vector2 Remarks The value is clamped to a strictly positive value. Region The rectangle specifying the region of the texture to use as fragment. public RectangleF Region { get; set; } Property Value RectangleF Size Gets the size of the sprite in scene units. Note that the orientation of the image is taken into account in this calculation. public Vector2 Size { get; } Property Value Vector2 SizeInPixels Gets the size of the sprite in pixels. Note that the orientation of the image is taken into account in this calculation. public Vector2 SizeInPixels { get; } Property Value Vector2 Texture The texture in which the image is contained public Texture Texture { get; set; } Property Value Texture Methods Clone() Clone the current sprite. public Sprite Clone() Returns Sprite A new instance of the current sprite. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Graphics.Sprite3DBatch.Sprite3DDrawInfo.html": {
    "href": "api/Stride.Graphics.Sprite3DBatch.Sprite3DDrawInfo.html",
    "title": "Struct Sprite3DBatch.Sprite3DDrawInfo | Stride API",
    "summary": "Struct Sprite3DBatch.Sprite3DDrawInfo Namespace Stride.Graphics Assembly Stride.Graphics.dll public struct Sprite3DBatch.Sprite3DDrawInfo Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ColorAdd public Color4 ColorAdd Field Value Color4 ColorScale public Color4 ColorScale Field Value Color4 LeftTopCornerWorld public Vector4 LeftTopCornerWorld Field Value Vector4 Source public RectangleF Source Field Value RectangleF Swizzle public SwizzleMode Swizzle Field Value SwizzleMode UnitXWorld public Vector4 UnitXWorld Field Value Vector4 UnitYWorld public Vector4 UnitYWorld Field Value Vector4"
  },
  "api/Stride.Graphics.Sprite3DBatch.html": {
    "href": "api/Stride.Graphics.Sprite3DBatch.html",
    "title": "Class Sprite3DBatch | Stride API",
    "summary": "Class Sprite3DBatch Namespace Stride.Graphics Assembly Stride.Graphics.dll A batcher for sprite in the 3D world. public class Sprite3DBatch : BatchBase<Sprite3DBatch.Sprite3DDrawInfo>, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase BatchBase<Sprite3DBatch.Sprite3DDrawInfo> Sprite3DBatch Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.ResourceContextPool BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.ResourceContext BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.mutablePipeline BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.graphicsDevice BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.blendState BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.rasterizerState BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.samplerState BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.depthStencilState BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.stencilReferenceValue BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.sortMode BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.Effect BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.GraphicsContext BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.DefaultEffect BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.DefaultEffectSRgb BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.TextureComparer BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.BackToFrontComparer BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.FrontToBackComparer BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.Destroy() BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.Parameters BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.Begin(GraphicsContext, EffectInstance, SpriteSortMode, BlendStateDescription?, SamplerState, DepthStencilStateDescription?, RasterizerStateDescription?, int) BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.CheckBeginHasBeenCalled(string) BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.CheckEndHasBeenCalled(string) BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.End() BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.Draw(Texture, in BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.ElementInfo) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors Sprite3DBatch(GraphicsDevice, int, int) Creates a new instance of Sprite3DBatch. public Sprite3DBatch(GraphicsDevice device, int bufferElementCount = 1024, int batchCapacity = 64) Parameters device GraphicsDevice bufferElementCount int The maximum number element that can be batched in one time. batchCapacity int The batch capacity default to 64. Methods Begin(GraphicsContext, Matrix, SpriteSortMode, BlendStateDescription?, SamplerState, DepthStencilStateDescription?, RasterizerStateDescription?, EffectInstance, int) Begins a 3D sprite batch rendering using the specified sorting mode and blend state, sampler, depth stencil, rasterizer state objects, plus a custom effect and a view-projection matrix. Passing null for any of the state objects selects the default default state objects (BlendState.AlphaBlend, DepthStencilState.Default, RasterizerState.CullCounterClockwise, SamplerState.LinearClamp). Passing a null effect selects the default SpriteBatch Class shader. public void Begin(GraphicsContext graphicsContext, Matrix viewProjection, SpriteSortMode sortMode = SpriteSortMode.Deferred, BlendStateDescription? blendState = null, SamplerState samplerState = null, DepthStencilStateDescription? depthStencilState = null, RasterizerStateDescription? rasterizerState = null, EffectInstance effect = null, int stencilValue = 0) Parameters graphicsContext GraphicsContext The graphics context to use. viewProjection Matrix The view-projection matrix to use for the batch session sortMode SpriteSortMode The sprite drawing order to use for the batch session blendState BlendStateDescription? The blending state to use for the batch session samplerState SamplerState The sampling state to use for the batch session depthStencilState DepthStencilStateDescription? The depth stencil state to use for the batch session rasterizerState RasterizerStateDescription? The rasterizer state to use for the batch session effect EffectInstance The effect to use for the batch session stencilValue int The value of the stencil buffer to take as reference for the batch session Draw(Texture, ref Matrix, ref RectangleF, ref Vector2, ref Color4, ImageOrientation, SwizzleMode, float?) Draw a 3D sprite (or add it to the draw list depending on the sortMode). public void Draw(Texture texture, ref Matrix worldMatrix, ref RectangleF sourceRectangle, ref Vector2 elementSize, ref Color4 color, ImageOrientation imageOrientation = ImageOrientation.AsIs, SwizzleMode swizzle = SwizzleMode.None, float? depth = null) Parameters texture Texture The texture to use during the draw worldMatrix Matrix The world matrix of the element sourceRectangle RectangleF The rectangle indicating the source region of the texture to use elementSize Vector2 The size of the sprite in the object space color Color4 The color to apply to the texture image. imageOrientation ImageOrientation The rotation to apply on the image uv swizzle SwizzleMode Swizzle mode indicating the swizzle use when sampling the texture in the shader depth float? The depth of the element. If null, it is calculated using world and view-projection matrix. PrepareForRendering() protected override void PrepareForRendering() UpdateBufferValuesFromElementInfo(ref ElementInfo, nint, nint, int) Update the mapped vertex and index buffer values using the provided element info. protected override void UpdateBufferValuesFromElementInfo(ref BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.ElementInfo elementInfo, nint vertexPointer, nint indexPointer, int vexterStartOffset) Parameters elementInfo BatchBase<Sprite3DBatch.Sprite3DDrawInfo>.ElementInfo The structure containing the information about the element to draw. vertexPointer nint The pointer to the vertex array buffer to update. indexPointer nint The pointer to the index array buffer to update. This value is null if the index buffer used is static. vexterStartOffset int The offset in the vertex buffer where the vertex of the element starts"
  },
  "api/Stride.Graphics.SpriteBatch.SpriteDrawInfo.html": {
    "href": "api/Stride.Graphics.SpriteBatch.SpriteDrawInfo.html",
    "title": "Struct SpriteBatch.SpriteDrawInfo | Stride API",
    "summary": "Struct SpriteBatch.SpriteDrawInfo Namespace Stride.Graphics Assembly Stride.Graphics.dll public struct SpriteBatch.SpriteDrawInfo Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ColorAdd public Color4 ColorAdd Field Value Color4 ColorScale public Color4 ColorScale Field Value Color4 Depth public float Depth Field Value float Destination public RectangleF Destination Field Value RectangleF Orientation public ImageOrientation Orientation Field Value ImageOrientation Origin public Vector2 Origin Field Value Vector2 Rotation public float Rotation Field Value float Source public RectangleF Source Field Value RectangleF SpriteEffects public SpriteEffects SpriteEffects Field Value SpriteEffects Swizzle public SwizzleMode Swizzle Field Value SwizzleMode TextureSize public Vector2 TextureSize Field Value Vector2"
  },
  "api/Stride.Graphics.SpriteBatch.html": {
    "href": "api/Stride.Graphics.SpriteBatch.html",
    "title": "Class SpriteBatch | Stride API",
    "summary": "Class SpriteBatch Namespace Stride.Graphics Assembly Stride.Graphics.dll Renders a group of sprites. public class SpriteBatch : BatchBase<SpriteBatch.SpriteDrawInfo>, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase BatchBase<SpriteBatch.SpriteDrawInfo> SpriteBatch Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members BatchBase<SpriteBatch.SpriteDrawInfo>.ResourceContextPool BatchBase<SpriteBatch.SpriteDrawInfo>.ResourceContext BatchBase<SpriteBatch.SpriteDrawInfo>.mutablePipeline BatchBase<SpriteBatch.SpriteDrawInfo>.graphicsDevice BatchBase<SpriteBatch.SpriteDrawInfo>.blendState BatchBase<SpriteBatch.SpriteDrawInfo>.rasterizerState BatchBase<SpriteBatch.SpriteDrawInfo>.samplerState BatchBase<SpriteBatch.SpriteDrawInfo>.depthStencilState BatchBase<SpriteBatch.SpriteDrawInfo>.stencilReferenceValue BatchBase<SpriteBatch.SpriteDrawInfo>.sortMode BatchBase<SpriteBatch.SpriteDrawInfo>.Effect BatchBase<SpriteBatch.SpriteDrawInfo>.GraphicsContext BatchBase<SpriteBatch.SpriteDrawInfo>.DefaultEffect BatchBase<SpriteBatch.SpriteDrawInfo>.DefaultEffectSRgb BatchBase<SpriteBatch.SpriteDrawInfo>.TextureComparer BatchBase<SpriteBatch.SpriteDrawInfo>.BackToFrontComparer BatchBase<SpriteBatch.SpriteDrawInfo>.FrontToBackComparer BatchBase<SpriteBatch.SpriteDrawInfo>.Destroy() BatchBase<SpriteBatch.SpriteDrawInfo>.Parameters BatchBase<SpriteBatch.SpriteDrawInfo>.Begin(GraphicsContext, EffectInstance, SpriteSortMode, BlendStateDescription?, SamplerState, DepthStencilStateDescription?, RasterizerStateDescription?, int) BatchBase<SpriteBatch.SpriteDrawInfo>.CheckBeginHasBeenCalled(string) BatchBase<SpriteBatch.SpriteDrawInfo>.CheckEndHasBeenCalled(string) BatchBase<SpriteBatch.SpriteDrawInfo>.End() BatchBase<SpriteBatch.SpriteDrawInfo>.Draw(Texture, in BatchBase<SpriteBatch.SpriteDrawInfo>.ElementInfo) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors SpriteBatch(GraphicsDevice, int, int) Initializes a new instance of the SpriteBatch class. public SpriteBatch(GraphicsDevice graphicsDevice, int bufferElementCount = 1024, int batchCapacity = 64) Parameters graphicsDevice GraphicsDevice The graphics device. bufferElementCount int The maximum number element that can be batched in one time. batchCapacity int The batch capacity default to 64. Properties DefaultDepth Gets or sets the default depth value used by the SpriteBatch when the VirtualResolution is not set. public float DefaultDepth { get; set; } Property Value float Remarks More precisely, this value represents the length \"farPlane-nearPlane\" used by the default projection matrix. TextureSpriteFontEffect public EffectInstance TextureSpriteFontEffect { get; } Property Value EffectInstance VirtualResolution Gets or sets the virtual resolution used for this SpriteBatch public Vector3? VirtualResolution { get; set; } Property Value Vector3? Methods Begin(GraphicsContext, Matrix, Matrix, SpriteSortMode, BlendStateDescription?, SamplerState, DepthStencilStateDescription?, RasterizerStateDescription?, EffectInstance, int) Begins a sprite batch rendering using the specified sorting mode and blend state, sampler, depth stencil, rasterizer state objects, plus a custom effect and a 2D transformation matrix. Passing null for any of the state objects selects the default default state objects (BlendState.AlphaBlend, DepthStencilState.Default, RasterizerState.CullCounterClockwise, SamplerState.LinearClamp). Passing a null effect selects the default SpriteBatch Class shader. public void Begin(GraphicsContext graphicsContext, Matrix viewMatrix, Matrix projectionMatrix, SpriteSortMode sortMode = SpriteSortMode.Deferred, BlendStateDescription? blendState = null, SamplerState samplerState = null, DepthStencilStateDescription? depthStencilState = null, RasterizerStateDescription? rasterizerState = null, EffectInstance effect = null, int stencilValue = 0) Parameters graphicsContext GraphicsContext The graphics context to use. viewMatrix Matrix The view matrix to use for the batch session projectionMatrix Matrix The projection matrix to use for the batch session sortMode SpriteSortMode The sprite drawing order to use for the batch session blendState BlendStateDescription? The blending state to use for the batch session samplerState SamplerState The sampling state to use for the batch session depthStencilState DepthStencilStateDescription? The depth stencil state to use for the batch session rasterizerState RasterizerStateDescription? The rasterizer state to use for the batch session effect EffectInstance The effect to use for the batch session stencilValue int The value of the stencil buffer to take as reference for the batch session Begin(GraphicsContext, Matrix, SpriteSortMode, BlendStateDescription?, SamplerState, DepthStencilStateDescription?, RasterizerStateDescription?, EffectInstance, int) Begins a sprite batch rendering using the specified sorting mode and blend state, sampler, depth stencil, rasterizer state objects, plus a custom effect and a 2D transformation matrix. Passing null for any of the state objects selects the default default state objects (BlendState.AlphaBlend, DepthStencilState.Default, RasterizerState.CullCounterClockwise, SamplerState.LinearClamp). Passing a null effect selects the default SpriteBatch Class shader. public void Begin(GraphicsContext graphicsContext, Matrix viewMatrix, SpriteSortMode sortMode = SpriteSortMode.Deferred, BlendStateDescription? blendState = null, SamplerState samplerState = null, DepthStencilStateDescription? depthStencilState = null, RasterizerStateDescription? rasterizerState = null, EffectInstance effect = null, int stencilValue = 0) Parameters graphicsContext GraphicsContext The graphics context to use. viewMatrix Matrix The view matrix to use for the batch session sortMode SpriteSortMode The sprite drawing order to use for the batch session blendState BlendStateDescription? The blending state to use for the batch session samplerState SamplerState The sampling state to use for the batch session depthStencilState DepthStencilStateDescription? The depth stencil state to use for the batch session rasterizerState RasterizerStateDescription? The rasterizer state to use for the batch session effect EffectInstance The effect to use for the batch session stencilValue int The value of the stencil buffer to take as reference for the batch session Begin(GraphicsContext, SpriteSortMode, EffectInstance) Begins a sprite batch operation using deferred sort and default state objects (BlendState.AlphaBlend, SamplerState.LinearClamp, DepthStencilState.Default, RasterizerState.CullCounterClockwise). public void Begin(GraphicsContext graphicsContext, SpriteSortMode sortMode, EffectInstance effect) Parameters graphicsContext GraphicsContext The graphics context to use. sortMode SpriteSortMode The sprite drawing order to use for the batch session effect EffectInstance The effect to use for the batch session Begin(GraphicsContext, SpriteSortMode, BlendStateDescription?, SamplerState, DepthStencilStateDescription?, RasterizerStateDescription?, EffectInstance, int) Begins a sprite batch rendering using the specified sorting mode and blend state, sampler, depth stencil and rasterizer state objects, plus a custom effect. Passing null for any of the state objects selects the default default state objects (BlendState.AlphaBlend, DepthStencilState.Default, RasterizerState.CullCounterClockwise, SamplerState.LinearClamp). Passing a null effect selects the default SpriteBatch Class shader. public void Begin(GraphicsContext graphicsContext, SpriteSortMode sortMode = SpriteSortMode.Deferred, BlendStateDescription? blendState = null, SamplerState samplerState = null, DepthStencilStateDescription? depthStencilState = null, RasterizerStateDescription? rasterizerState = null, EffectInstance effect = null, int stencilValue = 0) Parameters graphicsContext GraphicsContext The graphics context to use. sortMode SpriteSortMode The sprite drawing order to use for the batch session blendState BlendStateDescription? The blending state to use for the batch session samplerState SamplerState The sampling state to use for the batch session depthStencilState DepthStencilStateDescription? The depth stencil state to use for the batch session rasterizerState RasterizerStateDescription? The rasterizer state to use for the batch session effect EffectInstance The effect to use for the batch session stencilValue int The value of the stencil buffer to take as reference for the batch session CalculateDefaultProjection(Vector3) Calculate the default projection matrix for the provided virtual resolution. public static Matrix CalculateDefaultProjection(Vector3 virtualResolution) Parameters virtualResolution Vector3 Returns Matrix The default projection matrix for the provided virtual resolution Remarks The sprite batch default projection is an orthogonal matrix such as (0,0) is the Top/Left corner of the screen and (VirtualResolution.X, VirtualResolution.Y) is the Bottom/Right corner of the screen. CalculateDefaultProjection(ref Vector3, out Matrix) Calculate the default projection matrix for the provided virtual resolution. public static void CalculateDefaultProjection(ref Vector3 virtualResolution, out Matrix projection) Parameters virtualResolution Vector3 projection Matrix Draw(Texture, RectangleF, Color4, Color4) Adds a sprite to a batch of sprites for rendering using the specified texture, destination rectangle, and color. public void Draw(Texture texture, RectangleF destinationRectangle, Color4 color, Color4 colorAdd = default) Parameters texture Texture A texture. destinationRectangle RectangleF A rectangle that specifies (in screen coordinates) the destination for drawing the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. colorAdd Color4 Remarks Before making any calls to Draw, you must call Begin. Once all calls to Draw are complete, call End. Draw(Texture, RectangleF, RectangleF?, Color4, float, Vector2, SpriteEffects, ImageOrientation, float, Color4, SwizzleMode) Adds a sprite to a batch of sprites for rendering using the specified texture, destination rectangle, source rectangle, color, rotation, origin, effects and layer. public void Draw(Texture texture, RectangleF destinationRectangle, RectangleF? sourceRectangle, Color4 color, float rotation, Vector2 origin, SpriteEffects effects = SpriteEffects.None, ImageOrientation orientation = ImageOrientation.AsIs, float layerDepth = 0, Color4 colorAdd = default, SwizzleMode swizzle = SwizzleMode.None) Parameters texture Texture A texture. destinationRectangle RectangleF A rectangle that specifies (in screen coordinates) the destination for drawing the sprite. If this rectangle is not the same size as the source rectangle, the sprite will be scaled to fit. sourceRectangle RectangleF? A rectangle that specifies (in texels) the source texels from a texture. Use null to draw the entire texture. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. rotation float Specifies the angle (in radians) to rotate the sprite about its center. origin Vector2 The sprite origin in the texture in pixels (dependent of image orientation). Default value is (0,0) which represents the upper-left corner. effects SpriteEffects Effects to apply. orientation ImageOrientation The source image orientation layerDepth float The depth of a layer. By default, 0 represents the front layer and 1 represents a back layer. Use SpriteSortMode if you want sprites to be sorted during drawing. colorAdd Color4 swizzle SwizzleMode Draw(Texture, Vector2) Adds a sprite to a batch of sprites for rendering using the specified texture, position and color. public void Draw(Texture texture, Vector2 position) Parameters texture Texture A texture. position Vector2 The location (in screen coordinates) to draw the sprite. Draw(Texture, Vector2, Color, Color4) Adds a sprite to a batch of sprites for rendering using the specified texture, position and color. public void Draw(Texture texture, Vector2 position, Color color, Color4 colorAdd = default) Parameters texture Texture A texture. position Vector2 The location (in screen coordinates) to draw the sprite. color Color The color to tint a sprite. Use Color.White for full color with no tinting. colorAdd Color4 Draw(Texture, Vector2, Color4, float, Vector2, Vector2, SpriteEffects, ImageOrientation, float) Adds a sprite to a batch of sprites for rendering using the specified texture, position, source rectangle, color, rotation, origin, scale, effects, and layer. public void Draw(Texture texture, Vector2 position, Color4 color, float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects = SpriteEffects.None, ImageOrientation orientation = ImageOrientation.AsIs, float layerDepth = 0) Parameters texture Texture A texture. position Vector2 The location (in screen coordinates) to draw the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. rotation float Specifies the angle (in radians) to rotate the sprite about its center. origin Vector2 The sprite origin in the texture in pixels (dependent of image orientation). Default value is (0,0) which represents the upper-left corner. scale Vector2 Scale factor. effects SpriteEffects Effects to apply. orientation ImageOrientation The source image orientation layerDepth float The depth of a layer. By default, 0 represents the front layer and 1 represents a back layer. Use SpriteSortMode if you want sprites to be sorted during drawing. Draw(Texture, Vector2, Color4, float, Vector2, float, SpriteEffects, ImageOrientation, float) Adds a sprite to a batch of sprites for rendering using the specified texture, position, source rectangle, color, rotation, origin, scale, effects, and layer. public void Draw(Texture texture, Vector2 position, Color4 color, float rotation, Vector2 origin, float scale = 1, SpriteEffects effects = SpriteEffects.None, ImageOrientation orientation = ImageOrientation.AsIs, float layerDepth = 0) Parameters texture Texture A texture. position Vector2 The location (in screen coordinates) to draw the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. rotation float Specifies the angle (in radians) to rotate the sprite about its center. origin Vector2 The sprite origin in the texture in pixels (dependent of image orientation). Default value is (0,0) which represents the upper-left corner. scale float Scale factor. effects SpriteEffects Effects to apply. orientation ImageOrientation The source image orientation layerDepth float The depth of a layer. By default, 0 represents the front layer and 1 represents a back layer. Use SpriteSortMode if you want sprites to be sorted during drawing. Draw(Texture, Vector2, RectangleF?, Color4, Color4) Adds a sprite to a batch of sprites for rendering using the specified texture, position, source rectangle, and color. public void Draw(Texture texture, Vector2 position, RectangleF? sourceRectangle, Color4 color, Color4 colorAdd = default) Parameters texture Texture A texture. position Vector2 The location (in screen coordinates) to draw the sprite. sourceRectangle RectangleF? A rectangle that specifies (in texels) the source texels from a texture. Use null to draw the entire texture. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. colorAdd Color4 Draw(Texture, Vector2, RectangleF?, Color4, float, Vector2, Vector2, SpriteEffects, ImageOrientation, float, Color4) Adds a sprite to a batch of sprites for rendering using the specified texture, position, source rectangle, color, rotation, origin, scale, effects, and layer. public void Draw(Texture texture, Vector2 position, RectangleF? sourceRectangle, Color4 color, float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects = SpriteEffects.None, ImageOrientation orientation = ImageOrientation.AsIs, float layerDepth = 0, Color4 colorAdd = default) Parameters texture Texture A texture. position Vector2 The location (in screen coordinates) to draw the sprite. sourceRectangle RectangleF? A rectangle that specifies (in texels) the source texels from a texture. Use null to draw the entire texture. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. rotation float Specifies the angle (in radians) to rotate the sprite about its center. origin Vector2 The sprite origin in the texture in pixels (dependent of image orientation). Default value is (0,0) which represents the upper-left corner. scale Vector2 Scale factor. effects SpriteEffects Effects to apply. orientation ImageOrientation The source image orientation layerDepth float The depth of a layer. By default, 0 represents the front layer and 1 represents a back layer. Use SpriteSortMode if you want sprites to be sorted during drawing. colorAdd Color4 Draw(Texture, Vector2, RectangleF?, Color4, float, Vector2, float, SpriteEffects, ImageOrientation, float, Color4, SwizzleMode) Adds a sprite to a batch of sprites for rendering using the specified texture, position, source rectangle, color, rotation, origin, scale, effects, and layer. public void Draw(Texture texture, Vector2 position, RectangleF? sourceRectangle, Color4 color, float rotation, Vector2 origin, float scale = 1, SpriteEffects effects = SpriteEffects.None, ImageOrientation orientation = ImageOrientation.AsIs, float layerDepth = 0, Color4 colorAdd = default, SwizzleMode swizzle = SwizzleMode.None) Parameters texture Texture A texture. position Vector2 The location (in screen coordinates) to draw the sprite. sourceRectangle RectangleF? A rectangle that specifies (in texels) the source texels from a texture. Use null to draw the entire texture. color Color4 The color to tint a sprite. Use Color4.White for full color with no tinting. rotation float Specifies the angle (in radians) to rotate the sprite about its center. origin Vector2 The sprite origin in the texture in pixels (dependent of image orientation). Default value is (0,0) which represents the upper-left corner. scale float Scale factor. effects SpriteEffects Effects to apply. orientation ImageOrientation The source image orientation layerDepth float The depth of a layer. By default, 0 represents the front layer and 1 represents a back layer. Use SpriteSortMode if you want sprites to be sorted during drawing. colorAdd Color4 swizzle SwizzleMode DrawString(SpriteFont, string, Vector2, Color4, TextAlignment) Adds a string to a batch of sprites for rendering using the specified font, text, position, and color. public void DrawString(SpriteFont spriteFont, string text, Vector2 position, Color4 color, TextAlignment alignment = TextAlignment.Left) Parameters spriteFont SpriteFont A font for displaying text. text string A text string. position Vector2 The location (in screen coordinates) to draw the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. alignment TextAlignment Describes how to align the text to draw DrawString(SpriteFont, string, Vector2, Color4, float, Vector2, Vector2, SpriteEffects, float, TextAlignment) Adds a string to a batch of sprites for rendering using the specified font, text, position, color, rotation, origin, scale, effects and layer. public void DrawString(SpriteFont spriteFont, string text, Vector2 position, Color4 color, float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth, TextAlignment alignment) Parameters spriteFont SpriteFont A font for displaying text. text string A text string. position Vector2 The location (in screen coordinates) to draw the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. rotation float Specifies the angle (in radians) to rotate the sprite about its center. origin Vector2 The sprite origin in virtual pixels; the default is (0,0) which represents the upper-left corner. scale Vector2 Scale factor. effects SpriteEffects Effects to apply. layerDepth float The depth of a layer. By default, 0 represents the front layer and 1 represents a back layer. Use SpriteSortMode if you want sprites to be sorted during drawing. alignment TextAlignment Describes how to align the text to draw DrawString(SpriteFont, string, float, Vector2, Color4, TextAlignment) Adds a string to a batch of sprites for rendering using the specified font, text, position, and color. public void DrawString(SpriteFont spriteFont, string text, float fontSize, Vector2 position, Color4 color, TextAlignment alignment = TextAlignment.Left) Parameters spriteFont SpriteFont A font for displaying text. text string A text string. fontSize float The font size in pixels (ignored in the case of static fonts) position Vector2 The location (in screen coordinates) to draw the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. alignment TextAlignment Describes how to align the text to draw DrawString(SpriteFont, string, float, Vector2, Color4, float, Vector2, Vector2, SpriteEffects, float, TextAlignment) Adds a string to a batch of sprites for rendering using the specified font, text, position, color, rotation, origin, scale, effects and layer. public void DrawString(SpriteFont spriteFont, string text, float fontSize, Vector2 position, Color4 color, float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth, TextAlignment alignment) Parameters spriteFont SpriteFont A font for displaying text. text string A text string. fontSize float The font size in pixels (ignored in the case of static fonts) position Vector2 The location (in screen coordinates) to draw the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. rotation float Specifies the angle (in radians) to rotate the sprite about its center. origin Vector2 The sprite origin in virtual pixels; the default is (0,0) which represents the upper-left corner. scale Vector2 Scale factor. effects SpriteEffects Effects to apply. layerDepth float The depth of a layer. By default, 0 represents the front layer and 1 represents a back layer. Use SpriteSortMode if you want sprites to be sorted during drawing. alignment TextAlignment Describes how to align the text to draw DrawString(SpriteFont, StringBuilder, Vector2, Color4, TextAlignment) Adds a string to a batch of sprites for rendering using the specified font, text, position, and color. public void DrawString(SpriteFont spriteFont, StringBuilder text, Vector2 position, Color4 color, TextAlignment alignment = TextAlignment.Left) Parameters spriteFont SpriteFont A font for displaying text. text StringBuilder Text string. position Vector2 The location (in screen coordinates) to draw the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. alignment TextAlignment Describes how to align the text to draw DrawString(SpriteFont, StringBuilder, Vector2, Color4, float, Vector2, Vector2, SpriteEffects, float, TextAlignment) Adds a string to a batch of sprites for rendering using the specified font, text, position, color, rotation, origin, scale, effects and layer. public void DrawString(SpriteFont spriteFont, StringBuilder text, Vector2 position, Color4 color, float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth, TextAlignment alignment) Parameters spriteFont SpriteFont A font for displaying text. text StringBuilder Text string. position Vector2 The location (in screen coordinates) to draw the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. rotation float Specifies the angle (in radians) to rotate the sprite about its center. origin Vector2 The sprite origin in virtual pixels; the default is (0,0) which represents the upper-left corner. scale Vector2 Scale factor. effects SpriteEffects Effects to apply. layerDepth float The depth of a layer. By default, 0 represents the front layer and 1 represents a back layer. Use SpriteSortMode if you want sprites to be sorted during drawing. alignment TextAlignment Describes how to align the text to draw DrawString(SpriteFont, StringBuilder, float, Vector2, Color4, TextAlignment) Adds a string to a batch of sprites for rendering using the specified font, text, position, and color. public void DrawString(SpriteFont spriteFont, StringBuilder text, float fontSize, Vector2 position, Color4 color, TextAlignment alignment = TextAlignment.Left) Parameters spriteFont SpriteFont A font for displaying text. text StringBuilder Text string. fontSize float The font size in pixels (ignored in the case of static fonts) position Vector2 The location (in screen coordinates) to draw the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. alignment TextAlignment Describes how to align the text to draw DrawString(SpriteFont, StringBuilder, float, Vector2, Color4, float, Vector2, Vector2, SpriteEffects, float, TextAlignment) Adds a string to a batch of sprites for rendering using the specified font, text, position, color, rotation, origin, scale, effects and layer. public void DrawString(SpriteFont spriteFont, StringBuilder text, float fontSize, Vector2 position, Color4 color, float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth, TextAlignment alignment) Parameters spriteFont SpriteFont A font for displaying text. text StringBuilder Text string. fontSize float The font size in pixels (ignored in the case of static fonts) position Vector2 The location (in screen coordinates) to draw the sprite. color Color4 The color to tint a sprite. Use Color.White for full color with no tinting. rotation float Specifies the angle (in radians) to rotate the sprite about its center. origin Vector2 The sprite origin in virtual pixels; the default is (0,0) which represents the upper-left corner. scale Vector2 Scale factor. effects SpriteEffects Effects to apply. layerDepth float The depth of a layer. By default, 0 represents the front layer and 1 represents a back layer. Use SpriteSortMode if you want sprites to be sorted during drawing. alignment TextAlignment Describes how to align the text to draw MeasureString(SpriteFont, string, Vector2?) Measure the size of the given text in virtual pixels depending on the target size. public Vector2 MeasureString(SpriteFont spriteFont, string text, Vector2? targetSize = null) Parameters spriteFont SpriteFont The font used to draw the text. text string The text to measure. targetSize Vector2? The size of the target to render in. If null, the size of the window back buffer is used. Returns Vector2 The size of the text in virtual pixels. Exceptions ArgumentNullException The provided sprite font is null. MeasureString(SpriteFont, string, float, Vector2?) Measure the size of the given text in virtual pixels depending on the target size. public Vector2 MeasureString(SpriteFont spriteFont, string text, float fontSize, Vector2? targetSize = null) Parameters spriteFont SpriteFont The font used to draw the text. text string The text to measure. fontSize float The font size (in pixels) used to draw the text. targetSize Vector2? The size of the target to render in. If null, the size of the window back buffer is used. Returns Vector2 The size of the text in virtual pixels. Exceptions ArgumentNullException The provided sprite font is null. PrepareForRendering() protected override void PrepareForRendering() UpdateBufferValuesFromElementInfo(ref ElementInfo, nint, nint, int) Update the mapped vertex and index buffer values using the provided element info. protected override void UpdateBufferValuesFromElementInfo(ref BatchBase<SpriteBatch.SpriteDrawInfo>.ElementInfo elementInfo, nint vertexPtr, nint indexPtr, int vertexOffset) Parameters elementInfo BatchBase<SpriteBatch.SpriteDrawInfo>.ElementInfo The structure containing the information about the element to draw. vertexPtr nint indexPtr nint vertexOffset int"
  },
  "api/Stride.Graphics.SpriteEffect.html": {
    "href": "api/Stride.Graphics.SpriteEffect.html",
    "title": "Class SpriteEffect | Stride API",
    "summary": "Class SpriteEffect Namespace Stride.Graphics Assembly Stride.Graphics.dll public class SpriteEffect Inheritance object SpriteEffect Extension Methods UnsafeUtilities.As<T>(object?) Properties Bytecode public static EffectBytecode Bytecode { get; } Property Value EffectBytecode"
  },
  "api/Stride.Graphics.SpriteEffects.html": {
    "href": "api/Stride.Graphics.SpriteEffects.html",
    "title": "Enum SpriteEffects | Stride API",
    "summary": "Enum SpriteEffects Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines sprite mirroring options. [DataContract] public enum SpriteEffects Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields FlipBoth = 2 Rotate 180 degrees around both the X and Y axis before rendering. FlipHorizontally = 1 Rotate 180 degrees around the Y axis before rendering. FlipVertically = 3 Rotate 180 degrees around the X axis before rendering. None = 0 No rotations specified. Remarks Description is taken from original XNA SpriteEffects class."
  },
  "api/Stride.Graphics.SpriteExtensions.html": {
    "href": "api/Stride.Graphics.SpriteExtensions.html",
    "title": "Class SpriteExtensions | Stride API",
    "summary": "Class SpriteExtensions Namespace Stride.Graphics Assembly Stride.Graphics.dll A sprite represents a series frames in an atlas forming an animation. public static class SpriteExtensions Inheritance object SpriteExtensions Methods Draw(Sprite, SpriteBatch, Vector2, Color, Vector2, float, float, SpriteEffects) Draw a sprite using a sprite batch. public static void Draw(this Sprite sprite, SpriteBatch spriteBatch, Vector2 position, Color color, Vector2 scales, float rotation = 0, float depthLayer = 0, SpriteEffects spriteEffects = SpriteEffects.None) Parameters sprite Sprite The sprite spriteBatch SpriteBatch The sprite batch used to draw the sprite. position Vector2 The position to which draw the sprite color Color The color to use to draw the sprite scales Vector2 The scale factors to apply on the sprite rotation float The rotation to apply on the sprite depthLayer float The depth layer to which draw the sprite spriteEffects SpriteEffects The sprite effect to apply on the sprite Remarks This function must be called between the Begin(GraphicsContext, SpriteSortMode, EffectInstance) and SpriteBatch.End() calls of the provided spriteBatch Exceptions ArgumentException The provided frame index is not valid. ArgumentOutOfRangeException The provided spriteBatch is null Draw(Sprite, SpriteBatch, Vector2, float, float, SpriteEffects) Draw a sprite using a sprite batch and with white color and scale of 1. public static void Draw(this Sprite sprite, SpriteBatch spriteBatch, Vector2 position, float rotation = 0, float depthLayer = 0, SpriteEffects spriteEffects = SpriteEffects.None) Parameters sprite Sprite The sprite spriteBatch SpriteBatch The sprite batch used to draw the sprite. position Vector2 The position to which draw the sprite rotation float The rotation to apply on the sprite depthLayer float The depth layer to which draw the sprite spriteEffects SpriteEffects The sprite effect to apply on the sprite Remarks This function must be called between the Begin(GraphicsContext, SpriteSortMode, EffectInstance) and SpriteBatch.End() calls of the provided spriteBatch Exceptions ArgumentException The provided frame index is not valid. ArgumentOutOfRangeException The provided spriteBatch is null Draw3D(Sprite, Sprite3DBatch, ref Matrix, ref Color4) Draw a sprite in the 3D world using the provided 3D sprite batch, world matrix and color. public static void Draw3D(this Sprite sprite, Sprite3DBatch spriteBatch, ref Matrix worldMatrix, ref Color4 color) Parameters sprite Sprite The sprite spriteBatch Sprite3DBatch The sprite batch used to draw the sprite. worldMatrix Matrix The world matrix of the sprite color Color4 The color to apply on the sprite Remarks This function must be called between the Begin(GraphicsContext, SpriteSortMode, EffectInstance) and SpriteBatch.End() calls of the provided spriteBatch Exceptions ArgumentException The provided frame index is not valid. ArgumentOutOfRangeException The provided spriteBatch is null"
  },
  "api/Stride.Graphics.SpriteFont.GlyphPosition.html": {
    "href": "api/Stride.Graphics.SpriteFont.GlyphPosition.html",
    "title": "Struct SpriteFont.GlyphPosition | Stride API",
    "summary": "Struct SpriteFont.GlyphPosition Namespace Stride.Graphics Assembly Stride.Graphics.dll public record struct SpriteFont.GlyphPosition : IEquatable<SpriteFont.GlyphPosition> Implements IEquatable<SpriteFont.GlyphPosition> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors GlyphPosition(Glyph, float, float, float, int, Vector2) public GlyphPosition(Glyph Glyph, float X, float Y, float NextX, int Index, Vector2 AuxiliaryScaling) Parameters Glyph Glyph X float Y float NextX float Index int AuxiliaryScaling Vector2 Properties AuxiliaryScaling public Vector2 AuxiliaryScaling { readonly get; set; } Property Value Vector2 Glyph public Glyph Glyph { readonly get; set; } Property Value Glyph Index public int Index { readonly get; set; } Property Value int NextX public float NextX { readonly get; set; } Property Value float Position public Vector2 Position { get; } Property Value Vector2 X public float X { readonly get; set; } Property Value float Y public float Y { readonly get; set; } Property Value float"
  },
  "api/Stride.Graphics.SpriteFont.html": {
    "href": "api/Stride.Graphics.SpriteFont.html",
    "title": "Class SpriteFont | Stride API",
    "summary": "Class SpriteFont Namespace Stride.Graphics Assembly Stride.Graphics.dll SpriteFont to use with SpriteBatch. See SpriteFont to learn how to use it. [DataContract] [DataSerializerGlobal(typeof(ReferenceSerializer<SpriteFont>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public class SpriteFont : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase SpriteFont Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields Logger public static readonly Logger Logger Field Value Logger swizzle The swizzle mode to use when drawing the sprite font. protected SwizzleMode swizzle Field Value SwizzleMode Properties DefaultCharacter Gets or sets the default character for the font. public char? DefaultCharacter { get; set; } Property Value char? ExtraLineSpacing Gets or sets the extra line spacing (in pixels) to add to the default font line spacing for the current font Size. This value will be scaled during the draw in the case of dynamic fonts. Use GetExtraLineSpacing(float) to get the value of the extra spacing for a given font size. public float ExtraLineSpacing { get; set; } Property Value float Remarks Line spacing is the distance between the base lines of two consecutive lines of text (blank space as well as characters' height are thus included). ExtraSpacing Gets or sets extra spacing (in pixels) between the characters for the current font Size. This value is scaled during the draw in the case of dynamic fonts. Use GetExtraSpacing(float) to get the value of the extra spacing for a given font size. public float ExtraSpacing { get; set; } Property Value float FontType Gets the type indicating if the current font is static, dynamic or SDF. public SpriteFontType FontType { get; protected set; } Property Value SpriteFontType IgnoreUnkownCharacters Completely skips characters that are not in the map. public bool IgnoreUnkownCharacters { get; set; } Property Value bool Size Gets the font size (resp. the default font size) for static fonts (resp. for dynamic fonts) in pixels. [DataMember] public float Size { get; } Property Value float Textures Gets the textures containing the font character data. public virtual IReadOnlyList<Texture> Textures { get; protected set; } Property Value IReadOnlyList<Texture> Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. GetBaseOffsetY(float) Get the value of the base offset for the given font size. protected virtual float GetBaseOffsetY(float fontSize) Parameters fontSize float The font size in pixels Returns float The value of the base offset GetExtraLineSpacing(float) Get the value of the extra character spacing for the given font size. public virtual float GetExtraLineSpacing(float fontSize) Parameters fontSize float The font size in pixels Returns float The value of the character spacing GetExtraSpacing(float) Get the value of the extra line spacing for the given font size. public virtual float GetExtraSpacing(float fontSize) Parameters fontSize float The font size in pixels Returns float The value of the character spacing GetFontDefaultLineSpacing(float) Get the value of the font default line spacing for the given font size. public virtual float GetFontDefaultLineSpacing(float fontSize) Parameters fontSize float The font size in pixels Returns float The value of the default line spacing GetGlyph(CommandList, char, in Vector2, bool, out Vector2) Return the glyph associated to provided character at the given size. protected virtual Glyph GetGlyph(CommandList commandList, char character, in Vector2 fontSize, bool uploadGpuResources, out Vector2 auxiliaryScaling) Parameters commandList CommandList The command list in case we upload gpu resources character char The character we want the glyph of fontSize Vector2 The font size in pixel uploadGpuResources bool Indicate if the GPU resource should be uploaded or not. auxiliaryScaling Vector2 If the requested font size isn't available, the closest one is chosen and an auxiliary scaling is returned Returns Glyph The glyph corresponding to the request or null if not existing GetTotalLineSpacing(float) Gets the value of the total line spacing (font default + user defined) in pixels for a given font size. public float GetTotalLineSpacing(float fontSize) Parameters fontSize float Returns float Remarks Line spacing is the distance between the base lines of two consecutive lines of text (blank space as well as characters' height are thus included). IndexInString(string, in Vector2, Vector2, (TextAlignment text, Vector2 boxSize)?) public int IndexInString(string text, in Vector2 fontSize, Vector2 pointOnText, (TextAlignment text, Vector2 boxSize)? scanOption) Parameters text string fontSize Vector2 pointOnText Vector2 scanOption (TextAlignment text, Vector2 boxSize)? Returns int IsCharPresent(char) Checks whether the provided character is present in the character map of the current SpriteFont. public virtual bool IsCharPresent(char c) Parameters c char The character to check. Returns bool true if the c is present in the character map, false - otherwise. MeasureString(string) Returns the width and height of the provided text for the current font size Size public Vector2 MeasureString(string text) Parameters text string The string to measure. Returns Vector2 Vector2. MeasureString(string, Vector2) Returns the width and height of the provided text for a given font size public Vector2 MeasureString(string text, Vector2 fontSize) Parameters text string The string to measure. fontSize Vector2 The size of the font (ignored in the case of static fonts) Returns Vector2 Vector2. MeasureString(string, Vector2, int) Returns the width and height of the provided text for a given font size public Vector2 MeasureString(string text, Vector2 fontSize, int length) Parameters text string The string to measure. fontSize Vector2 The size of the font (ignored in the case of static fonts) length int The length of the string to measure Returns Vector2 Vector2. MeasureString(string, ref Vector2) Returns the width and height of the provided text for a given font size public Vector2 MeasureString(string text, ref Vector2 fontSize) Parameters text string The string to measure. fontSize Vector2 The size of the font (ignored in the case of static fonts) Returns Vector2 Vector2. MeasureString(string, ref Vector2, int) Returns the width and height of the provided text for a given font size public Vector2 MeasureString(string text, ref Vector2 fontSize, int length) Parameters text string The string to measure. fontSize Vector2 The size of the font (ignored in the case of static fonts) length int The length of the string to measure Returns Vector2 Vector2. MeasureString(string, float) Returns the width and height of the provided text for a given font size public Vector2 MeasureString(string text, float fontSize) Parameters text string The string to measure. fontSize float The size of the font (ignored in the case of static fonts) Returns Vector2 Vector2. MeasureString(StringBuilder) Returns the width and height of the provided text for the current font size Size public Vector2 MeasureString(StringBuilder text) Parameters text StringBuilder The string to measure. Returns Vector2 Vector2. MeasureString(StringBuilder, Vector2) Returns the width and height of the provided text for a given font size public Vector2 MeasureString(StringBuilder text, Vector2 fontSize) Parameters text StringBuilder The string to measure. fontSize Vector2 The size of the font (ignored in the case of static fonts) Returns Vector2 Vector2. MeasureString(StringBuilder, Vector2, int) Returns the width and height of the provided text for a given font size public Vector2 MeasureString(StringBuilder text, Vector2 fontSize, int length) Parameters text StringBuilder The string to measure. fontSize Vector2 The size of the font (ignored in the case of static fonts) length int The length of the string to measure Returns Vector2 Vector2. MeasureString(StringBuilder, ref Vector2) Returns the width and height of the provided text for a given font size public Vector2 MeasureString(StringBuilder text, ref Vector2 fontSize) Parameters text StringBuilder The string to measure. fontSize Vector2 The size of the font (ignored in the case of static fonts) Returns Vector2 Vector2. MeasureString(StringBuilder, ref Vector2, int) Returns the width and height of the provided text for a given font size public Vector2 MeasureString(StringBuilder text, ref Vector2 fontSize, int length) Parameters text StringBuilder The string to measure. fontSize Vector2 The size of the font (ignored in the case of static fonts) length int The length of the string to measure Returns Vector2 Vector2. MeasureString(StringBuilder, float) Returns the width and height of the provided text for a given font size public Vector2 MeasureString(StringBuilder text, float fontSize) Parameters text StringBuilder The string to measure. fontSize float The size of the font (ignored in the case of static fonts) Returns Vector2 Vector2. PreGenerateGlyphs(string, Vector2) Pre-generate synchronously the glyphs of the character needed to render the provided text at the provided size. public void PreGenerateGlyphs(string text, Vector2 size) Parameters text string The text containing the characters to pre-generate size Vector2 The size of the font"
  },
  "api/Stride.Graphics.SpriteFontType.html": {
    "href": "api/Stride.Graphics.SpriteFontType.html",
    "title": "Enum SpriteFontType | Stride API",
    "summary": "Enum SpriteFontType Namespace Stride.Graphics Assembly Stride.Graphics.dll public enum SpriteFontType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"Runtime Rasterized\", null)] Dynamic = 1 Font which can change its font size dynamically and is compiled at runtime [Display(\"Signed Distance Field\", null)] SDF = 2 Signed Distance Field font which is pre-compiled but can still be scaled at runtime [Display(\"Offline Rasterized\", null)] Static = 0 Static font which has fixed font size and is pre-compiled"
  },
  "api/Stride.Graphics.SpriteFrame.html": {
    "href": "api/Stride.Graphics.SpriteFrame.html",
    "title": "Class SpriteFrame | Stride API",
    "summary": "Class SpriteFrame Namespace Stride.Graphics Assembly Stride.Graphics.dll A sprite frame represents a single frame a sprite animation. It contains the region of the texture representing the frame and the time it is supposed to be displayed. [DataContract] public class SpriteFrame Inheritance object SpriteFrame Extension Methods UnsafeUtilities.As<T>(object?) Fields CenterBias The bias to the frame center in pixels. public Vector2 CenterBias Field Value Vector2 TextureRegion The rectangle specifying the region of the texture to use for that frame. public Rectangle TextureRegion Field Value Rectangle Methods Clone() Clone the current sprite frame instance. public SpriteFrame Clone() Returns SpriteFrame A new instance of the current sprite frame."
  },
  "api/Stride.Graphics.SpriteSheet.html": {
    "href": "api/Stride.Graphics.SpriteSheet.html",
    "title": "Class SpriteSheet | Stride API",
    "summary": "Class SpriteSheet Namespace Stride.Graphics Assembly Stride.Graphics.dll A sheet (group) of sprites. [DataContract] [DataSerializerGlobal(typeof(ReferenceSerializer<SpriteSheet>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] [ContentSerializer(typeof(DataContentSerializer<SpriteSheet>))] public class SpriteSheet Inheritance object SpriteSheet Extension Methods UnsafeUtilities.As<T>(object?) Properties this[int] Gets or sets the image of the group at index. public Sprite this[int index] { get; set; } Parameters index int The image index Property Value Sprite The image this[string] Gets or sets the image of the group having the provided name. public Sprite this[string name] { get; set; } Parameters name string The name of the image Property Value Sprite The image Sprites The list of sprites. public List<Sprite> Sprites { get; } Property Value List<Sprite> Methods FindImageIndex(string) Find the index of a sprite in the group using its name. public int FindImageIndex(string spriteName) Parameters spriteName string The name of the sprite Returns int The index value Remarks If two sprites have the provided name then the first sprite found is returned Exceptions KeyNotFoundException No sprite in the group have the given name"
  },
  "api/Stride.Graphics.SpriteSortMode.html": {
    "href": "api/Stride.Graphics.SpriteSortMode.html",
    "title": "Enum SpriteSortMode | Stride API",
    "summary": "Enum SpriteSortMode Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines sprite sort-rendering options. public enum SpriteSortMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BackToFront = 3 Same as Deferred mode, except sprites are sorted by depth in back-to-front order prior to drawing. This procedure is recommended when drawing transparent sprites of varying depths. Deferred = 0 Sprites are not drawn until End is called. End will apply graphics device settings and draw all the sprites in one batch, in the same order calls to Draw were received. This mode allows Draw calls to two or more instances of SpriteBatch without introducing conflicting graphics device settings. SpriteBatch defaults to Deferred mode. FrontToBack = 4 Same as Deferred mode, except sprites are sorted by depth in front-to-back order prior to drawing. This procedure is recommended when drawing opaque sprites of varying depths. Immediate = 1 Begin will apply new graphics device settings, and sprites will be drawn within each Draw call. In Immediate mode there can only be one active SpriteBatch instance without introducing conflicting device settings. Texture = 2 Same as Deferred mode, except sprites are sorted by texture prior to drawing. This can improve performance when drawing non-overlapping sprites of uniform depth. Remarks Description is taken from original XNA SpriteBatch class."
  },
  "api/Stride.Graphics.StencilOperation.html": {
    "href": "api/Stride.Graphics.StencilOperation.html",
    "title": "Enum StencilOperation | Stride API",
    "summary": "Enum StencilOperation Namespace Stride.Graphics Assembly Stride.Graphics.dll Specifies the operation to perform on the stencil part of the Depth-Stencil Buffer when rasterizing primitives. [DataContract] public enum StencilOperation Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Decrement = 8 Decrements the value of the stencil buffer by one, wrapping around to the maximum value if it goes below zero. DecrementSaturation = 5 Decrements the value of the stencil buffer by one, saturating at zero (usually 0 for 8-bit buffers). Increment = 7 Increments the value of the stencil buffer by one, wrapping around to zero if it exceeds the maximum value. IncrementSaturation = 4 Increments the value of the stencil buffer by one, saturating at the maximum value allowed (usually 255 for 8-bit buffers). Invert = 6 Inverts all bits in the stencil buffer value, effectively flipping each bit from 0 to 1 and from 1 to 0. Keep = 1 Keeps the current value of the stencil buffer, without modifying it. Replace = 3 Sets the value of the stencil buffer to a specified value when the stencil test passes. Zero = 2 Sets the value of the stencil buffer to zero. Remarks This enumeration is part of a Depth-Stencil State object description (see DepthStencilStateDescription)."
  },
  "api/Stride.Graphics.SwapChainGraphicsPresenter.html": {
    "href": "api/Stride.Graphics.SwapChainGraphicsPresenter.html",
    "title": "Class SwapChainGraphicsPresenter | Stride API",
    "summary": "Class SwapChainGraphicsPresenter Namespace Stride.Graphics Assembly Stride.Graphics.dll A GraphicsPresenter wrapping a DirectX Swap-Chain (Silk.NET.DXGI.IDXGISwapChain). public class SwapChainGraphicsPresenter : GraphicsPresenter, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsPresenter SwapChainGraphicsPresenter Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsPresenter.GraphicsDevice GraphicsPresenter.Description GraphicsPresenter.DepthStencilBuffer GraphicsPresenter.PresentInterval GraphicsPresenter.Resize(int, int, PixelFormat) GraphicsPresenter.SetOutputColorSpace(ColorSpaceType, PixelFormat) GraphicsPresenter.DestroyChildrenTextures(Texture) GraphicsPresenter.DetachDepthStencilBuffer() GraphicsPresenter.Destroy() GraphicsPresenter.ProcessPresentationParameters() GraphicsPresenter.CreateDepthStencilBuffer() ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks A Swap-Chain is a collection of same-sized buffers (one front-buffer, one or more -usually one- Back-Buffer, and an optional Depth-Stencil Buffer) that are used to present the final rendered image to the screen. In order to create a new GraphicsPresenter, a GraphicsDevice should have been initialized first. Constructors SwapChainGraphicsPresenter(GraphicsDevice, PresentationParameters) Initializes a new instance of the SwapChainGraphicsPresenter class. public SwapChainGraphicsPresenter(GraphicsDevice device, PresentationParameters presentationParameters) Parameters device GraphicsDevice The Graphics Device. presentationParameters PresentationParameters The parameters describing the buffers the device will present to. Exceptions ArgumentNullException device is null. ArgumentNullException presentationParameters is null. InvalidOperationException DeviceWindowHandle is null or the Handle is invalid or zero. NotSupportedException The Depth-Stencil format specified is not supported. Properties BackBuffer Gets the default Back-Buffer for the Graphics Presenter. public override Texture BackBuffer { get; } Property Value Texture The Texture where rendering will happen, which will then be presented to the front-buffer. IsFullScreen Gets or sets a value indicating if the Graphics Presenter is in full-screen mode. public override bool IsFullScreen { get; set; } Property Value bool A value indicating whether the presentation will be in full screen. true if the presentation will be in full screen. false if the presentation will be in a window. Remarks This property is only valid on desktop Windows. It has no effect on UWP. NativePresenter Gets the underlying native presenter. public override object NativePresenter { get; } Property Value object The native presenter. Depending on platform, for exmaple, it can be a Silk.NET.DXGI.IDXGISwapChain or Silk.NET.DXGI.IDXGISwapChain1 or null. Methods BeginDraw(CommandList) Marks the beginning of a frame that will be presented later by the Graphics Presenter. public override void BeginDraw(CommandList commandList) Parameters commandList CommandList The Command List where rendering commands will be registered. Remarks When overriden in a derived class, this method should prepare the Graphics Presenter to receive graphics commands to be executed at the beginning of the current frame. EndDraw(CommandList, bool) Marks the end of a frame that will be presented later by the Graphics Presenter. public override void EndDraw(CommandList commandList, bool present) Parameters commandList CommandList The Command List where rendering commands will be registered. present bool A value indicating whether the frame will be presented, i.e. if the Back-Buffer will be shown to the screen. Remarks When overriden in a derived class, this method should prepare the Graphics Presenter to receive graphics commands to be executed at the end of the current frame. OnDestroyed(bool) Called when the Graphics Presenter has been destroyed. protected override void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the resources used by the Graphics Presenter should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). Remarks When overriden in a derived class, this method allows to perform additional cleanup and release of associated resources. OnNameChanged() Called when the Name property has changed. protected override void OnNameChanged() OnRecreated() Called when the Graphics Presenter has been reinitialized. public override void OnRecreated() Remarks When overriden in a derived class, this method allows to perform additional resource creation, configuration, and initialization. Exceptions InvalidOperationException DeviceWindowHandle is null or the Handle is invalid or zero. Present() Presents the Back-Buffer to the screen. public override void Present() Exceptions GraphicsDeviceException An unexpected error occurred while presenting. Check the status of the Graphics Device for more information (Status). GraphicsDeviceException An unexpected error occurred while presenting the Swap-Chain. Check the status of the Graphics Device for more information (Status). ResizeBackBuffer(int, int, PixelFormat) Resizes the Back-Buffer. protected override void ResizeBackBuffer(int width, int height, PixelFormat format) Parameters width int The new width of the Back-Buffer, in pixels. height int The new height of the Back-Buffer, in pixels. format PixelFormat The new pixel format for the Back-Buffer. Remarks When implementing this method, the derived class should resize the Back-Buffer to the specified size and format. Exceptions NotSupportedException The specified pixel format or size is not supported by the Graphics Device. ResizeDepthStencilBuffer(int, int, PixelFormat) Resizes the Depth-Stencil Buffer. protected override void ResizeDepthStencilBuffer(int width, int height, PixelFormat format) Parameters width int The new width of the Depth-Stencil Buffer, in pixels. height int The new height of the Depth-Stencil Buffer, in pixels. format PixelFormat The new pixel format for the Depth-Stencil Buffer. Remarks When implementing this method, the derived class should resize the Depth-Stencil Buffer to the specified size and format. Exceptions NotSupportedException The specified depth format or size is not supported by the Graphics Device."
  },
  "api/Stride.Graphics.SwizzleMode.html": {
    "href": "api/Stride.Graphics.SwizzleMode.html",
    "title": "Enum SwizzleMode | Stride API",
    "summary": "Enum SwizzleMode Namespace Stride.Graphics Assembly Stride.Graphics.dll Specify how to swizzle a vector. public enum SwizzleMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"Default\", null)] None = 0 Take the vector as is. [Display(\"Normal map\", null)] NormalMap = 2 Reconstructs the Z(B) component from R and G. [Display(\"Grayscale (opaque)\", null)] RRR1 = 3 Take the only the red component of the vector, but keeps the object opaque [Display(\"Grayscale (alpha)\", null)] RRRR = 1 Take the only the red component of the vector. [Display(\"Grayscale (alpha)\", null)] XXXX = 1 Take the only the x component of the vector."
  },
  "api/Stride.Graphics.TextAlignment.html": {
    "href": "api/Stride.Graphics.TextAlignment.html",
    "title": "Enum TextAlignment | Stride API",
    "summary": "Enum TextAlignment Namespace Stride.Graphics Assembly Stride.Graphics.dll Specify the available text alignment when rendering text. public enum TextAlignment Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Center = 1 The text will be centered. Left = 0 The text will aligned on the left border. Right = 2 The text will be aligned on the right border."
  },
  "api/Stride.Graphics.Texture.html": {
    "href": "api/Stride.Graphics.Texture.html",
    "title": "Class Texture | Stride API",
    "summary": "Class Texture Namespace Stride.Graphics Assembly Stride.Graphics.dll All-in-one GPU Texture that is able to represent many types of textures (1D, 2D, 3D, Depth-Stencil Buffers, Render Targets, etc), as well as Texture Views over a parent Texture. [DataSerializerGlobal(typeof(ReferenceSerializer<Texture>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] [ContentSerializer(typeof(TextureContentSerializer))] [ContentSerializer(typeof(TextureImageSerializer))] [DataSerializer(typeof(TextureSerializer))] public sealed class Texture : GraphicsResource, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase GraphicsResourceBase GraphicsResource Texture Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members GraphicsResourceBase.Reload GraphicsResourceBase.GraphicsDevice GraphicsResourceBase.Destroyed ComponentBase.Tags ComponentBase.Name ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) GraphicsSerializerExtensions.GetSerializationData(Texture) GraphicsSerializerExtensions.SetSerializationData(Texture, TextureSerializationData) GraphicsSerializerExtensions.SetSerializationData(Texture, Image) TextureExtensions.CreateDepthTextureCompatible(Texture) TextureExtensions.EnsureRenderTarget(Texture) TextureExtensions.ToDepthStencilReadOnlyTexture(Texture) TextureExtensions.ToTextureView(Texture, ViewType, int, int) UnsafeUtilities.As<T>(object?) Remarks Texture constains static methods for creating new Textures by specifying all their characteristics. Also look for the following static methods that aid in the creation of specific kinds of buffers: New1D(GraphicsDevice, int, PixelFormat, TextureFlags, int, GraphicsResourceUsage) (for one-dimensional Textures), New2D(GraphicsDevice, int, int, PixelFormat, TextureFlags, int, GraphicsResourceUsage, TextureOptions) (for two-dimensional Textures), New3D(GraphicsDevice, int, int, int, PixelFormat, TextureFlags, GraphicsResourceUsage) (for three-dimensional Textures), and NewCube(GraphicsDevice, int, PixelFormat, TextureFlags, GraphicsResourceUsage) (for six-sided two-dimensional Cube-maps). Consult the documentation of your graphics API for more information on each kind of Texture. Constructors Texture() public Texture() Properties ArraySize Gets the number of Textures in the array (if this is a Texture Array). public int ArraySize { get; } Property Value int The largestSize of the array. If this is not a Texture Array, it will return 1. Remarks This field is only valid for 1D, 2D and Cube Textures. ArraySlice Gets the index of the array slice the Texture View is referencing. public int ArraySlice { get; } Property Value int The array index the Texture View references. If the parent Texture is not a Texture Array or a Cube-map, only a single array slice will exist with index 0. Remarks See ViewType for more information on how MipLevel and ArraySlice determines which sub-resources to select based on ViewType. Depth Gets the depth of the Texture. public int Depth { get; } Property Value int The depth of the Texture in pixels. Description Gets the common description for the original Texture. public ref readonly TextureDescription Description { get; } Property Value TextureDescription Dimension Gets the type of the Texture. public TextureDimension Dimension { get; } Property Value TextureDimension Flags Gets a combination of flags indicating how the Texture can be bound to the graphics pipeline. public TextureFlags Flags { get; } Property Value TextureFlags Format Gets the pixel format of the Texture. public PixelFormat Format { get; } Property Value PixelFormat FullQualitySize Gets the largestSize of the Texture when loaded at full quality when texture streaming is enabled. public Size3 FullQualitySize { get; } Property Value Size3 Height Gets the height of the Texture. public int Height { get; } Property Value int The height of the Texture in pixels. IsBlockCompressed Gets a value indicating if the Texture is a using a block compress format (BC1, BC2, BC3, BC4, BC5, BC6H, BC7). public bool IsBlockCompressed { get; } Property Value bool See Also Format IsDepthStencil Gets a value indicating if the Texture View is a Depth-Stencil View. public bool IsDepthStencil { get; } Property Value bool true if the Texture View is a Depth-Stencil View; otherwise, false. IsDepthStencilReadOnly Gets a value indicating if the Texture View is a read-only Depth-Stencil View. public bool IsDepthStencilReadOnly { get; } Property Value bool true if the Texture View is a read-only Depth-Stencil View; otherwise, false. IsMultiSampled Gets a value indicating if the Texture is a multi-sampled Texture. public bool IsMultiSampled { get; } Property Value bool true if the Texture is multi-sampled; otherwise, false. IsRenderTarget Gets a value indicating if the Texture View is a Render Target View. public bool IsRenderTarget { get; } Property Value bool true if the Texture View is a Render Target View; otherwise, false. IsShaderResource Gets a value indicating if the Texture View is a Shader Resource View. public bool IsShaderResource { get; } Property Value bool true if the Texture View is a Shader Resource View; otherwise, false. IsUnorderedAccess Gets a value indicating if the Texture View is an Unordered Access View. public bool IsUnorderedAccess { get; } Property Value bool true if the Texture View is an Unordered Access View; otherwise, false. MipLevel Gets the index of the mip-level the Texture View is referencing. public int MipLevel { get; } Property Value int The index of the mip-level the Texture View references. The first (largest) mipLevel is always index 0. Remarks See ViewType for more information on how MipLevel and ArraySlice determines which sub-resources to select based on ViewType. MipLevelCount Gets the maximum number of mip-Levels in the Texture. public int MipLevelCount { get; } Property Value int MultisampleCount Gets the multisampling for the Texture. public MultisampleCount MultisampleCount { get; } Property Value MultisampleCount A value of MultisampleCount specifying the number of samples per pixel. Remarks This field is only valid for 2D Textures. Options Gets a combination of flags indicating special options for the Texture, like sharing. public TextureOptions Options { get; } Property Value TextureOptions SharedHandle Gets a handle that identifies the Texture as a shared resource when it has the option Shared or SharedNtHandle. public nint SharedHandle { get; } Property Value nint A handle that identifies the shared Texture, or Zero if it is not a shared resource. SharedNtHandleName Gets the name of the shared NT handle that identifies the Texture as a shared resource when it has the option SharedNtHandle. public string SharedNtHandleName { get; } Property Value string The name of the NT handle of the shared Texture, or Empty if it is not a shared resource. Size Gets the largestSize of the Texture or Texture View. public Size3 Size { get; } Property Value Size3 The largestSize of the Texture or Texture View as (Width, Height, Depth). Usage Gets the intended usage of the Texture. public GraphicsResourceUsage Usage { get; } Property Value GraphicsResourceUsage A value that identifies how the Texture is to be read from and written to. ViewDepth Gets the depth of the Texture View. public int ViewDepth { get; } Property Value int ViewDescription Gets the view description. public ref readonly TextureViewDescription ViewDescription { get; } Property Value TextureViewDescription ViewDimension Gets the type of the Texture View. public TextureDimension ViewDimension { get; } Property Value TextureDimension ViewFlags Gets a combination of flags describing the type of Texture View and how it can be bound to the graphics pipeline. public TextureFlags ViewFlags { get; } Property Value TextureFlags ViewFormat Gets the pixel format of the Texture View. public PixelFormat ViewFormat { get; } Property Value PixelFormat ViewHeight Gets the height of the Texture View. public int ViewHeight { get; } Property Value int ViewType Gets a value indicating which sub-resources of the Texture are accessible through the Texture View. public ViewType ViewType { get; } Property Value ViewType ViewWidth Gets the width of the Texture View. public int ViewWidth { get; } Property Value int Width Gets the width of the Texture. public int Width { get; } Property Value int The width of the Texture in pixels. Methods CalculateMipSize(int, int) Calculates the largestSize of a specific mip-level. public static int CalculateMipSize(int size, int mipLevel) Parameters size int The original full largestSize from which to calculate mip-level largestSize, in texels. mipLevel int The mip-level index. Returns int The largestSize of the specified mipLevel, in texels. Remarks Each mip-level becomes progressively smaller as mipLevel grows. CalculatePixelDataCount<TData>(int) Calculates the number of pixel elements of type TData the Texture requires for a particular mip-level. public int CalculatePixelDataCount<TData>(int mipLevel = 0) where TData : unmanaged Parameters mipLevel int The mip-level for which to calculate the width. By default, the first mip-level at index 0 is selected, which is the most detailed one. Returns int The expected number of TData elements of the Texture for the mip-level specified by mipLevel. Type Parameters TData The type of the pixel data. Remarks This method can be used to allocate a Texture data buffer to hold pixel data of type TData as follows: var textureData = new TData[ texture.CalculatePixelDataCount<TData>() ]; Exceptions ArgumentException The largestSize of Format and the largestSize of TData does not match. The ratio between the two must be an integer, or else there would be remaining bytes. See Also CalculateWidth<TData>(int) CalculateWidth<TData>(int) Calculates the expected width of the Texture for a specific mip-level, in TData elements. public int CalculateWidth<TData>(int mipLevel = 0) where TData : unmanaged Parameters mipLevel int The mip-level for which to calculate the width. By default, the first mip-level at index 0 is selected, which is the most detailed one. Returns int The expected width of the Texture for the mip-level specified by mipLevel, y.e. the number of TData elements across the width of the Texture. Type Parameters TData The type of the pixel data. Remarks The expected width of the Texture depends both on the largestSize of Format and the largestSize of TData. It's relation (which must be an integer ratio) defines how they alter the original mip-level width. For example, for a Texture with a width of 100 pixels and format R8G8B8A8_UNorm (4 bytes per pixel), this method allows to interpret the width as different types: int widthAsUInts = texture.CalculateWidth<uint>(); // 100 uints int widthAsBytes = texture.CalculateWidth<byte>(); // 400 bytes int widthAsFloats = texture.CalculateWidth<float>(); // 100 floats Exceptions ArgumentException The largestSize of Format and the largestSize of TData does not match. The ratio between the two must be an integer, or else there would be remaining bytes. Clone() Creates a copy of the Texture. public Texture Clone() Returns Texture A copy of the Texture. Remarks This method creates a new Texture with the exact same characteristics, but does not copy the contents of the Texture to the new one. CountMipLevels(int) Counts the number of mip-levels for a one-dimensional Texture. public static int CountMipLevels(int width) Parameters width int The width of the Texture, in texels. Returns int The number of mip-levels that can be created for width. CountMipLevels(int, MipMapCount) Counts the number of mip-levels for a one-dimensional Texture. public static int CountMipLevels(int width, MipMapCount mipLevels) Parameters width int The width of the Texture, in texels. mipLevels MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. Returns int The number of mip-levels that can be created for width. Exceptions ArgumentOutOfRangeException mipLevels is greater than the maximum number of possible mip-levels for the provided width. CountMipLevels(int, int) Counts the number of mip-levels for a two-dimensional Texture. public static int CountMipLevels(int width, int height) Parameters width int The width of the Texture, in texels. height int The height of the Texture, in texels. Returns int The number of mip-levels that can be created for width and height. CountMipLevels(int, int, MipMapCount) Counts the number of mip-levels for a two-dimensional Texture. public static int CountMipLevels(int width, int height, MipMapCount mipLevels) Parameters width int The width of the Texture, in texels. height int The height of the Texture, in texels. mipLevels MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. Returns int The number of mip-levels that can be created for width and height. Exceptions ArgumentOutOfRangeException mipLevels is greater than the maximum number of possible mip-levels for the provided width and height. CountMipLevels(int, int, int) Counts the number of mip-levels for a three-dimensional Texture. public static int CountMipLevels(int width, int height, int depth) Parameters width int The width of the Texture, in texels. height int The height of the Texture, in texels. depth int The depth of the Texture, in texels. Returns int The number of mip-levels that can be created for width, height, and depth. CountMipLevels(int, int, int, MipMapCount) Counts the number of mip-levels for a three-dimensional Texture. public static int CountMipLevels(int width, int height, int depth, MipMapCount mipLevels) Parameters width int The width of the Texture, in texels. height int The height of the Texture, in texels. depth int The depth of the Texture, in texels. mipLevels MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. Returns int The number of mip-levels that can be created for width, height, and depth. Exceptions ArgumentOutOfRangeException mipLevels is greater than the maximum number of possible mip-levels for the provided width, height, and depth. ArgumentException width, height, and depth must all be a power of two. InvalidOperationException The dimensions must be a power of two (2^n). CountMips(int) Counts the number of mip-levels a Texture with the specified size can have. public static int CountMips(int width) Parameters width int The width of the Texture, in pixels. Returns int The maximum number of mip-levels for the given size. CountMips(int, int) Counts the number of mip-levels a Texture with the specified size can have. public static int CountMips(int width, int height) Parameters width int The width of the Texture, in pixels. height int The height of the Texture, in pixels. Returns int The maximum number of mip-levels for the given size. CountMips(int, int, int) Counts the number of mip-levels a Texture with the specified size can have. public static int CountMips(int width, int height, int depth) Parameters width int The width of the Texture, in pixels. height int The height of the Texture, in pixels. depth int The depth of the Texture, in pixels. Returns int The maximum number of mip-levels for the given size. Destroy() Disposes the resources associated with the Graphics Resource, removes itself from the GraphicsDevice's resource registry, and transitions to the Destroyed state. protected override void Destroy() GetData(CommandList, Texture, DataPointer, int, int, bool) Copies the contents of the Texture from GPU memory to CPU memory using a specific staging Resource. [Obsolete(\"This method is obsolete. Use the Span-based methods instead\")] public bool GetData(CommandList commandList, Texture stagingTexture, DataPointer toData, int arrayIndex = 0, int mipLevel = 0, bool doNotWait = false) Parameters commandList CommandList The CommandList where to register the command. stagingTexture Texture The staging Texture used to transfer the Texture contents to. toData DataPointer A ptrFromData to the data buffer in CPU memory to copy the Texture contents into. arrayIndex int The array index. If the Texture is not a Texture Array or a Cube-map, only a single array slice will exist with index 0, which is the default value. This index must be 0 for a three-dimensional Texture. mipLevel int The mip-level to get the data from. By default, the first mip-level at index 0 is selected, which is the most detailed one. doNotWait bool If true this method will return immediately if the resource is still being used by the GPU for writing. false makes this method wait until the operation is complete. The default value is false (wait). Returns bool true if data was correctly retrieved; false if doNotWait flag was true and the resource is still being used by the GPU for writing. Exceptions ArgumentException The length of the destination buffer toData is not compatible with the expected largestSize for the data at arrayIndex and mipLevel. GetDataAsImage(CommandList) Copies the contents of the Texture on GPU memory to an Image on the CPU. public Image GetDataAsImage(CommandList commandList) Parameters commandList CommandList The CommandList where to register the command. Returns Image The Image on CPU memory. GetDataAsImage(CommandList, Texture) Gets the contents of the Texture on GPU memory to an Image on the CPU. public Image GetDataAsImage(CommandList commandList, Texture stagingTexture) Parameters commandList CommandList The CommandList where to register the command. stagingTexture Texture The staging Texture used to temporarily transfer the image from GPU memory to CPU memory. Returns Image The Image on CPU memory. Exceptions ArgumentException stagingTexture is not a staging Texture. ArgumentNullException stagingTexture is null. GetData<T>(CommandList, Texture, Span<T>, int, int, bool) Copies the contents of the Texture from GPU memory to CPU memory using a specific staging Resource. public bool GetData<T>(CommandList commandList, Texture stagingTexture, Span<T> toData, int arrayIndex = 0, int mipLevel = 0, bool doNotWait = false) where T : unmanaged Parameters commandList CommandList The CommandList where to register the command. stagingTexture Texture The staging Texture used to transfer the Texture contents to. toData Span<T> The data buffer in CPU memory to copy the Texture contents into. arrayIndex int The array index. If the Texture is not a Texture Array or a Cube-map, only a single array slice will exist with index 0, which is the default value. This index must be 0 for a three-dimensional Texture. mipLevel int The mip-level to get the data from. By default, the first mip-level at index 0 is selected, which is the most detailed one. doNotWait bool If true this method will return immediately if the resource is still being used by the GPU for writing. false makes this method wait until the operation is complete. The default value is false (wait). Returns bool true if data was correctly retrieved; false if doNotWait flag was true and the resource is still being used by the GPU for writing. Type Parameters T Exceptions ArgumentException The length of the destination buffer toData is not compatible with the expected largestSize for the data at arrayIndex and mipLevel. GetData<TData>(CommandList, Texture, TData[], int, int, bool) Copies the contents of the Texture from GPU memory to CPU memory using a specific staging Resource. public bool GetData<TData>(CommandList commandList, Texture stagingTexture, TData[] toData, int arrayIndex = 0, int mipLevel = 0, bool doNotWait = false) where TData : unmanaged Parameters commandList CommandList The CommandList where to register the command. stagingTexture Texture The staging Texture used to transfer the Texture contents to. toData TData[] The destination buffer to copy the Texture data into. arrayIndex int The array index. If the Texture is not a Texture Array or a Cube-map, only a single array slice will exist with index 0, which is the default value. This index must be 0 for a three-dimensional Texture. mipLevel int The mip-level to get the data from. By default, the first mip-level at index 0 is selected, which is the most detailed one. doNotWait bool If true this method will return immediately if the resource is still being used by the GPU for writing. false makes this method wait until the operation is complete. The default value is false (wait). Returns bool true if data was correctly retrieved; false if doNotWait flag was true and the resource is still being used by the GPU for writing. Type Parameters TData The type of the pixel data. Exceptions ArgumentException The length of the destination buffer toData is not compatible with the expected largestSize for the data at arrayIndex and mipLevel. GetData<TData>(CommandList, int, int) Copies the contents of the Texture from GPU memory to CPU memory. public TData[] GetData<TData>(CommandList commandList, int arrayIndex = 0, int mipLevel = 0) where TData : unmanaged Parameters commandList CommandList The CommandList where to register the command. arrayIndex int The array index. If the Texture is not a Texture Array or a Cube-map, only a single array slice will exist with index 0, which is the default value. This index must be 0 for a three-dimensional Texture. mipLevel int The mip-level to get the data from. By default, the first mip-level at index 0 is selected, which is the most detailed one. Returns TData[] An array of TData with the Texture's data. Type Parameters TData The type of the pixel data. Remarks This method is only working when called from the main thread that is accessing the main GraphicsDevice. This method creates internally a staging Resource, copies the data into it, and maps it to CPU memory. You can use one of the methods that specify an explicit staging Resource for better performance. GetData<TData>(CommandList, TData[], int, int, bool) Copies the contents of the Texture from GPU memory to CPU memory. public bool GetData<TData>(CommandList commandList, TData[] toData, int arrayIndex = 0, int mipLevel = 0, bool doNotWait = false) where TData : unmanaged Parameters commandList CommandList The CommandList where to register the command. toData TData[] The destination buffer to copy the Texture data into. arrayIndex int The array index. If the Texture is not a Texture Array or a Cube-map, only a single array slice will exist with index 0, which is the default value. This index must be 0 for a three-dimensional Texture. mipLevel int The mip-level to get the data from. By default, the first mip-level at index 0 is selected, which is the most detailed one. doNotWait bool If true this method will return immediately if the resource is still being used by the GPU for writing. false makes this method wait until the operation is complete. The default value is false (wait). Returns bool true if data was correctly retrieved; false if doNotWait flag was true and the resource is still being used by the GPU for writing. Type Parameters TData The type of the pixel data. Remarks This method is only working when called from the main thread that is accessing the main GraphicsDevice. This method creates internally a staging Resource, copies the data into it, and maps it to CPU memory. You can use one of the methods that specify an explicit staging Resource for better performance. GetMipMapDescription(int) Gets the description a specific mipLevel of the Texture. public ref readonly MipMapDescription GetMipMapDescription(int mipLevel) Parameters mipLevel int The mipmap level to query. Returns MipMapDescription A MipMapDescription describing the requested mipmap. GetSubResourceIndex(int, int) Returns the absolute sub-resource index from an array slice and mip-level. public int GetSubResourceIndex(int arrayIndex, int mipLevel) Parameters arrayIndex int The array index. mipLevel int The mip slice index. Returns int The sub-resource absolute index, calculated as arrayIndex * Description.MipLevelCount + mipLevel. IsDepthStencilReadOnlySupported(GraphicsDevice) Checks if the specified GraphicsDevice supports binding a Depth-Stencil buffer as a read-only Render Target. public static bool IsDepthStencilReadOnlySupported(GraphicsDevice device) Parameters device GraphicsDevice The graphics device. Returns bool true if the device supports binding a Depth-Stencil buffer as a read-only Render Target View; false otherwise. See Also HasDepthAsReadOnlyRT Load(GraphicsDevice, Stream, TextureFlags, GraphicsResourceUsage, bool) Loads a Texture from a stream. public static Texture Load(GraphicsDevice device, Stream stream, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable, bool loadAsSrgb = false) Parameters device GraphicsDevice The GraphicsDevice. stream Stream The stream to load the Texture from. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Immutable, meaning it will need read access by the GPU. loadAsSrgb bool true if the Texture should be loaded as an sRGB Texture; false to load it in its default format. Returns Texture The loaded Texture. New(GraphicsDevice, Image, TextureFlags, GraphicsResourceUsage) Creates a new Texture from an Image. public static Texture New(GraphicsDevice device, Image image, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) Parameters device GraphicsDevice The GraphicsDevice. image Image An Image to create the Texture from. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Immutable, meaning it will need read access by the GPU. Returns Texture The loaded Texture. Exceptions ArgumentNullException device is null, or image is null. New(GraphicsDevice, TextureDescription, params DataBox[]) Creates a new Texture with the specified description. public static Texture New(GraphicsDevice graphicsDevice, TextureDescription description, params DataBox[] boxes) Parameters graphicsDevice GraphicsDevice description TextureDescription A TextureDescription for the new Texture. boxes DataBox[] An optional array of DataBox structures describing the initial data for all the sub-Resources of the new Texture. Returns Texture The new Texture. Exceptions ArgumentNullException graphicsDevice New(GraphicsDevice, TextureDescription, TextureViewDescription, params DataBox[]) Creates a new Texture with the specified description. public static Texture New(GraphicsDevice graphicsDevice, TextureDescription description, TextureViewDescription viewDescription, params DataBox[] boxes) Parameters graphicsDevice GraphicsDevice description TextureDescription A TextureDescription for the new Texture. viewDescription TextureViewDescription A TextureViewDescription describing a Texture View that will be created the same time. boxes DataBox[] An optional array of DataBox structures describing the initial data for all the sub-Resources of the new Texture. Returns Texture The new Texture. Exceptions ArgumentNullException graphicsDevice is null. NotSupportedException The Texture's Flags and the ViewFlags are not compatible. The parent Texture must include all the flags defined by the Texture View, or The MultisampleCount is not supported for the specified Format. Check the Features for information about supported pixel formats and the compatible multi-sample counts. New1D(GraphicsDevice, int, MipMapCount, PixelFormat, TextureFlags, int, GraphicsResourceUsage) Creates a new one-dimensional (1D) Texture. public static Texture New1D(GraphicsDevice device, int width, MipMapCount mipCount, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, int arraySize = 1, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. mipCount MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. arraySize int The number of array slices for the Texture. The default value is 1, indicating the Texture is not a Texture Array. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns Texture A new one-dimensional Texture. New1D(GraphicsDevice, int, PixelFormat, TextureFlags, int, GraphicsResourceUsage) Creates a new one-dimensional (1D) Texture with a single mipmap. public static Texture New1D(GraphicsDevice device, int width, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, int arraySize = 1, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. arraySize int The number of array slices for the Texture. The default value is 1, indicating the Texture is not a Texture Array. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns Texture A new one-dimensional Texture. New1D(GraphicsDevice, int, PixelFormat, nint, TextureFlags, GraphicsResourceUsage) Creates a new one-dimensional (1D) Texture with initial data and a single mipmap. public static Texture New1D(GraphicsDevice device, int width, PixelFormat format, nint dataPtr, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. format PixelFormat The format to use. dataPtr nint A pointer to the data to upload to the Texture. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Immutable, meaning it will need read access by the GPU. Returns Texture A new one-dimensional Texture. New1D<T>(GraphicsDevice, int, PixelFormat, T[], TextureFlags, GraphicsResourceUsage) Creates a new one-dimensional (1D) Texture with initial data and a single mipmap. public static Texture New1D<T>(GraphicsDevice device, int width, PixelFormat format, T[] textureData, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. format PixelFormat The format to use. textureData T[] The initial data array to upload to the Texture. It must have a size (in bytes, not elements) equal to the size of the format times the width. See PixelFormatExtensions.SizeInBytes(PixelFormat) for calculating the size of a pixel format. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Immutable, meaning it will need read access by the GPU. Returns Texture A new one-dimensional Texture. Type Parameters T Type of the initial data to upload to the Texture. New2D(GraphicsDevice, int, int, MipMapCount, PixelFormat, DataBox[], TextureFlags, int, GraphicsResourceUsage, MultisampleCount, TextureOptions) Creates a new two-dimensional (2D) Texture with initial data. public static Texture New2D(GraphicsDevice device, int width, int height, MipMapCount mipCount, PixelFormat format, DataBox[] textureData, TextureFlags textureFlags = TextureFlags.ShaderResource, int arraySize = 1, GraphicsResourceUsage usage = GraphicsResourceUsage.Default, MultisampleCount multisampleCount = MultisampleCount.None, TextureOptions options = TextureOptions.None) Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. height int The height of the Texture in texels. mipCount MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. format PixelFormat The format to use. textureData DataBox[] An array of DataBox pointing to the initial Texture data for each of the mipmaps. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. arraySize int The number of array slices for the Texture. The default value is 1, indicating the Texture is not a Texture Array. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. multisampleCount MultisampleCount The number of samples per texel the Texture will have. The default value is None, indicating a non-multisampled Texture. options TextureOptions A combination of flags indicating options about the creation of the Texture, like creating it as a shared resource. The default value is None. Returns Texture A new two-dimensional Texture. New2D(GraphicsDevice, int, int, MipMapCount, PixelFormat, TextureFlags, int, GraphicsResourceUsage, TextureOptions) Creates a new two-dimensional (2D) Texture. public static Texture New2D(GraphicsDevice device, int width, int height, MipMapCount mipCount, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, int arraySize = 1, GraphicsResourceUsage usage = GraphicsResourceUsage.Default, TextureOptions options = TextureOptions.None) Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. height int The height of the Texture in texels. mipCount MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. arraySize int The number of array slices for the Texture. The default value is 1, indicating the Texture is not a Texture Array. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. options TextureOptions A combination of flags indicating options about the creation of the Texture, like creating it as a shared resource. The default value is None. Returns Texture A new two-dimensional Texture. New2D(GraphicsDevice, int, int, PixelFormat, TextureFlags, int, GraphicsResourceUsage, TextureOptions) Creates a new two-dimensional (2D) Texture with a single mipmap. public static Texture New2D(GraphicsDevice device, int width, int height, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, int arraySize = 1, GraphicsResourceUsage usage = GraphicsResourceUsage.Default, TextureOptions options = TextureOptions.None) Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. height int The height of the Texture in texels. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. arraySize int The number of array slices for the Texture. The default value is 1, indicating the Texture is not a Texture Array. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. options TextureOptions A combination of flags indicating options about the creation of the Texture, like creating it as a shared resource. The default value is None. Returns Texture A new two-dimensional Texture. New2D<T>(GraphicsDevice, int, int, PixelFormat, T[], TextureFlags, GraphicsResourceUsage, TextureOptions) Creates a new two-dimensional (2D) Texture with initial data and a single mipmap. public static Texture New2D<T>(GraphicsDevice device, int width, int height, PixelFormat format, T[] textureData, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable, TextureOptions options = TextureOptions.None) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. height int The height of the Texture in texels. format PixelFormat The format to use. textureData T[] The initial data array to upload to the Texture for a single mipmap and a single array slice. It must have a size (in bytes, not elements) equal to the size of the format times (width * height). See PixelFormatExtensions.SizeInBytes(PixelFormat) for calculating the size of a pixel format. Each value in the data array will be a texel in the destination Texture. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Immutable, meaning it will need read access by the GPU. options TextureOptions A combination of flags indicating options about the creation of the Texture, like creating it as a shared resource. The default value is None. Returns Texture A new two-dimensional Texture. Type Parameters T Type of the initial data to upload to the Texture. New3D(GraphicsDevice, int, int, int, MipMapCount, PixelFormat, DataBox[], TextureFlags, GraphicsResourceUsage) Creates a new three-dimensional (3D) Texture (also known as a volume texture) with initial data. public static Texture New3D(GraphicsDevice device, int width, int height, int depth, MipMapCount mipCount, PixelFormat format, DataBox[] textureData, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. height int The height of the Texture in texels. depth int The depth of the Texture in texels. mipCount MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. format PixelFormat The format to use. textureData DataBox[] An array of DataBox pointing to the initial data to upload for each of the mipmaps. The first element will be the largest mipmap, and each successive element is for the smaller ones. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns Texture A new three-dimensional Texture. New3D(GraphicsDevice, int, int, int, MipMapCount, PixelFormat, TextureFlags, GraphicsResourceUsage) Creates a new three-dimensional (3D) Texture (also known as a volume texture). public static Texture New3D(GraphicsDevice device, int width, int height, int depth, MipMapCount mipCount, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. height int The height of the Texture in texels. depth int The depth of the Texture in texels. mipCount MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns Texture A new three-dimensional Texture. New3D(GraphicsDevice, int, int, int, PixelFormat, TextureFlags, GraphicsResourceUsage) Creates a new three-dimensional (3D) Texture (also known as a volume texture) with a single mipmap. public static Texture New3D(GraphicsDevice device, int width, int height, int depth, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. height int The height of the Texture in texels. depth int The depth of the Texture in texels. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns Texture A new three-dimensional Texture. New3D<T>(GraphicsDevice, int, int, int, PixelFormat, T[], TextureFlags, GraphicsResourceUsage) Creates a new three-dimensional (3D) Texture (also known as a volume texture) with initial data and a single mipmap. public static Texture New3D<T>(GraphicsDevice device, int width, int height, int depth, PixelFormat format, T[] textureData, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. width int The width of the Texture in texels. height int The height of the Texture in texels. depth int The depth of the Texture in texels. format PixelFormat The format to use. textureData T[] The initial data array to upload to the Texture for a single mipmap and a single array slice. It must have a size (in bytes, not elements) equal to the size of the format times (width * height * depth). See PixelFormatExtensions.SizeInBytes(PixelFormat) for calculating the size of a pixel format. Each value in the data array will be a texel in the destination Texture. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Immutable, meaning it will need read access by the GPU. Returns Texture A new three-dimensional Texture. Type Parameters T Type of the initial data to upload to the Texture. NewCube(GraphicsDevice, int, MipMapCount, PixelFormat, TextureFlags, GraphicsResourceUsage) Creates a new cube-map composed of six two-dimensional (2D) Textures. public static Texture NewCube(GraphicsDevice device, int size, MipMapCount mipCount, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. size int The size in texels of the faces of the cube Texture. As the Texture is a cube, this single value specifies both the width and the height. mipCount MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns Texture A new cube-map Texture. NewCube(GraphicsDevice, int, PixelFormat, DataBox[], TextureFlags, GraphicsResourceUsage) Creates a new cube-map composed of six two-dimensional (2D) Textures from a initial data. public static Texture NewCube(GraphicsDevice device, int size, PixelFormat format, DataBox[] textureData, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) Parameters device GraphicsDevice The GraphicsDevice. size int The size in texels of the faces of the cube Texture. As the Texture is a cube, this single value specifies both the width and the height. format PixelFormat The format to use. textureData DataBox[] An array of DataBox pointing to the initial Texture data for each of cube faces. There must be exactly six. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Immutable, meaning it will need read access by the GPU. Returns Texture A new cube-map Texture. Remarks The first dimension of mipMapTextures describes the number of array (TextureCube Array), the second is the texture data for a particular cube face. Exceptions ArgumentException The Texture data is invalid. There must be exactly six elements in the array. NewCube(GraphicsDevice, int, PixelFormat, TextureFlags, GraphicsResourceUsage) Creates a new cube-map composed of six two-dimensional (2D) Textures. public static Texture NewCube(GraphicsDevice device, int size, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters device GraphicsDevice The GraphicsDevice. size int The size in texels of the faces of the cube Texture. As the Texture is a cube, this single value specifies both the width and the height. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns Texture A new cube-map Texture. NewCube<T>(GraphicsDevice, int, PixelFormat, T[][], TextureFlags, GraphicsResourceUsage) Creates a new cube-map composed of six two-dimensional (2D) Textures from a initial data. public static Texture NewCube<T>(GraphicsDevice device, int size, PixelFormat format, T[][] textureData, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) where T : unmanaged Parameters device GraphicsDevice The GraphicsDevice. size int The size in texels of the faces of the cube Texture. As the Texture is a cube, this single value specifies both the width and the height. format PixelFormat The format to use. textureData T[][] The initial data array to upload to the Texture for a single mipmap. It is an array of arrays (two dimensions): The first dimension of the array is the index of the cube face. There must be exactly six. The second dimension is the data for each of the cube faces. It must have a size (in bytes, not elements) equal to the size of the format times (size * size). See PixelFormatExtensions.SizeInBytes(PixelFormat) for calculating the size of a pixel format. Each value in the data array of each of the cube faces will be a texel in the destination Texture. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Immutable, meaning it will need read access by the GPU. Returns Texture A new cube-map Texture. Type Parameters T Type of the initial data to upload to the Texture. Exceptions ArgumentException The Texture data is invalid. The first dimension of textureData array must be equal to 6. OnDestroyed(bool) Called when the GraphicsDevice has been detected to be internally destroyed, or when the Destroy() methad has been called. Raises the Destroyed event. protected override void OnDestroyed(bool immediately = false) Parameters immediately bool A value indicating whether the Texture should be destroyed immediately (true), or if it can be deferred until it's safe to do so (false). Remarks This method releases all the native resources associated with the Texture: If it is a Texture, this releases the underlying native texture resource and also the associated Views. If it is a Texture View, it releases only the resources related to the View, not the parent Texture's. OnRecreate() Called when the GraphicsDevice has been recreated. protected override bool OnRecreate() Returns bool true if resource has transitioned to the Active state. Recreate(DataBox[]) Recreates the Texture from the specified data. public void Recreate(DataBox[] dataBoxes = null) Parameters dataBoxes DataBox[] An array of DataBox structures pointing to the data for all the subresources to initialize for the Texture. ReleaseData() Releases the Texture data. public void ReleaseData() Save(CommandList, Stream, ImageFileType) Saves the Texture to a stream with the specified image format. public void Save(CommandList commandList, Stream stream, ImageFileType fileType) Parameters commandList CommandList The CommandList where to register the command. stream Stream The stream to write the Texture contents to. fileType ImageFileType The type of the image file to create. Exceptions ArgumentNullException stream is null. Save(CommandList, Stream, Texture, ImageFileType) Saves the Texture to a stream with a specified format. public void Save(CommandList commandList, Stream stream, Texture stagingTexture, ImageFileType fileType) Parameters commandList CommandList The CommandList where to register the command. stream Stream The stream to write the Texture to. stagingTexture Texture The staging Texture used to temporarily transfer the image from GPU memory to CPU memory. fileType ImageFileType The type of the image file to create. Exceptions ArgumentException stagingTexture is not a staging Texture. SetData(CommandList, DataPointer, int, int, ResourceRegion?) Copies the contents of a data buffer on CPU memory into the Texture in GPU memory. [Obsolete(\"This method is obsolete. Use the Span-based methods instead\")] public void SetData(CommandList commandList, DataPointer fromData, int arrayIndex = 0, int mipLevel = 0, ResourceRegion? region = null) Parameters commandList CommandList The CommandList where to register the command. fromData DataPointer A ptrFromData to the data buffer to copy from. arrayIndex int The array index. If the Texture is not a Texture Array or a Cube-map, only a single array slice will exist with index 0, which is the default value. This index must be 0 for a three-dimensional Texture. mipLevel int The mip-level to copy the data to. By default, the first mip-level at index 0 is selected, which is the most detailed one. region ResourceRegion? An optional ResourceRegion describing the region of data of the Texture to copy into. Specify null to copy to the whole sub-Resource at arrayIndex/mipLevel. Remarks See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions. Exceptions ArgumentException The length of fromData is not compatible with the expected largestSize for the data at arrayIndex and mipLevel. This can also occur when the stride is different from the optimal stride, and TData is not the same largestSize as the largestSize of Format. ArgumentException region can only be specified (non-null) for Textures with Default. ArgumentOutOfRangeException The region largestSize (in any of its dimensions) cannot be greater than the mip-level largestSize. SetData<TData>(CommandList, ReadOnlySpan<TData>, int, int, ResourceRegion?) Copies the contents of a data buffer on CPU memory into the Texture in GPU memory. public void SetData<TData>(CommandList commandList, ReadOnlySpan<TData> fromData, int arrayIndex = 0, int mipLevel = 0, ResourceRegion? region = null) where TData : unmanaged Parameters commandList CommandList The CommandList where to register the command. fromData ReadOnlySpan<TData> The data buffer to copy from. arrayIndex int The array index. If the Texture is not a Texture Array or a Cube-map, only a single array slice will exist with index 0, which is the default value. This index must be 0 for a three-dimensional Texture. mipLevel int The mip-level to copy the data to. By default, the first mip-level at index 0 is selected, which is the most detailed one. region ResourceRegion? An optional ResourceRegion describing the region of data of the Texture to copy into. Specify null to copy to the whole sub-Resource at arrayIndex/mipLevel. Type Parameters TData The type of the pixel data. Remarks See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions. Exceptions ArgumentException The length of fromData is not compatible with the expected largestSize for the data at arrayIndex and mipLevel. This can also occur when the stride is different from the optimal stride, and TData is not the same largestSize as the largestSize of Format. ArgumentException region can only be specified (non-null) for Textures with Default. ArgumentOutOfRangeException The region largestSize (in any of its dimensions) cannot be greater than the mip-level largestSize. SetData<TData>(CommandList, TData[], int, int, ResourceRegion?) Copies the contents of an array of data on CPU memory into the Texture in GPU memory. public void SetData<TData>(CommandList commandList, TData[] fromData, int arrayIndex = 0, int mipLevel = 0, ResourceRegion? region = null) where TData : unmanaged Parameters commandList CommandList The CommandList where to register the command. fromData TData[] The data buffer to copy from. arrayIndex int The array index. If the Texture is not a Texture Array or a Cube-map, only a single array slice will exist with index 0, which is the default value. This index must be 0 for a three-dimensional Texture. mipLevel int The mip-level to copy the data to. By default, the first mip-level at index 0 is selected, which is the most detailed one. region ResourceRegion? An optional ResourceRegion describing the region of data of the Texture to copy into. Specify null to copy to the whole sub-Resource at arrayIndex/mipLevel. Type Parameters TData The type of the pixel data. Remarks See MapSubResource(GraphicsResource, int, MapMode, bool, int, int) and UpdateSubResource(GraphicsResource, int, DataBox, ResourceRegion) for more information about usage and restrictions. Exceptions ArgumentException The length of fromData is not compatible with the expected largestSize for the data at arrayIndex and mipLevel. This can also occur when the stride is different from the optimal stride, and TData is not the same largestSize as the largestSize of Format. ArgumentException region can only be specified (non-null) for Textures with Default. ArgumentOutOfRangeException The region largestSize (in any of its dimensions) cannot be greater than the mip-level largestSize. ToStaging() Creates a new Texture with the needed changes to serve as a staging Texture that can be read / written by the CPU. public Texture ToStaging() Returns Texture The equivalent staging Texture. ToTextureView(TextureViewDescription) Gets a Texture View on this Texture. public Texture ToTextureView(TextureViewDescription viewDescription) Parameters viewDescription TextureViewDescription The description of the Texture View to create. Returns Texture A new Texture that represents the requested Texture View. Exceptions NotSupportedException The Texture's Flags and the ViewFlags are not compatible. The parent Texture must include all the flags defined by the Texture View, or The MultisampleCount is not supported for the specified Format. Check the Features for information about supported pixel formats and the compatible multi-sample counts."
  },
  "api/Stride.Graphics.TextureAddressMode.html": {
    "href": "api/Stride.Graphics.TextureAddressMode.html",
    "title": "Enum TextureAddressMode | Stride API",
    "summary": "Enum TextureAddressMode Namespace Stride.Graphics Assembly Stride.dll Identifies a technique for resolving Texture coordinates that are outside of the boundaries of a Texture (outside the [0, 1] range). [DataContract(\"TextureAddressMode\")] public enum TextureAddressMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Border = 4 Texture coordinates outside the range [0, 1] are set to the border color specified in SamplerState or HLSL code. Clamp = 3 Texture coordinates outside the range [0, 1] are set to the Texture color at 0 or 1, respectively. Mirror = 2 Flip the Texture at every (u,v) integer junction. For u values between 0 and 1, for example, the Texture is addressed normally; between 1 and 2, the Texture is flipped (mirrored); between 2 and 3, the Texture is normal again; and so on. MirrorOnce = 5 Similar to Mirror and Clamp. Takes the absolute value of the Texture coordinate (thus, mirroring around 0), and then clamps to the maximum value. Wrap = 1 Tile the Texture at every (u,v) integer junction. For example, for u values between 0 and 3, the Texture is repeated three times."
  },
  "api/Stride.Graphics.TextureDescription.html": {
    "href": "api/Stride.Graphics.TextureDescription.html",
    "title": "Struct TextureDescription | Stride API",
    "summary": "Struct TextureDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll A structure providing a common description for all kinds of Textures. public struct TextureDescription : IEquatable<TextureDescription> Implements IEquatable<TextureDescription> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ArraySize The number of Textures in the Texture Array. public int ArraySize Field Value int Remarks The range of this value is from 1 to the maximum supported array size, which is constrained by the graphics profile of the device. This field is valid for Texture1D, Texture2D, and TextureCube. See Also MaximumTexture1DArraySize MaximumTexture2DArraySize Depth The Texture depth in texels. public int Depth Field Value int Remarks The range of this value is from 1 to the maximum supported size, which is constrained by the graphics profile of the device. This field is valid for Texture3D. See Also MaximumTexture3DSize Dimension The dimension (type) of the Texture. public TextureDimension Dimension Field Value TextureDimension Flags A combination of flags describing how the Texture is to be bound to the stages of the graphics pipeline. public TextureFlags Flags Field Value TextureFlags Format The format of the Texture. public PixelFormat Format Field Value PixelFormat Height The Texture height in texels. public int Height Field Value int Remarks The range of this value is from 1 to the maximum supported size, which is constrained by the graphics profile of the device. This field is valid for Texture2D, Texture3D, and TextureCube. See Also MaximumTexture2DSize MaximumTexture3DSize MaximumTextureCubeSize MipLevelCount The number of mipmap levels in the Texture. public int MipLevelCount Field Value int Remarks The range of this value is from 1 to MaximumMipLevels, which is constrained by the graphics profile of the device. Use 1 for a multisampled Texture; or 0 to generate a full set of subtextures. See Also MaximumMipLevels MultisampleCount The level of multisampling for the Texture. public MultisampleCount MultisampleCount Field Value MultisampleCount Remarks This field is only valid for Texture2D. Options A combination of flags specifying options for Textures, like creating them as shared resources. public TextureOptions Options Field Value TextureOptions Remarks This field must be None when creating Textures with CPU access flags. Usage A value that indicates how the Texture is to be read from and written to. public GraphicsResourceUsage Usage Field Value GraphicsResourceUsage Remarks The most common value is Default. Width The Texture width in texels. public int Width Field Value int Remarks The range of this value is from 1 to the maximum supported size, which is constrained by the graphics profile of the device. This field is valid for all textures: Texture1D, Texture2D, Texture3D, and TextureCube. See Also MaximumTexture1DSize MaximumTexture2DSize MaximumTexture3DSize MaximumTextureCubeSize Properties IsDepthStencil Gets a value indicating whether the Texture is a Depth-Stencil buffer. public readonly bool IsDepthStencil { get; } Property Value bool true if the Texture is a Depth-Stencil buffer; otherwise, false. IsMultiSampled Gets a value indicating whether the Texture is a multi-sampled Texture. public readonly bool IsMultiSampled { get; } Property Value bool true if the Texture is multi-sampled; otherwise, false. IsRenderTarget Gets a value indicating whether the Texture is a Render Target. public readonly bool IsRenderTarget { get; } Property Value bool true if the Texture is a Render Target; otherwise, false. IsShaderResource Gets a value indicating whether the Texture is a Shader Resource. public readonly bool IsShaderResource { get; } Property Value bool true if the Texture is a Shader Resource; otherwise, false. IsUnorderedAccess Gets a value indicating whether the Texture is a created to allow Unordered Access when used as Shader Resource. public readonly bool IsUnorderedAccess { get; } Property Value bool true if the Texture allows Unordered Access; otherwise, false. Methods Equals(TextureDescription) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(TextureDescription other) Parameters other TextureDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FromDescription(TextureDescription, TextureFlags, GraphicsResourceUsage) Creates a new description from another description but overrides Flags and Usage. public static TextureDescription FromDescription(TextureDescription description, TextureFlags textureFlags, GraphicsResourceUsage usage) Parameters description TextureDescription The Texture Description to copy. textureFlags TextureFlags The new Texture flags. usage GraphicsResourceUsage The new usage. Returns TextureDescription A modified copy of the specified description. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. New1D(int, MipMapCount, PixelFormat, TextureFlags, int, GraphicsResourceUsage) Creates a new TextureDescription for a one-dimensional (1D) Texture. public static TextureDescription New1D(int width, MipMapCount mipCount, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, int arraySize = 1, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters width int The width of the Texture in texels. mipCount MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. arraySize int The number of array slices for the Texture. The default value is 1, indicating the Texture is not a Texture Array. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns TextureDescription A new description for a one-dimensional Texture. New1D(int, PixelFormat, TextureFlags, GraphicsResourceUsage) Creates a new TextureDescription for a one-dimensional (1D) Texture with a single mipmap. public static TextureDescription New1D(int width, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Immutable) Parameters width int The width of the Texture in texels. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns TextureDescription A new description for a one-dimensional Texture. New1D(int, PixelFormat, TextureFlags, int, GraphicsResourceUsage) Creates a new TextureDescription for a one-dimensional (1D) Texture with a single mipmap. public static TextureDescription New1D(int width, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, int arraySize = 1, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters width int The width of the Texture in texels. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. arraySize int The number of array slices for the Texture. The default value is 1, indicating the Texture is not a Texture Array. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns TextureDescription A new description for a one-dimensional Texture. New2D(int, int, MipMapCount, PixelFormat, TextureFlags, int, GraphicsResourceUsage, MultisampleCount, TextureOptions) Creates a new TextureDescription for a two-dimensional (2D) Texture. public static TextureDescription New2D(int width, int height, MipMapCount mipCount, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, int arraySize = 1, GraphicsResourceUsage usage = GraphicsResourceUsage.Default, MultisampleCount multisampleCount = MultisampleCount.None, TextureOptions textureOptions = TextureOptions.None) Parameters width int The width of the Texture in texels. height int The height of the Texture in texels. mipCount MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. arraySize int The number of array slices for the Texture. The default value is 1, indicating the Texture is not a Texture Array. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. multisampleCount MultisampleCount The number of samples per texel the Texture will have. The default value is None, indicating a non-multisampled Texture. textureOptions TextureOptions A combination of flags indicating options about the creation of the Texture, like creating it as a shared resource. The default value is None. Returns TextureDescription A new description for a two-dimensional Texture. New2D(int, int, PixelFormat, TextureFlags, int, GraphicsResourceUsage, TextureOptions) Creates a new TextureDescription for a two-dimensional (2D) Texture with a single mipmap. public static TextureDescription New2D(int width, int height, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, int arraySize = 1, GraphicsResourceUsage usage = GraphicsResourceUsage.Default, TextureOptions textureOptions = TextureOptions.None) Parameters width int The width of the Texture in texels. height int The height of the Texture in texels. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. arraySize int The number of array slices for the Texture. The default value is 1, indicating the Texture is not a Texture Array. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. textureOptions TextureOptions A combination of flags indicating options about the creation of the Texture, like creating it as a shared resource. The default value is None. Returns TextureDescription A new description for a two-dimensional Texture. New3D(int, int, int, MipMapCount, PixelFormat, TextureFlags, GraphicsResourceUsage) Creates a new TextureDescription for a three-dimensional (3D) Texture. public static TextureDescription New3D(int width, int height, int depth, MipMapCount mipCount, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters width int The width of the Texture in texels. height int The height of the Texture in texels. depth int The depth of the Texture in texels. mipCount MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns TextureDescription A new description for a three-dimensional Texture. New3D(int, int, int, PixelFormat, TextureFlags, GraphicsResourceUsage) Creates a new TextureDescription for a three-dimensional (3D) Texture with a single mipmap. public static TextureDescription New3D(int width, int height, int depth, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters width int The width of the Texture in texels. height int The height of the Texture in texels. depth int The depth of the Texture in texels. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns TextureDescription A new description for a three-dimensional Texture. NewCube(int, MipMapCount, PixelFormat, TextureFlags, GraphicsResourceUsage) Creates a new TextureDescription for a cube-map composed of six two-dimensional (2D) Textures. public static TextureDescription NewCube(int size, MipMapCount mipCount, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters size int The size in texels of the faces of the cube Texture. As the Texture is a cube, this single value specifies both the width and the height. mipCount MipMapCount A MipMapCount structure describing the number of mipmaps for the Texture. Specify Auto to have all mipmaps, or One to indicate a single mipmap, or any number greater than 1 for a particular mipmap count. You can also specify a number (which will be converted implicitly) or a bool. See MipMapCount for more information about accepted values. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns TextureDescription A new description for a cube-map Texture. NewCube(int, PixelFormat, TextureFlags, GraphicsResourceUsage) Creates a new TextureDescription for a cube-map composed of six two-dimensional (2D) Textures with a single mipmap. public static TextureDescription NewCube(int size, PixelFormat format, TextureFlags textureFlags = TextureFlags.ShaderResource, GraphicsResourceUsage usage = GraphicsResourceUsage.Default) Parameters size int The size in texels of the faces of the cube Texture. As the Texture is a cube, this single value specifies both the width and the height. format PixelFormat The format to use. textureFlags TextureFlags A combination of flags determining what kind of Texture and how the is should behave (i.e. how it is bound, how can it be read / written, etc.). By default, it is ShaderResource. usage GraphicsResourceUsage A combination of flags determining how the Texture will be used during rendering. The default is Default, meaning it will need read/write access by the GPU. Returns TextureDescription A new description for a cube-map Texture. ToCloneableDescription() Returns a copy of this Texture Description modified so if the Texture is Immutable, it is switched to Default. public readonly TextureDescription ToCloneableDescription() Returns TextureDescription A modified copy of this Texture Description. ToStagingDescription() Returns a copy of this Texture Description modified to describe a staging Texture. public readonly TextureDescription ToStagingDescription() Returns TextureDescription A staging Texture Description. Operators operator ==(TextureDescription, TextureDescription) public static bool operator ==(TextureDescription left, TextureDescription right) Parameters left TextureDescription right TextureDescription Returns bool implicit operator TextureDescription(ImageDescription) Performs an explicit conversion from ImageDescription to TextureDescription. public static implicit operator TextureDescription(ImageDescription description) Parameters description ImageDescription The Image Description to convert. Returns TextureDescription The result of the conversion. implicit operator ImageDescription(TextureDescription) Performs an implicit conversion from TextureDescription to ImageDescription. public static implicit operator ImageDescription(TextureDescription description) Parameters description TextureDescription The Texture Description to convert. Returns ImageDescription The result of the conversion. operator !=(TextureDescription, TextureDescription) public static bool operator !=(TextureDescription left, TextureDescription right) Parameters left TextureDescription right TextureDescription Returns bool"
  },
  "api/Stride.Graphics.TextureDimension.html": {
    "href": "api/Stride.Graphics.TextureDimension.html",
    "title": "Enum TextureDimension | Stride API",
    "summary": "Enum TextureDimension Namespace Stride.Graphics Assembly Stride.dll Identifies the type of Texture resource being used. [DataContract] public enum TextureDimension Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Texture1D = 0 The Texture is a one-dimensional (1D) texture. Texture2D = 1 The Texture is a two-dimensional (2D) texture. Texture3D = 2 The Texture is a three-dimensional (3D) texture (also known as a Volume Texture). TextureCube = 3 The Texture is a Cube Map, six two-dimensional images forming a cube, each with their own mip-chain."
  },
  "api/Stride.Graphics.TextureExtensions.html": {
    "href": "api/Stride.Graphics.TextureExtensions.html",
    "title": "Class TextureExtensions | Stride API",
    "summary": "Class TextureExtensions Namespace Stride.Graphics Assembly Stride.Graphics.dll public static class TextureExtensions Inheritance object TextureExtensions Methods CreateDepthTextureCompatible(Texture) Creates a Shader Resource View on a Depth-Stencil Texture. public static Texture CreateDepthTextureCompatible(this Texture texture) Parameters texture Texture The Texture to create a Depth-Stencil Texture View for. Returns Texture A new Texture representing the Texture View bound to texture. EnsureRenderTarget(Texture) Verifies that a given Texture is a Render Target. public static Texture EnsureRenderTarget(this Texture texture) Parameters texture Texture Returns Texture Exceptions ArgumentException FromFileData(GraphicsDevice, byte[]) Creates a Texture from image file data. public static Texture FromFileData(GraphicsDevice graphicsDevice, byte[] data) Parameters graphicsDevice GraphicsDevice The graphics device in which to create the Texture. data byte[] The image file data. Returns Texture The created Texture. ToDepthStencilReadOnlyTexture(Texture) Creates a Shader Resource View that is read-only on a Depth-Stencil Texture. public static Texture ToDepthStencilReadOnlyTexture(this Texture texture) Parameters texture Texture The Texture to create a read-only Depth-Stencil Texture View for. Returns Texture A new Texture representing the Texture View bound to texture. ToTextureView(Texture, ViewType, int, int) Creates a Shader Resource View for a Texture. public static Texture ToTextureView(this Texture texture, ViewType viewType, int arraySlice, int mipLevel) Parameters texture Texture The Texture to create a Shader Resource View for. viewType ViewType One of the values of ViewType indicating which sub-resources from the Texture's mip hierarchy and array slices (if a Texture Array) the Shader Resource View can access. arraySlice int The index of the array slice. It is zero-based, so the first index is 0. If the Texture is not a Texture Array, specify 0. mipLevel int The index of the mip level. It is zero-based, so the first index is 0. If the Texture has no mip-chain, specify 0. Returns Texture A new Texture representing the Texture View bound to texture."
  },
  "api/Stride.Graphics.TextureFilter.html": {
    "href": "api/Stride.Graphics.TextureFilter.html",
    "title": "Enum TextureFilter | Stride API",
    "summary": "Enum TextureFilter Namespace Stride.Graphics Assembly Stride.dll Identifies the filtering mode to use during Texture sampling. [DataContract(\"TextureFilter\")] public enum TextureFilter Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Anisotropic = 85 Use anisotropic interpolation for minification, magnification, and mip-level sampling. When viewing a surface at a shallow angle, the Texture is stretched according to the perspective. Point or linear interpolation sample in a circular area independent of the viewing angle, producing a blurry or smeared appearance. Anisotropic filtering addresses this by sampling Textures differently depending on the angle of the surface relative to the viewer. Instead of assuming a circular sampling footprint (as in isotropic methods like bilinear filtering), it stretches the sampling region into an ellipse or more complex shapes that better fit the distorted projection of the Texture, and takes more samples along that direction, depending on the anisotropy level. It also interacts with mipmapping, selecting and interpolating from the appropriate mipmap levels, to ensure that the correct Texture resolution is used, even when viewed at extreme angles. ComparisonAnisotropic = 213 Use anisotropic interpolation for minification, magnification, and mip-level sampling. Compare the result to the comparison value. Comparison filtering compares each sampled texel against a comparison value. The boolean result is blended the same way that normal texture filtering is blended. Comparison filters only work with textures that have the following formats: R32_Float_X8X24_Typeless, R32_Float, R24_UNorm_X8_Typeless, and R16_UNorm. ComparisonLinear = 149 Use linear interpolation for minification, magnification, and mip-level sampling. Compare the result to the comparison value. Comparison filtering compares each sampled texel against a comparison value. The boolean result is blended the same way that normal texture filtering is blended. Comparison filters only work with textures that have the following formats: R32_Float_X8X24_Typeless, R32_Float, R24_UNorm_X8_Typeless, and R16_UNorm. ComparisonMinLinearMagMipPoint = 144 Use linear interpolation for minification, and point sampling for magnification and mip-level sampling. Compare the result to the comparison value. Comparison filtering compares each sampled texel against a comparison value. The boolean result is blended the same way that normal texture filtering is blended. Comparison filters only work with textures that have the following formats: R32_Float_X8X24_Typeless, R32_Float, R24_UNorm_X8_Typeless, and R16_UNorm. ComparisonMinLinearMagPointMipLinear = 145 Use linear interpolation for minification, point sampling for magnification, and linear interpolation for mip-level sampling. Compare the result to the comparison value. Comparison filtering compares each sampled texel against a comparison value. The boolean result is blended the same way that normal texture filtering is blended. Comparison filters only work with textures that have the following formats: R32_Float_X8X24_Typeless, R32_Float, R24_UNorm_X8_Typeless, and R16_UNorm. ComparisonMinMagLinearMipPoint = 148 Use linear interpolation for minification and magnification, and point sampling for mip-level sampling. Compare the result to the comparison value. Comparison filtering compares each sampled texel against a comparison value. The boolean result is blended the same way that normal texture filtering is blended. Comparison filters only work with textures that have the following formats: R32_Float_X8X24_Typeless, R32_Float, R24_UNorm_X8_Typeless, and R16_UNorm. ComparisonMinMagPointMipLinear = 129 Use point sampling for minification and magnification, and linear interpolation for mip-level sampling. Compare the result to the comparison value. Comparison filtering compares each sampled texel against a comparison value. The boolean result is blended the same way that normal texture filtering is blended. Comparison filters only work with textures that have the following formats: R32_Float_X8X24_Typeless, R32_Float, R24_UNorm_X8_Typeless, and R16_UNorm. ComparisonMinPointMagLinearMipPoint = 132 Use point sampling for minification, linear interpolation for magnification, and point sampling for mip-level sampling. Compare the result to the comparison value. Comparison filtering compares each sampled texel against a comparison value. The boolean result is blended the same way that normal texture filtering is blended. Comparison filters only work with textures that have the following formats: R32_Float_X8X24_Typeless, R32_Float, R24_UNorm_X8_Typeless, and R16_UNorm. ComparisonMinPointMagMipLinear = 133 Use point sampling for minification, and linear interpolation for magnification and mip-level sampling. Compare the result to the comparison value. Comparison filtering compares each sampled texel against a comparison value. The boolean result is blended the same way that normal texture filtering is blended. Comparison filters only work with textures that have the following formats: R32_Float_X8X24_Typeless, R32_Float, R24_UNorm_X8_Typeless, and R16_UNorm. ComparisonPoint = 128 Use point sampling for minification, magnification, and mip-level sampling. Compare the result to the comparison value. Comparison filtering compares each sampled texel against a comparison value. The boolean result is blended the same way that normal texture filtering is blended. Comparison filters only work with textures that have the following formats: R32_Float_X8X24_Typeless, R32_Float, R24_UNorm_X8_Typeless, and R16_UNorm. Linear = 21 Use linear interpolation for minification, magnification, and mip-level sampling. Linear interpolation is slower than point sampling, but produces higher quality results. Two samples are taken across the sampling direction, and a linearly interpolated value is generated between those by blending them. MinLinearMagMipPoint = 16 Use linear interpolation for minification, point sampling for magnification and mip-level sampling. MinLinearMagPointMipLinear = 17 Use linear interpolation for minification, point sampling for magnification, and linear interpolation for mip-level sampling. MinMagLinearMipPoint = 20 Use linear interpolation for minification and magnification, and point sampling for mip-level sampling. MinMagPointMipLinear = 1 Use point sampling for minification and magnification, and linear interpolation for mip-level sampling. MinPointMagLinearMipPoint = 4 Use point sampling for minification, linear interpolation for magnification, and point sampling for mip-level sampling. MinPointMagMipLinear = 5 Use point sampling for minification, linear interpolation for magnification and mip-level sampling. Point = 0 Use point sampling for minification, magnification, and mip-level sampling. Point sampling is the fastest texture filtering method. It is also the lowest quality, because it just reads a single value and does not blend between texels. Remarks During texture sampling, one or more texels are read and combined (this is called filtering) to produce a single value."
  },
  "api/Stride.Graphics.TextureFlags.html": {
    "href": "api/Stride.Graphics.TextureFlags.html",
    "title": "Enum TextureFlags | Stride API",
    "summary": "Enum TextureFlags Namespace Stride.Graphics Assembly Stride.Graphics.dll Flags describing how a Texture can be bound to the graphics pipeline. [Flags] public enum TextureFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields DepthStencil = 8 The Texture can be used as a Depth-Stencil buffer, i.e. it can be bound as a render target where the output-merger stage writes depth or stencil information. DepthStencilReadOnly = 24 The Texture can be used as a read-only Depth-Stencil buffer. This allows reading from it in a shader stage even at the same time as it is bound as a Depth-Stencil Buffer in the output-merger stage. None = 0 RenderTarget = 2 The Texture can be used as a Render Target View, i.e. it can be bound as the render target of the output-merger stage. ShaderResource = 1 The Texture can be used as a Shader Resource View, i.e. it can be bound to a shader stage. UnorderedAccess = 4 The Texture can be used as an Unordered Access resource."
  },
  "api/Stride.Graphics.TextureOptions.html": {
    "href": "api/Stride.Graphics.TextureOptions.html",
    "title": "Enum TextureOptions | Stride API",
    "summary": "Enum TextureOptions Namespace Stride.Graphics Assembly Stride.Graphics.dll Flags describing resource options for a Texture. [Flags] public enum TextureOptions Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields None = 0 Shared = 2 Enables data sharing between two or more Direct3D devices. The only resources that can be shared are 2D non-mipmapped Textures. Shared and SharedKeyedMutex are mutually exclusive. Note that, starting with Windows 8, it is recommended to enable resource data sharing between two or more Direct3D devices by using a combination of the SharedNtHandle and SharedKeyedMutex flags instead. SharedKeyedMutex = 256 Enables the Texture to be synchronized by using Silk.NET.DXGI.IDXGIKeyedMutex APIs. When using this flag when creating a Texture with a graphics device, any other device can open the same Texture by using OpenSharedResource. Then they must obtain the KeyedMutex from the Texture and acquire the mutex before they issue any rendering commands to the Texture. When those devices finish rendering, they must release the mutex. Shared and SharedKeyedMutex are mutually exclusive. SharedNtHandle = 2048 Enable the use of NT HANDLE values when you create a shared Texture. When you use this flag, you must combine it with the SharedKeyedMutex flag by using a bitwise OR operation. The resulting value specifies a new shared resource type that directs the runtime to use NT HANDLE values for the shared resource. The runtime then must confirm that the shared resource works on all hardware at the specified graphics profile. Without this flag set, the runtime does not strictly validate shared resource parameters (that is, formats, flags, usage, and so on). This flag is not supported until Level_11_1. Remarks This enumeration is used in TextureDescription."
  },
  "api/Stride.Graphics.TextureViewDescription.html": {
    "href": "api/Stride.Graphics.TextureViewDescription.html",
    "title": "Struct TextureViewDescription | Stride API",
    "summary": "Struct TextureViewDescription Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a View for a Texture. public struct TextureViewDescription Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ArraySlice The index of the array slice. public int ArraySlice Field Value int Remarks If the Texture is not a Texture Array, only a single slice is assumed, so this should be zero (i.e. the first index). Flags A combination of flags determining what kind of Texture the View is attached to and how it should behave (i.e. how it is bound, how can it be read / written, etc.). If this field is None, the View is reusing the same flags as its parent Texture. For any other value, this field overrides the flags of the parent Texture. public TextureFlags Flags Field Value TextureFlags Format The pixel format of the View (used for the Shader Resource View or Unordered Access View). public PixelFormat Format Field Value PixelFormat MipLevel The index of the mip-level. public int MipLevel Field Value int Remarks If the Texture has a single mipmap, this should be zero (i.e. the first index). Type A value of ViewType indicating which sub-resources the View can see (single mip, band, or full). public ViewType Type Field Value ViewType Methods ToStagingDescription() Returns a copy of this description modified to describe a Texture View that will be used for staging. public readonly TextureViewDescription ToStagingDescription() Returns TextureViewDescription A staging-compatible copy of the View description."
  },
  "api/Stride.Graphics.UIBatch.PrimitiveType.html": {
    "href": "api/Stride.Graphics.UIBatch.PrimitiveType.html",
    "title": "Enum UIBatch.PrimitiveType | Stride API",
    "summary": "Enum UIBatch.PrimitiveType Namespace Stride.Graphics Assembly Stride.Graphics.dll The primitive type to draw for an element. public enum UIBatch.PrimitiveType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BorderRectangle = 1 A rectangle with borders tessellated as 3x3 rectangles Cube = 2 A simple cube (not necessary square faces) Rectangle = 0 A simple rectangle composed of 2 triangles ReverseCube = 3 A cube with back and front faces inversed."
  },
  "api/Stride.Graphics.UIBatch.UIImageDrawInfo.html": {
    "href": "api/Stride.Graphics.UIBatch.UIImageDrawInfo.html",
    "title": "Struct UIBatch.UIImageDrawInfo | Stride API",
    "summary": "Struct UIBatch.UIImageDrawInfo Namespace Stride.Graphics Assembly Stride.Graphics.dll public struct UIBatch.UIImageDrawInfo Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BorderSize X = Left, Y = Top, Z = Right, W = Bottom public Vector4 BorderSize Field Value Vector4 ColorAdd public Color ColorAdd Field Value Color ColorScale public Color ColorScale Field Value Color DepthBias public int DepthBias Field Value int LeftTopCornerWorld public Vector4 LeftTopCornerWorld Field Value Vector4 Primitive public UIBatch.PrimitiveType Primitive Field Value UIBatch.PrimitiveType SnapImage public bool SnapImage Field Value bool Source public RectangleF Source Field Value RectangleF Swizzle public SwizzleMode Swizzle Field Value SwizzleMode UnitXWorld public Vector4 UnitXWorld Field Value Vector4 UnitYWorld public Vector4 UnitYWorld Field Value Vector4 UnitZWorld public Vector4 UnitZWorld Field Value Vector4 VertexShift X = Left, Y = Top, Z = Right, W = Bottom public Vector4 VertexShift Field Value Vector4"
  },
  "api/Stride.Graphics.UIBatch.html": {
    "href": "api/Stride.Graphics.UIBatch.html",
    "title": "Class UIBatch | Stride API",
    "summary": "Class UIBatch Namespace Stride.Graphics Assembly Stride.Graphics.dll A utility class to batch and draw UI images. public class UIBatch : BatchBase<UIBatch.UIImageDrawInfo>, IDisposable, IComponent, IReferencable, ICollectorHolder Inheritance object DisposeBase ComponentBase BatchBase<UIBatch.UIImageDrawInfo> UIBatch Implements IDisposable IComponent IReferencable ICollectorHolder Inherited Members BatchBase<UIBatch.UIImageDrawInfo>.ResourceContextPool BatchBase<UIBatch.UIImageDrawInfo>.ResourceContext BatchBase<UIBatch.UIImageDrawInfo>.mutablePipeline BatchBase<UIBatch.UIImageDrawInfo>.graphicsDevice BatchBase<UIBatch.UIImageDrawInfo>.blendState BatchBase<UIBatch.UIImageDrawInfo>.rasterizerState BatchBase<UIBatch.UIImageDrawInfo>.samplerState BatchBase<UIBatch.UIImageDrawInfo>.depthStencilState BatchBase<UIBatch.UIImageDrawInfo>.stencilReferenceValue BatchBase<UIBatch.UIImageDrawInfo>.sortMode BatchBase<UIBatch.UIImageDrawInfo>.Effect BatchBase<UIBatch.UIImageDrawInfo>.GraphicsContext BatchBase<UIBatch.UIImageDrawInfo>.DefaultEffect BatchBase<UIBatch.UIImageDrawInfo>.DefaultEffectSRgb BatchBase<UIBatch.UIImageDrawInfo>.TextureComparer BatchBase<UIBatch.UIImageDrawInfo>.BackToFrontComparer BatchBase<UIBatch.UIImageDrawInfo>.FrontToBackComparer BatchBase<UIBatch.UIImageDrawInfo>.Destroy() BatchBase<UIBatch.UIImageDrawInfo>.Parameters BatchBase<UIBatch.UIImageDrawInfo>.Begin(GraphicsContext, EffectInstance, SpriteSortMode, BlendStateDescription?, SamplerState, DepthStencilStateDescription?, RasterizerStateDescription?, int) BatchBase<UIBatch.UIImageDrawInfo>.PrepareForRendering() BatchBase<UIBatch.UIImageDrawInfo>.CheckBeginHasBeenCalled(string) BatchBase<UIBatch.UIImageDrawInfo>.CheckEndHasBeenCalled(string) BatchBase<UIBatch.UIImageDrawInfo>.End() BatchBase<UIBatch.UIImageDrawInfo>.Draw(Texture, in BatchBase<UIBatch.UIImageDrawInfo>.ElementInfo) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors UIBatch(GraphicsDevice) Initializes a new instance of the UIBatch class. public UIBatch(GraphicsDevice device) Parameters device GraphicsDevice A valid instance of GraphicsDevice. Properties SDFSpriteFontEffect public EffectInstance SDFSpriteFontEffect { get; } Property Value EffectInstance Methods Begin(GraphicsContext, ref Matrix, BlendStateDescription?, SamplerState, RasterizerStateDescription?, DepthStencilStateDescription?, int) Begins a image batch rendering using the specified blend state, sampler, depth stencil, rasterizer state objects, and the view-projection transformation matrix. Passing null for any of the state objects selects the default default state objects (BlendState.AlphaBlend, DepthStencilState.None, RasterizerState.CullCounterClockwise, SamplerState.LinearClamp). public void Begin(GraphicsContext graphicsContext, ref Matrix viewProjection, BlendStateDescription? blendState, SamplerState samplerState, RasterizerStateDescription? rasterizerState, DepthStencilStateDescription? depthStencilState, int stencilValue) Parameters graphicsContext GraphicsContext The graphics context to use. viewProjection Matrix The view projection matrix used for this series of draw calls blendState BlendStateDescription? Blending options. samplerState SamplerState Texture sampling options. rasterizerState RasterizerStateDescription? Rasterization options. depthStencilState DepthStencilStateDescription? Depth and stencil options. stencilValue int The value of the stencil buffer to take as reference Begin(GraphicsContext, ref Matrix, BlendStateDescription?, DepthStencilStateDescription?, int) Begins a image batch rendering using the specified blend state, depth stencil and a view-projection transformation matrix. Passing null for any of the state objects selects the default default state objects (BlendState.AlphaBlend, DepthStencilState.None). public void Begin(GraphicsContext graphicsContext, ref Matrix viewProjection, BlendStateDescription? blendState, DepthStencilStateDescription? depthStencilState, int stencilValue) Parameters graphicsContext GraphicsContext The graphics context to use. viewProjection Matrix The view projection matrix used for this series of draw calls blendState BlendStateDescription? Blending options. depthStencilState DepthStencilStateDescription? Depth and stencil options. stencilValue int The value of the stencil buffer to take as reference BeginCustom(GraphicsContext, int) public void BeginCustom(GraphicsContext graphicsContext, int overrideEffect) Parameters graphicsContext GraphicsContext overrideEffect int DrawBackground(ref Matrix, ref Vector3, ref Color, int) Draw a colored background having provided size at the position specified by the world matrix. public void DrawBackground(ref Matrix worldMatrix, ref Vector3 elementSize, ref Color color, int depthBias) Parameters worldMatrix Matrix The world matrix specifying the position of the element in the world elementSize Vector3 The size of the element color Color The color of the element depthBias int The depth bias to use when drawing the element DrawCube(ref Matrix, ref Vector3, ref Color, int) Draw a cube of the provided size at the position specified by the world matrix having the provided color. public void DrawCube(ref Matrix worldMatrix, ref Vector3 elementSize, ref Color color, int depthBias) Parameters worldMatrix Matrix The world matrix specifying the position of the cube in the world elementSize Vector3 The size of the cube color Color The color of the cube depthBias int The depth bias to use when drawing the element DrawImage(Texture, ref Matrix, ref RectangleF, ref Vector3, ref Vector4, ref Color, int, ImageOrientation, SwizzleMode, bool) Batch a new border image draw to the draw list. public void DrawImage(Texture texture, ref Matrix worldMatrix, ref RectangleF sourceRectangle, ref Vector3 elementSize, ref Vector4 borderSize, ref Color color, int depthBias, ImageOrientation imageOrientation = ImageOrientation.AsIs, SwizzleMode swizzle = SwizzleMode.None, bool snapImage = false) Parameters texture Texture The texture to use during the draw worldMatrix Matrix The world matrix of the element sourceRectangle RectangleF The rectangle indicating the source region of the texture to use elementSize Vector3 The size of the ui element borderSize Vector4 The size of the borders in the texture in pixels (left/top/right/bottom) color Color The color to apply to the texture image. depthBias int The depth bias of the ui element imageOrientation ImageOrientation The rotation to apply on the image uv swizzle SwizzleMode Swizzle mode indicating the swizzle use when sampling the texture in the shader snapImage bool Indicate if the image needs to be snapped or not DrawRectangle(ref Matrix, ref Vector3, ref Color, int) Draw a rectangle of the provided size at the position specified by the world matrix having the provided color. public void DrawRectangle(ref Matrix worldMatrix, ref Vector3 elementSize, ref Color color, int depthBias) Parameters worldMatrix Matrix The world matrix specifying the position of the rectangle in the world elementSize Vector3 The size of the rectangle color Color The color of the rectangle depthBias int The depth bias to use when drawing the element UpdateBufferValuesFromElementInfo(ref ElementInfo, nint, nint, int) Update the mapped vertex and index buffer values using the provided element info. protected override void UpdateBufferValuesFromElementInfo(ref BatchBase<UIBatch.UIImageDrawInfo>.ElementInfo elementInfo, nint vertexPtr, nint indexPtr, int vertexOffset) Parameters elementInfo BatchBase<UIBatch.UIImageDrawInfo>.ElementInfo The structure containing the information about the element to draw. vertexPtr nint indexPtr nint vertexOffset int"
  },
  "api/Stride.Graphics.Vertex2DPositionTexture.html": {
    "href": "api/Stride.Graphics.Vertex2DPositionTexture.html",
    "title": "Struct Vertex2DPositionTexture | Stride API",
    "summary": "Struct Vertex2DPositionTexture Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a custom vertex format structure that contains position and UV information. public struct Vertex2DPositionTexture : IEquatable<Vertex2DPositionTexture>, IVertex Implements IEquatable<Vertex2DPositionTexture> IVertex Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Vertex2DPositionTexture(Vector2, Vector2) Initializes a new Vertex2DPositionTexture instance. public Vertex2DPositionTexture(Vector2 position, Vector2 textureCoordinate) Parameters position Vector2 The position of this vertex. textureCoordinate Vector2 UV texture coordinates. Fields Layout The vertex layout of this struct. public static readonly VertexDeclaration Layout Field Value VertexDeclaration Position XY position. public Vector2 Position Field Value Vector2 Size Defines structure byte size. public static readonly int Size Field Value int TextureCoordinate UV texture coordinates. public Vector2 TextureCoordinate Field Value Vector2 Methods Equals(Vertex2DPositionTexture) Indicates whether the current object is equal to another object of the same type. public bool Equals(Vertex2DPositionTexture other) Parameters other Vertex2DPositionTexture An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FlipWinding() Flip the vertex winding. public void FlipWinding() GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. GetLayout() Gets the layout of the vertex. public VertexDeclaration GetLayout() Returns VertexDeclaration ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(Vertex2DPositionTexture, Vertex2DPositionTexture) public static bool operator ==(Vertex2DPositionTexture left, Vertex2DPositionTexture right) Parameters left Vertex2DPositionTexture right Vertex2DPositionTexture Returns bool operator !=(Vertex2DPositionTexture, Vertex2DPositionTexture) public static bool operator !=(Vertex2DPositionTexture left, Vertex2DPositionTexture right) Parameters left Vertex2DPositionTexture right Vertex2DPositionTexture Returns bool"
  },
  "api/Stride.Graphics.VertexBufferBinding.html": {
    "href": "api/Stride.Graphics.VertexBufferBinding.html",
    "title": "Struct VertexBufferBinding | Stride API",
    "summary": "Struct VertexBufferBinding Namespace Stride.Graphics Assembly Stride.Graphics.dll Binding structure that specifies a Vertex Buffer and other per-vertex parameters (such as offset and instancing) for a Graphics Device. [DataSerializer(typeof(VertexBufferBinding.Serializer))] public readonly struct VertexBufferBinding : IEquatable<VertexBufferBinding> Implements IEquatable<VertexBufferBinding> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) BoundingExtensions.ComputeBounds(VertexBufferBinding, ref Matrix, out BoundingSphere) IndexExtensions.GenerateIndexMapping(VertexBufferBinding, CommandList, params string[]) SimpleExtensions.IsSimple(VertexBufferBinding) TransformExtensions.TransformBuffer(VertexBufferBinding, ref Matrix) TransformExtensions.TransformBuffer(VertexBufferBinding, byte[], ref Matrix) MeshExtension.AsReadable(VertexBufferBinding, IServiceRegistry, out VertexBufferHelper, out int) UnsafeUtilities.As<T>(object?) Constructors VertexBufferBinding(Buffer, VertexDeclaration, int, int, int) Initializes a new instance of the VertexBufferBinding structure. public VertexBufferBinding(Buffer vertexBuffer, VertexDeclaration vertexDeclaration, int vertexCount, int vertexStride = -1, int vertexOffset = 0) Parameters vertexBuffer Buffer The Vertex Buffer to bind. vertexDeclaration VertexDeclaration A description of the layout of the vertices in the vertexBuffer, defining how the data is structured. vertexCount int The number of vertices in the Buffer to use. vertexStride int The size of a single vertex in bytes. This is the distance between two consecutive vertices in the buffer. Specify -1 to auto-discover the stride from the vertexDeclaration. vertexOffset int The offset in bytes from the beginning of the Buffer to the first vertex to use. Default is 0, meaning the first vertex in the Buffer will be used. Exceptions ArgumentNullException vertexBuffer or vertexDeclaration is null. Properties Buffer Gets the Vertex Buffer to bind. public Buffer Buffer { get; } Property Value Buffer Count Gets the number of vertices in the Buffer to use. public int Count { get; } Property Value int Declaration Gets a description of the layout of the vertices in the Buffer, defining how the data is structured. public VertexDeclaration Declaration { get; } Property Value VertexDeclaration Offset Gets the offset in bytes from the beginning of the Buffer to the first vertex to use. public int Offset { get; } Property Value int Stride Gets the size of a single vertex in bytes. This is the distance between two consecutive vertices in the Buffer. public int Stride { get; } Property Value int Methods Equals(VertexBufferBinding) Indicates whether the current object is equal to another object of the same type. public bool Equals(VertexBufferBinding other) Parameters other VertexBufferBinding An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(VertexBufferBinding, VertexBufferBinding) public static bool operator ==(VertexBufferBinding left, VertexBufferBinding right) Parameters left VertexBufferBinding right VertexBufferBinding Returns bool operator !=(VertexBufferBinding, VertexBufferBinding) public static bool operator !=(VertexBufferBinding left, VertexBufferBinding right) Parameters left VertexBufferBinding right VertexBufferBinding Returns bool"
  },
  "api/Stride.Graphics.VertexBufferBindingExtensions.html": {
    "href": "api/Stride.Graphics.VertexBufferBindingExtensions.html",
    "title": "Class VertexBufferBindingExtensions | Stride API",
    "summary": "Class VertexBufferBindingExtensions Namespace Stride.Graphics Assembly Stride.Graphics.dll Provides extension methods that facilitate the conversion of Vertex Declarations and Vertex Buffer bindings into InputElementDescription structures, which are used to define the input layout for Shaders in the graphics pipeline. public static class VertexBufferBindingExtensions Inheritance object VertexBufferBindingExtensions Methods CreateInputElements(VertexBufferBinding[]) Creates descriptions for the Input Elements in the Vertex Buffers that will be bound to the Graphics Pipeline and fed to a Shader based on the specified Vertex Declaration. public static InputElementDescription[] CreateInputElements(this VertexBufferBinding[] vertexBuffers) Parameters vertexBuffers VertexBufferBinding[] The descriptions of the Vertex Buffers that will be bound to the pipeline. Returns InputElementDescription[] An array of InputElementDescription structures representing the Input Elements derived from the Vertex Buffer bindings. Remarks This method processes the vertex elements in the provided VertexBufferBindings and maps them to corresponding InputElementDescription structures. CreateInputElements(VertexDeclaration) Creates descriptions for the Input Elements in a Vertex Buffer that will be fed to a Shader based on the specified Vertex Declaration. public static InputElementDescription[] CreateInputElements(this VertexDeclaration vertexDeclaration) Parameters vertexDeclaration VertexDeclaration The Vertex Declaration containing the Vertex Elements to be converted into Input Element descriptions. Returns InputElementDescription[] An array of InputElementDescription structures representing the Input Elements derived from the Vertex Declaration. Remarks This method processes the vertex elements in the provided VertexDeclaration and maps them to corresponding InputElementDescription structures."
  },
  "api/Stride.Graphics.VertexBufferHelper.CopyAsTriangleList.html": {
    "href": "api/Stride.Graphics.VertexBufferHelper.CopyAsTriangleList.html",
    "title": "Struct VertexBufferHelper.CopyAsTriangleList | Stride API",
    "summary": "Struct VertexBufferHelper.CopyAsTriangleList Namespace Stride.Graphics Assembly Stride.Graphics.dll public struct VertexBufferHelper.CopyAsTriangleList : VertexBufferHelper.IReader<Vector3> Implements VertexBufferHelper.IReader<Vector3> Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields IndexBufferHelper public required IndexBufferHelper IndexBufferHelper Field Value IndexBufferHelper Methods Read<TConverter, TSource>(byte*, int, int, Span<Vector3>) public void Read<TConverter, TSource>(byte* sourcePointer, int elementCount, int stride, Span<Vector3> destination) where TConverter : IConverter<TSource, Vector3> where TSource : unmanaged Parameters sourcePointer byte* Points to the first element in the vertex buffer, read it as a TSource* to retrieve its value elementCount int The amount of vertices. This is not equivalent to the size of the vertex buffer, or the size in bytes taken by individual vertices stride int The size in bytes taken by individual vertices, add it to sourcePointer to point to the next element destination Span<Vector3> The span passed into the Read<TConverter, TSource>(byte*, int, int, Span<TDest>) method call Type Parameters TConverter A helper to convert between TSource and Vector3 properly TSource The source type this vertex buffer was built with, for example Vector2 or Byte4, use TConverter to convert it into a Vector3. Examples Implementing Copy<TSemantic, TValue>(Span<TValue>, int) manually: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); var vertexPositions = new Vector3[count]; var myReader = new CopyTo(); helper.Read<PositionSemantic, Vector3, CopyTo>(vertexPositions, myReader); struct CopyTo : IReader<Vector3> { public unsafe void Read<TConverter, TSource>(byte* sourcePointer, int elementCount, int stride, Span<T> destination) where TConverter : IConverter<TSource, T> where TSource : unmanaged { if (destination.Length != elementCount) throw new ArgumentException($\"{nameof(destination)} length does not match the amount of vertices contained within this vertex buffer ({destination.Length} / {elementCount})\"); fixed (T* ptrDest = destination) { byte* end = sourcePointer + elementCount * stride; T* dest = ptrDest; for (; sourcePointer < end; sourcePointer += stride, dest++) TConverter.Convert(*(TSource*)sourcePointer, out *dest); } } }"
  },
  "api/Stride.Graphics.VertexBufferHelper.IReader-1.html": {
    "href": "api/Stride.Graphics.VertexBufferHelper.IReader-1.html",
    "title": "Interface VertexBufferHelper.IReader<TDest> | Stride API",
    "summary": "Interface VertexBufferHelper.IReader<TDest> Namespace Stride.Graphics Assembly Stride.Graphics.dll public interface VertexBufferHelper.IReader<TDest> Type Parameters TDest Extension Methods UnsafeUtilities.As<T>(object?) Examples Implementing Copy<TSemantic, TValue>(Span<TValue>, int) manually: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); var vertexPositions = new Vector3[count]; var myReader = new CopyTo(); helper.Read<PositionSemantic, Vector3, CopyTo>(vertexPositions, myReader); struct CopyTo : IReader<Vector3> { public unsafe void Read<TConverter, TSource>(byte* sourcePointer, int elementCount, int stride, Span<T> destination) where TConverter : IConverter<TSource, T> where TSource : unmanaged { if (destination.Length != elementCount) throw new ArgumentException($\"{nameof(destination)} length does not match the amount of vertices contained within this vertex buffer ({destination.Length} / {elementCount})\"); fixed (T* ptrDest = destination) { byte* end = sourcePointer + elementCount * stride; T* dest = ptrDest; for (; sourcePointer < end; sourcePointer += stride, dest++) TConverter.Convert(*(TSource*)sourcePointer, out *dest); } } } Methods Read<TConverter, TSource>(byte*, int, int, Span<TDest>) void Read<TConverter, TSource>(byte* sourcePointer, int elementCount, int stride, Span<TDest> destination) where TConverter : IConverter<TSource, TDest> where TSource : unmanaged Parameters sourcePointer byte* Points to the first element in the vertex buffer, read it as a TSource* to retrieve its value elementCount int The amount of vertices. This is not equivalent to the size of the vertex buffer, or the size in bytes taken by individual vertices stride int The size in bytes taken by individual vertices, add it to sourcePointer to point to the next element destination Span<TDest> The span passed into the Read<TConverter, TSource>(byte*, int, int, Span<TDest>) method call Type Parameters TConverter A helper to convert between TSource and TDest properly TSource The source type this vertex buffer was built with, for example Vector2 or Byte4, use TConverter to convert it into a TDest. Examples Implementing Copy<TSemantic, TValue>(Span<TValue>, int) manually: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); var vertexPositions = new Vector3[count]; var myReader = new CopyTo(); helper.Read<PositionSemantic, Vector3, CopyTo>(vertexPositions, myReader); struct CopyTo : IReader<Vector3> { public unsafe void Read<TConverter, TSource>(byte* sourcePointer, int elementCount, int stride, Span<T> destination) where TConverter : IConverter<TSource, T> where TSource : unmanaged { if (destination.Length != elementCount) throw new ArgumentException($\"{nameof(destination)} length does not match the amount of vertices contained within this vertex buffer ({destination.Length} / {elementCount})\"); fixed (T* ptrDest = destination) { byte* end = sourcePointer + elementCount * stride; T* dest = ptrDest; for (; sourcePointer < end; sourcePointer += stride, dest++) TConverter.Convert(*(TSource*)sourcePointer, out *dest); } } }"
  },
  "api/Stride.Graphics.VertexBufferHelper.IWriter-1.html": {
    "href": "api/Stride.Graphics.VertexBufferHelper.IWriter-1.html",
    "title": "Interface VertexBufferHelper.IWriter<TDest> | Stride API",
    "summary": "Interface VertexBufferHelper.IWriter<TDest> Namespace Stride.Graphics Assembly Stride.Graphics.dll public interface VertexBufferHelper.IWriter<TDest> Type Parameters TDest Extension Methods UnsafeUtilities.As<T>(object?) Examples Writing directly to mesh color: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); // Write to colors if that semantic already exist in the buffer, otherwise returns false helper.Write<ColorSemantic, Vector4, MultColor>(new MultColor(){ Color = Color.Gray }); // Upload changes to the GPU Model.Meshes[0].Draw.VertexBuffers[0].Buffer.Recreate(helper.DataOuter); private struct MultColor : VertexBufferHelper.IWriter<Vector4> { public Color Color; public unsafe void Write<TConverter, TSource>(byte* sourcePointer, int elementCount, int stride) where TConverter : IConverter<TSource, Vector4>, IConverter<Vector4, TSource> where TSource : unmanaged { for (byte* end = sourcePointer + elementCount * stride; sourcePointer < end; sourcePointer += stride) { TConverter.Convert(*(TSource*)sourcePointer, out var val); val *= (Vector4)Color; TConverter.Convert(val, out *(TSource*)sourcePointer); } } } Methods Write<TConverter, TSource>(byte*, int, int) void Write<TConverter, TSource>(byte* sourcePointer, int elementCount, int stride) where TConverter : IConverter<TSource, TDest>, IConverter<TDest, TSource> where TSource : unmanaged Parameters sourcePointer byte* Points to the first element in the vertex buffer, read it as a TSource* to retrieve its value elementCount int The amount of vertices. This is not equivalent to the size of the vertex buffer, or the size in bytes taken by individual vertices stride int The size in bytes taken by individual vertices, add it to sourcePointer to point to the next element Type Parameters TConverter A helper to convert between TSource and TDest properly TSource The source type this vertex buffer was built with, for example Vector2 or Byte4, use TConverter to convert it into a TDest. Examples Writing directly to mesh color: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); // Write to colors if that semantic already exist in the buffer, otherwise returns false helper.Write<ColorSemantic, Vector4, MultColor>(new MultColor(){ Color = Color.Gray }); // Upload changes to the GPU Model.Meshes[0].Draw.VertexBuffers[0].Buffer.Recreate(helper.DataOuter); private struct MultColor : VertexBufferHelper.IWriter<Vector4> { public Color Color; public unsafe void Write<TConverter, TSource>(byte* sourcePointer, int elementCount, int stride) where TConverter : IConverter<TSource, Vector4>, IConverter<Vector4, TSource> where TSource : unmanaged { for (byte* end = sourcePointer + elementCount * stride; sourcePointer < end; sourcePointer += stride) { TConverter.Convert(*(TSource*)sourcePointer, out var val); val *= (Vector4)Color; TConverter.Convert(val, out *(TSource*)sourcePointer); } } }"
  },
  "api/Stride.Graphics.VertexBufferHelper.html": {
    "href": "api/Stride.Graphics.VertexBufferHelper.html",
    "title": "Struct VertexBufferHelper | Stride API",
    "summary": "Struct VertexBufferHelper Namespace Stride.Graphics Assembly Stride.Graphics.dll public readonly struct VertexBufferHelper Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Examples Reading the vertex positions of a mesh: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); var vertexPositions = new Vector3[count]; helper.Copy<PositionSemantic, Vector3>(vertexPositions); Constructors VertexBufferHelper(VertexBufferBinding, IServiceRegistry, out int) Fetch this buffer and create a helper to read from it. public VertexBufferHelper(VertexBufferBinding binding, IServiceRegistry services, out int count) Parameters binding VertexBufferBinding The bindings for this buffer services IServiceRegistry The service used to retrieve the buffer from disk/GPU if it wasn't found through other means count int The amount of vertices this buffer holds Examples Reading the vertex positions of a mesh: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); var vertexPositions = new Vector3[count]; helper.Copy<PositionSemantic, Vector3>(vertexPositions); Remarks This operation loads the buffer from disk, or directly from the gpu. It is very slow, avoid calling this too often if at all possible. VertexBufferHelper(VertexBufferBinding, byte[], out int) Create the helper from existing data instead of trying to fetch the buffer automatically public VertexBufferHelper(VertexBufferBinding binding, byte[] dataOuter, out int count) Parameters binding VertexBufferBinding dataOuter byte[] count int Exceptions ArgumentException dataOuter does not match the binding definition provided, dataOuter must be the entire vertex buffer Fields Binding public readonly VertexBufferBinding Binding Field Value VertexBufferBinding DataOuter Full vertex buffer, the start and end of this buffer may contain data that does not map to this Binding, use DataInner if you want to only read the data that is mapped to this binding. public readonly byte[] DataOuter Field Value byte[] Properties DataInner Effective vertex buffer, accounts for the binding offset and length public Span<byte> DataInner { get; } Property Value Span<byte> Methods Copy<TDest>(Span<TDest>) Copies this vertex buffer's data to the vertex-buffer-like span provided. Any semantic data present in destination that is not present in this buffer is left untouched. public bool Copy<TDest>(Span<TDest> destination) where TDest : unmanaged, IVertex Parameters destination Span<TDest> The buffer which will be written to, must be of the same length as the amount of vertices in this buffer Returns bool True if every semantic element of TDest was written to from this buffers' data, false if at least one semantic was missing Type Parameters TDest Examples Copying a mesh's vertex positions, colors and UVs: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); var vertexPositionsColorsAndUVs = new VertexPositionColorTexture[count]; helper.Copy(vertexPositionsColorsAndUVs); Exceptions NotImplementedException When the data format for this semantic is too arcane - no conversion logic is implemented for that type Copy<TSemantic, TValue>(Span<TValue>, int) Extract individual element from each vertex contained in this vertex buffer and copies them into buffer public bool Copy<TSemantic, TValue>(Span<TValue> buffer, int semanticIndex = 0) where TSemantic : IConverter<Vector2, TValue>, IConverter<Vector3, TValue>, IConverter<Vector4, TValue>, IConverter<Half2, TValue>, IConverter<Half4, TValue>, IConverter<UShort4, TValue>, IConverter<Byte4, TValue>, IConverter<Color, TValue>, ISemantic where TValue : unmanaged Parameters buffer Span<TValue> The buffer which will be written to, must have exactly the same amount of items as there are vertices in the buffer semanticIndex int The semantic to read with that index, starts at zero. For example, to sample the second TextureCoordinate, you would use helper.Copy<TextureCoordinateSemantic, Vector2>(myUvs, 1); Returns bool True when this semantic exists in the vertex buffer, false otherwise Type Parameters TSemantic The semantic to read, for example PositionSemantic TValue The value type to read, depends entirely on the TSemantic used Examples Reading the vertex positions of a mesh: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); var vertexPositions = new Vector3[count]; helper.Copy<PositionSemantic, Vector3>(vertexPositions); Exceptions NotImplementedException When the data format for this semantic is too arcane - no conversion logic is implemented for that type Read<TSemantic, TDest, TReader>(Span<TDest>, TReader, int) Lower level access to read into the vertex buffer public bool Read<TSemantic, TDest, TReader>(Span<TDest> destination, TReader reader, int semanticIndex = 0) where TSemantic : IConverter<Vector2, TDest>, IConverter<Vector3, TDest>, IConverter<Vector4, TDest>, IConverter<Half2, TDest>, IConverter<Half4, TDest>, IConverter<UShort4, TDest>, IConverter<Byte4, TDest>, IConverter<Color, TDest>, ISemantic where TDest : unmanaged where TReader : VertexBufferHelper.IReader<TDest>, allows ref struct Parameters destination Span<TDest> The destination span your TReader Read<TConverter, TSource>(byte*, int, int, Span<TDest>) method receives, you may pass Empty if you do not need one. reader TReader An implementation of VertexBufferHelper.IReader<TDest>, implement this interface to read directly from the vertex buffer while making use of the auto-conversion of the TSemantic provided Preferably as a struct to ensure it is inlined by the JIT semanticIndex int The semantic to read with that index, starts at zero. For example, to sample the second TextureCoordinate, you would use helper.Read<TextureCoordinateSemantic, Vector2>(yourReader, 1); Returns bool True when this semantic exists in the vertex buffer, false otherwise Type Parameters TSemantic The semantic to read, PositionSemantic for example TDest The value type to read, depends on the TSemantic used, Vector3 when your TSemantic PositionSemantic for example TReader The type of the reader you're providing Examples Implementing Copy<TSemantic, TValue>(Span<TValue>, int) manually: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); var vertexPositions = new Vector3[count]; var myReader = new CopyTo(); helper.Read<PositionSemantic, Vector3, CopyTo>(vertexPositions, myReader); struct CopyTo : IReader<Vector3> { public unsafe void Read<TConverter, TSource>(byte* sourcePointer, int elementCount, int stride, Span<T> destination) where TConverter : IConverter<TSource, T> where TSource : unmanaged { if (destination.Length != elementCount) throw new ArgumentException($\"{nameof(destination)} length does not match the amount of vertices contained within this vertex buffer ({destination.Length} / {elementCount})\"); fixed (T* ptrDest = destination) { byte* end = sourcePointer + elementCount * stride; T* dest = ptrDest; for (; sourcePointer < end; sourcePointer += stride, dest++) TConverter.Convert(*(TSource*)sourcePointer, out *dest); } } } Exceptions NotImplementedException When the data format for this semantic is too arcane - no conversion logic is implemented for that type Write<TSemantic, TDest, TWriter>(TWriter, int) Lower level access to write directly to the vertex buffer public bool Write<TSemantic, TDest, TWriter>(TWriter writer, int semanticIndex = 0) where TSemantic : IConverter<TDest, Vector2>, IConverter<TDest, Vector3>, IConverter<TDest, Vector4>, IConverter<TDest, Half2>, IConverter<TDest, Half4>, IConverter<TDest, UShort4>, IConverter<TDest, Byte4>, IConverter<TDest, Color>, IConverter<Vector2, TDest>, IConverter<Vector3, TDest>, IConverter<Vector4, TDest>, IConverter<Half2, TDest>, IConverter<Half4, TDest>, IConverter<UShort4, TDest>, IConverter<Byte4, TDest>, IConverter<Color, TDest>, ISemantic where TDest : unmanaged where TWriter : VertexBufferHelper.IWriter<TDest> Parameters writer TWriter An implementation of VertexBufferHelper.IWriter<TDest>, implement this interface to write directly into the vertex buffer while making use of the auto-conversion of the TSemantic provided Preferably as a struct to ensure it is inlined by the JIT semanticIndex int The semantic to read with that index, starts at zero. For example, to sample the second TextureCoordinate, you would use helper.Write<TextureCoordinateSemantic, Vector2, YourWriter>(yourWriter, 1); Returns bool True when this semantic exists in the vertex buffer, false otherwise Type Parameters TSemantic The semantic to read, PositionSemantic for example TDest The concrete type this writer will work with TWriter A struct implementing VertexBufferHelper.IWriter<TDest> which will be called in turn to write into this buffer when this method is called. Examples Writing directly to mesh color: Model.Meshes[0].Draw.VertexBuffers[0].AsReadable(Services, out VertexBufferHelper helper, out int count); // Write to colors if that semantic already exist in the buffer, otherwise returns false helper.Write<ColorSemantic, Vector4, MultColor>(new MultColor(){ Color = Color.Gray }); // Upload changes to the GPU Model.Meshes[0].Draw.VertexBuffers[0].Buffer.Recreate(helper.DataOuter); private struct MultColor : VertexBufferHelper.IWriter<Vector4> { public Color Color; public unsafe void Write<TConverter, TSource>(byte* sourcePointer, int elementCount, int stride) where TConverter : IConverter<TSource, Vector4>, IConverter<Vector4, TSource> where TSource : unmanaged { for (byte* end = sourcePointer + elementCount * stride; sourcePointer < end; sourcePointer += stride) { TConverter.Convert(*(TSource*)sourcePointer, out var val); val *= (Vector4)Color; TConverter.Convert(val, out *(TSource*)sourcePointer); } } } Exceptions NotImplementedException When the data format for this semantic is too arcane - no conversion logic is implemented for that type"
  },
  "api/Stride.Graphics.VertexDeclaration.html": {
    "href": "api/Stride.Graphics.VertexDeclaration.html",
    "title": "Class VertexDeclaration | Stride API",
    "summary": "Class VertexDeclaration Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines the layout of the vertices in a Vertex Buffer by specifying its component VertexElements. [DataContract] [DataSerializer(typeof(VertexDeclaration.Serializer))] public sealed class VertexDeclaration : IEquatable<VertexDeclaration> Inheritance object VertexDeclaration Implements IEquatable<VertexDeclaration> Extension Methods MeshExtension.TryGetElement(VertexDeclaration, string, int, out VertexElementWithOffset) VertexBufferBindingExtensions.CreateInputElements(VertexDeclaration) UnsafeUtilities.As<T>(object?) Constructors VertexDeclaration(params VertexElement[]) Initializes a new instance of the VertexDeclaration class. public VertexDeclaration(params VertexElement[] elements) Parameters elements VertexElement[] The elements that compose a vertex. VertexDeclaration(VertexElement[], int, int) Initializes a new instance of the VertexDeclaration class. public VertexDeclaration(VertexElement[] elements, int instanceCount, int vertexStride) Parameters elements VertexElement[] The elements that compose a vertex. instanceCount int The instance count. vertexStride int The size of a single vertex in bytes. This is the distance between two consecutive vertices in the Vertex Buffer. Specify 0 to auto-discover the stride from the elements. Exceptions ArgumentNullException elements is null. Properties InstanceCount Gets the instance count. public int InstanceCount { get; } Property Value int VertexElements Gets the Vertex Elements that define the layout of the vertices in this declaration. [DataMember] public VertexElement[] VertexElements { get; } Property Value VertexElement[] VertexStride Gets the size, in bytes, of a single vertex in this declaration. public int VertexStride { get; } Property Value int Methods CalculateSize() Calculates the size in bytes of a vertex described by this Vertex Declaration. public int CalculateSize() Returns int The size in bytes of the vertices using the layout described by this instance. EnumerateWithOffsets() Enumerates the Vertex Elements along with their declared offsets. public IEnumerable<VertexElementWithOffset> EnumerateWithOffsets() Returns IEnumerable<VertexElementWithOffset> A sequence of VertexElementWithOffsets structures. Equals(VertexDeclaration) Indicates whether the current object is equal to another object of the same type. public bool Equals(VertexDeclaration other) Parameters other VertexDeclaration An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Determines whether the specified object is equal to the current object. public override bool Equals(object obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Operators implicit operator VertexDeclaration(VertexElement) Performs an implicit conversion from VertexElement to VertexDeclaration, creating a Vertex Declaration with a single Vertex Element. public static implicit operator VertexDeclaration(VertexElement element) Parameters element VertexElement The single Vertex Element. Returns VertexDeclaration The resulting Vertex Declaration. implicit operator VertexDeclaration(VertexElement[]) Performs an implicit conversion from an array of VertexElement to VertexDeclaration, creating a Vertex Declaration with the provided Vertex Elements. public static implicit operator VertexDeclaration(VertexElement[] elements) Parameters elements VertexElement[] The Vertex Elements. Returns VertexDeclaration The resulting Vertex Declaration."
  },
  "api/Stride.Graphics.VertexElement.html": {
    "href": "api/Stride.Graphics.VertexElement.html",
    "title": "Struct VertexElement | Stride API",
    "summary": "Struct VertexElement Namespace Stride.Graphics Assembly Stride.Graphics.dll A description of a single element for the input-assembler stage. This structure is related to SharpDX.Direct3D11.InputElement. [DataContract] [DataSerializer(typeof(VertexElement.Serializer))] public struct VertexElement : IEquatable<VertexElement> Implements IEquatable<VertexElement> Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Remarks Because SharpDX.Direct3D11.InputElement requires to have the same VertexBufferLayout.SlotIndex, VertexBufferLayout.VertexClassification and VertexBufferLayout.instanceDataStepRate, the VertexBufferLayout structure encapsulates a set of VertexElement for a particular slot, classification and instance data step rate. Unlike the default SharpDX.Direct3D11.InputElement, this structure accepts a semantic name with a postfix number that will be automatically extracted to the semantic index. Constructors VertexElement(string, PixelFormat) Initializes a new instance of the VertexElement structure. public VertexElement(string semanticName, PixelFormat format) Parameters semanticName string The semantic name associated with this element, such as \"POSITION\", \"TEXCOORD\", or \"NORMAL\". If the semantic name contains a postfix number, this number will be used as a semantic index, such as \"TEXCOORD1\" or \"COLOR0\". format PixelFormat The data format of the element, such as R32G32B32_Float (equivalent to Vector3) or R8G8B8A8_UNorm (equivalent to a 32-bit, 8bpc RGBA color). Exceptions ArgumentException semanticName is null or an empty string. VertexElement(string, int, PixelFormat, int) Initializes a new instance of the VertexElement structure. public VertexElement(string semanticName, int semanticIndex, PixelFormat format, int alignedByteOffset = -1) Parameters semanticName string The semantic name associated with this element, such as \"POSITION\", \"TEXCOORD\", or \"NORMAL\". semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name, such as the 1 in \"TEXCOORD1\" or the 0 in \"COLOR0\". format PixelFormat The data format of the element, such as R32G32B32_Float (equivalent to Vector3) or R8G8B8A8_UNorm (equivalent to a 32-bit, 8bpc RGBA color). alignedByteOffset int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Exceptions ArgumentException semanticName is null or an empty string. ArgumentException Cannot specify a semantic index in the semanticName when using this constructor. Use the constructor with explicit semantic index instead (VertexElement(string, PixelFormat)). Fields AppendAligned Returns a value that can be used for the offset parameter of an Vertex Element to indicate that the element should be aligned directly after the previous one, including any packing if neccessary. public const int AppendAligned = -1 Field Value int Properties AlignedByteOffset The byte offset from the start of the vertex to this element. public readonly int AlignedByteOffset { get; } Property Value int Remarks Use -1 (or a constant like AppendAligned to automatically align the element after the previous one, including any packing if necessary. Format The data format of the element, such as R32G32B32_Float or R8G8B8A8_UNorm. public readonly PixelFormat Format { get; } Property Value PixelFormat Remarks This must match the format expected by the Shader and the layout of the Vertex Buffer. SemanticAsText Gets the HLSL semantic name associated with this element, such as \"POSITION\", \"TEXCOORD\", or \"NORMAL\". It can contain a postfix number, the SemanticIndex, such as \"TEXCOORD1\" or \"COLOR0\". public readonly string SemanticAsText { get; } Property Value string Remarks This name must match the semantic used in the Vertex Shader input signature. See Also SemanticName SemanticIndex SemanticIndex Gets the semantic index for the element, used when multiple elements share the same semantic name. public readonly int SemanticIndex { get; } Property Value int Remarks For example, a 4x4 matrix might be passed as four \"TEXCOORD\" elements with indices 0 through 3. SemanticName Gets the HLSL semantic name associated with this element, such as \"POSITION\", \"TEXCOORD\", or \"NORMAL\". public readonly string SemanticName { get; } Property Value string Remarks This name must match the semantic used in the Vertex Shader input signature. Methods BiTangent(PixelFormat, int) Declares a VertexElement with the semantic \"BITANGENT\". public static VertexElement BiTangent(PixelFormat format, int offsetInBytes = -1) Parameters format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"BITANGENT\" semantic. BiTangent(int, PixelFormat, int) Declares a VertexElement with the semantic \"BITANGENT\". public static VertexElement BiTangent(int semanticIndex, PixelFormat format, int offsetInBytes = -1) Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"BITANGENT\" semantic. BiTangent<T>(int, int) Declares a VertexElement with the semantic \"BITANGENT\". public static VertexElement BiTangent<T>(int semanticIndex = 0, int offsetInBytes = -1) where T : struct Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"BITANGENT\" semantic. Type Parameters T The type of the bitangent element. Exceptions NotSupportedException The specified T is not supported. It cannot be converted to a PixelFormat. Color(PixelFormat, int) Declares a VertexElement with the semantic \"COLOR\". public static VertexElement Color(PixelFormat format, int offsetInBytes = -1) Parameters format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"COLOR\" semantic. Color(int, PixelFormat, int) Declares a VertexElement with the semantic \"COLOR\". public static VertexElement Color(int semanticIndex, PixelFormat format, int offsetInBytes = -1) Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"COLOR\" semantic. Color<T>(int, int) Declares a VertexElement with the semantic \"COLOR\". public static VertexElement Color<T>(int semanticIndex = 0, int offsetInBytes = -1) where T : struct Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"COLOR\" semantic. Type Parameters T The type of the color element. Exceptions NotSupportedException The specified T is not supported. It cannot be converted to a PixelFormat. ConvertTypeToFormat<T>() Converts a type T to its equivalent PixelFormat. public static PixelFormat ConvertTypeToFormat<T>() where T : struct Returns PixelFormat The equivalent PixelFormat to T. Type Parameters T The type of the Vertex Element to convert. Exceptions NotSupportedException The specified T is not supported. It cannot be converted to a PixelFormat. Equals(VertexElement) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(VertexElement other) Parameters other VertexElement An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Normal(PixelFormat, int) Declares a VertexElement with the semantic \"NORMAL\". public static VertexElement Normal(PixelFormat format, int offsetInBytes = -1) Parameters format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"NORMAL\" semantic. Normal(int, PixelFormat, int) Declares a VertexElement with the semantic \"NORMAL\". public static VertexElement Normal(int semanticIndex, PixelFormat format, int offsetInBytes = -1) Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"NORMAL\" semantic. Normal<T>(int, int) Declares a VertexElement with the semantic \"NORMAL\". public static VertexElement Normal<T>(int semanticIndex = 0, int offsetInBytes = -1) where T : struct Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"NORMAL\" semantic. Type Parameters T The type of the normal element. Exceptions NotSupportedException The specified T is not supported. It cannot be converted to a PixelFormat. Position(PixelFormat, int) Declares a VertexElement with the semantic \"POSITION\". public static VertexElement Position(PixelFormat format, int offsetInBytes = -1) Parameters format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"POSITION\" semantic. Position(int, PixelFormat, int) Declares a VertexElement with the semantic \"POSITION\". public static VertexElement Position(int semanticIndex, PixelFormat format, int offsetInBytes = -1) Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"POSITION\" semantic. PositionTransformed(PixelFormat, int) Declares a VertexElement with the semantic \"SV_POSITION\" (transformed position). public static VertexElement PositionTransformed(PixelFormat format, int offsetInBytes = -1) Parameters format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"SV_POSITION\" semantic. PositionTransformed(int, PixelFormat, int) Declares a VertexElement with the semantic \"SV_POSITION\" (transformed position). public static VertexElement PositionTransformed(int semanticIndex, PixelFormat format, int offsetInBytes = -1) Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"SV_POSITION\" semantic. PositionTransformed<T>(int, int) Declares a VertexElement with the semantic \"SV_POSITION\" (transformed position). public static VertexElement PositionTransformed<T>(int semanticIndex = 0, int offsetInBytes = -1) where T : struct Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"SV_POSITION\" semantic. Type Parameters T The type of the tranformed position element. Exceptions NotSupportedException The specified T is not supported. It cannot be converted to a PixelFormat. Position<T>(int, int) Declares a VertexElement with the semantic \"POSITION\". public static VertexElement Position<T>(int semanticIndex = 0, int offsetInBytes = -1) where T : struct Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"POSITION\" semantic. Type Parameters T The type of the position element. Exceptions NotSupportedException The specified T is not supported. It cannot be converted to a PixelFormat. Tangent(PixelFormat, int) Declares a VertexElement with the semantic \"TANGENT\". public static VertexElement Tangent(PixelFormat format, int offsetInBytes = -1) Parameters format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"TANGENT\" semantic. Tangent(int, PixelFormat, int) Declares a VertexElement with the semantic \"TANGENT\". public static VertexElement Tangent(int semanticIndex, PixelFormat format, int offsetInBytes = -1) Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"TANGENT\" semantic. Tangent<T>(int, int) Declares a VertexElement with the semantic \"TANGENT\". public static VertexElement Tangent<T>(int semanticIndex = 0, int offsetInBytes = -1) where T : struct Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"TANGENT\" semantic. Type Parameters T The type of the tangent element. Exceptions NotSupportedException The specified T is not supported. It cannot be converted to a PixelFormat. TextureCoordinate(PixelFormat, int) Declares a VertexElement with the semantic \"TEXCOORD\" (texture coordinates). public static VertexElement TextureCoordinate(PixelFormat format, int offsetInBytes = -1) Parameters format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"TEXCOORD\" semantic. TextureCoordinate(int, PixelFormat, int) Declares a VertexElement with the semantic \"TEXCOORD\" (texture coordinates). public static VertexElement TextureCoordinate(int semanticIndex, PixelFormat format, int offsetInBytes = -1) Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. format PixelFormat The data format of the element. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"TEXCOORD\" semantic. TextureCoordinate<T>(int, int) Declares a VertexElement with the semantic \"TEXCOORD\" (texture coordinates). public static VertexElement TextureCoordinate<T>(int semanticIndex = 0, int offsetInBytes = -1) where T : struct Parameters semanticIndex int The semantic index for the element, used when multiple elements share the same semantic name. offsetInBytes int The byte offset from the start of the vertex to this element. Use -1 (or a constant like AppendAligned to automatically align the element after the previous one. Returns VertexElement A new Vertex Element that represents the \"TEXCOORD\" semantic. Type Parameters T The type of the texture coordinates element. Exceptions NotSupportedException The specified T is not supported. It cannot be converted to a PixelFormat. ToString() Returns the fully qualified type name of this instance. public override readonly string ToString() Returns string The fully qualified type name. Operators operator ==(VertexElement, VertexElement) public static bool operator ==(VertexElement left, VertexElement right) Parameters left VertexElement right VertexElement Returns bool operator !=(VertexElement, VertexElement) public static bool operator !=(VertexElement left, VertexElement right) Parameters left VertexElement right VertexElement Returns bool"
  },
  "api/Stride.Graphics.VertexElementUsage.html": {
    "href": "api/Stride.Graphics.VertexElementUsage.html",
    "title": "Class VertexElementUsage | Stride API",
    "summary": "Class VertexElementUsage Namespace Stride.Graphics Assembly Stride.Graphics.dll public static class VertexElementUsage Inheritance object VertexElementUsage Fields BiTangent Vertex Bitangent data. public static readonly string BiTangent Field Value string BlendIndices Bone blend indices data. public static readonly string BlendIndices Field Value string BlendWeight Bone blend weight data. public static readonly string BlendWeight Field Value string Color Vertex data contains diffuse or specular color. public static readonly string Color Field Value string Normal Vertex normal data. public static readonly string Normal Field Value string Position Position data. public static readonly string Position Field Value string PositionTransformed Position transformed data. public static readonly string PositionTransformed Field Value string Tangent Vertex tangent data. public static readonly string Tangent Field Value string TextureCoordinate Texture coordinate data. public static readonly string TextureCoordinate Field Value string"
  },
  "api/Stride.Graphics.VertexElementWithOffset.html": {
    "href": "api/Stride.Graphics.VertexElementWithOffset.html",
    "title": "Struct VertexElementWithOffset | Stride API",
    "summary": "Struct VertexElementWithOffset Namespace Stride.Graphics Assembly Stride.Graphics.dll Represents a VertexElement with additional metadata, including its offset and size. public struct VertexElementWithOffset Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors VertexElementWithOffset(VertexElement, int, int) Represents a VertexElement with additional metadata, including its offset and size. public VertexElementWithOffset(VertexElement vertexElement, int offset, int size) Parameters vertexElement VertexElement The Vertex Element structure that describes a vertex attribute. offset int The offset in bytes from the start of the vertex to this element. size int The size in bytes of this element within the vertex structure. Fields Offset The offset in bytes from the start of the vertex to this element. public int Offset Field Value int Size The size in bytes of this element within the vertex structure. public int Size Field Value int VertexElement The Vertex Element structure that describes a vertex attribute. public VertexElement VertexElement Field Value VertexElement"
  },
  "api/Stride.Graphics.VertexHelper.VertexTransformResult.html": {
    "href": "api/Stride.Graphics.VertexHelper.VertexTransformResult.html",
    "title": "Struct VertexHelper.VertexTransformResult | Stride API",
    "summary": "Struct VertexHelper.VertexTransformResult Namespace Stride.Graphics Assembly Stride.Graphics.dll Result of a vertex buffer transform. public struct VertexHelper.VertexTransformResult Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors VertexTransformResult(VertexDeclaration, byte[]) Initializes a new instance of the VertexHelper.VertexTransformResult struct. public VertexTransformResult(VertexDeclaration layout, byte[] vertexBuffer) Parameters layout VertexDeclaration The layout. vertexBuffer byte[] The vertex buffer. Fields Layout The new layout of the vertex buffer. public readonly VertexDeclaration Layout Field Value VertexDeclaration VertexBuffer The vertex buffer. public readonly byte[] VertexBuffer Field Value byte[]"
  },
  "api/Stride.Graphics.VertexHelper.html": {
    "href": "api/Stride.Graphics.VertexHelper.html",
    "title": "Class VertexHelper | Stride API",
    "summary": "Class VertexHelper Namespace Stride.Graphics Assembly Stride.Graphics.dll An helper class for manipulating vertex buffers on CPU (Generate new vertex attributes...etc.) public static class VertexHelper Inheritance object VertexHelper Methods GenerateMultiTextureCoordinates(VertexDeclaration, byte[], int, int) Generates multi texture coordinates for an existing vertex buffer. See remarks. public static VertexHelper.VertexTransformResult GenerateMultiTextureCoordinates(VertexDeclaration vertexDeclaration, byte[] vertexBufferData, int vertexStride = 0, int maxTexcoord = 9) Parameters vertexDeclaration VertexDeclaration The vertex declaration. vertexBufferData byte[] The vertex buffer data. vertexStride int The vertex stride. maxTexcoord int The maximum texcoord. Returns VertexHelper.VertexTransformResult A new vertex buffer with additional texture coordinates. Remarks The original vertex buffer must contain at least a TEXCOORD[0-9] attribute in order for this method to work. This method will copy the value of the first existing TEXCOORD found in the vertex buffer to the newly created TEXCOORDS. Exceptions ArgumentNullException vertexDeclaration or vertexBufferData GenerateMultiTextureCoordinates(VertexDeclaration, nint, int, int, int, int) Generates multi texture coordinates for an existing vertex buffer. See remarks. public static VertexHelper.VertexTransformResult GenerateMultiTextureCoordinates(VertexDeclaration vertexDeclaration, nint vertexBufferData, int vertexCount, int vertexOffset, int vertexStride, int maxTexcoord = 9) Parameters vertexDeclaration VertexDeclaration The vertex declaration. vertexBufferData nint The vertex buffer data. vertexCount int The vertex count. vertexOffset int The vertex offset. vertexStride int The vertex stride. maxTexcoord int The maximum texcoord. Returns VertexHelper.VertexTransformResult A new vertex buffer with additional texture coordinates. Remarks The original vertex buffer must contain at least a TEXCOORD[0-9] attribute in order for this method to work. This method will copy the value of the first existing TEXCOORD found in the vertex buffer to the newly created TEXCOORDS. Exceptions ArgumentNullException vertexDeclaration or vertexBufferData ArgumentOutOfRangeException vertexCount;vertexCount must be > 0 or vertexStride;vertexStride must be >= 0 or maxTexcoord;maxTexcoord must be >= 0 InvalidOperationException The vertex buffer must contain at least the TEXCOORD GenerateMultiTextureCoordinates(VertexTransformResult, int, int) Generates multi texture coordinates for an existing vertex buffer. See remarks. public static VertexHelper.VertexTransformResult GenerateMultiTextureCoordinates(VertexHelper.VertexTransformResult transform, int vertexStride = 0, int maxTexcoord = 9) Parameters transform VertexHelper.VertexTransformResult The result of a previous transform. vertexStride int The vertex stride. maxTexcoord int The maximum texcoord. Returns VertexHelper.VertexTransformResult A new vertex buffer with additional texture coordinates. Remarks The original vertex buffer must contain at least a TEXCOORD[0-9] attribute in order for this method to work. This method will copy the value of the first existing TEXCOORD found in the vertex buffer to the newly created TEXCOORDS. GenerateMultiTextureCoordinates<T>(VertexDeclaration, T[], int) Generates multi texture coordinates for an existing vertex buffer. See remarks. public static VertexHelper.VertexTransformResult GenerateMultiTextureCoordinates<T>(VertexDeclaration vertexDeclaration, T[] vertexBufferData, int maxTexcoord = 9) where T : unmanaged Parameters vertexDeclaration VertexDeclaration The vertex declaration. vertexBufferData T[] The vertex buffer data. maxTexcoord int The maximum texcoord. Returns VertexHelper.VertexTransformResult A new vertex buffer with additional texture coordinates. Type Parameters T Remarks The original vertex buffer must contain at least a TEXCOORD[0-9] attribute in order for this method to work. This method will copy the value of the first existing TEXCOORD found in the vertex buffer to the newly created TEXCOORDS. Exceptions ArgumentNullException vertexDeclaration or vertexBufferData GenerateTangentBinormal(VertexDeclaration, nint, int, int, int, nint, bool, int) Generate Tangent BiNormal from an existing vertex/index buffer. public static VertexHelper.VertexTransformResult GenerateTangentBinormal(VertexDeclaration vertexDeclaration, nint vertexBufferData, int vertexCount, int vertexOffset, int vertexStride, nint indexData, bool is32BitIndex, int indexCountArg) Parameters vertexDeclaration VertexDeclaration The vertex declaration of the vertex buffer passed by parameters. vertexBufferData nint The vertex buffer. vertexCount int The vertex count. vertexOffset int The vertex offset. vertexStride int The vertex stride. If 0, It takes the stride from the vertex declaration indexData nint The index data. is32BitIndex bool if set to true [is32 bit index]. indexCountArg int The index count argument. Returns VertexHelper.VertexTransformResult A new vertex buffer with its new layout. GenerateTangentBinormal<T>(VertexDeclaration, T[], int[]) Generates the tangent binormal for an existing vertex buffer. public static VertexHelper.VertexTransformResult GenerateTangentBinormal<T>(VertexDeclaration vertexDeclaration, T[] vertexBufferData, int[] indexBuffer) where T : unmanaged Parameters vertexDeclaration VertexDeclaration The vertex declaration. vertexBufferData T[] The vertex buffer data. indexBuffer int[] The index buffer. Returns VertexHelper.VertexTransformResult A new vertex buffer with its new layout. Type Parameters T"
  },
  "api/Stride.Graphics.VertexPosition2.html": {
    "href": "api/Stride.Graphics.VertexPosition2.html",
    "title": "Struct VertexPosition2 | Stride API",
    "summary": "Struct VertexPosition2 Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a custom vertex format structure that contains position as a Vector2. public struct VertexPosition2 : IEquatable<VertexPosition2>, IVertex Implements IEquatable<VertexPosition2> IVertex Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors VertexPosition2(Vector2) Initializes a new VertexPositionTexture instance. public VertexPosition2(Vector2 position) Parameters position Vector2 The position of this vertex. Fields Layout The vertex layout of this struct. public static readonly VertexDeclaration Layout Field Value VertexDeclaration Position XY position. public Vector2 Position Field Value Vector2 Size Defines structure byte size. public static readonly int Size Field Value int Methods Equals(VertexPosition2) Indicates whether the current object is equal to another object of the same type. public bool Equals(VertexPosition2 other) Parameters other VertexPosition2 An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FlipWinding() Flip the vertex winding. public void FlipWinding() GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. GetLayout() Gets the layout of the vertex. public VertexDeclaration GetLayout() Returns VertexDeclaration ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(VertexPosition2, VertexPosition2) public static bool operator ==(VertexPosition2 left, VertexPosition2 right) Parameters left VertexPosition2 right VertexPosition2 Returns bool operator !=(VertexPosition2, VertexPosition2) public static bool operator !=(VertexPosition2 left, VertexPosition2 right) Parameters left VertexPosition2 right VertexPosition2 Returns bool"
  },
  "api/Stride.Graphics.VertexPositionColorTexture.html": {
    "href": "api/Stride.Graphics.VertexPositionColorTexture.html",
    "title": "Struct VertexPositionColorTexture | Stride API",
    "summary": "Struct VertexPositionColorTexture Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a custom vertex format structure that contains position and color information. public struct VertexPositionColorTexture : IEquatable<VertexPositionColorTexture>, IVertex Implements IEquatable<VertexPositionColorTexture> IVertex Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors VertexPositionColorTexture(Vector3, Color, Vector2) Initializes a new VertexPositionColorTexture instance. public VertexPositionColorTexture(Vector3 position, Color color, Vector2 textureCoordinate) Parameters position Vector3 The position of this vertex. color Color The color of this vertex. textureCoordinate Vector2 UV texture coordinates. Fields Color The vertex color. public Color Color Field Value Color Layout The vertex layout of this struct. public static readonly VertexDeclaration Layout Field Value VertexDeclaration Position XYZ position. public Vector3 Position Field Value Vector3 Size Defines structure byte size. public static readonly int Size Field Value int TextureCoordinate UV texture coordinates. public Vector2 TextureCoordinate Field Value Vector2 Methods Equals(VertexPositionColorTexture) Indicates whether the current object is equal to another object of the same type. public bool Equals(VertexPositionColorTexture other) Parameters other VertexPositionColorTexture An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FlipWinding() Flip the vertex winding. public void FlipWinding() GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. GetLayout() Gets the layout of the vertex. public VertexDeclaration GetLayout() Returns VertexDeclaration ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(VertexPositionColorTexture, VertexPositionColorTexture) public static bool operator ==(VertexPositionColorTexture left, VertexPositionColorTexture right) Parameters left VertexPositionColorTexture right VertexPositionColorTexture Returns bool operator !=(VertexPositionColorTexture, VertexPositionColorTexture) public static bool operator !=(VertexPositionColorTexture left, VertexPositionColorTexture right) Parameters left VertexPositionColorTexture right VertexPositionColorTexture Returns bool"
  },
  "api/Stride.Graphics.VertexPositionColorTextureSwizzle.html": {
    "href": "api/Stride.Graphics.VertexPositionColorTextureSwizzle.html",
    "title": "Struct VertexPositionColorTextureSwizzle | Stride API",
    "summary": "Struct VertexPositionColorTextureSwizzle Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a custom vertex format structure that contains position, color, texture and swizzle information. public struct VertexPositionColorTextureSwizzle : IEquatable<VertexPositionColorTextureSwizzle>, IVertex Implements IEquatable<VertexPositionColorTextureSwizzle> IVertex Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors VertexPositionColorTextureSwizzle(Vector4, Color, Color, Vector2, SwizzleMode) Initializes a new instance of the VertexPositionColorTextureSwizzle struct. public VertexPositionColorTextureSwizzle(Vector4 position, Color color, Color colorAdd, Vector2 textureCoordinate, SwizzleMode swizzle) Parameters position Vector4 The position of this vertex. color Color The color of this vertex. colorAdd Color textureCoordinate Vector2 UV texture coordinates. swizzle SwizzleMode The swizzle mode Fields ColorAdd The vertex color. public Color4 ColorAdd Field Value Color4 ColorScale The vertex color. public Color4 ColorScale Field Value Color4 Layout The vertex layout of this struct. public static readonly VertexDeclaration Layout Field Value VertexDeclaration Position XYZ position. public Vector4 Position Field Value Vector4 Size Defines structure byte size. public static readonly int Size Field Value int Swizzle The Swizzle mode public float Swizzle Field Value float TextureCoordinate UV texture coordinates. public Vector2 TextureCoordinate Field Value Vector2 Methods Equals(VertexPositionColorTextureSwizzle) Indicates whether the current object is equal to another object of the same type. public bool Equals(VertexPositionColorTextureSwizzle other) Parameters other VertexPositionColorTextureSwizzle An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FlipWinding() Flip the vertex winding. public void FlipWinding() GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. GetLayout() Gets the layout of the vertex. public VertexDeclaration GetLayout() Returns VertexDeclaration ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(VertexPositionColorTextureSwizzle, VertexPositionColorTextureSwizzle) public static bool operator ==(VertexPositionColorTextureSwizzle left, VertexPositionColorTextureSwizzle right) Parameters left VertexPositionColorTextureSwizzle right VertexPositionColorTextureSwizzle Returns bool operator !=(VertexPositionColorTextureSwizzle, VertexPositionColorTextureSwizzle) public static bool operator !=(VertexPositionColorTextureSwizzle left, VertexPositionColorTextureSwizzle right) Parameters left VertexPositionColorTextureSwizzle right VertexPositionColorTextureSwizzle Returns bool"
  },
  "api/Stride.Graphics.VertexPositionNormalColor.html": {
    "href": "api/Stride.Graphics.VertexPositionNormalColor.html",
    "title": "Struct VertexPositionNormalColor | Stride API",
    "summary": "Struct VertexPositionNormalColor Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a custom vertex format structure that contains position, normal and color information. public struct VertexPositionNormalColor : IEquatable<VertexPositionNormalColor>, IVertex Implements IEquatable<VertexPositionNormalColor> IVertex Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors VertexPositionNormalColor(Vector3, Vector3, Color) Initializes a new VertexPositionNormalColor instance. public VertexPositionNormalColor(Vector3 position, Vector3 normal, Color color) Parameters position Vector3 The position of this vertex. normal Vector3 The vertex normal. color Color the color Fields Color The color. public Color Color Field Value Color Layout The vertex layout of this structure. public static readonly VertexDeclaration Layout Field Value VertexDeclaration Normal The vertex normal. public Vector3 Normal Field Value Vector3 Position XYZ position. public Vector3 Position Field Value Vector3 Size Defines structure byte size. public static readonly int Size Field Value int Methods Equals(VertexPositionNormalColor) Indicates whether the current object is equal to another object of the same type. public bool Equals(VertexPositionNormalColor other) Parameters other VertexPositionNormalColor An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FlipWinding() Flip the vertex winding. public void FlipWinding() GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. GetLayout() Gets the layout of the vertex. public VertexDeclaration GetLayout() Returns VertexDeclaration ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(VertexPositionNormalColor, VertexPositionNormalColor) public static bool operator ==(VertexPositionNormalColor left, VertexPositionNormalColor right) Parameters left VertexPositionNormalColor right VertexPositionNormalColor Returns bool operator !=(VertexPositionNormalColor, VertexPositionNormalColor) public static bool operator !=(VertexPositionNormalColor left, VertexPositionNormalColor right) Parameters left VertexPositionNormalColor right VertexPositionNormalColor Returns bool"
  },
  "api/Stride.Graphics.VertexPositionNormalTexture.html": {
    "href": "api/Stride.Graphics.VertexPositionNormalTexture.html",
    "title": "Struct VertexPositionNormalTexture | Stride API",
    "summary": "Struct VertexPositionNormalTexture Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a custom vertex format structure that contains position, normal and texture information. public struct VertexPositionNormalTexture : IEquatable<VertexPositionNormalTexture>, IVertex Implements IEquatable<VertexPositionNormalTexture> IVertex Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors VertexPositionNormalTexture(Vector3, Vector3, Vector2) Initializes a new instance of the VertexPositionNormalTexture struct. public VertexPositionNormalTexture(Vector3 position, Vector3 normal, Vector2 textureCoordinate) Parameters position Vector3 The position of this vertex. normal Vector3 The vertex normal. textureCoordinate Vector2 UV texture coordinates. Fields Layout The vertex layout of this struct. public static readonly VertexDeclaration Layout Field Value VertexDeclaration Normal The vertex normal. public Vector3 Normal Field Value Vector3 Position XYZ position. public Vector3 Position Field Value Vector3 Size Defines structure byte size. public static readonly int Size Field Value int TextureCoordinate UV texture coordinates. public Vector2 TextureCoordinate Field Value Vector2 Methods Equals(VertexPositionNormalTexture) Indicates whether the current object is equal to another object of the same type. public bool Equals(VertexPositionNormalTexture other) Parameters other VertexPositionNormalTexture An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FlipWinding() Flip the vertex winding. public void FlipWinding() GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. GetLayout() Gets the layout of the vertex. public VertexDeclaration GetLayout() Returns VertexDeclaration ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(VertexPositionNormalTexture, VertexPositionNormalTexture) public static bool operator ==(VertexPositionNormalTexture left, VertexPositionNormalTexture right) Parameters left VertexPositionNormalTexture right VertexPositionNormalTexture Returns bool operator !=(VertexPositionNormalTexture, VertexPositionNormalTexture) public static bool operator !=(VertexPositionNormalTexture left, VertexPositionNormalTexture right) Parameters left VertexPositionNormalTexture right VertexPositionNormalTexture Returns bool"
  },
  "api/Stride.Graphics.VertexPositionTexture.html": {
    "href": "api/Stride.Graphics.VertexPositionTexture.html",
    "title": "Struct VertexPositionTexture | Stride API",
    "summary": "Struct VertexPositionTexture Namespace Stride.Graphics Assembly Stride.Graphics.dll Describes a custom vertex format structure that contains position and color information. public struct VertexPositionTexture : IEquatable<VertexPositionTexture>, IVertex Implements IEquatable<VertexPositionTexture> IVertex Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors VertexPositionTexture(Vector3, Vector2) Initializes a new VertexPositionTexture instance. public VertexPositionTexture(Vector3 position, Vector2 textureCoordinate) Parameters position Vector3 The position of this vertex. textureCoordinate Vector2 UV texture coordinates. Fields Layout The vertex layout of this struct. public static readonly VertexDeclaration Layout Field Value VertexDeclaration Position XYZ position. public Vector3 Position Field Value Vector3 Size Defines structure byte size. public static readonly int Size Field Value int TextureCoordinate UV texture coordinates. public Vector2 TextureCoordinate Field Value Vector2 Methods Equals(VertexPositionTexture) Indicates whether the current object is equal to another object of the same type. public bool Equals(VertexPositionTexture other) Parameters other VertexPositionTexture An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FlipWinding() Flip the vertex winding. public void FlipWinding() GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. GetLayout() Gets the layout of the vertex. public VertexDeclaration GetLayout() Returns VertexDeclaration ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(VertexPositionTexture, VertexPositionTexture) public static bool operator ==(VertexPositionTexture left, VertexPositionTexture right) Parameters left VertexPositionTexture right VertexPositionTexture Returns bool operator !=(VertexPositionTexture, VertexPositionTexture) public static bool operator !=(VertexPositionTexture left, VertexPositionTexture right) Parameters left VertexPositionTexture right VertexPositionTexture Returns bool"
  },
  "api/Stride.Graphics.ViewType.html": {
    "href": "api/Stride.Graphics.ViewType.html",
    "title": "Enum ViewType | Stride API",
    "summary": "Enum ViewType Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines what sub-resources (mip-levels, array elements) from a GraphicsResource are selected by a View. public enum ViewType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ArrayBand = 2 A band Texture View containing all the mip level Texture elements from the specified mip level and array index. Here is an example of what the resulting View will cover with a Texture Array of 3, each with 3 mip levels when specifying a mipmap level index of 1, and a array index of 1: Array slice 0 1 2 ┌───┬───┬───┐ 0 │ │ │ │ ■ = Selected M ├───┼───┼───┤ □ = Not selected i 1 │ │ ▓ │ │ p ├───┼───┼───┤ 2 │ │ ▓ │ │ └───┴───┴───┘ Full = 0 Gets a Texture View for the whole Texture and for all mips/arrays dimensions. Here is an example of what the resulting View will cover with a Texture Array of 3, each with 3 mip levels: Array slice 0 1 2 ┌───┬───┬───┐ 0 │ ▓ │ ▓ │ ▓ │ ■ = Selected M ├───┼───┼───┤ □ = Not selected i 1 │ ▓ │ ▓ │ ▓ │ p ├───┼───┼───┤ 2 │ ▓ │ ▓ │ ▓ │ └───┴───┴───┘ MipBand = 3 A band Texture View containing all the array Texture elements from the specified mip level and array index. Here is an example of what the resulting View will cover with a Texture Array of 3, each with 3 mip levels when specifying a mipmap level index of 1, and a array index of 1: Array slice 0 1 2 ┌───┬───┬───┐ 0 │ │ │ │ ■ = Selected M ├───┼───┼───┤ □ = Not selected i 1 │ │ ▓ │ ▓ │ p ├───┼───┼───┤ 2 │ │ │ │ └───┴───┴───┘ Single = 1 The Texture View contains a single Texture element at the specified mip level and array index. Here is an example of what the resulting View will cover with a Texture Array of 3, each with 3 mip levels when specifying a mipmap level index of 1, and a array index of 1: Array slice 0 1 2 ┌───┬───┬───┐ 0 │ │ │ │ ■ = Selected M ├───┼───┼───┤ □ = Not selected i 1 │ │ ▓ │ │ p ├───┼───┼───┤ 2 │ │ │ │ └───┴───┴───┘ Remarks This selection model is taken from Nuaj by Patapom (https://wiki.nuaj.net/index.php?title=Nuaj)."
  },
  "api/Stride.Graphics.Viewport.html": {
    "href": "api/Stride.Graphics.Viewport.html",
    "title": "Struct Viewport | Stride API",
    "summary": "Struct Viewport Namespace Stride.Graphics Assembly Stride.Graphics.dll Defines the viewport dimensions of a render-target surface onto which a 3D volume projects. public struct Viewport : IEquatable<Viewport> Implements IEquatable<Viewport> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Viewport(Rectangle) Initializes a new instance of the Viewport struct. public Viewport(Rectangle bounds) Parameters bounds Rectangle A rectangle that defines the location and size of the viewport in a render target. Viewport(int, int, int, int) Initializes a new instance of the Viewport struct. public Viewport(int x, int y, int width, int height) Parameters x int The X coordinate of the upper-left corner of the viewport in pixels. y int The Y coordinate of the upper-left corner of the viewport in pixels. width int The width of the viewport in pixels. height int The height of the viewport in pixels. Viewport(float, float, float, float) Initializes a new instance of the Viewport struct. public Viewport(float x, float y, float width, float height) Parameters x float The X coordinate of the upper-left corner of the viewport in pixels. y float The Y coordinate of the upper-left corner of the viewport in pixels. width float The width of the viewport in pixels. height float The height of the viewport in pixels. Fields Empty Empty value for an undefined viewport. public static readonly Viewport Empty Field Value Viewport Height Height dimension of the viewport on the render-target surface, in pixels. public float Height Field Value float MaxDepth Maximum depth of the clip volume. public float MaxDepth Field Value float MinDepth Minimum depth of the clip volume. public float MinDepth Field Value float Width Width dimension of the viewport on the render-target surface, in pixels. public float Width Field Value float X X coordinate of the upper-left corner of the viewport on the render-target surface, in pixels. public float X Field Value float Y Y coordinate of the upper-left corner of the viewport on the render-target surface, in pixels. public float Y Field Value float Properties AspectRatio Gets the aspect ratio of the viewport, i.e. Width / Height. public readonly float AspectRatio { get; } Property Value float Bounds Gets a rectangle with the location and size of the viewport. public Rectangle Bounds { readonly get; set; } Property Value Rectangle Size Gets the size of the viewport. public readonly Vector2 Size { get; } Property Value Vector2 Methods Equals(Viewport) Indicates whether the current object is equal to another object of the same type. public readonly bool Equals(Viewport other) Parameters other Viewport An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override readonly bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override readonly int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Project(Vector3, Matrix, Matrix, Matrix) Projects a 3D vector from object space into screen space. public readonly Vector3 Project(Vector3 source, Matrix projection, Matrix view, Matrix world) Parameters source Vector3 The vector to project. projection Matrix The projection matrix. view Matrix The view matrix. world Matrix The world matrix. Returns Vector3 ToString() Returns a string representation of this viewport. public override readonly string ToString() Returns string Unproject(Vector3, Matrix, Matrix, Matrix) Converts a screen space point into a corresponding point in world space. public Vector3 Unproject(Vector3 source, Matrix projection, Matrix view, Matrix world) Parameters source Vector3 The vector to unproject. projection Matrix The projection matrix. view Matrix The view matrix. world Matrix The world matrix. Returns Vector3 Unproject(Vector3, ref readonly Matrix) Converts a screen space point into a corresponding point in world space. public readonly Vector3 Unproject(Vector3 source, ref readonly Matrix worldViewProjection) Parameters source Vector3 The vector to unproject. worldViewProjection Matrix The World-View-Projection matrix. Returns Vector3 Operators operator ==(Viewport, Viewport) public static bool operator ==(Viewport left, Viewport right) Parameters left Viewport right Viewport Returns bool operator !=(Viewport, Viewport) public static bool operator !=(Viewport left, Viewport right) Parameters left Viewport right Viewport Returns bool"
  },
  "api/Stride.Graphics.WindowHandle.html": {
    "href": "api/Stride.Graphics.WindowHandle.html",
    "title": "Class WindowHandle | Stride API",
    "summary": "Class WindowHandle Namespace Stride.Graphics Assembly Stride.Graphics.dll Encapsulates a platform-specific window handle. public class WindowHandle Inheritance object WindowHandle Extension Methods UnsafeUtilities.As<T>(object?) Constructors WindowHandle(AppContextType, object, nint) Encapsulates a platform-specific window handle. public WindowHandle(AppContextType context, object nativeWindow, nint handle) Parameters context AppContextType The context type, indicating the platform and UI framework. nativeWindow object The native window instance (e.g. a Windows Forms' Form, a SDL's SDLWindow, etc.). handle nint The associated handle of nativeWindow. Fields Context The context type, indicating the platform and graphics API. public readonly AppContextType Context Field Value AppContextType Properties Handle Gets the associated platform-specific handle of NativeWindow. public nint Handle { get; } Property Value nint NativeWindow Gets the native window as an opaque object. public object NativeWindow { get; } Property Value object"
  },
  "api/Stride.Graphics.html": {
    "href": "api/Stride.Graphics.html",
    "title": "Namespace Stride.Graphics | Stride API",
    "summary": "Namespace Stride.Graphics Classes BatchBase<TDrawInfo> Base class to batch a group of draw calls into one. BatchBase<TDrawInfo>.DeviceResourceContext Use a ResourceContext per GraphicsDevice (DeviceContext) BatchBase<TDrawInfo>.QueueComparer<TInfo> BatchBase<TDrawInfo>.ResourceBufferInfo A class containing information on how to build the batch vertex and index buffer. BatchBase<TDrawInfo>.StaticQuadBufferInfo A class containing the information required to build a vertex and index buffer for simple quad based batching. BatchBase<TDrawInfo>.TextureIdComparer BlendStates Defines a set of built-in BlendStateDescriptions for common blending configurations. Buffer All-in-one GPU Buffer that is able to represent many types of Buffers (shader Constant Buffers, Structured Buffers, Raw Buffers, Argument Buffers, etc.). Buffer.Argument Helper methods for creating Argument Buffers. Buffer.Constant Helper methods for creating Constant Buffers. Buffer.Index Helper methods for creating Index Buffers. Buffer.Raw Helper methods for creating Raw Buffers. Buffer.Structured Helper methods for creating Structured Buffers. Buffer.StructuredAppend Helper methods for creating Structured Append Buffers. Buffer.StructuredCounter Helper methods for creating Structured Counter Buffers. Buffer.Typed Helper methods for creating Typed Buffers. Buffer.Vertex Helper methods for creating Vertex Buffers. BufferPool Buffer<T> All-in-one GPU buffer that is able to represent many types of Buffers (shader Constant Buffers, Structured Buffers, Raw Buffers, Argument Buffers, etc.), but with typed information. ColorExtensions Extension class for Color CommandList Represents a list of graphics commands for playback, which can include resource binding, primitive-based rendering, etc. DepthStencilStates Defines a set of built-in DepthStencilStateDescriptions for common Depth and Stencil testing configurations. DescriptorPool A pool where the application can allocate Descriptors that are grouped together in DescriptorSets. DescriptorSetLayout Defines the Graphics Resources (Descriptors) that need to be bound together, their layout, types, and other associated metadata. This description is used to allocate a DescriptorSet. DescriptorSetLayoutBuilder Helper class to build a DescriptorSetLayout. Effect EffectDescriptorSetReflection A reflection object that describes the Descriptor Sets and their layouts for an Effect / Shader based on reflection data extracted from its bytecode. This includes the bindings for Graphics Resources such as Textures, Buffers, and Sampler States. FastTextRenderer Renders text with a fixed size font. GeometricMeshData<T> A geometric data. GraphicsAdapter Represents a display subsystem (including one or more GPUs, DACs and video memory). A display subsystem is often referred to as a video card, however, on some machines the display subsystem is part of the motherboard. GraphicsAdapterFactory Static factory for obtaining the available GraphicsAdapters in the system. GraphicsContext A graphics command context. You should usually stick to one per rendering thread. GraphicsDevice A virtual adapter that can be used for creating GPU resources (buffers, textures, states, shaders, etc), and to manipulate CommandLists. GraphicsDeviceException An exception that is thrown when a Graphics Device operation fails. GraphicsDeviceExtensions Defines a set of extension methods for the GraphicsDevice class. GraphicsDeviceServiceLocal A default simple implementation of IGraphicsDeviceService that is used by some systems that only need quick access to the GraphicsDevice. GraphicsException An exception that is thrown when a graphics operation fails. GraphicsMarshal An unsafe class that provides a set of methods to access the underlying native DXGI and Direct3D devices and resources from its Stride counterparts. GraphicsOutput Represents an output (such as a monitor) attached to a GraphicsAdapter. GraphicsPresenter Represents an abstraction over a Swap-Chain. GraphicsResource Represents an abstract resource that depends on a GraphicsDevice. GraphicsResourceAllocator A GraphicsResource allocator tracking usage references and allowing to recycle unused resources based on a recycle policy. GraphicsResourceAllocator.ResourceCache<TResourceDesc> Internal type for a cache of Graphics Resources associated with their description. GraphicsResourceAllocatorExtensions Extensions for the GraphicsResourceAllocator. GraphicsResourceBase Base class for a Graphics Resource. GraphicsResourceFactoryBase Base class for all Graphics Resource factories. GraphicsResourceLink An object linking a Graphics Resource allocated by a GraphicsResourceAllocator and providing allocation information. Image Provides method to instantiate an image 1D/2D/3D supporting TextureArray and mipmaps on the CPU or to load/save an image from the disk. ImageFileTypeExtensions ImageHelper IndexBufferBinding Binding structure that specifies an Index Buffer for a Graphics Device. MeshExtension MutablePipelineState A convenience class that allows to compose a Pipeline State by modifying its configuration (as PipelineState objects are immutable once compiled), and only compile it into a Pipeline State object when needed. ParameterCollectionLayoutExtensions Provides extension methods for updating ParameterCollectionLayout instances. PipelineState A Pipeline State object encapsulates the complete pipeline configuration, including Shaders, input layout, Render States, and output settings. It represents an atomic, immutable collection of states that can be efficiently bound and unbound as a single unit during rendering operations. An instance of this class can represent either the state of the graphics pipeline, or the state of the compute pipeline (in the platforms that support compute). PipelineStateDescription Describes the configuration of the graphics pipeline that will be encapsulated by a PipelineState object. This includes Shaders, input layout, Render States, and output settings. PixelBuffer An unmanaged buffer of pixels. PixelBufferArray Used by Image to provide a selector to a PixelBuffer. PixelFormatExtensions Provides extensions for PixelFormat to help in conversions between formats, querying format information, calculating sizes, pitches, etc. PresentationParameters Describes how a GraphicsDevice will display to the screen. PrimitiveQuad A primitive triangle that can be used to draw a Texture or an Effect, commonly used to draw full-screen. This is directly accessible from the DrawQuad(GraphicsContext, EffectInstance) method. PrimitiveTypeExtensions Defines extensions and helpers for PrimitiveType. QueryPool A pool holding asynchronous GPU Queries of a specific type. RasterizerStates Defines a set of built-in RasterizerStateDescriptions for common rasterizer configurations. RenderTargetGraphicsPresenter A simple GraphicsPresenter wrapping a Render-Target Texture where drawing will occur but no actual presentation will happen. RenderingSettings ResourceGroup Groups bound Graphics Resources and a Constant Buffer, that usually change at a given frequency. ResourceGroupAllocator Allocator for resource groups. ResourceGroupLayout Represents the layout of the Graphics Resources and parameter values which form a resource group. ResumeManager RootSignature Represents a Root Signature, used to specify how Graphics Resources, such as Textures and Buffers, are bound to the graphics pipeline (i.e. how DescriptorSet will be bound together). SamplerState A graphics object that describes a Sampler State, which determines how to sample Texture data. SamplerStateFactory A factory for creating SamplerState instances. Contains pre-created Sampler States for commonly used configurations. SamplerStateSerializer Serializer for SamplerState. Sprite A sprite. Sprite3DBatch A batcher for sprite in the 3D world. SpriteBatch Renders a group of sprites. SpriteEffect SpriteExtensions A sprite represents a series frames in an atlas forming an animation. SpriteFont SpriteFont to use with SpriteBatch. See SpriteFont to learn how to use it. SpriteFrame A sprite frame represents a single frame a sprite animation. It contains the region of the texture representing the frame and the time it is supposed to be displayed. SpriteSheet A sheet (group) of sprites. SwapChainGraphicsPresenter A GraphicsPresenter wrapping a DirectX Swap-Chain (Silk.NET.DXGI.IDXGISwapChain). Texture All-in-one GPU Texture that is able to represent many types of textures (1D, 2D, 3D, Depth-Stencil Buffers, Render Targets, etc), as well as Texture Views over a parent Texture. TextureExtensions UIBatch A utility class to batch and draw UI images. VertexBufferBindingExtensions Provides extension methods that facilitate the conversion of Vertex Declarations and Vertex Buffer bindings into InputElementDescription structures, which are used to define the input layout for Shaders in the graphics pipeline. VertexDeclaration Defines the layout of the vertices in a Vertex Buffer by specifying its component VertexElements. VertexElementUsage VertexHelper An helper class for manipulating vertex buffers on CPU (Generate new vertex attributes...etc.) WindowHandle Encapsulates a platform-specific window handle. Structs BatchBase<TDrawInfo>.DrawTextures BatchBase<TDrawInfo>.ElementInfo The structure containing all the information required to batch one element. BlendStateDescription A description of a Blend State, which defines how colors are blended when rendering to one or multiple Render Targets. BlendStateDescription.RenderTargetBlendStates A structure that contains an inline array of BlendStateRenderTargetDescription for up to eight render targets. BlendStateRenderTargetDescription A description of a Blend State for a Render Target, which defines how colors are blended when rendering. BufferDescription Describes a GPU Buffer. BufferPoolAllocationResult CompiledCommandList DataBox Defines a region of data organized in 3D. DataPointer DataRectangle Provides a pointer to 2D data. DefaultCommandListLock Used to prevent concurrent uses of CommandList against the main one. DepthStencilStateDescription A description of a Depth-Stencil State, which defines how depth and stencil testing are performed during rasterization. DepthStencilStencilOpDescription Describes the stencil operations and comparison function used during stencil testing for a given face orientation (front or back). DescriptorSet Represents a set of Descriptors (such as Textures or Buffers) that can be bound together to a graphics pipeline. DescriptorTypeCount Describes how many Descriptor of a specific type will need to be allocated in a DescriptorPool. DisplayMode Describes a display mode. GraphicsDeviceFeatures Contains information about the general features supported by a GraphicsDevice, as well as supported features specific to a particular pixel format or data format. GraphicsDeviceFeatures.FeaturesPerFormat Contains information about the features a GraphicsDevice supports for a particular PixelFormat. GraphicsResourceAllocator.QueryPoolDescription A description of a GPU queries pool. ImageDescription A description for Image. IndexBufferHelper InputElementDescription Describes a single input element for the definition of a vertex format layout. MappedResource A GPU resource mapped for CPU access. This is returned by using MapSubResource(GraphicsResource, int, MapMode, bool, int, int). MipMapCount Describes the number of mipmap levels of a Texture. MipMapDescription Describes a mipmap image. RasterizerStateDescription A description of a Rasterizer State, which defines how primitives are rasterized to the Render Targets. Rational Represents a rational number. RenderOutputDescription Describes the output formats of the Render Targets and the Depth-Stencil Buffer. ResourceGroupBufferUploader Describes how a Descriptor Set maps to real resource bindings. ResourceGroupDescription Represents a description of a resource group, including the layout of its Graphics Resources and Constant Buffers. ResourceRegion Defines a 3D box with integer coordinates, represented as the coordinates of its minimum (left, top, front) and maximum (right, bottom, back) corners. SamplerStateDescription Describes a Sampler State object, which determines how to sample Texture data. Sprite3DBatch.Sprite3DDrawInfo SpriteBatch.SpriteDrawInfo SpriteFont.GlyphPosition TextureDescription A structure providing a common description for all kinds of Textures. TextureViewDescription Describes a View for a Texture. UIBatch.UIImageDrawInfo Vertex2DPositionTexture Describes a custom vertex format structure that contains position and UV information. VertexBufferBinding Binding structure that specifies a Vertex Buffer and other per-vertex parameters (such as offset and instancing) for a Graphics Device. VertexBufferHelper VertexBufferHelper.CopyAsTriangleList VertexElement A description of a single element for the input-assembler stage. This structure is related to SharpDX.Direct3D11.InputElement. VertexElementWithOffset Represents a VertexElement with additional metadata, including its offset and size. VertexHelper.VertexTransformResult Result of a vertex buffer transform. VertexPosition2 Describes a custom vertex format structure that contains position as a Vector2. VertexPositionColorTexture Describes a custom vertex format structure that contains position and color information. VertexPositionColorTextureSwizzle Describes a custom vertex format structure that contains position, color, texture and swizzle information. VertexPositionNormalColor Describes a custom vertex format structure that contains position, normal and color information. VertexPositionNormalTexture Describes a custom vertex format structure that contains position, normal and texture information. VertexPositionTexture Describes a custom vertex format structure that contains position and color information. Viewport Defines the viewport dimensions of a render-target surface onto which a 3D volume projects. Interfaces IGraphicsDeviceService Service providing access to the GraphicsDevice and events that can be subscribed to be notified of when the device is created, reset, or disposed. IVertex The base interface for all the vertex data structure. VertexBufferHelper.IReader<TDest> VertexBufferHelper.IWriter<TDest> Enums Blend A Blend Option identifying the data source and an optional pre-blend operation, which help define how Pixel Shader output is mixed with the destination color in rendering operations. BlendFunction Defines a function for color blending. BufferFlags Identifies the intended use of a graphics Buffer when rendering. BufferPoolAllocationType ColorSpace Defines the color space used for Textures, Materials, lighting calculations, etc. ColorSpaceType Specifies the type of color space a Graphics Presenter has to output. ColorWriteChannels Identifies which components of each pixel of a Render Target can be written to during blending. CompareFunction Identifies comparison functions that can be used to determine how the runtime compares source (new) data against destination (existing) data before storing the new data. ComputeShaderFormatSupport Flags specifying which resources and features are supported when using compute shaders for a given pixel format for a graphics device. CubeMapFace Defines the faces of a cube map for Cube Texture. CullMode Indicates the facing direction of triangles that will be culled (not drawn). DepthStencilClearOptions Flags that specify what parts of a Depth-Stencil Buffer to clear when calling Clear(Texture, DepthStencilClearOptions, float, byte). DeviceCreationFlags Flags describing the parameters that are used to create a Graphics Device. DisplayOrientation Describes the orientation of the display. DisplayRotation Defines the rotation of a display, indicating how the Back-Buffers should be rotated to fit the physical rotation of a monitor. FillMode Determines the fill mode to use when rendering triangles. FormatSupport Flags specifying which resources and features are supported for a given PixelFormat for a GraphicsDevice. GraphicsDeviceStatus Describes the current status of a GraphicsDevice. GraphicsPlatform The graphics platform. GraphicsProfile Identifies the base set of capabilities a Graphics Device supports. GraphicsResourceLifetimeState Describes the lifetime state of a graphics resource. GraphicsResourceState Defines constants that specify the state of a Graphics Resource regarding how the resource is being used. GraphicsResourceUsage Identifies the intended use of a resource during rendering. The usage directly reflects whether a resource is accessible by the CPU and/or the GPU. ImageFileType Image file format used by Save(Stream, ImageFileType) ImageOrientation Defines the possible rotations to apply on image regions. IndexElementSize Specifies the size of indices in an Index Buffer. InputClassification Specifies whether the data of a Input Element is per-vertex or per-instance. MapMode Describes how the CPU is accessing a GraphicsResource with the MapSubResource(GraphicsResource, int, MapMode, bool, int, int) method. MultisampleCount Defines the level of multisampling. PixelFormat Defines various types of pixel formats. PreferredGraphicsPlatform PresentInterval Defines the relationship between the GraphicsOutput's refresh rate and the rate at which Present operations are completed. PrimitiveType Values that indicate how the graphics pipeline interprets input vertex data. QueryType Defines the types of a GPU query. RequiredDisplayOrientation SpriteEffects Defines sprite mirroring options. SpriteFontType SpriteSortMode Defines sprite sort-rendering options. StencilOperation Specifies the operation to perform on the stencil part of the Depth-Stencil Buffer when rasterizing primitives. SwizzleMode Specify how to swizzle a vector. TextAlignment Specify the available text alignment when rendering text. TextureAddressMode Identifies a technique for resolving Texture coordinates that are outside of the boundaries of a Texture (outside the [0, 1] range). TextureDimension Identifies the type of Texture resource being used. TextureFilter Identifies the filtering mode to use during Texture sampling. TextureFlags Flags describing how a Texture can be bound to the graphics pipeline. TextureOptions Flags describing resource options for a Texture. UIBatch.PrimitiveType The primitive type to draw for an element. ViewType Defines what sub-resources (mip-levels, array elements) from a GraphicsResource are selected by a View. Delegates GraphicsDevice.CreateSharedData<T> A delegate called to create shareable data. GraphicsDevice.GraphicsDeviceInfoMessageHandler Represents a method that handles messages related to Graphics Device information. GraphicsResourceAllocator.CreateResourceDelegate<TResource, TDescription> Represents a method that creates a Graphics Resource of type TResource based on the specified description and pixel format. GraphicsResourceAllocator.GetDescriptionDelegate<TResource, TDescription> Represents a method that retrieves a description of a Graphics Resource. GraphicsResourceRecyclePolicyDelegate A recycle policy to check whether a Graphics Resource tracked by a GraphicsResourceAllocator must be disposed / recycled. Image.ImageLoadDelegate Image.ImageSaveDelegate"
  },
  "api/Stride.Input.AxisEvent.html": {
    "href": "api/Stride.Input.AxisEvent.html",
    "title": "Class AxisEvent | Stride API",
    "summary": "Class AxisEvent Namespace Stride.Input Assembly Stride.Input.dll Event for an axis changing state on a device public abstract class AxisEvent : InputEvent, IInputEventArgs Inheritance object InputEvent AxisEvent Implements IInputEventArgs Derived GameControllerAxisEvent GamePadAxisEvent Inherited Members InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields Value The new value of the axis public float Value Field Value float"
  },
  "api/Stride.Input.ButtonEvent.html": {
    "href": "api/Stride.Input.ButtonEvent.html",
    "title": "Class ButtonEvent | Stride API",
    "summary": "Class ButtonEvent Namespace Stride.Input Assembly Stride.Input.dll Event for a button changing state on a device public abstract class ButtonEvent : InputEvent, IInputEventArgs Inheritance object InputEvent ButtonEvent Implements IInputEventArgs Derived GameControllerButtonEvent GamePadButtonEvent KeyEvent MouseButtonEvent Inherited Members InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields IsDown The new state of the button public bool IsDown Field Value bool"
  },
  "api/Stride.Input.DeviceChangedEventArgs.html": {
    "href": "api/Stride.Input.DeviceChangedEventArgs.html",
    "title": "Class DeviceChangedEventArgs | Stride API",
    "summary": "Class DeviceChangedEventArgs Namespace Stride.Input Assembly Stride.Input.dll An event used when a device was changed public class DeviceChangedEventArgs : EventArgs Inheritance object EventArgs DeviceChangedEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Fields Device The device that changed public IInputDevice Device Field Value IInputDevice Source The input source this device belongs to public IInputSource Source Field Value IInputSource Type The type of change that happened public DeviceChangedEventType Type Field Value DeviceChangedEventType"
  },
  "api/Stride.Input.DeviceChangedEventType.html": {
    "href": "api/Stride.Input.DeviceChangedEventType.html",
    "title": "Enum DeviceChangedEventType | Stride API",
    "summary": "Enum DeviceChangedEventType Namespace Stride.Input Assembly Stride.Input.dll public enum DeviceChangedEventType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Added = 1 A device was added Removed = 0 A device was removed"
  },
  "api/Stride.Input.Direction.html": {
    "href": "api/Stride.Input.Direction.html",
    "title": "Struct Direction | Stride API",
    "summary": "Struct Direction Namespace Stride.Input Assembly Stride.Input.dll Represents a direction or neutral position public struct Direction : IEquatable<Direction> Implements IEquatable<Direction> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Direction(Vector2) Creates a new direction from the given vector public Direction(Vector2 direction) Parameters direction Vector2 A normalized 2d direction or Zero for a neutral position Fields Down public static readonly Direction Down Field Value Direction Left public static readonly Direction Left Field Value Direction LeftDown public static readonly Direction LeftDown Field Value Direction LeftUp public static readonly Direction LeftUp Field Value Direction None public static readonly Direction None Field Value Direction Right public static readonly Direction Right Field Value Direction RightDown public static readonly Direction RightDown Field Value Direction RightUp public static readonly Direction RightUp Field Value Direction Up public static readonly Direction Up Field Value Direction Properties IsNeutral true if the direction is in a neutral position. Same as checking against Direction.None public bool IsNeutral { get; } Property Value bool Methods Equals(Direction) Indicates whether the current object is equal to another object of the same type. public bool Equals(Direction other) Parameters other Direction An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. FromTicks(int, int) Creates a new direction from a ratio. with 0/1 corresponding to the direction (0,1), 1/4 corresponding to (1,0), etc. public static Direction FromTicks(int value, int maxValue) Parameters value int The amount of ticks clockwise from the Up direction (numerator) maxValue int The number of ticks representing a full rotation (denominator) Returns Direction A direction with ratio value over maxValue GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. GetTicks(int) Retrieves the amount of ticks clockwise from the Up direction public int GetTicks(int maxValue) Parameters maxValue int The number of ticks representing a full rotation Returns int ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(Direction, Direction) public static bool operator ==(Direction left, Direction right) Parameters left Direction right Direction Returns bool explicit operator Direction(Vector2) public static explicit operator Direction(Vector2 value) Parameters value Vector2 Returns Direction explicit operator Vector2(Direction) public static explicit operator Vector2(Direction value) Parameters value Direction Returns Vector2 operator !=(Direction, Direction) public static bool operator !=(Direction left, Direction right) Parameters left Direction right Direction Returns bool"
  },
  "api/Stride.Input.GameControllerAxisEvent.html": {
    "href": "api/Stride.Input.GameControllerAxisEvent.html",
    "title": "Class GameControllerAxisEvent | Stride API",
    "summary": "Class GameControllerAxisEvent Namespace Stride.Input Assembly Stride.Input.dll An event to describe a change in a game controller axis state public class GameControllerAxisEvent : AxisEvent, IInputEventArgs Inheritance object InputEvent AxisEvent GameControllerAxisEvent Implements IInputEventArgs Inherited Members AxisEvent.Value InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields Index Index of the axis public int Index Field Value int Properties GameController The game controller that sent this event public IGameControllerDevice GameController { get; } Property Value IGameControllerDevice Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.GameControllerAxisInfo.html": {
    "href": "api/Stride.Input.GameControllerAxisInfo.html",
    "title": "Class GameControllerAxisInfo | Stride API",
    "summary": "Class GameControllerAxisInfo Namespace Stride.Input Assembly Stride.Input.dll Provides information about a gamepad axis public class GameControllerAxisInfo : GameControllerObjectInfo Inheritance object GameControllerObjectInfo GameControllerAxisInfo Inherited Members GameControllerObjectInfo.Name Extension Methods UnsafeUtilities.As<T>(object?) Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.GameControllerButtonEvent.html": {
    "href": "api/Stride.Input.GameControllerButtonEvent.html",
    "title": "Class GameControllerButtonEvent | Stride API",
    "summary": "Class GameControllerButtonEvent Namespace Stride.Input Assembly Stride.Input.dll An event to describe a change in game controller button state public class GameControllerButtonEvent : ButtonEvent, IInputEventArgs Inheritance object InputEvent ButtonEvent GameControllerButtonEvent Implements IInputEventArgs Inherited Members ButtonEvent.IsDown InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields Index The index of the button public int Index Field Value int Properties GameController The game controller that sent this event public IGameControllerDevice GameController { get; } Property Value IGameControllerDevice Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.GameControllerButtonInfo.html": {
    "href": "api/Stride.Input.GameControllerButtonInfo.html",
    "title": "Class GameControllerButtonInfo | Stride API",
    "summary": "Class GameControllerButtonInfo Namespace Stride.Input Assembly Stride.Input.dll Provides information about a gamepad button public class GameControllerButtonInfo : GameControllerObjectInfo Inheritance object GameControllerObjectInfo GameControllerButtonInfo Inherited Members GameControllerObjectInfo.Name Extension Methods UnsafeUtilities.As<T>(object?) Fields Type The type of button public GameControllerButtonType Type Field Value GameControllerButtonType Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.GameControllerButtonType.html": {
    "href": "api/Stride.Input.GameControllerButtonType.html",
    "title": "Enum GameControllerButtonType | Stride API",
    "summary": "Enum GameControllerButtonType Namespace Stride.Input Assembly Stride.Input.dll The types of gamepad buttons public enum GameControllerButtonType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields PushButton = 0 A regular button ToggleButton = 1 A button that is physically toggled when pressed"
  },
  "api/Stride.Input.GameControllerDeviceBase.html": {
    "href": "api/Stride.Input.GameControllerDeviceBase.html",
    "title": "Class GameControllerDeviceBase | Stride API",
    "summary": "Class GameControllerDeviceBase Namespace Stride.Input Assembly Stride.Input.dll Base class for gamepads, contains common functionality for gamepad devices public abstract class GameControllerDeviceBase : IGameControllerDevice, IInputDevice Inheritance object GameControllerDeviceBase Implements IGameControllerDevice IInputDevice Extension Methods GameControllerDeviceExtensions.IsButtonDown(IGameControllerDevice, int) GameControllerDeviceExtensions.IsButtonPressed(IGameControllerDevice, int) GameControllerDeviceExtensions.IsButtonReleased(IGameControllerDevice, int) GameControllerExtensions.GetAxisCount(IGameControllerDevice) GameControllerExtensions.GetButtonCount(IGameControllerDevice) GameControllerExtensions.GetDPad(IGameControllerDevice, int) GameControllerExtensions.GetDirectionCount(IGameControllerDevice) UnsafeUtilities.As<T>(object?) Constructors GameControllerDeviceBase() protected GameControllerDeviceBase() Fields AxisStates protected float[] AxisStates Field Value float[] ButtonStates protected bool[] ButtonStates Field Value bool[] DirectionStates protected Direction[] DirectionStates Field Value Direction[] Properties AxisInfos Information about the axes on this game controller public abstract IReadOnlyList<GameControllerAxisInfo> AxisInfos { get; } Property Value IReadOnlyList<GameControllerAxisInfo> ButtonInfos Information about the buttons on this game controller public abstract IReadOnlyList<GameControllerButtonInfo> ButtonInfos { get; } Property Value IReadOnlyList<GameControllerButtonInfo> DirectionInfos Information about the direction controllers on this game controller public abstract IReadOnlyList<GameControllerDirectionInfo> DirectionInfos { get; } Property Value IReadOnlyList<GameControllerDirectionInfo> DownButtons The buttons that are down public IReadOnlySet<int> DownButtons { get; } Property Value IReadOnlySet<int> Id The unique identifier of this device public abstract Guid Id { get; } Property Value Guid Name The name of the device public abstract string Name { get; } Property Value string PressedButtons The buttons that have been pressed since the last frame public IReadOnlySet<int> PressedButtons { get; } Property Value IReadOnlySet<int> Priority The device priority. Larger means higher priority when selecting the first device of some type public int Priority { get; set; } Property Value int ProductId Product Id of the device public virtual Guid ProductId { get; } Property Value Guid ReleasedButtons The buttons that have been released since the last frame public IReadOnlySet<int> ReleasedButtons { get; } Property Value IReadOnlySet<int> Source The input source the device belongs to. public abstract IInputSource Source { get; } Property Value IInputSource Methods GetAxis(int) Retrieves the state of a single axis public virtual float GetAxis(int index) Parameters index int The axis' index, as exposed in AxisInfos Returns float The value read directly from the axis GetDirection(int) Retrieves the state of a single point of direction controller public virtual Direction GetDirection(int index) Parameters index int The direction controller's index, as exposed in DirectionInfos Returns Direction The current state of the direction controller HandleAxis(int, float) protected void HandleAxis(int index, float state) Parameters index int state float HandleButton(int, bool) protected void HandleButton(int index, bool state) Parameters index int state bool HandleDirection(int, Direction) protected void HandleDirection(int index, Direction state) Parameters index int state Direction InitializeButtonStates() Creates the correct amount of states based on the amount of object infos that are set protected void InitializeButtonStates() Update(List<InputEvent>) Raise gamepad events collected by Handle... functions public virtual void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent>"
  },
  "api/Stride.Input.GameControllerDeviceExtensions.html": {
    "href": "api/Stride.Input.GameControllerDeviceExtensions.html",
    "title": "Class GameControllerDeviceExtensions | Stride API",
    "summary": "Class GameControllerDeviceExtensions Namespace Stride.Input Assembly Stride.Input.dll Provides easier ways to set vibration levels on a controller, rather than setting 4 motors public static class GameControllerDeviceExtensions Inheritance object GameControllerDeviceExtensions Methods IsButtonDown(IGameControllerDevice, int) Determines whether the specified button is being pressed down public static bool IsButtonDown(this IGameControllerDevice controller, int button) Parameters controller IGameControllerDevice The controller button int The button Returns bool true if the specified button is being pressed down; otherwise, false. IsButtonPressed(IGameControllerDevice, int) Determines whether the specified button is pressed since the previous update. public static bool IsButtonPressed(this IGameControllerDevice controller, int button) Parameters controller IGameControllerDevice The controller button int The button Returns bool true if the specified button is pressed; otherwise, false. IsButtonReleased(IGameControllerDevice, int) Determines whether the specified button is released since the previous update. public static bool IsButtonReleased(this IGameControllerDevice controller, int button) Parameters controller IGameControllerDevice The controller button int The button Returns bool true if the specified button is released; otherwise, false."
  },
  "api/Stride.Input.GameControllerDirectionEvent.html": {
    "href": "api/Stride.Input.GameControllerDirectionEvent.html",
    "title": "Class GameControllerDirectionEvent | Stride API",
    "summary": "Class GameControllerDirectionEvent Namespace Stride.Input Assembly Stride.Input.dll An event to describe a change in game controller direction state public class GameControllerDirectionEvent : InputEvent, IInputEventArgs Inheritance object InputEvent GameControllerDirectionEvent Implements IInputEventArgs Inherited Members InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields Direction The new direction public Direction Direction Field Value Direction Index The index of the direction controller public int Index Field Value int Properties GameController The gamepad that sent this event public IGameControllerDevice GameController { get; } Property Value IGameControllerDevice Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.GameControllerDirectionInfo.html": {
    "href": "api/Stride.Input.GameControllerDirectionInfo.html",
    "title": "Class GameControllerDirectionInfo | Stride API",
    "summary": "Class GameControllerDirectionInfo Namespace Stride.Input Assembly Stride.Input.dll Provides information about a gamepad direction input public class GameControllerDirectionInfo : GameControllerObjectInfo Inheritance object GameControllerObjectInfo GameControllerDirectionInfo Inherited Members GameControllerObjectInfo.Name Extension Methods UnsafeUtilities.As<T>(object?) Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.GameControllerExtensions.html": {
    "href": "api/Stride.Input.GameControllerExtensions.html",
    "title": "Class GameControllerExtensions | Stride API",
    "summary": "Class GameControllerExtensions Namespace Stride.Input Assembly Stride.Input.dll public static class GameControllerExtensions Inheritance object GameControllerExtensions Methods GetAxisCount(IGameControllerDevice) Gets the number of axes on this gamepad public static int GetAxisCount(this IGameControllerDevice device) Parameters device IGameControllerDevice The gamepad Returns int The number of axes GetButtonCount(IGameControllerDevice) Gets the number of buttons on this gamepad public static int GetButtonCount(this IGameControllerDevice device) Parameters device IGameControllerDevice The gamepad Returns int The number of buttons GetDPad(IGameControllerDevice, int) Returns the value of a direction controller converted to a GamePadButton which has the matching Pad flags set public static GamePadButton GetDPad(this IGameControllerDevice device, int index) Parameters device IGameControllerDevice The gamepad index int The index of the direction controller Returns GamePadButton GetDirectionCount(IGameControllerDevice) Gets the number of direction inputs on this gamepad public static int GetDirectionCount(this IGameControllerDevice device) Parameters device IGameControllerDevice The gamepad Returns int The number of direction controllers"
  },
  "api/Stride.Input.GameControllerObjectInfo.html": {
    "href": "api/Stride.Input.GameControllerObjectInfo.html",
    "title": "Class GameControllerObjectInfo | Stride API",
    "summary": "Class GameControllerObjectInfo Namespace Stride.Input Assembly Stride.Input.dll Provides information about an object exposed by a gamepad public class GameControllerObjectInfo Inheritance object GameControllerObjectInfo Derived GameControllerAxisInfo GameControllerButtonInfo GameControllerDirectionInfo Extension Methods UnsafeUtilities.As<T>(object?) Fields Name The name of the object, reported by the device public string Name Field Value string Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.GameControllerUtils.html": {
    "href": "api/Stride.Input.GameControllerUtils.html",
    "title": "Class GameControllerUtils | Stride API",
    "summary": "Class GameControllerUtils Namespace Stride.Input Assembly Stride.Input.dll Provides some useful functions relating to game controllers public static class GameControllerUtils Inheritance object GameControllerUtils Methods ButtonsToDirection(GamePadButton) Converts the pad buttons of a GamePadButton to a Direction public static Direction ButtonsToDirection(GamePadButton padDirection) Parameters padDirection GamePadButton Returns Direction DirectionToButtons(Direction) Converts a Direction to a combination of GamePadButton's public static GamePadButton DirectionToButtons(Direction direction) Parameters direction Direction Returns GamePadButton"
  },
  "api/Stride.Input.GamePadAxis.html": {
    "href": "api/Stride.Input.GamePadAxis.html",
    "title": "Enum GamePadAxis | Stride API",
    "summary": "Enum GamePadAxis Namespace Stride.Input Assembly Stride.Input.dll Axis for gamepad returned by GamePadState. [Flags] public enum GamePadAxis : ushort Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields LeftThumbX = 2 The X-Axis of the left thumb stick LeftThumbY = 4 The Y-Axis of the left thumb stick LeftTrigger = 32 The left trigger None = 0 No Axis RightThumbX = 8 The X-Axis of the right thumb stick RightThumbY = 16 The Y-Axis of the right thumb stick RightTrigger = 64 The right trigger"
  },
  "api/Stride.Input.GamePadAxisEvent.html": {
    "href": "api/Stride.Input.GamePadAxisEvent.html",
    "title": "Class GamePadAxisEvent | Stride API",
    "summary": "Class GamePadAxisEvent Namespace Stride.Input Assembly Stride.Input.dll An event to describe a change in a gamepad axis public class GamePadAxisEvent : AxisEvent, IInputEventArgs Inheritance object InputEvent AxisEvent GamePadAxisEvent Implements IInputEventArgs Inherited Members AxisEvent.Value InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields Axis The gamepad axis identifier public GamePadAxis Axis Field Value GamePadAxis Properties GamePad The gamepad that sent this event public IGamePadDevice GamePad { get; } Property Value IGamePadDevice Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.GamePadButton.html": {
    "href": "api/Stride.Input.GamePadButton.html",
    "title": "Enum GamePadButton | Stride API",
    "summary": "Enum GamePadButton Namespace Stride.Input Assembly Stride.Input.dll Buttons for gamepad returned by GamePadState. [Flags] public enum GamePadButton : ushort Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields A = 4096 A button. B = 8192 B button. Back = 32 Back button. LeftShoulder = 256 Left shoulder button. LeftThumb = 64 Left thumb button. None = 0 No buttons. Pad = PadUp | PadDown | PadLeft | PadRight Any pad button (DPad / Directional Pad) PadDown = 2 PadDown button. (DPad / Directional Pad) PadLeft = 4 PadLeft button. (DPad / Directional Pad) PadRight = 8 PadRight button. (DPad / Directional Pad) PadUp = 1 PadUp button. (DPad / Directional Pad) RightShoulder = 512 Right shoulder button. RightThumb = 128 Right thumb button. Start = 16 Start button. X = 16384 X button. Y = 32768 Y button."
  },
  "api/Stride.Input.GamePadButtonEvent.html": {
    "href": "api/Stride.Input.GamePadButtonEvent.html",
    "title": "Class GamePadButtonEvent | Stride API",
    "summary": "Class GamePadButtonEvent Namespace Stride.Input Assembly Stride.Input.dll An event to describe a change in gamepad button state public class GamePadButtonEvent : ButtonEvent, IInputEventArgs Inheritance object InputEvent ButtonEvent GamePadButtonEvent Implements IInputEventArgs Inherited Members ButtonEvent.IsDown InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields Button The gamepad button identifier public GamePadButton Button Field Value GamePadButton Properties GamePad The gamepad that sent this event public IGamePadDevice GamePad { get; } Property Value IGamePadDevice Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.GamePadDeviceBase.html": {
    "href": "api/Stride.Input.GamePadDeviceBase.html",
    "title": "Class GamePadDeviceBase | Stride API",
    "summary": "Class GamePadDeviceBase Namespace Stride.Input Assembly Stride.Input.dll public abstract class GamePadDeviceBase : IGamePadDevice, IInputDevice Inheritance object GamePadDeviceBase Implements IGamePadDevice IInputDevice Derived GamePadFromLayout GamePadSimulated Extension Methods GamePadDeviceExtensions.IsButtonDown(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.IsButtonPressed(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.IsButtonReleased(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.SetVibration(IGamePadDevice, float) GamePadDeviceExtensions.SetVibration(IGamePadDevice, float, float) UnsafeUtilities.As<T>(object?) Constructors GamePadDeviceBase() protected GamePadDeviceBase() Properties CanChangeIndex true if the index of this gamepad can be changed public bool CanChangeIndex { get; protected set; } Property Value bool DownButtons The gamepad buttons that are down public IReadOnlySet<GamePadButton> DownButtons { get; } Property Value IReadOnlySet<GamePadButton> Id The unique identifier of this device public abstract Guid Id { get; } Property Value Guid Index The index of the gamepad assigned by the input manager public int Index { get; set; } Property Value int Remarks If CanChangeIndex is false, this value can not be changed Name The name of the device public abstract string Name { get; } Property Value string PressedButtons The gamepad buttons that have been pressed since the last frame public IReadOnlySet<GamePadButton> PressedButtons { get; } Property Value IReadOnlySet<GamePadButton> Priority The device priority. Larger means higher priority when selecting the first device of some type public int Priority { get; set; } Property Value int ProductId Product Id of the device public abstract Guid ProductId { get; } Property Value Guid ReleasedButtons The gamepad buttons that have been released since the last frame public IReadOnlySet<GamePadButton> ReleasedButtons { get; } Property Value IReadOnlySet<GamePadButton> Source The input source the device belongs to. public abstract IInputSource Source { get; } Property Value IInputSource State The state of the gamepad public abstract GamePadState State { get; } Property Value GamePadState Methods ClearButtonStates() Clears previous Pressed/Released states protected void ClearButtonStates() SetIndexInternal(int, bool) protected void SetIndexInternal(int newIndex, bool isDeviceSideChange = true) Parameters newIndex int isDeviceSideChange bool SetVibration(float, float, float, float) Sets 4 vibration motors one the device or approximates the effect if less are supported public abstract void SetVibration(float smallLeft, float smallRight, float largeLeft, float largeRight) Parameters smallLeft float The small left side motor smallRight float The small right side motor largeLeft float The large left side motor largeRight float The large right side motor Remarks Values range from 0 to 1, where 0 is off and 1 is maximum vibration Update(List<InputEvent>) Updates the input device, filling the list inputEvents with input events that were generated by this device this frame public abstract void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent> A list that gets filled with input events that were generated since the last frame Remarks Input devices are always updated after their respective input source UpdateButtonState(GamePadButtonEvent) Updates Pressed/Released/Down collections protected void UpdateButtonState(GamePadButtonEvent evt) Parameters evt GamePadButtonEvent Events IndexChanged Raised if the index assigned to this gamepad changed public event EventHandler<GamePadIndexChangedEventArgs> IndexChanged Event Type EventHandler<GamePadIndexChangedEventArgs>"
  },
  "api/Stride.Input.GamePadDeviceExtensions.html": {
    "href": "api/Stride.Input.GamePadDeviceExtensions.html",
    "title": "Class GamePadDeviceExtensions | Stride API",
    "summary": "Class GamePadDeviceExtensions Namespace Stride.Input Assembly Stride.Input.dll Provides easier ways to set vibration levels on a controller, rather than setting 4 motors public static class GamePadDeviceExtensions Inheritance object GamePadDeviceExtensions Methods IsButtonDown(IGamePadDevice, GamePadButton) Determines whether the specified button is being pressed down public static bool IsButtonDown(this IGamePadDevice gamepad, GamePadButton button) Parameters gamepad IGamePadDevice The gamepad button GamePadButton The button Returns bool true if the specified button is being pressed down; otherwise, false. IsButtonPressed(IGamePadDevice, GamePadButton) Determines whether the specified button is pressed since the previous update. public static bool IsButtonPressed(this IGamePadDevice gamepad, GamePadButton button) Parameters gamepad IGamePadDevice The gamepad button GamePadButton The button Returns bool true if the specified button is pressed; otherwise, false. IsButtonReleased(IGamePadDevice, GamePadButton) Determines whether the specified button is released since the previous update. public static bool IsButtonReleased(this IGamePadDevice gamepad, GamePadButton button) Parameters gamepad IGamePadDevice The gamepad button GamePadButton The button Returns bool true if the specified button is released; otherwise, false. SetVibration(IGamePadDevice, float) Sets all the gamepad vibration motors to the same amount public static void SetVibration(this IGamePadDevice gamepad, float amount) Parameters gamepad IGamePadDevice The gamepad amount float The amount of vibration SetVibration(IGamePadDevice, float, float) Sets the gamepad's large and small motors to the given amounts public static void SetVibration(this IGamePadDevice gamepad, float largeMotors, float smallMotors) Parameters gamepad IGamePadDevice The gamepad largeMotors float The amount of vibration for the large motors smallMotors float The amount of vibration for the small motors"
  },
  "api/Stride.Input.GamePadFromLayout.html": {
    "href": "api/Stride.Input.GamePadFromLayout.html",
    "title": "Class GamePadFromLayout | Stride API",
    "summary": "Class GamePadFromLayout Namespace Stride.Input Assembly Stride.Input.dll A IGamePadDevice from a IGameControllerDevice using a GamePadLayout to create a mapping between the two public abstract class GamePadFromLayout : GamePadDeviceBase, IGamePadDevice, IInputDevice Inheritance object GamePadDeviceBase GamePadFromLayout Implements IGamePadDevice IInputDevice Inherited Members GamePadDeviceBase.Name GamePadDeviceBase.Id GamePadDeviceBase.ProductId GamePadDeviceBase.CanChangeIndex GamePadDeviceBase.Priority GamePadDeviceBase.Index GamePadDeviceBase.PressedButtons GamePadDeviceBase.ReleasedButtons GamePadDeviceBase.DownButtons GamePadDeviceBase.Source GamePadDeviceBase.IndexChanged GamePadDeviceBase.SetVibration(float, float, float, float) GamePadDeviceBase.SetIndexInternal(int, bool) GamePadDeviceBase.ClearButtonStates() GamePadDeviceBase.UpdateButtonState(GamePadButtonEvent) Extension Methods GamePadDeviceExtensions.IsButtonDown(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.IsButtonPressed(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.IsButtonReleased(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.SetVibration(IGamePadDevice, float) GamePadDeviceExtensions.SetVibration(IGamePadDevice, float, float) UnsafeUtilities.As<T>(object?) Constructors GamePadFromLayout(InputManager, IGameControllerDevice, GamePadLayout) Initializes a new instance of the GamePadFromLayout class. protected GamePadFromLayout(InputManager inputManager, IGameControllerDevice controller, GamePadLayout layout) Parameters inputManager InputManager controller IGameControllerDevice layout GamePadLayout Properties GameControllerDevice protected IGameControllerDevice GameControllerDevice { get; } Property Value IGameControllerDevice InputManager protected InputManager InputManager { get; } Property Value InputManager Layout protected GamePadLayout Layout { get; } Property Value GamePadLayout State The state of the gamepad public override GamePadState State { get; } Property Value GamePadState Methods Update(List<InputEvent>) Updates the input device, filling the list inputEvents with input events that were generated by this device this frame public override void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent> A list that gets filled with input events that were generated since the last frame Remarks Input devices are always updated after their respective input source"
  },
  "api/Stride.Input.GamePadIndexChangedEventArgs.html": {
    "href": "api/Stride.Input.GamePadIndexChangedEventArgs.html",
    "title": "Class GamePadIndexChangedEventArgs | Stride API",
    "summary": "Class GamePadIndexChangedEventArgs Namespace Stride.Input Assembly Stride.Input.dll Event for when a IGamePadDevice's index changed public class GamePadIndexChangedEventArgs : EventArgs Inheritance object EventArgs GamePadIndexChangedEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Fields Index New device index public int Index Field Value int IsDeviceSideChange if true, this change was initiate by the device public bool IsDeviceSideChange Field Value bool"
  },
  "api/Stride.Input.GamePadLayout.html": {
    "href": "api/Stride.Input.GamePadLayout.html",
    "title": "Class GamePadLayout | Stride API",
    "summary": "Class GamePadLayout Namespace Stride.Input Assembly Stride.Input.dll Provides a IGameControllerDevice to IGamePadDevice mapping public abstract class GamePadLayout Inheritance object GamePadLayout Derived GamePadLayoutDS4 GamePadLayoutXInput Extension Methods UnsafeUtilities.As<T>(object?) Fields mapFirstPovToPad Should direction controller 0 be mapped to the directional pad? protected bool mapFirstPovToPad Field Value bool Methods AddAxisToAxis(int, GamePadAxis, bool, bool) Adds a mapping from an axis index to GamePadAxis protected void AddAxisToAxis(int index, GamePadAxis axis, bool invert = false, bool remap = false) Parameters index int The axis index of the axis on this device axis GamePadAxis The axis to map to invert bool Should axis be inverted remap bool Remap this axis from (-1,1) to (0,1) AddAxisToButton(int, GamePadButton) Adds a mapping from an axis index to GamePadButton protected void AddAxisToButton(int index, GamePadButton button) Parameters index int The axis index of the axis on this device button GamePadButton The button(s) to map to AddButtonToAxis(int, GamePadAxis, bool) Adds a mapping from a button index to GamePadAxis protected void AddButtonToAxis(int index, GamePadAxis axis, bool invert = false) Parameters index int The button index of the button on this device axis GamePadAxis The axi to map to invert bool Should axis be inverted, output -1 instead of 1 on press AddButtonToButton(int, GamePadButton) Adds a mapping from a button index to GamePadButton protected void AddButtonToButton(int index, GamePadButton button) Parameters index int The button index of the button on this device button GamePadButton The button(s) to map to CompareProductId(Guid, Guid, int, int) Compares a product id public static bool CompareProductId(Guid a, Guid b, int numBytes = 16, int byteOffset = 0) Parameters a Guid id a b Guid id b numBytes int number of bytes to compare, starting from byteOffset byteOffset int starting byte index from where to compare Returns bool InitializeDevice(IGamePadDevice, IGameControllerDevice) Allows the user to perform some additional setup operations when using this layout on a device public virtual void InitializeDevice(IGamePadDevice targetDevice, IGameControllerDevice sourceDevice) Parameters targetDevice IGamePadDevice The gamepad that events are mapped to sourceDevice IGameControllerDevice The game controller that is mapped to a gamepad MapInputEvent(IGamePadDevice, IGameControllerDevice, InputEvent, List<InputEvent>) Maps game controller events to gamepad events public virtual void MapInputEvent(IGamePadDevice targetDevice, IGameControllerDevice sourceDevice, InputEvent controllerEvent, List<InputEvent> target) Parameters targetDevice IGamePadDevice The gamepad that events are mapped to sourceDevice IGameControllerDevice The game controller that is mapped to a gamepad controllerEvent InputEvent The controller input event as a source target List<InputEvent> Target list MatchDevice(IInputSource, IGameControllerDevice) Checks if a device matches this gamepad layout, and thus should use this when mapping it to a GamePadState public abstract bool MatchDevice(IInputSource source, IGameControllerDevice device) Parameters source IInputSource Source that this device comes from device IGameControllerDevice The device to match Returns bool"
  },
  "api/Stride.Input.GamePadLayoutDS4.html": {
    "href": "api/Stride.Input.GamePadLayoutDS4.html",
    "title": "Class GamePadLayoutDS4 | Stride API",
    "summary": "Class GamePadLayoutDS4 Namespace Stride.Input Assembly Stride.Input.dll A gamepad layout for a DualShock4 controller public class GamePadLayoutDS4 : GamePadLayout Inheritance object GamePadLayout GamePadLayoutDS4 Inherited Members GamePadLayout.mapFirstPovToPad GamePadLayout.CompareProductId(Guid, Guid, int, int) GamePadLayout.InitializeDevice(IGamePadDevice, IGameControllerDevice) GamePadLayout.MapInputEvent(IGamePadDevice, IGameControllerDevice, InputEvent, List<InputEvent>) GamePadLayout.AddButtonToButton(int, GamePadButton) GamePadLayout.AddAxisToButton(int, GamePadButton) GamePadLayout.AddButtonToAxis(int, GamePadAxis, bool) GamePadLayout.AddAxisToAxis(int, GamePadAxis, bool, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors GamePadLayoutDS4() public GamePadLayoutDS4() Methods MatchDevice(IInputSource, IGameControllerDevice) Checks if a device matches this gamepad layout, and thus should use this when mapping it to a GamePadState public override bool MatchDevice(IInputSource source, IGameControllerDevice device) Parameters source IInputSource Source that this device comes from device IGameControllerDevice The device to match Returns bool"
  },
  "api/Stride.Input.GamePadLayoutXInput.html": {
    "href": "api/Stride.Input.GamePadLayoutXInput.html",
    "title": "Class GamePadLayoutXInput | Stride API",
    "summary": "Class GamePadLayoutXInput Namespace Stride.Input Assembly Stride.Input.dll Layout for XInput devices so that they can be used by SDL or other systems that do not have the XInput API but do support joysticks in some other way public class GamePadLayoutXInput : GamePadLayout Inheritance object GamePadLayout GamePadLayoutXInput Inherited Members GamePadLayout.mapFirstPovToPad GamePadLayout.CompareProductId(Guid, Guid, int, int) GamePadLayout.InitializeDevice(IGamePadDevice, IGameControllerDevice) GamePadLayout.MapInputEvent(IGamePadDevice, IGameControllerDevice, InputEvent, List<InputEvent>) GamePadLayout.AddButtonToButton(int, GamePadButton) GamePadLayout.AddAxisToButton(int, GamePadButton) GamePadLayout.AddButtonToAxis(int, GamePadAxis, bool) GamePadLayout.AddAxisToAxis(int, GamePadAxis, bool, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors GamePadLayoutXInput() public GamePadLayoutXInput() Methods MatchDevice(IInputSource, IGameControllerDevice) Checks if a device matches this gamepad layout, and thus should use this when mapping it to a GamePadState public override bool MatchDevice(IInputSource source, IGameControllerDevice device) Parameters source IInputSource Source that this device comes from device IGameControllerDevice The device to match Returns bool"
  },
  "api/Stride.Input.GamePadLayouts.html": {
    "href": "api/Stride.Input.GamePadLayouts.html",
    "title": "Class GamePadLayouts | Stride API",
    "summary": "Class GamePadLayouts Namespace Stride.Input Assembly Stride.Input.dll Keeps track of GamePadLayout public static class GamePadLayouts Inheritance object GamePadLayouts Methods AddLayout(GamePadLayout) Adds a new layout that cane be used for mapping gamepads to GamePadState public static void AddLayout(GamePadLayout layout) Parameters layout GamePadLayout The layout to add FindLayout(IInputSource, IGameControllerDevice) Finds a layout matching the given gamepad public static GamePadLayout FindLayout(IInputSource source, IGameControllerDevice device) Parameters source IInputSource The source that the device came from device IGameControllerDevice The device to find a layout for Returns GamePadLayout The gamepad layout that was found, or null if none was found"
  },
  "api/Stride.Input.GamePadSimulated.html": {
    "href": "api/Stride.Input.GamePadSimulated.html",
    "title": "Class GamePadSimulated | Stride API",
    "summary": "Class GamePadSimulated Namespace Stride.Input Assembly Stride.Input.dll public class GamePadSimulated : GamePadDeviceBase, IGamePadDevice, IInputDevice Inheritance object GamePadDeviceBase GamePadSimulated Implements IGamePadDevice IInputDevice Inherited Members GamePadDeviceBase.CanChangeIndex GamePadDeviceBase.Priority GamePadDeviceBase.Index GamePadDeviceBase.PressedButtons GamePadDeviceBase.ReleasedButtons GamePadDeviceBase.DownButtons GamePadDeviceBase.IndexChanged GamePadDeviceBase.SetIndexInternal(int, bool) GamePadDeviceBase.ClearButtonStates() GamePadDeviceBase.UpdateButtonState(GamePadButtonEvent) Extension Methods GamePadDeviceExtensions.IsButtonDown(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.IsButtonPressed(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.IsButtonReleased(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.SetVibration(IGamePadDevice, float) GamePadDeviceExtensions.SetVibration(IGamePadDevice, float, float) UnsafeUtilities.As<T>(object?) Constructors GamePadSimulated(InputSourceSimulated) public GamePadSimulated(InputSourceSimulated source) Parameters source InputSourceSimulated Properties Id The unique identifier of this device public override Guid Id { get; } Property Value Guid Name The name of the device public override string Name { get; } Property Value string ProductId Product Id of the device public override Guid ProductId { get; } Property Value Guid Source The input source the device belongs to. public override IInputSource Source { get; } Property Value IInputSource State The state of the gamepad public override GamePadState State { get; } Property Value GamePadState Methods SetAxis(GamePadAxis, float) public void SetAxis(GamePadAxis axis, float value) Parameters axis GamePadAxis value float SetButton(GamePadButton, bool) public void SetButton(GamePadButton button, bool state) Parameters button GamePadButton state bool SetVibration(float, float, float, float) Sets 4 vibration motors one the device or approximates the effect if less are supported public override void SetVibration(float smallLeft, float smallRight, float largeLeft, float largeRight) Parameters smallLeft float The small left side motor smallRight float The small right side motor largeLeft float The large left side motor largeRight float The large right side motor Remarks Values range from 0 to 1, where 0 is off and 1 is maximum vibration Update(List<InputEvent>) Updates the input device, filling the list inputEvents with input events that were generated by this device this frame public override void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent> A list that gets filled with input events that were generated since the last frame Remarks Input devices are always updated after their respective input source"
  },
  "api/Stride.Input.GamePadState.html": {
    "href": "api/Stride.Input.GamePadState.html",
    "title": "Struct GamePadState | Stride API",
    "summary": "Struct GamePadState Namespace Stride.Input Assembly Stride.Input.dll Describes the state of a typical gamepad. public struct GamePadState : IEquatable<GamePadState> Implements IEquatable<GamePadState> Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Buttons Bitmask of the gamepad buttons. public GamePadButton Buttons Field Value GamePadButton LeftThumb Left thumbstick x-axis/y-axis value. The value is in the range [-1.0f, 1.0f] for both axis. public Vector2 LeftThumb Field Value Vector2 LeftTrigger The left trigger analog control in the range [0, 1.0f]. See remarks. public float LeftTrigger Field Value float Remarks Some controllers are not supporting the range of value and may act as a simple button returning only 0 or 1. RightThumb Right thumbstick x-axis/y-axis value. The value is in the range [-1.0f, 1.0f] for both axis. public Vector2 RightThumb Field Value Vector2 RightTrigger The right trigger analog control in the range [0, 1.0f]. See remarks. public float RightTrigger Field Value float Remarks Some controllers are not supporting the range of value and may act as a simple button returning only 0 or 1. Methods Equals(GamePadState) Indicates whether the current object is equal to another object of the same type. public bool Equals(GamePadState other) Parameters other GamePadState An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Update(GamePadAxisEvent) Updates the state from any gamepad events received that have mapped buttons public bool Update(GamePadAxisEvent axisEvent) Parameters axisEvent GamePadAxisEvent The gamepad event to process Returns bool true if the event made any changes Update(GamePadButtonEvent) Updates the state from any gamepad events received that have mapped buttons public bool Update(GamePadButtonEvent buttonEvent) Parameters buttonEvent GamePadButtonEvent The gamepad event to process Returns bool true if the event made any changes Update(InputEvent) Updates the state from any gamepad events received that have mapped buttons public bool Update(InputEvent evt) Parameters evt InputEvent The gamepad event to process Returns bool true if the event made any changes Operators operator ==(GamePadState, GamePadState) Implements the == operator. public static bool operator ==(GamePadState left, GamePadState right) Parameters left GamePadState The left gamepad value. right GamePadState The right gamepad value. Returns bool The result of the operator. operator !=(GamePadState, GamePadState) Implements the != operator. public static bool operator !=(GamePadState left, GamePadState right) Parameters left GamePadState The left gamepad value. right GamePadState The right gamepad value. Returns bool The result of the operator. See Also State"
  },
  "api/Stride.Input.GestureConfig.html": {
    "href": "api/Stride.Input.GestureConfig.html",
    "title": "Class GestureConfig | Stride API",
    "summary": "Class GestureConfig Namespace Stride.Input Assembly Stride.Input.dll This represents the base class for all gesture configuration. public abstract class GestureConfig Inheritance object GestureConfig Derived GestureConfigComposite GestureConfigDrag GestureConfigFlick GestureConfigLongPress GestureConfigTap Extension Methods UnsafeUtilities.As<T>(object?) Remarks Gesture configurations cannot be modified after being added to the input system for gesture recognition. Doing so will throw an InvalidOperationException. Gesture Recognizers work with normalized coordinates belonging to [0,1]x[0,1/screenRatio] so distances, speeds and margin errors need to be expressed relatively to this coordinates system. Properties AssociatedGestureType Specify the GestureType corresponding to this configuration. public GestureType AssociatedGestureType { get; protected set; } Property Value GestureType RequiredNumberOfFingers This value represents the required number of simultaneous finger to tap to trigger the gesture. For example: 1 for single finger, and so on... public int RequiredNumberOfFingers { get; set; } Property Value int Remarks This value is strictly positive. Exceptions ArgumentOutOfRangeException The given value is not in the allowed range. InvalidOperationException Tried to modify the configuration after it has been frozen by the system."
  },
  "api/Stride.Input.GestureConfigComposite.html": {
    "href": "api/Stride.Input.GestureConfigComposite.html",
    "title": "Class GestureConfigComposite | Stride API",
    "summary": "Class GestureConfigComposite Namespace Stride.Input Assembly Stride.Input.dll Configuration class for the Composite gesture. public sealed class GestureConfigComposite : GestureConfig Inheritance object GestureConfig GestureConfigComposite Inherited Members GestureConfig.AssociatedGestureType GestureConfig.RequiredNumberOfFingers Extension Methods UnsafeUtilities.As<T>(object?) Remarks A composite gesture is a transformation which is a composition of a translation, a rotation and a scale. It is performed by using two fingers and performing translation, scale and rotation motions. A composite gesture can only be composed of 2 fingers. Trying to modify the RequiredNumberOfFingers field will throw an exception. Constructors GestureConfigComposite() Create a default Rotation gesture configuration. public GestureConfigComposite() Properties MinimumRotationAngle The rotation angle (in radian) above which the gesture is started. public float MinimumRotationAngle { get; set; } Property Value float Remarks The user can increase this value if he has small or no interest in the rotation component of the transformation. By doing so, he avoids triggering the Composite Gesture when only small rotation changes happen. On the contrary, the user can decrease this value if he wants to be immediately warned about the smallest change in rotation. Exceptions ArgumentOutOfRangeException The angle has to be strictly positive. InvalidOperationException Tried to modify the configuration after it has been frozen by the system. MinimumScaleValue The scale value above which the gesture is started. public float MinimumScaleValue { get; set; } Property Value float Remarks The user can increase this value if he has small or no interest in the scale component of the transformation. By doing so, he avoids triggering the Composite Gesture when only small scale changes happen. On the contrary, the user can decrease this value if he wants to be immediately warned about the smallest change in scale. Exceptions ArgumentOutOfRangeException The value has to be greater or equal to 1. InvalidOperationException Tried to modify the configuration after it has been frozen by the system. MinimumTranslationDistance The translation distance above which the gesture is started. public float MinimumTranslationDistance { get; set; } Property Value float Remarks The user can increase this value if he has small or no interest in the translation component of the transformation. By doing so, he avoids triggering the Composite Gesture when only small translation changes happen. On the contrary, the user can decrease this value if he wants to be immediately warned about the smallest change in translation. Exceptions ArgumentOutOfRangeException The value has to be positive. InvalidOperationException Tried to modify the configuration after it has been frozen by the system."
  },
  "api/Stride.Input.GestureConfigDrag.html": {
    "href": "api/Stride.Input.GestureConfigDrag.html",
    "title": "Class GestureConfigDrag | Stride API",
    "summary": "Class GestureConfigDrag Namespace Stride.Input Assembly Stride.Input.dll Configuration class for the Drag gesture. public sealed class GestureConfigDrag : GestureConfig Inheritance object GestureConfig GestureConfigDrag Inherited Members GestureConfig.AssociatedGestureType GestureConfig.RequiredNumberOfFingers Extension Methods UnsafeUtilities.As<T>(object?) Remarks A drag gesture can be composed of 1 or more fingers. Constructors GestureConfigDrag() Create a default drag gesture configuration for one finger free dragging. public GestureConfigDrag() GestureConfigDrag(GestureShape) Create a default drag gesture configuration for one finger dragging. public GestureConfigDrag(GestureShape dragShape) Parameters dragShape GestureShape The dragging shape Properties AllowedErrorMargins The (x,y) error margins allowed during directional dragging. public Vector2 AllowedErrorMargins { get; set; } Property Value Vector2 Remarks Those values are used only for directional (vertical or horizontal) dragging. Decrease those values to trigger the gesture only when the dragging is perfectly in the desired direction. Increase those values to allow directional gestures to be more approximative. Exceptions InvalidOperationException Tried to modify the configuration after it has been frozen by the system. ArgumentOutOfRangeException The provided x or y value was not positive. DragShape The shape (direction) of the drag gesture. public GestureShape DragShape { get; set; } Property Value GestureShape Exceptions InvalidOperationException Tried to modify the configuration after it has been frozen by the system. MinimumDragDistance Specify the minimum translation distance required before that the gesture can be recognized as a Drag. public float MinimumDragDistance { get; set; } Property Value float Remarks The user can reduce this value if he needs the drag gesture to be triggered even for very small drags. On the contrary, he can increase this value if he wants to avoid to deals with too small drags. Exceptions InvalidOperationException Tried to modify the configuration after it has been frozen by the system. ArgumentOutOfRangeException The provided value was negative."
  },
  "api/Stride.Input.GestureConfigFlick.html": {
    "href": "api/Stride.Input.GestureConfigFlick.html",
    "title": "Class GestureConfigFlick | Stride API",
    "summary": "Class GestureConfigFlick Namespace Stride.Input Assembly Stride.Input.dll Configuration class for the Flick gesture. public sealed class GestureConfigFlick : GestureConfig Inheritance object GestureConfig GestureConfigFlick Inherited Members GestureConfig.AssociatedGestureType GestureConfig.RequiredNumberOfFingers Extension Methods UnsafeUtilities.As<T>(object?) Remarks A Flick gesture can be composed of 1 or more fingers. Constructors GestureConfigFlick() Create a default Flick gesture configuration for one finger free flicking. public GestureConfigFlick() GestureConfigFlick(GestureShape) Create a default gesture configuration for one finger flicking. public GestureConfigFlick(GestureShape flickShape) Parameters flickShape GestureShape The shape of the flicking. Properties AllowedErrorMargins The (x,y) error margins allowed during directional dragging. public Vector2 AllowedErrorMargins { get; set; } Property Value Vector2 Exceptions InvalidOperationException Tried to modify the configuration after it has been frozen by the system. ArgumentOutOfRangeException The provided x or y value was not positive. FlickShape The shape of the flick gesture. public GestureShape FlickShape { get; set; } Property Value GestureShape Exceptions InvalidOperationException Tried to modify the configuration after it has been frozen by the system. MinimumAverageSpeed The minimum average speed of the gesture to be detected as a flick. public float MinimumAverageSpeed { get; set; } Property Value float Exceptions ArgumentOutOfRangeException The value must be positive InvalidOperationException Tried to modify the configuration after it has been frozen by the system. MinimumFlickLength The minimum distance that the flick gesture has to cross from its origin to be detected has Flick. public float MinimumFlickLength { get; set; } Property Value float Exceptions InvalidOperationException Tried to modify the configuration after it has been frozen by the system."
  },
  "api/Stride.Input.GestureConfigLongPress.html": {
    "href": "api/Stride.Input.GestureConfigLongPress.html",
    "title": "Class GestureConfigLongPress | Stride API",
    "summary": "Class GestureConfigLongPress Namespace Stride.Input Assembly Stride.Input.dll Configuration class the Long Press gestures. public sealed class GestureConfigLongPress : GestureConfig Inheritance object GestureConfig GestureConfigLongPress Inherited Members GestureConfig.AssociatedGestureType GestureConfig.RequiredNumberOfFingers Extension Methods UnsafeUtilities.As<T>(object?) Remarks A longPress gesture can be composed of 1 or more fingers. Constructors GestureConfigLongPress() Create a default LongPress gesture configuration. public GestureConfigLongPress() Remarks Single finger and 1 second long press. Properties MaximumTranslationDistance The value represents the maximum distance a finger can translate during the longPress action. public float MaximumTranslationDistance { get; set; } Property Value float Remarks By increasing this value, the user allows small movements of the fingers during the long press. By decreasing this value, the user forbids any movements during the long press. Exceptions ArgumentOutOfRangeException The value has to be positive. InvalidOperationException Tried to modify the configuration after it has been frozen by the system. RequiredPressTime The time the user has to hold his finger on the screen to trigger the gesture. public TimeSpan RequiredPressTime { get; set; } Property Value TimeSpan Exceptions InvalidOperationException Tried to modify the configuration after it has been frozen by the system."
  },
  "api/Stride.Input.GestureConfigTap.html": {
    "href": "api/Stride.Input.GestureConfigTap.html",
    "title": "Class GestureConfigTap | Stride API",
    "summary": "Class GestureConfigTap Namespace Stride.Input Assembly Stride.Input.dll Configuration class for the Tap gesture. public sealed class GestureConfigTap : GestureConfig Inheritance object GestureConfig GestureConfigTap Inherited Members GestureConfig.AssociatedGestureType GestureConfig.RequiredNumberOfFingers Extension Methods UnsafeUtilities.As<T>(object?) Remarks A tap gesture can be composed of 1 or more fingers. Constructors GestureConfigTap() Create a default Tap gesture configuration for single touch and single finger detection. public GestureConfigTap() GestureConfigTap(int, int) Create a default Tap gesture configuration for the given numbers of touches and fingers. public GestureConfigTap(int numberOfTap, int numberOfFingers) Parameters numberOfTap int The number of taps required numberOfFingers int The number of fingers required Properties MaximumDistanceTaps The value represents the maximum distance that can separate two touches of the same finger during the gesture. By reducing this value, the system will tend to detect multi-touch gesture has several single touch gesture. By increasing this value, the system will tend to regroup distant single touch gestures into a multi-touch gesture. public float MaximumDistanceTaps { get; set; } Property Value float Exceptions ArgumentOutOfRangeException The value has to be positive. InvalidOperationException Tried to modify the configuration after it has been frozen by the system. MaximumPressTime This value represents the maximum amount of time that the user can stay touching the screen before taking off its finger. public TimeSpan MaximumPressTime { get; set; } Property Value TimeSpan MaximumTimeBetweenTaps This value represents the maximum interval of time that can separate two touches of a same gesture. By reducing this value, the system will tend to detect multi-touch gesture has several single touch gesture. By increasing this value, the system will tend to regroup distant (in time) single touch gestures into a multi-touch gesture. public TimeSpan MaximumTimeBetweenTaps { get; set; } Property Value TimeSpan RequiredNumberOfTaps This value represents the required number of successive user touches to trigger the gesture. For example: 1 for single touch, 2 for double touch, and so on... public int RequiredNumberOfTaps { get; set; } Property Value int Remarks This value is strictly positive. Exceptions ArgumentOutOfRangeException The given value is not greater or equal to 1. InvalidOperationException Tried to modify the configuration after it has been frozen by the system."
  },
  "api/Stride.Input.GestureEvent.html": {
    "href": "api/Stride.Input.GestureEvent.html",
    "title": "Class GestureEvent | Stride API",
    "summary": "Class GestureEvent Namespace Stride.Input Assembly Stride.Input.dll Base class for the gesture events. public abstract class GestureEvent Inheritance object GestureEvent Derived GestureEventComposite GestureEventLongPress GestureEventTap GestureEventTranslation Extension Methods UnsafeUtilities.As<T>(object?) Properties DeltaTime The time elapsed between the two last events of the gesture. public TimeSpan DeltaTime { get; } Property Value TimeSpan Remarks This value is equal to TotalTime for discrete gestures. NumberOfFinger The number of fingers involved in the gesture. public int NumberOfFinger { get; } Property Value int State The state of the gesture. public GestureState State { get; } Property Value GestureState TotalTime The time elapsed since the beginning of the gesture. public TimeSpan TotalTime { get; } Property Value TimeSpan Type The type of the gesture. public GestureType Type { get; } Property Value GestureType"
  },
  "api/Stride.Input.GestureEventComposite.html": {
    "href": "api/Stride.Input.GestureEventComposite.html",
    "title": "Class GestureEventComposite | Stride API",
    "summary": "Class GestureEventComposite Namespace Stride.Input Assembly Stride.Input.dll Event class for the Composite gesture. public sealed class GestureEventComposite : GestureEvent Inheritance object GestureEvent GestureEventComposite Inherited Members GestureEvent.State GestureEvent.Type GestureEvent.NumberOfFinger GestureEvent.DeltaTime GestureEvent.TotalTime Extension Methods UnsafeUtilities.As<T>(object?) Properties CenterBeginningPosition The position of the center of the composite transformation at the beginning of the gesture (in normalized coordinates [0,1]). public Vector2 CenterBeginningPosition { get; } Property Value Vector2 Remarks The center of the transformation corresponds to the middle of the 2 fingers. CenterCurrentPosition The current position of the center of the composite transformation (in normalized coordinates [0,1]). public Vector2 CenterCurrentPosition { get; } Property Value Vector2 Remarks The center of the transformation corresponds to the middle of the 2 fingers. DeltaRotation The rotation angle (in radian) since the last event of the gesture. public float DeltaRotation { get; } Property Value float DeltaScale The difference of scale since the last event of the gesture. public float DeltaScale { get; } Property Value float DeltaTranslation The translation performed since the last event of the gesture. public Vector2 DeltaTranslation { get; } Property Value Vector2 TotalRotation The rotation angle (in radian) since the beginning of the gesture. public float TotalRotation { get; } Property Value float TotalScale The difference of scale since the beginning of the gesture. public float TotalScale { get; } Property Value float TotalTranslation The translation performed since the beginning of the gesture. public Vector2 TotalTranslation { get; } Property Value Vector2"
  },
  "api/Stride.Input.GestureEventDrag.html": {
    "href": "api/Stride.Input.GestureEventDrag.html",
    "title": "Class GestureEventDrag | Stride API",
    "summary": "Class GestureEventDrag Namespace Stride.Input Assembly Stride.Input.dll Event class for the Drag gesture. public sealed class GestureEventDrag : GestureEventTranslation Inheritance object GestureEvent GestureEventTranslation GestureEventDrag Inherited Members GestureEventTranslation.Shape GestureEventTranslation.StartPosition GestureEventTranslation.CurrentPosition GestureEventTranslation.DeltaTranslation GestureEventTranslation.TotalTranslation GestureEventTranslation.AverageSpeed GestureEvent.State GestureEvent.Type GestureEvent.NumberOfFinger GestureEvent.DeltaTime GestureEvent.TotalTime Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Input.GestureEventFlick.html": {
    "href": "api/Stride.Input.GestureEventFlick.html",
    "title": "Class GestureEventFlick | Stride API",
    "summary": "Class GestureEventFlick Namespace Stride.Input Assembly Stride.Input.dll Event class for the Flick gesture. public sealed class GestureEventFlick : GestureEventTranslation Inheritance object GestureEvent GestureEventTranslation GestureEventFlick Inherited Members GestureEventTranslation.Shape GestureEventTranslation.StartPosition GestureEventTranslation.CurrentPosition GestureEventTranslation.DeltaTranslation GestureEventTranslation.TotalTranslation GestureEventTranslation.AverageSpeed GestureEvent.State GestureEvent.Type GestureEvent.NumberOfFinger GestureEvent.DeltaTime GestureEvent.TotalTime Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Input.GestureEventLongPress.html": {
    "href": "api/Stride.Input.GestureEventLongPress.html",
    "title": "Class GestureEventLongPress | Stride API",
    "summary": "Class GestureEventLongPress Namespace Stride.Input Assembly Stride.Input.dll Event class for the LongPress gesture. public sealed class GestureEventLongPress : GestureEvent Inheritance object GestureEvent GestureEventLongPress Inherited Members GestureEvent.State GestureEvent.Type GestureEvent.NumberOfFinger GestureEvent.DeltaTime GestureEvent.TotalTime Extension Methods UnsafeUtilities.As<T>(object?) Properties Position The position where the LongPress gesture happened. public Vector2 Position { get; } Property Value Vector2"
  },
  "api/Stride.Input.GestureEventTap.html": {
    "href": "api/Stride.Input.GestureEventTap.html",
    "title": "Class GestureEventTap | Stride API",
    "summary": "Class GestureEventTap Namespace Stride.Input Assembly Stride.Input.dll Event class for the Tap gesture. public sealed class GestureEventTap : GestureEvent Inheritance object GestureEvent GestureEventTap Inherited Members GestureEvent.State GestureEvent.Type GestureEvent.NumberOfFinger GestureEvent.DeltaTime GestureEvent.TotalTime Extension Methods UnsafeUtilities.As<T>(object?) Properties NumberOfTaps The number of time the use successively touched the screen. public int NumberOfTaps { get; } Property Value int TapPosition The position of the tap. public Vector2 TapPosition { get; } Property Value Vector2"
  },
  "api/Stride.Input.GestureEventTranslation.html": {
    "href": "api/Stride.Input.GestureEventTranslation.html",
    "title": "Class GestureEventTranslation | Stride API",
    "summary": "Class GestureEventTranslation Namespace Stride.Input Assembly Stride.Input.dll Event class for the Drag gesture. public class GestureEventTranslation : GestureEvent Inheritance object GestureEvent GestureEventTranslation Derived GestureEventDrag GestureEventFlick Inherited Members GestureEvent.State GestureEvent.Type GestureEvent.NumberOfFinger GestureEvent.DeltaTime GestureEvent.TotalTime Extension Methods UnsafeUtilities.As<T>(object?) Properties AverageSpeed The average translation speed (in pixels per seconds) of the drag event. public Vector2 AverageSpeed { get; } Property Value Vector2 CurrentPosition The current position of the drag event. public Vector2 CurrentPosition { get; } Property Value Vector2 DeltaTranslation The translation performed since the last event of the gesture. public Vector2 DeltaTranslation { get; } Property Value Vector2 Shape The Shape of the drag. public GestureShape Shape { get; } Property Value GestureShape StartPosition The position where the drag event started. public Vector2 StartPosition { get; } Property Value Vector2 TotalTranslation The translation performed since the beginning of the gesture. public Vector2 TotalTranslation { get; } Property Value Vector2"
  },
  "api/Stride.Input.GestureShape.html": {
    "href": "api/Stride.Input.GestureShape.html",
    "title": "Enum GestureShape | Stride API",
    "summary": "Enum GestureShape Namespace Stride.Input Assembly Stride.Input.dll Gesture possible shapes. public enum GestureShape Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Free = 2 Represent a gesture that has a random shape. Horizontal = 0 Represent a gesture that has its shape along the horizontal axis. Vertical = 1 Represent a gesture that has its shape along the vertical axis."
  },
  "api/Stride.Input.GestureState.html": {
    "href": "api/Stride.Input.GestureState.html",
    "title": "Enum GestureState | Stride API",
    "summary": "Enum GestureState Namespace Stride.Input Assembly Stride.Input.dll The different possible states of a gestures. public enum GestureState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Began = 1 A continuous gesture has started. Changed = 2 A continuous gesture parameters changed. Ended = 3 A continuous gesture has stopped. Occurred = 0 A discrete gesture has occurred."
  },
  "api/Stride.Input.GestureType.html": {
    "href": "api/Stride.Input.GestureType.html",
    "title": "Enum GestureType | Stride API",
    "summary": "Enum GestureType Namespace Stride.Input Assembly Stride.Input.dll List all the available type of Gestures. public enum GestureType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Composite = 3 The user touched two points of the screen and performed a composite transformation (translation, rotation, scale). Rotation is a continuous gesture. Drag = 0 The user touched the screen and then performed a free translation. Drag is a continuous gesture. Flick = 1 The user touched the screen and then performed a quick swipe. Flick is a discrete gesture. LongPress = 2 The user touched and maintained a point on the screen. LongPress is a discrete gesture. Tap = 4 The user touched the screen. Tap is a discrete gesture."
  },
  "api/Stride.Input.IAccelerometerSensor.html": {
    "href": "api/Stride.Input.IAccelerometerSensor.html",
    "title": "Interface IAccelerometerSensor | Stride API",
    "summary": "Interface IAccelerometerSensor Namespace Stride.Input Assembly Stride.Input.dll This class represents a sensor of type Accelerometer. It measures the acceleration forces (including gravity) applying on the device. public interface IAccelerometerSensor : ISensorDevice, IInputDevice Inherited Members ISensorDevice.IsEnabled IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods UnsafeUtilities.As<T>(object?) Properties Acceleration Gets the current acceleration applied on the device (in meters/seconds^2). Vector3 Acceleration { get; } Property Value Vector3"
  },
  "api/Stride.Input.ICompassSensor.html": {
    "href": "api/Stride.Input.ICompassSensor.html",
    "title": "Interface ICompassSensor | Stride API",
    "summary": "Interface ICompassSensor Namespace Stride.Input Assembly Stride.Input.dll This class represents a sensor of type compass. It measures the angle between the device and the north. public interface ICompassSensor : ISensorDevice, IInputDevice Inherited Members ISensorDevice.IsEnabled IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods UnsafeUtilities.As<T>(object?) Properties Heading Gets the value of north heading, that is the angle (in radian) between the top of the device and north. float Heading { get; } Property Value float"
  },
  "api/Stride.Input.IGameControllerDevice.html": {
    "href": "api/Stride.Input.IGameControllerDevice.html",
    "title": "Interface IGameControllerDevice | Stride API",
    "summary": "Interface IGameControllerDevice Namespace Stride.Input Assembly Stride.Input.dll This interface is used for interacting with game controller devices. public interface IGameControllerDevice : IInputDevice Inherited Members IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods GameControllerDeviceExtensions.IsButtonDown(IGameControllerDevice, int) GameControllerDeviceExtensions.IsButtonPressed(IGameControllerDevice, int) GameControllerDeviceExtensions.IsButtonReleased(IGameControllerDevice, int) GameControllerExtensions.GetAxisCount(IGameControllerDevice) GameControllerExtensions.GetButtonCount(IGameControllerDevice) GameControllerExtensions.GetDPad(IGameControllerDevice, int) GameControllerExtensions.GetDirectionCount(IGameControllerDevice) UnsafeUtilities.As<T>(object?) Properties AxisInfos Information about the axes on this game controller IReadOnlyList<GameControllerAxisInfo> AxisInfos { get; } Property Value IReadOnlyList<GameControllerAxisInfo> ButtonInfos Information about the buttons on this game controller IReadOnlyList<GameControllerButtonInfo> ButtonInfos { get; } Property Value IReadOnlyList<GameControllerButtonInfo> DirectionInfos Information about the direction controllers on this game controller IReadOnlyList<GameControllerDirectionInfo> DirectionInfos { get; } Property Value IReadOnlyList<GameControllerDirectionInfo> DownButtons The buttons that are down IReadOnlySet<int> DownButtons { get; } Property Value IReadOnlySet<int> PressedButtons The buttons that have been pressed since the last frame IReadOnlySet<int> PressedButtons { get; } Property Value IReadOnlySet<int> ProductId Product Id of the device Guid ProductId { get; } Property Value Guid ReleasedButtons The buttons that have been released since the last frame IReadOnlySet<int> ReleasedButtons { get; } Property Value IReadOnlySet<int> Methods GetAxis(int) Retrieves the state of a single axis float GetAxis(int index) Parameters index int The axis' index, as exposed in AxisInfos Returns float The value read directly from the axis GetDirection(int) Retrieves the state of a single point of direction controller Direction GetDirection(int index) Parameters index int The direction controller's index, as exposed in DirectionInfos Returns Direction The current state of the direction controller"
  },
  "api/Stride.Input.IGamePadDevice.html": {
    "href": "api/Stride.Input.IGamePadDevice.html",
    "title": "Interface IGamePadDevice | Stride API",
    "summary": "Interface IGamePadDevice Namespace Stride.Input Assembly Stride.Input.dll A gamepad is a game controller that has a fixed button mapping, stored in State public interface IGamePadDevice : IInputDevice Inherited Members IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods GamePadDeviceExtensions.IsButtonDown(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.IsButtonPressed(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.IsButtonReleased(IGamePadDevice, GamePadButton) GamePadDeviceExtensions.SetVibration(IGamePadDevice, float) GamePadDeviceExtensions.SetVibration(IGamePadDevice, float, float) UnsafeUtilities.As<T>(object?) Properties CanChangeIndex true if the index of this gamepad can be changed bool CanChangeIndex { get; } Property Value bool DownButtons The gamepad buttons that are down IReadOnlySet<GamePadButton> DownButtons { get; } Property Value IReadOnlySet<GamePadButton> Index The index of the gamepad assigned by the input manager int Index { get; set; } Property Value int Remarks If CanChangeIndex is false, this value can not be changed PressedButtons The gamepad buttons that have been pressed since the last frame IReadOnlySet<GamePadButton> PressedButtons { get; } Property Value IReadOnlySet<GamePadButton> ProductId Product Id of the device Guid ProductId { get; } Property Value Guid ReleasedButtons The gamepad buttons that have been released since the last frame IReadOnlySet<GamePadButton> ReleasedButtons { get; } Property Value IReadOnlySet<GamePadButton> State The state of the gamepad GamePadState State { get; } Property Value GamePadState Methods SetVibration(float, float, float, float) Sets 4 vibration motors one the device or approximates the effect if less are supported void SetVibration(float smallLeft, float smallRight, float largeLeft, float largeRight) Parameters smallLeft float The small left side motor smallRight float The small right side motor largeLeft float The large left side motor largeRight float The large right side motor Remarks Values range from 0 to 1, where 0 is off and 1 is maximum vibration Events IndexChanged Raised if the index assigned to this gamepad changed event EventHandler<GamePadIndexChangedEventArgs> IndexChanged Event Type EventHandler<GamePadIndexChangedEventArgs>"
  },
  "api/Stride.Input.IGravitySensor.html": {
    "href": "api/Stride.Input.IGravitySensor.html",
    "title": "Interface IGravitySensor | Stride API",
    "summary": "Interface IGravitySensor Namespace Stride.Input Assembly Stride.Input.dll This class represents a sensor of type Gravity. It measures the gravity force applying on the device. public interface IGravitySensor : ISensorDevice, IInputDevice Inherited Members ISensorDevice.IsEnabled IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods UnsafeUtilities.As<T>(object?) Properties Vector Gets the current gravity applied on the device (in meters/seconds^2). Vector3 Vector { get; } Property Value Vector3"
  },
  "api/Stride.Input.IGyroscopeSensor.html": {
    "href": "api/Stride.Input.IGyroscopeSensor.html",
    "title": "Interface IGyroscopeSensor | Stride API",
    "summary": "Interface IGyroscopeSensor Namespace Stride.Input Assembly Stride.Input.dll This class represents a sensor of type Gyroscope. It measures the rotation speed of device along the x/y/z axis. public interface IGyroscopeSensor : ISensorDevice, IInputDevice Inherited Members ISensorDevice.IsEnabled IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods UnsafeUtilities.As<T>(object?) Properties RotationRate Gets the current rotation speed of the device along x/y/z axis. Vector3 RotationRate { get; } Property Value Vector3"
  },
  "api/Stride.Input.IInputDevice.html": {
    "href": "api/Stride.Input.IInputDevice.html",
    "title": "Interface IInputDevice | Stride API",
    "summary": "Interface IInputDevice Namespace Stride.Input Assembly Stride.Input.dll public interface IInputDevice Extension Methods UnsafeUtilities.As<T>(object?) Properties Id The unique identifier of this device Guid Id { get; } Property Value Guid Name The name of the device string Name { get; } Property Value string Priority The device priority. Larger means higher priority when selecting the first device of some type int Priority { get; set; } Property Value int Source The input source the device belongs to. IInputSource Source { get; } Property Value IInputSource Methods Update(List<InputEvent>) Updates the input device, filling the list inputEvents with input events that were generated by this device this frame void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent> A list that gets filled with input events that were generated since the last frame Remarks Input devices are always updated after their respective input source"
  },
  "api/Stride.Input.IInputEventArgs.html": {
    "href": "api/Stride.Input.IInputEventArgs.html",
    "title": "Interface IInputEventArgs | Stride API",
    "summary": "Interface IInputEventArgs Namespace Stride.Input Assembly Stride.Input.dll public interface IInputEventArgs Extension Methods UnsafeUtilities.As<T>(object?) Properties Device The device that sent this event IInputDevice Device { get; } Property Value IInputDevice"
  },
  "api/Stride.Input.IInputEventListener-1.html": {
    "href": "api/Stride.Input.IInputEventListener-1.html",
    "title": "Interface IInputEventListener<TEventType> | Stride API",
    "summary": "Interface IInputEventListener<TEventType> Namespace Stride.Input Assembly Stride.Input.dll Interface for classes that want to listen to input event of a certain type public interface IInputEventListener<TEventType> : IInputEventListener where TEventType : InputEvent Type Parameters TEventType The type of InputEvent that will be sent to this event listener Extension Methods UnsafeUtilities.As<T>(object?) Methods ProcessEvent(TEventType) Processes a new input event void ProcessEvent(TEventType inputEvent) Parameters inputEvent TEventType the input event"
  },
  "api/Stride.Input.IInputEventListener.html": {
    "href": "api/Stride.Input.IInputEventListener.html",
    "title": "Interface IInputEventListener | Stride API",
    "summary": "Interface IInputEventListener Namespace Stride.Input Assembly Stride.Input.dll Does not listen to any event but is used to pass around a type that might potentially listen for input events public interface IInputEventListener Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Input.IInputSource.html": {
    "href": "api/Stride.Input.IInputSource.html",
    "title": "Interface IInputSource | Stride API",
    "summary": "Interface IInputSource Namespace Stride.Input Assembly Stride.Input.dll An abstraction for a platform specific mechanism that provides input in the form of one of multiple IInputDevice(s). An input source is responsible for cleaning up it's own devices at cleanup public interface IInputSource : IDisposable Inherited Members IDisposable.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties Devices All the input devices currently proviced by this source TrackingDictionary<Guid, IInputDevice> Devices { get; } Property Value TrackingDictionary<Guid, IInputDevice> Methods Initialize(InputManager) Initializes the input source void Initialize(InputManager inputManager) Parameters inputManager InputManager The InputManager initializing this source Pause() Called when input should be paused, for example when the application leaves the foreground void Pause() Resume() Called when input should be resumed, when an application enters the forground void Resume() Scan() Allows the source to take it's time to search for new devices void Scan() Update() Update the input source and possibly add/remove input devices void Update()"
  },
  "api/Stride.Input.IKeyboardDevice.html": {
    "href": "api/Stride.Input.IKeyboardDevice.html",
    "title": "Interface IKeyboardDevice | Stride API",
    "summary": "Interface IKeyboardDevice Namespace Stride.Input Assembly Stride.Input.dll A keyboard device public interface IKeyboardDevice : IInputDevice Inherited Members IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods KeyboardDeviceExtensions.IsKeyDown(IKeyboardDevice, Keys) KeyboardDeviceExtensions.IsKeyPressed(IKeyboardDevice, Keys) KeyboardDeviceExtensions.IsKeyReleased(IKeyboardDevice, Keys) UnsafeUtilities.As<T>(object?) Properties DownKeys List of keys that are currently down on this keyboard IReadOnlySet<Keys> DownKeys { get; } Property Value IReadOnlySet<Keys> PressedKeys The keys that have been pressed since the last frame IReadOnlySet<Keys> PressedKeys { get; } Property Value IReadOnlySet<Keys> ReleasedKeys The keys that have been released since the last frame IReadOnlySet<Keys> ReleasedKeys { get; } Property Value IReadOnlySet<Keys>"
  },
  "api/Stride.Input.IMouseDevice.html": {
    "href": "api/Stride.Input.IMouseDevice.html",
    "title": "Interface IMouseDevice | Stride API",
    "summary": "Interface IMouseDevice Namespace Stride.Input Assembly Stride.Input.dll Represents functionality specific to mouse input such as buttons, wheels, mouse locking and setting cursor position public interface IMouseDevice : IPointerDevice, IInputDevice Inherited Members IPointerDevice.SurfaceSize IPointerDevice.SurfaceAspectRatio IPointerDevice.PressedPointers IPointerDevice.ReleasedPointers IPointerDevice.DownPointers IPointerDevice.SurfaceSizeChanged IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods MouseDeviceExtensions.IsButtonDown(IMouseDevice, MouseButton) MouseDeviceExtensions.IsButtonPressed(IMouseDevice, MouseButton) MouseDeviceExtensions.IsButtonReleased(IMouseDevice, MouseButton) UnsafeUtilities.As<T>(object?) Properties Delta Mouse delta Vector2 Delta { get; } Property Value Vector2 DownButtons The mouse buttons that are down IReadOnlySet<MouseButton> DownButtons { get; } Property Value IReadOnlySet<MouseButton> IsPositionLocked Gets or sets if the mouse is locked to the screen bool IsPositionLocked { get; } Property Value bool Position Normalized position of the mouse inside the window Vector2 Position { get; } Property Value Vector2 PressedButtons The mouse buttons that have been pressed since the last frame IReadOnlySet<MouseButton> PressedButtons { get; } Property Value IReadOnlySet<MouseButton> ReleasedButtons The mouse buttons that have been released since the last frame IReadOnlySet<MouseButton> ReleasedButtons { get; } Property Value IReadOnlySet<MouseButton> Methods LockPosition(bool) Locks the mouse position to the screen void LockPosition(bool forceCenter = false) Parameters forceCenter bool Force the mouse position to the center of the screen SetPosition(Vector2) Attempts to set the pointer position, this only makes sense for mouse pointers void SetPosition(Vector2 normalizedPosition) Parameters normalizedPosition Vector2 UnlockPosition() Unlocks the mouse position if it was locked void UnlockPosition()"
  },
  "api/Stride.Input.IOrientationSensor.html": {
    "href": "api/Stride.Input.IOrientationSensor.html",
    "title": "Interface IOrientationSensor | Stride API",
    "summary": "Interface IOrientationSensor Namespace Stride.Input Assembly Stride.Input.dll This class represents a sensor of type Orientation. It measures the orientation of device in the real world. public interface IOrientationSensor : ISensorDevice, IInputDevice Inherited Members ISensorDevice.IsEnabled IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods UnsafeUtilities.As<T>(object?) Properties Pitch Gets the value of the pitch (in radian). The pitch is the rotation around the lateral axis of the device, that is the Ox axis. float Pitch { get; } Property Value float Quaternion Gets the quaternion specifying the current rotation of the device. Quaternion Quaternion { get; } Property Value Quaternion Roll Gets the value of the roll (in radian). The roll is the rotation around the longitudinal axis of the device, that is the Oy axis. float Roll { get; } Property Value float RotationMatrix Gets the rotation matrix specifying the current rotation of the device. Matrix RotationMatrix { get; } Property Value Matrix Yaw Gets the value of the yaw (in radian). The yaw is the rotation around the vertical axis of the device, that is the Oz axis. float Yaw { get; } Property Value float"
  },
  "api/Stride.Input.IPointerDevice.html": {
    "href": "api/Stride.Input.IPointerDevice.html",
    "title": "Interface IPointerDevice | Stride API",
    "summary": "Interface IPointerDevice Namespace Stride.Input Assembly Stride.Input.dll Provides an interface for interacting with pointer devices, this can be a mouse, pen, touch screen, etc. public interface IPointerDevice : IInputDevice Inherited Members IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods UnsafeUtilities.As<T>(object?) Properties DownPointers The index of the pointers that are down IReadOnlySet<PointerPoint> DownPointers { get; } Property Value IReadOnlySet<PointerPoint> PressedPointers The index of the pointers that have been pressed since the last frame IReadOnlySet<PointerPoint> PressedPointers { get; } Property Value IReadOnlySet<PointerPoint> ReleasedPointers The index of the pointers that have been released since the last frame IReadOnlySet<PointerPoint> ReleasedPointers { get; } Property Value IReadOnlySet<PointerPoint> SurfaceAspectRatio The aspect ratio of the touch surface area float SurfaceAspectRatio { get; } Property Value float SurfaceSize The size of the surface used by the pointer, for a mouse this is the size of the window, for a touch device, the size of the touch area, etc. Vector2 SurfaceSize { get; } Property Value Vector2 Events SurfaceSizeChanged Raised when the surface size of this pointer changed event EventHandler<SurfaceSizeChangedEventArgs> SurfaceSizeChanged Event Type EventHandler<SurfaceSizeChangedEventArgs>"
  },
  "api/Stride.Input.ISensorDevice.html": {
    "href": "api/Stride.Input.ISensorDevice.html",
    "title": "Interface ISensorDevice | Stride API",
    "summary": "Interface ISensorDevice Namespace Stride.Input Assembly Stride.Input.dll Interface for a sensor device, use more specific interfaces to retrieve sensor data public interface ISensorDevice : IInputDevice Inherited Members IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsEnabled Gets or sets if this sensor is enabled bool IsEnabled { get; set; } Property Value bool Remarks Sensors are disabled by default"
  },
  "api/Stride.Input.ITextInputDevice.html": {
    "href": "api/Stride.Input.ITextInputDevice.html",
    "title": "Interface ITextInputDevice | Stride API",
    "summary": "Interface ITextInputDevice Namespace Stride.Input Assembly Stride.Input.dll A device such as a keyboard that supports text input. This can be a windows keyboard with IME support or a touch keyboard on a smartphone device public interface ITextInputDevice : IInputDevice Inherited Members IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods UnsafeUtilities.As<T>(object?) Methods DisableTextInput() Disallows text input to be entered, will close any IME active and stop sending text events void DisableTextInput() EnabledTextInput() Allows input to be entered, the input device will then send text events through the input manager void EnabledTextInput()"
  },
  "api/Stride.Input.IUserAccelerationSensor.html": {
    "href": "api/Stride.Input.IUserAccelerationSensor.html",
    "title": "Interface IUserAccelerationSensor | Stride API",
    "summary": "Interface IUserAccelerationSensor Namespace Stride.Input Assembly Stride.Input.dll This class represents a sensor of type user acceleration. It measures the acceleration applied by the user (no gravity) onto the device. public interface IUserAccelerationSensor : ISensorDevice, IInputDevice Inherited Members ISensorDevice.IsEnabled IInputDevice.Name IInputDevice.Id IInputDevice.Priority IInputDevice.Source IInputDevice.Update(List<InputEvent>) Extension Methods UnsafeUtilities.As<T>(object?) Properties Acceleration Gets the current acceleration applied by the user (in meters/seconds^2). Vector3 Acceleration { get; } Property Value Vector3"
  },
  "api/Stride.Input.IVirtualButton.html": {
    "href": "api/Stride.Input.IVirtualButton.html",
    "title": "Interface IVirtualButton | Stride API",
    "summary": "Interface IVirtualButton Namespace Stride.Input Assembly Stride.Input.dll Interface IVirtualButton public interface IVirtualButton Extension Methods UnsafeUtilities.As<T>(object?) Methods GetValue(InputManager) Gets the value associated with this virtual button from an input manager. float GetValue(InputManager manager) Parameters manager InputManager The manager. Returns float System.Single. IsDown(InputManager) Indicate if the button is currently down bool IsDown(InputManager manager) Parameters manager InputManager The input manager Returns bool IsPressed(InputManager) Indicate if the button has been pressed since the last frame bool IsPressed(InputManager manager) Parameters manager InputManager The input manager Returns bool IsReleased(InputManager) Indicate if the button has been released since the last frame bool IsReleased(InputManager manager) Parameters manager InputManager The input manager Returns bool"
  },
  "api/Stride.Input.InputDeviceUtils.html": {
    "href": "api/Stride.Input.InputDeviceUtils.html",
    "title": "Class InputDeviceUtils | Stride API",
    "summary": "Class InputDeviceUtils Namespace Stride.Input Assembly Stride.Input.dll Utilities for input devices public static class InputDeviceUtils Inheritance object InputDeviceUtils Methods DeviceNameToGuid(string) Generates a Guid unique to this name public static Guid DeviceNameToGuid(string name) Parameters name string the name to turn into a Guid Returns Guid A unique Guid for the given name"
  },
  "api/Stride.Input.InputEvent.html": {
    "href": "api/Stride.Input.InputEvent.html",
    "title": "Class InputEvent | Stride API",
    "summary": "Class InputEvent Namespace Stride.Input Assembly Stride.Input.dll An event that was generated from an IInputDevice public abstract class InputEvent : IInputEventArgs Inheritance object InputEvent Implements IInputEventArgs Derived AxisEvent ButtonEvent GameControllerDirectionEvent MouseWheelEvent PointerEvent TextInputEvent Extension Methods UnsafeUtilities.As<T>(object?) Properties Device The device that sent this event public IInputDevice Device { get; protected set; } Property Value IInputDevice"
  },
  "api/Stride.Input.InputEventPool-1.html": {
    "href": "api/Stride.Input.InputEventPool-1.html",
    "title": "Class InputEventPool<TEventType> | Stride API",
    "summary": "Class InputEventPool<TEventType> Namespace Stride.Input Assembly Stride.Input.dll Pools input events of a given type public static class InputEventPool<TEventType> where TEventType : InputEvent, new() Type Parameters TEventType The type of event to pool Inheritance object InputEventPool<TEventType> Properties ActiveObjects The number of events in circulation, if this number keeps increasing, Enqueue is possible not called somewhere public static int ActiveObjects { get; } Property Value int Methods Enqueue(TEventType) Puts a used event back into the pool to be recycled public static void Enqueue(TEventType item) Parameters item TEventType The event to reuse GetOrCreate(IInputDevice) Retrieves a new event that can be used, either from the pool or a new instance public static TEventType GetOrCreate(IInputDevice device) Parameters device IInputDevice The device that generates this event Returns TEventType An event"
  },
  "api/Stride.Input.InputManager.html": {
    "href": "api/Stride.Input.InputManager.html",
    "title": "Class InputManager | Stride API",
    "summary": "Class InputManager Namespace Stride.Input Assembly Stride.Input.dll Manages collecting input from connected input device in the form of IInputDevice objects. Also provides some convenience functions for most commonly used devices public class InputManager : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder, IInputEventListener<KeyEvent>, IInputEventListener<PointerEvent>, IInputEventListener<MouseWheelEvent>, IInputEventListener Inheritance object DisposeBase ComponentBase InputManager Implements IDisposable IComponent IReferencable ICollectorHolder IInputEventListener<KeyEvent> IInputEventListener<PointerEvent> IInputEventListener<MouseWheelEvent> IInputEventListener Inherited Members ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors InputManager() Initializes a new instance of the InputManager class. public InputManager() Fields GameControllerAxisDeadZone The deadzone amount applied to all game controller axes public static float GameControllerAxisDeadZone Field Value float Properties AbsoluteMouseDelta Mouse movement in device coordinates public Vector2 AbsoluteMouseDelta { get; } Property Value Vector2 AbsoluteMousePosition Mouse coordinates in device coordinates public Vector2 AbsoluteMousePosition { get; } Property Value Vector2 Accelerometer Gets the reference to the accelerometer sensor. The accelerometer measures all the acceleration forces applied on the device. public IAccelerometerSensor Accelerometer { get; } Property Value IAccelerometerSensor Compass Gets the reference to the compass sensor. The compass measures the angle between the device top and the north. public ICompassSensor Compass { get; } Property Value ICompassSensor DefaultGamePad Gets the first gamepad that was added to the device public IGamePadDevice DefaultGamePad { get; } Property Value IGamePadDevice DownButtons The mouse buttons that are down public IReadOnlySet<MouseButton> DownButtons { get; } Property Value IReadOnlySet<MouseButton> DownKeys The keys that are down public IReadOnlySet<Keys> DownKeys { get; } Property Value IReadOnlySet<Keys> Events All input events that happened since the last frame public IReadOnlyList<InputEvent> Events { get; } Property Value IReadOnlyList<InputEvent> GameControllerCount Gets the number of game controllers connected. public int GameControllerCount { get; } Property Value int The number of game controllers connected. GameControllers Gets the collection of connected game controllers public IReadOnlyList<IGameControllerDevice> GameControllers { get; } Property Value IReadOnlyList<IGameControllerDevice> GamePadCount Gets the number of gamepads connected. public int GamePadCount { get; } Property Value int The number of gamepads connected. GamePads Gets the collection of connected gamepads public IReadOnlyList<IGamePadDevice> GamePads { get; } Property Value IReadOnlyList<IGamePadDevice> GestureEvents Gets the collection of gesture events since the previous updates. public IReadOnlyList<GestureEvent> GestureEvents { get; } Property Value IReadOnlyList<GestureEvent> The gesture events. Gestures List of the gestures to recognize. public TrackingCollection<GestureConfig> Gestures { get; } Property Value TrackingCollection<GestureConfig> Gravity Gets the reference to the gravity sensor. The gravity sensor measures the gravity vector applied to the device. public IGravitySensor Gravity { get; } Property Value IGravitySensor Gyroscope Gets the reference to the gyroscope sensor. The gyroscope measures the rotation speed of the device. public IGyroscopeSensor Gyroscope { get; } Property Value IGyroscopeSensor HasDownKeys Determines whether one or more keys are down public bool HasDownKeys { get; } Property Value bool true if one or more keys are down; otherwise, false. HasDownMouseButtons Determines whether one or more of the mouse buttons are down public bool HasDownMouseButtons { get; } Property Value bool true if one or more of the mouse buttons are down; otherwise, false. HasGameController Gets a value indicating whether game controllers are available. public bool HasGameController { get; } Property Value bool true if game controllers are available; otherwise, false. HasGamePad Gets a value indicating whether gamepads are available. public bool HasGamePad { get; } Property Value bool true if gamepads are available; otherwise, false. HasKeyboard Gets a value indicating whether the keyboard is available. public bool HasKeyboard { get; } Property Value bool true if the keyboard is available; otherwise, false. HasMouse Gets a value indicating whether the mouse is available. public bool HasMouse { get; } Property Value bool true if the mouse is available; otherwise, false. HasPointer Gets a value indicating whether pointer device is available. public bool HasPointer { get; } Property Value bool true if pointer devices are available; otherwise, false. HasPressedKeys Determines whether one or more keys are pressed public bool HasPressedKeys { get; } Property Value bool true if one or more keys are pressed; otherwise, false. HasPressedMouseButtons Determines whether one or more of the mouse buttons are pressed public bool HasPressedMouseButtons { get; } Property Value bool true if one or more of the mouse buttons are pressed; otherwise, false. HasReleasedKeys Determines whether one or more keys are released public bool HasReleasedKeys { get; } Property Value bool true if one or more keys are released; otherwise, false. HasReleasedMouseButtons Determines whether one or more of the mouse buttons are released public bool HasReleasedMouseButtons { get; } Property Value bool true if one or more of the mouse buttons are released; otherwise, false. IsMousePositionLocked Gets the value indicating if the mouse position is currently locked or not. public bool IsMousePositionLocked { get; } Property Value bool KeyEvents Key events that happened since the last frame public IReadOnlyList<KeyEvent> KeyEvents { get; } Property Value IReadOnlyList<KeyEvent> Keyboard Gets the first keyboard device, or null if there is none public IKeyboardDevice Keyboard { get; } Property Value IKeyboardDevice Keyboards Gets the collection of connected keyboard inputs public IReadOnlyList<IKeyboardDevice> Keyboards { get; } Property Value IReadOnlyList<IKeyboardDevice> LastPointerDevice Device that is responsible for setting the current MouseDelta and MousePosition public IPointerDevice LastPointerDevice { get; } Property Value IPointerDevice Mouse Gets the first mouse pointer device, or null if there is none public IMouseDevice Mouse { get; } Property Value IMouseDevice MouseDelta Mouse delta in normalized coordinate space public Vector2 MouseDelta { get; } Property Value Vector2 MousePosition The mouse position in normalized coordinates. public Vector2 MousePosition { get; set; } Property Value Vector2 MouseWheelDelta The delta value of the mouse wheel button since last frame. public float MouseWheelDelta { get; } Property Value float Orientation Gets the reference to the orientation sensor. The orientation sensor measures orientation of device in the world. public IOrientationSensor Orientation { get; } Property Value IOrientationSensor Pointer Gets the first pointer device, or null if there is none public IPointerDevice Pointer { get; } Property Value IPointerDevice PointerEvents Pointer events that happened since the last frame public IReadOnlyList<PointerEvent> PointerEvents { get; } Property Value IReadOnlyList<PointerEvent> Pointers Gets the collection of connected pointing devices (mouses, touchpads, etc) public IReadOnlyList<IPointerDevice> Pointers { get; } Property Value IReadOnlyList<IPointerDevice> PressedButtons The mouse buttons that have been pressed since the last frame public IReadOnlySet<MouseButton> PressedButtons { get; } Property Value IReadOnlySet<MouseButton> PressedKeys The keys that have been pressed since the last frame public IReadOnlySet<Keys> PressedKeys { get; } Property Value IReadOnlySet<Keys> ReleasedButtons The mouse buttons that have been released since the last frame public IReadOnlySet<MouseButton> ReleasedButtons { get; } Property Value IReadOnlySet<MouseButton> ReleasedKeys The keys that have been released since the last frame public IReadOnlySet<Keys> ReleasedKeys { get; } Property Value IReadOnlySet<Keys> Sensors Gets the collection of connected sensor devices public IReadOnlyList<ISensorDevice> Sensors { get; } Property Value IReadOnlyList<ISensorDevice> Sources Input sources public TrackingCollection<IInputSource> Sources { get; } Property Value TrackingCollection<IInputSource> TextInput First device that supports text input, or null if there is none public ITextInputDevice TextInput { get; } Property Value ITextInputDevice UseRawInput Should raw input be used on windows public bool UseRawInput { get; set; } Property Value bool UserAcceleration Gets the reference to the user acceleration sensor. The user acceleration sensor measures the acceleration produce by the user on the device (no gravity). public IUserAccelerationSensor UserAcceleration { get; } Property Value IUserAccelerationSensor VirtualButtonConfigSet Gets or sets the configuration for virtual buttons. public VirtualButtonConfigSet VirtualButtonConfigSet { get; set; } Property Value VirtualButtonConfigSet The current binding. Methods AddListener(IInputEventListener) Registers an object that listens for certain types of events using the specialized versions of IInputEventListener<TEventType> public void AddListener(IInputEventListener listener) Parameters listener IInputEventListener The listener to register Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. GetFreeGamePadIndex(IGamePadDevice) Suggests an index that is unused for a given IGamePadDevice public int GetFreeGamePadIndex(IGamePadDevice gamePad) Parameters gamePad IGamePadDevice The gamepad to find an index for Returns int The unused gamepad index GetGamePadByIndex(int) Gets the first gamepad with a specific index public IGamePadDevice GetGamePadByIndex(int gamePadIndex) Parameters gamePadIndex int The index of the gamepad Returns IGamePadDevice The gamepad, or null if no gamepad has this index Exceptions IndexOutOfRangeException When gamePadIndex is less than 0 GetGamePadsByIndex(int) Gets all the gamepads with a specific index public IEnumerable<IGamePadDevice> GetGamePadsByIndex(int gamePadIndex) Parameters gamePadIndex int The index of the gamepad Returns IEnumerable<IGamePadDevice> The gamepads, or null if no gamepad has this index Exceptions IndexOutOfRangeException When gamePadIndex is less than 0 GetVirtualButton(int, object) Gets a binding value for the specified name and the specified config extract from the current VirtualButtonConfigSet. [Obsolete(\"This method is obsolete. Call GetVirtualButtonValue instead.\")] public virtual float GetVirtualButton(int configIndex, object bindingName) Parameters configIndex int An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet. bindingName object Name of the binding. Returns float The value of the binding. GetVirtualButtonValue(int, object) Gets a binding value for the specified name and the specified config extract from the current VirtualButtonConfigSet. public virtual float GetVirtualButtonValue(int configIndex, object bindingName) Parameters configIndex int An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet. bindingName object Name of the binding. Returns float The value of the binding. Initialize(GameContext) public void Initialize(GameContext gameContext) Parameters gameContext GameContext IsKeyDown(Keys) Determines whether the specified key is being pressed down. public bool IsKeyDown(Keys key) Parameters key Keys The key. Returns bool true if the specified key is being pressed down; otherwise, false. IsKeyPressed(Keys) Determines whether the specified key is pressed since the previous update. public bool IsKeyPressed(Keys key) Parameters key Keys The key. Returns bool true if the specified key is pressed; otherwise, false. IsKeyReleased(Keys) Determines whether the specified key is released since the previous update. public bool IsKeyReleased(Keys key) Parameters key Keys The key. Returns bool true if the specified key is released; otherwise, false. IsMouseButtonDown(MouseButton) Determines whether the specified mouse button is being pressed down. public bool IsMouseButtonDown(MouseButton mouseButton) Parameters mouseButton MouseButton The mouse button. Returns bool true if the specified mouse button is being pressed down; otherwise, false. IsMouseButtonPressed(MouseButton) Determines whether the specified mouse button is pressed since the previous update. public bool IsMouseButtonPressed(MouseButton mouseButton) Parameters mouseButton MouseButton The mouse button. Returns bool true if the specified mouse button is pressed since the previous update; otherwise, false. IsMouseButtonReleased(MouseButton) Determines whether the specified mouse button is released. public bool IsMouseButtonReleased(MouseButton mouseButton) Parameters mouseButton MouseButton The mouse button. Returns bool true if the specified mouse button is released; otherwise, false. IsVirtualButtonDown(int, object) Determines whether the specified binding in the specified config in the current VirtualButtonConfigSet is currently pressed down. public virtual bool IsVirtualButtonDown(int configIndex, object bindingName) Parameters configIndex int An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet. bindingName object Name of the binding. Returns bool true if the binding is currently pressed down; otherwise, false. IsVirtualButtonPressed(int, object) Determines whether the specified binding in the specified config in the current VirtualButtonConfigSet was pressed since the previous Update. public virtual bool IsVirtualButtonPressed(int configIndex, object bindingName) Parameters configIndex int An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet. bindingName object Name of the binding. Returns bool true if the binding was pressed; otherwise, false. IsVirtualButtonReleased(int, object) Determines whether the specified binding in the specified config in the current VirtualButtonConfigSet was released since the previous Update. public virtual bool IsVirtualButtonReleased(int configIndex, object bindingName) Parameters configIndex int An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet. bindingName object Name of the binding. Returns bool true if the binding was released; otherwise, false. LockMousePosition(bool) Lock the mouse's position and hides it until the next call to UnlockMousePosition(). public void LockMousePosition(bool forceCenter = false) Parameters forceCenter bool If true will make sure that the mouse cursor position moves to the center of the client window Remarks This function has no effects on devices that does not have mouse Pause() Pause all input sources. public void Pause() PoolInputEvent(InputEvent) Inserts any registered event back into it's InputEventPool<TEventType>. public void PoolInputEvent(InputEvent inputEvent) Parameters inputEvent InputEvent The event to insert into it's event pool ProcessEvent(KeyEvent) Processes a new input event public void ProcessEvent(KeyEvent inputEvent) Parameters inputEvent KeyEvent the input event ProcessEvent(MouseWheelEvent) Processes a new input event public void ProcessEvent(MouseWheelEvent inputEvent) Parameters inputEvent MouseWheelEvent the input event ProcessEvent(PointerEvent) Processes a new input event public void ProcessEvent(PointerEvent inputEvent) Parameters inputEvent PointerEvent the input event RegisterEventType<TEventType>() Registers an input event type to process public void RegisterEventType<TEventType>() where TEventType : InputEvent, new() Type Parameters TEventType The event type to process RemoveListener(IInputEventListener) Removes a previously registered event listener public void RemoveListener(IInputEventListener listener) Parameters listener IInputEventListener The listener to remove ResetSources() Resets the Sources collection back to it's default values public void ResetSources() Resume() Resume all input sources. public void Resume() Scan() Rescans all input devices in order to query new device connected. See remarks. public void Scan() Remarks This method could take several milliseconds and should be used at specific time in a game where performance is not crucial (pause, configuration screen...etc.) TransformPosition(Size2F, RectangleF, Vector2) Helper method to transform mouse and pointer event positions to sub rectangles public static Vector2 TransformPosition(Size2F fromSize, RectangleF destinationRectangle, Vector2 screenCoordinates) Parameters fromSize Size2F the size of the source rectangle destinationRectangle RectangleF The destination viewport rectangle screenCoordinates Vector2 The normalized screen coordinates Returns Vector2 UnlockMousePosition() Unlock the mouse's position previously locked by calling LockMousePosition(bool) and restore the mouse visibility. public void UnlockMousePosition() Remarks This function has no effects on devices that does not have mouse Update(GameTime) public void Update(GameTime gameTime) Parameters gameTime GameTime Events DeviceAdded Raised when a device was added to the system public event EventHandler<DeviceChangedEventArgs> DeviceAdded Event Type EventHandler<DeviceChangedEventArgs> DeviceRemoved Raised when a device was removed from the system public event EventHandler<DeviceChangedEventArgs> DeviceRemoved Event Type EventHandler<DeviceChangedEventArgs> PreUpdateInput Raised before new input is sent to their respective event listeners public event EventHandler<InputPreUpdateEventArgs> PreUpdateInput Event Type EventHandler<InputPreUpdateEventArgs>"
  },
  "api/Stride.Input.InputPreUpdateEventArgs.html": {
    "href": "api/Stride.Input.InputPreUpdateEventArgs.html",
    "title": "Class InputPreUpdateEventArgs | Stride API",
    "summary": "Class InputPreUpdateEventArgs Namespace Stride.Input Assembly Stride.Input.dll Arguments for input pre update event public class InputPreUpdateEventArgs : EventArgs Inheritance object EventArgs InputPreUpdateEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Fields GameTime The game time passed to Update(GameTime) public GameTime GameTime Field Value GameTime"
  },
  "api/Stride.Input.InputSourceBase.html": {
    "href": "api/Stride.Input.InputSourceBase.html",
    "title": "Class InputSourceBase | Stride API",
    "summary": "Class InputSourceBase Namespace Stride.Input Assembly Stride.Input.dll Base class for input sources, implements common parts of the IInputSource interface and keeps track of registered devices through RegisterDevice(IInputDevice) and UnregisterDevice(IInputDevice) public abstract class InputSourceBase : IInputSource, IDisposable Inheritance object InputSourceBase Implements IInputSource IDisposable Derived InputSourceSimulated Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties Devices All the input devices currently proviced by this source public TrackingDictionary<Guid, IInputDevice> Devices { get; } Property Value TrackingDictionary<Guid, IInputDevice> Methods Dispose() Unregisters all devices registered with RegisterDevice(IInputDevice) which have not been unregistered yet public virtual void Dispose() Initialize(InputManager) Initializes the input source public abstract void Initialize(InputManager inputManager) Parameters inputManager InputManager The InputManager initializing this source Pause() Called when input should be paused, for example when the application leaves the foreground public virtual void Pause() RegisterDevice(IInputDevice) Adds the device to the list Devices protected void RegisterDevice(IInputDevice device) Parameters device IInputDevice The device Resume() Called when input should be resumed, when an application enters the forground public virtual void Resume() Scan() Allows the source to take it's time to search for new devices public virtual void Scan() UnregisterDevice(IInputDevice) CRemoves the device from the list Devices protected void UnregisterDevice(IInputDevice device) Parameters device IInputDevice The device Update() Update the input source and possibly add/remove input devices public virtual void Update()"
  },
  "api/Stride.Input.InputSourceFactory.html": {
    "href": "api/Stride.Input.InputSourceFactory.html",
    "title": "Class InputSourceFactory | Stride API",
    "summary": "Class InputSourceFactory Namespace Stride.Input Assembly Stride.Input.dll Given a GameContext creates the corresponding IInputSource for the platform specific window. public static class InputSourceFactory Inheritance object InputSourceFactory Methods NewWindowInputSource(GameContext) Creates a new input source for the window provided by the context. public static IInputSource NewWindowInputSource(GameContext context) Parameters context GameContext The context containing the platform specific window. Returns IInputSource An input source for the window."
  },
  "api/Stride.Input.InputSourceSimulated.html": {
    "href": "api/Stride.Input.InputSourceSimulated.html",
    "title": "Class InputSourceSimulated | Stride API",
    "summary": "Class InputSourceSimulated Namespace Stride.Input Assembly Stride.Input.dll Provides a virtual mouse and keyboard that generate input events like a normal mouse/keyboard when any of the functions (Simulate...) are called public class InputSourceSimulated : InputSourceBase, IInputSource, IDisposable Inheritance object InputSourceBase InputSourceSimulated Implements IInputSource IDisposable Inherited Members InputSourceBase.Devices InputSourceBase.Update() InputSourceBase.Pause() InputSourceBase.Resume() InputSourceBase.Scan() InputSourceBase.RegisterDevice(IInputDevice) InputSourceBase.UnregisterDevice(IInputDevice) Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties GamePads public IReadOnlyList<GamePadSimulated> GamePads { get; } Property Value IReadOnlyList<GamePadSimulated> Keyboards public IReadOnlyList<KeyboardSimulated> Keyboards { get; } Property Value IReadOnlyList<KeyboardSimulated> Mice public IReadOnlyList<MouseSimulated> Mice { get; } Property Value IReadOnlyList<MouseSimulated> Pointers public IReadOnlyList<PointerSimulated> Pointers { get; } Property Value IReadOnlyList<PointerSimulated> Methods AddGamePad() public GamePadSimulated AddGamePad() Returns GamePadSimulated AddKeyboard() public KeyboardSimulated AddKeyboard() Returns KeyboardSimulated AddMouse() public MouseSimulated AddMouse() Returns MouseSimulated AddPointer() public PointerSimulated AddPointer() Returns PointerSimulated Dispose() Unregisters all devices registered with RegisterDevice(IInputDevice) which have not been unregistered yet public override void Dispose() Initialize(InputManager) Initializes the input source public override void Initialize(InputManager inputManager) Parameters inputManager InputManager The InputManager initializing this source RemoveAllGamePads() public void RemoveAllGamePads() RemoveAllKeyboards() public void RemoveAllKeyboards() RemoveAllMice() public void RemoveAllMice() RemoveAllPointers() public void RemoveAllPointers() RemoveGamePad(GamePadSimulated) public void RemoveGamePad(GamePadSimulated gamePad) Parameters gamePad GamePadSimulated RemoveKeyboard(KeyboardSimulated) public void RemoveKeyboard(KeyboardSimulated keyboard) Parameters keyboard KeyboardSimulated RemoveMouse(MouseSimulated) public void RemoveMouse(MouseSimulated mouse) Parameters mouse MouseSimulated RemovePointer(PointerSimulated) public void RemovePointer(PointerSimulated pointer) Parameters pointer PointerSimulated"
  },
  "api/Stride.Input.KeyEvent.html": {
    "href": "api/Stride.Input.KeyEvent.html",
    "title": "Class KeyEvent | Stride API",
    "summary": "Class KeyEvent Namespace Stride.Input Assembly Stride.Input.dll Event for a keyboard button changing state public class KeyEvent : ButtonEvent, IInputEventArgs Inheritance object InputEvent ButtonEvent KeyEvent Implements IInputEventArgs Inherited Members ButtonEvent.IsDown InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields Key The key that is being pressed or released. public Keys Key Field Value Keys RepeatCount The repeat count for this key. If it is 0 this is the initial press of the key public int RepeatCount Field Value int Properties Keyboard The keyboard that sent this event public IKeyboardDevice Keyboard { get; } Property Value IKeyboardDevice Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.KeyboardDeviceBase.html": {
    "href": "api/Stride.Input.KeyboardDeviceBase.html",
    "title": "Class KeyboardDeviceBase | Stride API",
    "summary": "Class KeyboardDeviceBase Namespace Stride.Input Assembly Stride.Input.dll Base class for keyboard devices public abstract class KeyboardDeviceBase : IKeyboardDevice, IInputDevice Inheritance object KeyboardDeviceBase Implements IKeyboardDevice IInputDevice Derived KeyboardSimulated Extension Methods KeyboardDeviceExtensions.IsKeyDown(IKeyboardDevice, Keys) KeyboardDeviceExtensions.IsKeyPressed(IKeyboardDevice, Keys) KeyboardDeviceExtensions.IsKeyReleased(IKeyboardDevice, Keys) UnsafeUtilities.As<T>(object?) Constructors KeyboardDeviceBase() protected KeyboardDeviceBase() Fields Events protected readonly List<KeyEvent> Events Field Value List<KeyEvent> KeyRepeats public readonly Dictionary<Keys, int> KeyRepeats Field Value Dictionary<Keys, int> Properties DownKeys List of keys that are currently down on this keyboard public IReadOnlySet<Keys> DownKeys { get; } Property Value IReadOnlySet<Keys> Id The unique identifier of this device public abstract Guid Id { get; } Property Value Guid Name The name of the device public abstract string Name { get; } Property Value string PressedKeys The keys that have been pressed since the last frame public IReadOnlySet<Keys> PressedKeys { get; } Property Value IReadOnlySet<Keys> Priority The device priority. Larger means higher priority when selecting the first device of some type public int Priority { get; set; } Property Value int ReleasedKeys The keys that have been released since the last frame public IReadOnlySet<Keys> ReleasedKeys { get; } Property Value IReadOnlySet<Keys> Source The input source the device belongs to. public abstract IInputSource Source { get; } Property Value IInputSource Methods HandleKeyDown(Keys) public void HandleKeyDown(Keys key) Parameters key Keys HandleKeyUp(Keys) public void HandleKeyUp(Keys key) Parameters key Keys Update(List<InputEvent>) Updates the input device, filling the list inputEvents with input events that were generated by this device this frame public virtual void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent> A list that gets filled with input events that were generated since the last frame Remarks Input devices are always updated after their respective input source"
  },
  "api/Stride.Input.KeyboardDeviceExtensions.html": {
    "href": "api/Stride.Input.KeyboardDeviceExtensions.html",
    "title": "Class KeyboardDeviceExtensions | Stride API",
    "summary": "Class KeyboardDeviceExtensions Namespace Stride.Input Assembly Stride.Input.dll public static class KeyboardDeviceExtensions Inheritance object KeyboardDeviceExtensions Methods IsKeyDown(IKeyboardDevice, Keys) Determines whether the specified key is being pressed down public static bool IsKeyDown(this IKeyboardDevice keyboardDevice, Keys key) Parameters keyboardDevice IKeyboardDevice The keyboard key Keys The key Returns bool true if the specified key is being pressed down; otherwise, false. IsKeyPressed(IKeyboardDevice, Keys) Determines whether the specified key is pressed since the previous update. public static bool IsKeyPressed(this IKeyboardDevice keyboardDevice, Keys key) Parameters keyboardDevice IKeyboardDevice The keyboard key Keys The key Returns bool true if the specified key is pressed; otherwise, false. IsKeyReleased(IKeyboardDevice, Keys) Determines whether the specified key is released since the previous update. public static bool IsKeyReleased(this IKeyboardDevice keyboardDevice, Keys key) Parameters keyboardDevice IKeyboardDevice The keyboard key Keys The key Returns bool true if the specified key is released; otherwise, false."
  },
  "api/Stride.Input.KeyboardSimulated.html": {
    "href": "api/Stride.Input.KeyboardSimulated.html",
    "title": "Class KeyboardSimulated | Stride API",
    "summary": "Class KeyboardSimulated Namespace Stride.Input Assembly Stride.Input.dll public class KeyboardSimulated : KeyboardDeviceBase, IKeyboardDevice, IInputDevice Inheritance object KeyboardDeviceBase KeyboardSimulated Implements IKeyboardDevice IInputDevice Inherited Members KeyboardDeviceBase.Events KeyboardDeviceBase.KeyRepeats KeyboardDeviceBase.PressedKeys KeyboardDeviceBase.ReleasedKeys KeyboardDeviceBase.DownKeys KeyboardDeviceBase.Priority KeyboardDeviceBase.Update(List<InputEvent>) KeyboardDeviceBase.HandleKeyDown(Keys) KeyboardDeviceBase.HandleKeyUp(Keys) Extension Methods KeyboardDeviceExtensions.IsKeyDown(IKeyboardDevice, Keys) KeyboardDeviceExtensions.IsKeyPressed(IKeyboardDevice, Keys) KeyboardDeviceExtensions.IsKeyReleased(IKeyboardDevice, Keys) UnsafeUtilities.As<T>(object?) Constructors KeyboardSimulated(InputSourceSimulated) public KeyboardSimulated(InputSourceSimulated source) Parameters source InputSourceSimulated Properties Id The unique identifier of this device public override Guid Id { get; } Property Value Guid Name The name of the device public override string Name { get; } Property Value string Source The input source the device belongs to. public override IInputSource Source { get; } Property Value IInputSource Methods SimulateDown(Keys) public void SimulateDown(Keys key) Parameters key Keys SimulateUp(Keys) public void SimulateUp(Keys key) Parameters key Keys"
  },
  "api/Stride.Input.Keys.html": {
    "href": "api/Stride.Input.Keys.html",
    "title": "Enum Keys | Stride API",
    "summary": "Enum Keys Namespace Stride.Input Assembly Stride.Input.dll Enumeration for keys. public enum Keys Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields A = 44 The 'a' key. Add = 85 The numeric keypad 'add' key. Apps = 72 The 'apps'/'Menu'/'FN2' key, between the windows and right ctrl key on a 104 keys keyboard. Attn = 163 The 'attn' key. B = 45 The 'b' key. Back = 2 The 'back'/'backspace' key. BackSpace = 2 The 'back'/'backspace' key. BrowserBack = 122 The 'browserback' key. BrowserFavorites = 127 The 'browserfavorites' key. BrowserForward = 123 The 'browserforward' key. BrowserHome = 128 The 'browserhome' key. BrowserRefresh = 124 The 'browserrefresh' key. BrowserSearch = 126 The 'browsersearch' key. BrowserStop = 125 The 'browserstop' key. C = 46 The 'c' key. Cancel = 1 The 'cancel' key. Capital = 8 The 'capslock'/'capital' key. CapsLock = 8 The 'capslock'/'capital' key. Clear = 5 The 'clear' key. CrSel = 164 The 'crsel' key. D = 47 The 'd' key. D0 = 34 The number row '0' key. D1 = 35 The number row '1' key. D2 = 36 The number row '2' key. D3 = 37 The number row '3' key. D4 = 38 The number row '4' key. D5 = 39 The number row '5' key. D6 = 40 The number row '6' key. D7 = 41 The number row '7' key. D8 = 42 The number row '8' key. D9 = 43 The number row '9' key. Decimal = 88 The numeric keypad 'decimal' and 'decimal separator' key. Delete = 32 The 'delete' key. Divide = 89 The numeric keypad 'divide' key. Down = 26 The 'down' key. E = 48 The 'e' key. End = 21 The 'end' key. Enter = 6 The 'enter'/'return' key. EraseEof = 166 The 'eraseeof' key. Escape = 13 The 'escape' key. ExSel = 165 The 'exsel' key. Execute = 29 The 'execute' key. F = 49 The 'f' key. F1 = 90 The function key 'f1'. F10 = 99 The function key 'f10'. F11 = 100 The function key 'f11'. F12 = 101 The function key 'f12'. F13 = 102 The function key 'f13'. F14 = 103 The function key 'f14'. F15 = 104 The function key 'f15'. F16 = 105 The function key 'f16'. F17 = 106 The function key 'f17'. F18 = 107 The function key 'f18'. F19 = 108 The function key 'f19'. F2 = 91 The function key 'f2'. F20 = 109 The function key 'f20'. F21 = 110 The function key 'f21'. F22 = 111 The function key 'f22'. F23 = 112 The function key 'f23'. F24 = 113 The function key 'f24'. F3 = 92 The function key 'f3'. F4 = 93 The function key 'f4'. F5 = 94 The function key 'f5'. F6 = 95 The function key 'f6'. F7 = 96 The function key 'f7'. F8 = 97 The function key 'f8'. F9 = 98 The function key 'f9'. FinalMode = 11 The 'finalmode' key. G = 50 The 'g' key. H = 51 The 'h' key. HangulMode = 9 The 'hangulmode' key. HanjaMode = 12 The 'hanjamode' key. Help = 33 The 'help' key. Home = 22 The 'home' key. I = 52 The 'i' key. ImeAccept = 16 The 'imeaccept' key. ImeConvert = 14 The 'imeconvert' key. ImeModeChange = 17 The 'imemodechange' key. ImeNonConvert = 15 The 'imenonconvert' key. Insert = 31 The 'insert' key. J = 53 The 'j' key. JunjaMode = 10 The 'junjamode' key. K = 54 The 'k' key. KanaMode = 9 The 'kanamode' key. KanjiMode = 12 The 'kanjimode' key. L = 55 The 'l' key. LaunchApplication1 = 138 The 'launchapplication1' key. LaunchApplication2 = 139 The 'launchapplication2' key. LaunchMail = 136 The 'launchmail' key. Left = 23 The 'left' key. LeftAlt = 120 The left 'alt' key. LeftCtrl = 118 The left 'ctrl' key. LeftShift = 116 The left 'shift' key. LeftWin = 70 The left 'windows'/'command'/'meta' key. LineFeed = 4 The 'linefeed' key. M = 56 The 'm' key. MediaNextTrack = 132 The 'medianexttrack' key. MediaPlayPause = 135 The 'mediaplaypause' key. MediaPreviousTrack = 133 The 'mediaprevioustrack' key. MediaStop = 134 The 'mediastop' key. Multiply = 84 The numeric keypad 'multiply' key. N = 57 The 'n' key. Next = 20 The 'pagedown'/'next' key. NoName = 169 A windows-reserved key. None = 0 Invalid key. NumLock = 114 The 'numlock' key. NumPad0 = 74 The numeric keypad '0' key. NumPad1 = 75 The numeric keypad '1' key. NumPad2 = 76 The numeric keypad '2' key. NumPad3 = 77 The numeric keypad '3' key. NumPad4 = 78 The numeric keypad '4' key. NumPad5 = 79 The numeric keypad '5' key. NumPad6 = 80 The numeric keypad '6' key. NumPad7 = 81 The numeric keypad '7' key. NumPad8 = 82 The numeric keypad '8' key. NumPad9 = 83 The numeric keypad '9' key. [Obsolete(\"Use Decimal instead\")] NumPadDecimal = 181 The numeric keypad 'decimal' key. NumPadEnter = 180 The numeric keypad 'enter' key in SDL and RawInput, Winforms forwards it to Return instead. O = 58 The 'o' key. Oem1 = 140 The 'oem1'/'semicolon' key, to the right of the 'L' key on a standard US layout. Oem102 = 154 The 'OemBackSlash'/'oem102' key, on US ISO keyboards this key sits between left shift and 'Z'. Oem2 = 145 The 'oemquestion'/'oem2' key, next to 'right shift' on a standard US layout. Oem3 = 146 The 'oemtilde'/'oem3' key, above 'tab' on a standard US layout. Oem4 = 149 The 'OemOpenBrackets'/'oem4' key, to the right of 'P' on a standard US layout. Oem5 = 150 The 'OemPipe'/'oem5' key, either at the lower left of the 'return' key for ISO or between 'return' and 'backspace' for ANSI on a standard US layout. Oem6 = 151 The 'OemCloseBrackets'/'oem6' key, second key to the right of 'P' on a standard US layout. Oem7 = 152 The 'OemQuotes'/'oem7' key, second key to the right of 'L' on a standard US layout. Oem8 = 153 The 'oem8' key, on a UK layout the left most key on the number row, same position as OemTilde on US layout. OemBackslash = 154 The 'OemBackSlash'/'oem102' key, on US ISO keyboards this key sits between left shift and 'Z'. OemClear = 171 The 'oemclear' key. OemCloseBrackets = 151 The 'OemCloseBrackets'/'oem6' key, second key to the right of 'P' on a standard US layout. OemComma = 142 The 'oemcomma' key, to the right of the 'M' key on a standard US layout. OemMinus = 143 The 'oemminus' key, to the right of the number row '0' key on a standard US layout. OemOpenBrackets = 149 The 'OemOpenBrackets'/'oem4' key, to the right of 'P' on a standard US layout. OemPeriod = 144 The 'oemperiod' key, right between 'M' and the right shift key on a standard US layout. OemPipe = 150 The 'OemPipe'/'oem5' key, either at the lower left of the 'return' key for ISO or between 'return' and 'backspace' for ANSI on a standard US layout. OemPlus = 141 The 'oemplus'/'Equals' key, to the left of the backspace key on a standard US layout. OemQuestion = 145 The 'oemquestion'/'oem2' key, next to 'right shift' on a standard US layout. OemQuotes = 152 The 'OemQuotes'/'oem7' key, second key to the right of 'L' on a standard US layout. OemSemicolon = 140 The 'oem1'/'semicolon' key, to the right of the 'L' key on a standard US layout. OemTilde = 146 The 'oemtilde'/'oem3' key, above 'tab' on a standard US layout. P = 59 The 'p' key. Pa1 = 170 The 'PA1' or 'Program Action'/'Program Attention' 1 key on a 3270 IBM keyboard. PageDown = 20 The 'pagedown'/'next' key. PageUp = 19 The 'pageup'/'prior' key. Pause = 7 The 'pause' key. Play = 167 The 'play' key. Print = 28 The 'print' key, not to be confused with PrintScreen. PrintScreen = 30 The 'snapshot'/'printscreen' key. Prior = 19 The 'pageup'/'prior' key. Q = 60 The 'q' key. R = 61 The 'r' key. Return = 6 The 'enter'/'return' key. Right = 25 The 'right' key. RightAlt = 121 The right 'alt' key. RightCtrl = 119 The right 'ctrl' key. RightShift = 117 The right 'shift' key. RightWin = 71 The right 'windows'/'command'/'meta' key. S = 62 The 's' key. Scroll = 115 The 'scroll'/'scroll lock' key. Select = 27 The 'select' key. SelectMedia = 137 The 'selectmedia' key. Separator = 86 The 'separator' key. Sleep = 73 The 'sleep' key. Snapshot = 30 The 'snapshot'/'printscreen' key Space = 18 The 'space' key. Subtract = 87 The numeric keypad 'subtract' key. T = 63 The 't' key. Tab = 3 The 'tab' key. U = 64 The 'u' key. Up = 24 The 'up' key. V = 65 The 'v' key. VolumeDown = 130 The 'volumedown' key. VolumeMute = 129 The 'volumemute' key. VolumeUp = 131 The 'volumeup' key. W = 66 The 'w' key. X = 67 The 'x' key. Y = 68 The 'y' key. Z = 69 The 'z' key. Zoom = 168 The 'zoom' key."
  },
  "api/Stride.Input.MouseAxis.html": {
    "href": "api/Stride.Input.MouseAxis.html",
    "title": "Enum MouseAxis | Stride API",
    "summary": "Enum MouseAxis Namespace Stride.Input Assembly Stride.Input.dll Mouse axes public enum MouseAxis Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Wheel = 2 The scroll wheel X = 0 The horizontal mouse movement Y = 1 The vertical mouse movement"
  },
  "api/Stride.Input.MouseButton.html": {
    "href": "api/Stride.Input.MouseButton.html",
    "title": "Enum MouseButton | Stride API",
    "summary": "Enum MouseButton Namespace Stride.Input Assembly Stride.Input.dll Mouse buttons. public enum MouseButton Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Extended1 = 3 Extended button 1. Extended2 = 4 Extended button 2. Left = 0 Left button. Middle = 1 Middle button. Right = 2 Right button."
  },
  "api/Stride.Input.MouseButtonEvent.html": {
    "href": "api/Stride.Input.MouseButtonEvent.html",
    "title": "Class MouseButtonEvent | Stride API",
    "summary": "Class MouseButtonEvent Namespace Stride.Input Assembly Stride.Input.dll Describes a button on a mouse changing state public class MouseButtonEvent : ButtonEvent, IInputEventArgs Inheritance object InputEvent ButtonEvent MouseButtonEvent Implements IInputEventArgs Inherited Members ButtonEvent.IsDown InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields Button The button that changed state public MouseButton Button Field Value MouseButton Properties Mouse The mouse that sent this event public IMouseDevice Mouse { get; } Property Value IMouseDevice Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.MouseDeviceBase.html": {
    "href": "api/Stride.Input.MouseDeviceBase.html",
    "title": "Class MouseDeviceBase | Stride API",
    "summary": "Class MouseDeviceBase Namespace Stride.Input Assembly Stride.Input.dll Base class for mouse devices, implements some common functionality of IMouseDevice, inherits from PointerDeviceBase public abstract class MouseDeviceBase : PointerDeviceBase, IMouseDevice, IPointerDevice, IInputDevice Inheritance object PointerDeviceBase MouseDeviceBase Implements IMouseDevice IPointerDevice IInputDevice Derived MouseSimulated Inherited Members PointerDeviceBase.PointerState PointerDeviceBase.SurfaceSize PointerDeviceBase.SurfaceAspectRatio PointerDeviceBase.PressedPointers PointerDeviceBase.ReleasedPointers PointerDeviceBase.DownPointers PointerDeviceBase.SurfaceSizeChanged PointerDeviceBase.Priority PointerDeviceBase.Name PointerDeviceBase.Id PointerDeviceBase.Source PointerDeviceBase.SetSurfaceSize(Vector2) PointerDeviceBase.Normalize(Vector2) PointerDeviceBase.GetFingerId(long, long, PointerEventType) Extension Methods MouseDeviceExtensions.IsButtonDown(IMouseDevice, MouseButton) MouseDeviceExtensions.IsButtonPressed(IMouseDevice, MouseButton) MouseDeviceExtensions.IsButtonReleased(IMouseDevice, MouseButton) UnsafeUtilities.As<T>(object?) Constructors MouseDeviceBase() protected MouseDeviceBase() Fields MouseState protected MouseDeviceState MouseState Field Value MouseDeviceState Properties Delta Mouse delta public Vector2 Delta { get; } Property Value Vector2 DownButtons The mouse buttons that are down public IReadOnlySet<MouseButton> DownButtons { get; } Property Value IReadOnlySet<MouseButton> IsPositionLocked Gets or sets if the mouse is locked to the screen public abstract bool IsPositionLocked { get; } Property Value bool Position Normalized position of the mouse inside the window public Vector2 Position { get; } Property Value Vector2 PressedButtons The mouse buttons that have been pressed since the last frame public IReadOnlySet<MouseButton> PressedButtons { get; } Property Value IReadOnlySet<MouseButton> ReleasedButtons The mouse buttons that have been released since the last frame public IReadOnlySet<MouseButton> ReleasedButtons { get; } Property Value IReadOnlySet<MouseButton> Methods LockPosition(bool) Locks the mouse position to the screen public abstract void LockPosition(bool forceCenter = false) Parameters forceCenter bool Force the mouse position to the center of the screen SetPosition(Vector2) Attempts to set the pointer position, this only makes sense for mouse pointers public abstract void SetPosition(Vector2 normalizedPosition) Parameters normalizedPosition Vector2 UnlockPosition() Unlocks the mouse position if it was locked public abstract void UnlockPosition() Update(List<InputEvent>) Updates the input device, filling the list inputEvents with input events that were generated by this device this frame public override void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent> A list that gets filled with input events that were generated since the last frame Remarks Input devices are always updated after their respective input source"
  },
  "api/Stride.Input.MouseDeviceExtensions.html": {
    "href": "api/Stride.Input.MouseDeviceExtensions.html",
    "title": "Class MouseDeviceExtensions | Stride API",
    "summary": "Class MouseDeviceExtensions Namespace Stride.Input Assembly Stride.Input.dll public static class MouseDeviceExtensions Inheritance object MouseDeviceExtensions Methods IsButtonDown(IMouseDevice, MouseButton) Determines whether the specified button is being pressed down public static bool IsButtonDown(this IMouseDevice mouseDevice, MouseButton mouseButton) Parameters mouseDevice IMouseDevice The mnouse mouseButton MouseButton The mouse button Returns bool true if the specified button is being pressed down; otherwise, false. IsButtonPressed(IMouseDevice, MouseButton) Determines whether the specified mouse button is pressed since the previous update. public static bool IsButtonPressed(this IMouseDevice mouseDevice, MouseButton mouseButton) Parameters mouseDevice IMouseDevice The mnouse mouseButton MouseButton The mouse button Returns bool true if the specified mouse button is pressed since the previous update; otherwise, false. IsButtonReleased(IMouseDevice, MouseButton) Determines whether the specified mouse button is released. public static bool IsButtonReleased(this IMouseDevice mouseDevice, MouseButton mouseButton) Parameters mouseDevice IMouseDevice The mnouse mouseButton MouseButton The mouse button Returns bool true if the specified mouse button is released; otherwise, false."
  },
  "api/Stride.Input.MouseDeviceState.html": {
    "href": "api/Stride.Input.MouseDeviceState.html",
    "title": "Class MouseDeviceState | Stride API",
    "summary": "Class MouseDeviceState Namespace Stride.Input Assembly Stride.Input.dll An extension to PointerDeviceState that handle mouse input and translates it to pointer input public class MouseDeviceState Inheritance object MouseDeviceState Extension Methods UnsafeUtilities.As<T>(object?) Constructors MouseDeviceState(PointerDeviceState, IMouseDevice) public MouseDeviceState(PointerDeviceState pointerState, IMouseDevice mouseDevice) Parameters pointerState PointerDeviceState mouseDevice IMouseDevice Fields Events protected readonly List<InputEvent> Events Field Value List<InputEvent> MouseDevice protected IMouseDevice MouseDevice Field Value IMouseDevice PointerState protected PointerDeviceState PointerState Field Value PointerDeviceState Properties Delta public Vector2 Delta { get; set; } Property Value Vector2 DownButtons public IReadOnlySet<MouseButton> DownButtons { get; } Property Value IReadOnlySet<MouseButton> Position public Vector2 Position { get; set; } Property Value Vector2 PressedButtons public IReadOnlySet<MouseButton> PressedButtons { get; } Property Value IReadOnlySet<MouseButton> ReleasedButtons public IReadOnlySet<MouseButton> ReleasedButtons { get; } Property Value IReadOnlySet<MouseButton> Methods HandleButtonDown(MouseButton) public void HandleButtonDown(MouseButton button) Parameters button MouseButton HandleButtonUp(MouseButton) public void HandleButtonUp(MouseButton button) Parameters button MouseButton HandleMouseDelta(Vector2) Special move that generates pointer events with just delta public void HandleMouseDelta(Vector2 delta) Parameters delta Vector2 The movement delta HandleMouseWheel(float) public void HandleMouseWheel(float wheelDelta) Parameters wheelDelta float HandleMove(Vector2) Handles a single pointer move public void HandleMove(Vector2 newPosition) Parameters newPosition Vector2 New position of the pointer HandlePointerDown() Handles a single pointer down public void HandlePointerDown() HandlePointerUp() Handles a single pointer up public void HandlePointerUp() Update(List<InputEvent>) Generate input events public void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent>"
  },
  "api/Stride.Input.MouseSimulated.html": {
    "href": "api/Stride.Input.MouseSimulated.html",
    "title": "Class MouseSimulated | Stride API",
    "summary": "Class MouseSimulated Namespace Stride.Input Assembly Stride.Input.dll public class MouseSimulated : MouseDeviceBase, IMouseDevice, IPointerDevice, IInputDevice Inheritance object PointerDeviceBase MouseDeviceBase MouseSimulated Implements IMouseDevice IPointerDevice IInputDevice Inherited Members MouseDeviceBase.PressedButtons MouseDeviceBase.ReleasedButtons MouseDeviceBase.DownButtons MouseDeviceBase.Position MouseDeviceBase.Delta PointerDeviceBase.SurfaceSize PointerDeviceBase.SurfaceAspectRatio PointerDeviceBase.PressedPointers PointerDeviceBase.ReleasedPointers PointerDeviceBase.DownPointers PointerDeviceBase.SurfaceSizeChanged PointerDeviceBase.Priority PointerDeviceBase.SetSurfaceSize(Vector2) PointerDeviceBase.Normalize(Vector2) PointerDeviceBase.GetFingerId(long, long, PointerEventType) Extension Methods MouseDeviceExtensions.IsButtonDown(IMouseDevice, MouseButton) MouseDeviceExtensions.IsButtonPressed(IMouseDevice, MouseButton) MouseDeviceExtensions.IsButtonReleased(IMouseDevice, MouseButton) UnsafeUtilities.As<T>(object?) Constructors MouseSimulated(InputSourceSimulated) public MouseSimulated(InputSourceSimulated source) Parameters source InputSourceSimulated Properties Id The unique identifier of this device public override Guid Id { get; } Property Value Guid IsPositionLocked Gets or sets if the mouse is locked to the screen public override bool IsPositionLocked { get; } Property Value bool MouseState public MouseDeviceState MouseState { get; } Property Value MouseDeviceState Name The name of the device public override string Name { get; } Property Value string PointerState public PointerDeviceState PointerState { get; } Property Value PointerDeviceState Source The input source the device belongs to. public override IInputSource Source { get; } Property Value IInputSource Methods LockPosition(bool) Locks the mouse position to the screen public override void LockPosition(bool forceCenter = false) Parameters forceCenter bool Force the mouse position to the center of the screen SetPosition(Vector2) Attempts to set the pointer position, this only makes sense for mouse pointers public override void SetPosition(Vector2 position) Parameters position Vector2 SimulateMouseDown(MouseButton) public void SimulateMouseDown(MouseButton button) Parameters button MouseButton SimulateMouseUp(MouseButton) public void SimulateMouseUp(MouseButton button) Parameters button MouseButton SimulateMouseWheel(float) public void SimulateMouseWheel(float wheelDelta) Parameters wheelDelta float SimulatePointer(PointerEventType, Vector2, int) public void SimulatePointer(PointerEventType pointerEventType, Vector2 position, int id = 0) Parameters pointerEventType PointerEventType position Vector2 id int UnlockPosition() Unlocks the mouse position if it was locked public override void UnlockPosition() Update(List<InputEvent>) Updates the input device, filling the list inputEvents with input events that were generated by this device this frame public override void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent> A list that gets filled with input events that were generated since the last frame Remarks Input devices are always updated after their respective input source"
  },
  "api/Stride.Input.MouseWheelEvent.html": {
    "href": "api/Stride.Input.MouseWheelEvent.html",
    "title": "Class MouseWheelEvent | Stride API",
    "summary": "Class MouseWheelEvent Namespace Stride.Input Assembly Stride.Input.dll Event for a mouse wheel being used public class MouseWheelEvent : InputEvent, IInputEventArgs Inheritance object InputEvent MouseWheelEvent Implements IInputEventArgs Inherited Members InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields WheelDelta The amount the mouse wheel scrolled public float WheelDelta Field Value float Properties Mouse The mouse that sent this event public IMouseDevice Mouse { get; } Property Value IMouseDevice Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.PointerDeviceBase.html": {
    "href": "api/Stride.Input.PointerDeviceBase.html",
    "title": "Class PointerDeviceBase | Stride API",
    "summary": "Class PointerDeviceBase Namespace Stride.Input Assembly Stride.Input.dll Base class for pointer devices public abstract class PointerDeviceBase : IPointerDevice, IInputDevice Inheritance object PointerDeviceBase Implements IPointerDevice IInputDevice Derived MouseDeviceBase PointerSimulated Extension Methods UnsafeUtilities.As<T>(object?) Constructors PointerDeviceBase() protected PointerDeviceBase() Fields PointerState protected PointerDeviceState PointerState Field Value PointerDeviceState Properties DownPointers The index of the pointers that are down public IReadOnlySet<PointerPoint> DownPointers { get; } Property Value IReadOnlySet<PointerPoint> Id The unique identifier of this device public abstract Guid Id { get; } Property Value Guid Name The name of the device public abstract string Name { get; } Property Value string PressedPointers The index of the pointers that have been pressed since the last frame public IReadOnlySet<PointerPoint> PressedPointers { get; } Property Value IReadOnlySet<PointerPoint> Priority The device priority. Larger means higher priority when selecting the first device of some type public int Priority { get; set; } Property Value int ReleasedPointers The index of the pointers that have been released since the last frame public IReadOnlySet<PointerPoint> ReleasedPointers { get; } Property Value IReadOnlySet<PointerPoint> Source The input source the device belongs to. public abstract IInputSource Source { get; } Property Value IInputSource SurfaceAspectRatio The aspect ratio of the touch surface area public float SurfaceAspectRatio { get; } Property Value float SurfaceSize The size of the surface used by the pointer, for a mouse this is the size of the window, for a touch device, the size of the touch area, etc. public Vector2 SurfaceSize { get; } Property Value Vector2 Methods GetFingerId(long, long, PointerEventType) protected int GetFingerId(long touchId, long fingerId, PointerEventType type) Parameters touchId long fingerId long type PointerEventType Returns int Normalize(Vector2) protected Vector2 Normalize(Vector2 position) Parameters position Vector2 Returns Vector2 SetSurfaceSize(Vector2) Calls SetSurfaceSize(Vector2) and invokes the SurfaceSizeChanged event protected void SetSurfaceSize(Vector2 newSize) Parameters newSize Vector2 New size of the surface Update(List<InputEvent>) Updates the input device, filling the list inputEvents with input events that were generated by this device this frame public virtual void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent> A list that gets filled with input events that were generated since the last frame Remarks Input devices are always updated after their respective input source Events SurfaceSizeChanged Raised when the surface size of this pointer changed public event EventHandler<SurfaceSizeChangedEventArgs> SurfaceSizeChanged Event Type EventHandler<SurfaceSizeChangedEventArgs>"
  },
  "api/Stride.Input.PointerDeviceState.InputEvent.html": {
    "href": "api/Stride.Input.PointerDeviceState.InputEvent.html",
    "title": "Struct PointerDeviceState.InputEvent | Stride API",
    "summary": "Struct PointerDeviceState.InputEvent Namespace Stride.Input Assembly Stride.Input.dll Simplified event data used to generate the full events when Update(List<InputEvent>) gets called public struct PointerDeviceState.InputEvent Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Delta public Vector2 Delta Field Value Vector2 Id public int Id Field Value int Position public Vector2 Position Field Value Vector2 Type public PointerEventType Type Field Value PointerEventType"
  },
  "api/Stride.Input.PointerDeviceState.PointerData.html": {
    "href": "api/Stride.Input.PointerDeviceState.PointerData.html",
    "title": "Class PointerDeviceState.PointerData | Stride API",
    "summary": "Class PointerDeviceState.PointerData Namespace Stride.Input Assembly Stride.Input.dll Some additional data kept on top of PointerPoint for the purpose of generating PointerEvent public class PointerDeviceState.PointerData : PointerPoint Inheritance object PointerPoint PointerDeviceState.PointerData Inherited Members PointerPoint.Position PointerPoint.Delta PointerPoint.IsDown PointerPoint.Id PointerPoint.Pointer PointerPoint.ToString() Extension Methods UnsafeUtilities.As<T>(object?) Fields Clock public Stopwatch Clock Field Value Stopwatch"
  },
  "api/Stride.Input.PointerDeviceState.html": {
    "href": "api/Stride.Input.PointerDeviceState.html",
    "title": "Class PointerDeviceState | Stride API",
    "summary": "Class PointerDeviceState Namespace Stride.Input Assembly Stride.Input.dll Contains logic to generate pointer events and store the resulting state public class PointerDeviceState Inheritance object PointerDeviceState Extension Methods UnsafeUtilities.As<T>(object?) Constructors PointerDeviceState(IPointerDevice) public PointerDeviceState(IPointerDevice pointerDevice) Parameters pointerDevice IPointerDevice Fields PointerDatas public readonly List<PointerDeviceState.PointerData> PointerDatas Field Value List<PointerDeviceState.PointerData> PointerInputEvents public readonly List<PointerDeviceState.InputEvent> PointerInputEvents Field Value List<PointerDeviceState.InputEvent> SourceDevice public IPointerDevice SourceDevice Field Value IPointerDevice Properties DownPointers public IReadOnlySet<PointerPoint> DownPointers { get; } Property Value IReadOnlySet<PointerPoint> InverseSurfaceSize public Vector2 InverseSurfaceSize { get; } Property Value Vector2 PressedPointers public IReadOnlySet<PointerPoint> PressedPointers { get; } Property Value IReadOnlySet<PointerPoint> ReleasedPointers public IReadOnlySet<PointerPoint> ReleasedPointers { get; } Property Value IReadOnlySet<PointerPoint> SurfaceAspectRatio public float SurfaceAspectRatio { get; } Property Value float SurfaceSize public Vector2 SurfaceSize { get; } Property Value Vector2 Methods GetPointerData(int) Retrieves a pointer data structure unique to the given pointer ID public PointerDeviceState.PointerData GetPointerData(int pointerId) Parameters pointerId int Returns PointerDeviceState.PointerData ProcessPointerEvent(InputEvent) Processes a PointerDeviceState.InputEvent, converting it to a PointerEvent. Also calls UpdatePointerState(PointerEvent, bool) and updates current PointerEvent public PointerEvent ProcessPointerEvent(PointerDeviceState.InputEvent evt) Parameters evt PointerDeviceState.InputEvent Returns PointerEvent SetSurfaceSize(Vector2) Updates the surface size of the pointing device, updates SurfaceSize, SurfaceAspectRatio, InverseSurfaceSize and calls SurfaceSizeChanged public void SetSurfaceSize(Vector2 newSize) Parameters newSize Vector2 New size of the surface Update(List<InputEvent>) Generate input events public void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent> UpdatePointerState(PointerEvent, bool) Updates a pointer event with position / type / id set and updates the stored pointer data public void UpdatePointerState(PointerEvent evt, bool updateDelta = true) Parameters evt PointerEvent updateDelta bool"
  },
  "api/Stride.Input.PointerEvent.html": {
    "href": "api/Stride.Input.PointerEvent.html",
    "title": "Class PointerEvent | Stride API",
    "summary": "Class PointerEvent Namespace Stride.Input Assembly Stride.Input.dll A pointer event. public class PointerEvent : InputEvent, IInputEventArgs Inheritance object InputEvent PointerEvent Implements IInputEventArgs Inherited Members InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Properties AbsoluteDeltaPosition Gets the absolute delta position of the pointer since the previous frame. public Vector2 AbsoluteDeltaPosition { get; } Property Value Vector2 The absolute delta position. AbsolutePosition Gets the absolute screen position of the pointer. public Vector2 AbsolutePosition { get; } Property Value Vector2 The absolute delta position. DeltaPosition Gets the delta position of the pointer since the previous frame. public Vector2 DeltaPosition { get; } Property Value Vector2 The delta position. DeltaTime Gets the amount of time since the previous state. public TimeSpan DeltaTime { get; } Property Value TimeSpan The delta time. EventType Gets the type of pointer event (pressed,released,etc.) public PointerEventType EventType { get; } Property Value PointerEventType The state. IsDown Gets if the pointer is down, useful for filtering out move events that are not placed between drags public bool IsDown { get; } Property Value bool Pointer The pointer that sent this event public IPointerDevice Pointer { get; } Property Value IPointerDevice PointerId Gets a unique identifier of the pointer. See remarks. public int PointerId { get; } Property Value int The pointer id. Remarks The default mouse pointer will always be affected to the PointerId 0. On a tablet, a pen or each fingers will get a unique identifier. Position Gets the normalized screen position of the pointer. public Vector2 Position { get; } Property Value Vector2 The position. Methods Clone() Clones the pointer event, this is useful if you intend to use it after this frame, since otherwise it would be recycled by the input manager the next frame public PointerEvent Clone() Returns PointerEvent The cloned event ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.PointerEventType.html": {
    "href": "api/Stride.Input.PointerEventType.html",
    "title": "Enum PointerEventType | Stride API",
    "summary": "Enum PointerEventType Namespace Stride.Input Assembly Stride.Input.dll State of a pointer event. public enum PointerEventType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Canceled = 3 The pointer has been canceled. Moved = 1 The pointer is moving on the digitizer. Pressed = 0 The pointer just started to hit the digitizer. Released = 2 The pointer just released pressure to the digitizer."
  },
  "api/Stride.Input.PointerPoint.html": {
    "href": "api/Stride.Input.PointerPoint.html",
    "title": "Class PointerPoint | Stride API",
    "summary": "Class PointerPoint Namespace Stride.Input Assembly Stride.Input.dll Represents a unique pointer that is or was on the screen and information about it public class PointerPoint Inheritance object PointerPoint Derived PointerDeviceState.PointerData Extension Methods UnsafeUtilities.As<T>(object?) Fields Delta Pointer delta public Vector2 Delta Field Value Vector2 Id The pointer ID, from the device public int Id Field Value int IsDown Is the pointer currently down public bool IsDown Field Value bool Pointer The device to which this pointer belongs public IPointerDevice Pointer Field Value IPointerDevice Position Last position of the pointer public Vector2 Position Field Value Vector2 Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.PointerSimulated.html": {
    "href": "api/Stride.Input.PointerSimulated.html",
    "title": "Class PointerSimulated | Stride API",
    "summary": "Class PointerSimulated Namespace Stride.Input Assembly Stride.Input.dll Simulation of PointerEvents public class PointerSimulated : PointerDeviceBase, IPointerDevice, IInputDevice Inheritance object PointerDeviceBase PointerSimulated Implements IPointerDevice IInputDevice Inherited Members PointerDeviceBase.SurfaceSize PointerDeviceBase.SurfaceAspectRatio PointerDeviceBase.PressedPointers PointerDeviceBase.ReleasedPointers PointerDeviceBase.DownPointers PointerDeviceBase.SurfaceSizeChanged PointerDeviceBase.Priority PointerDeviceBase.SetSurfaceSize(Vector2) PointerDeviceBase.Normalize(Vector2) PointerDeviceBase.GetFingerId(long, long, PointerEventType) Extension Methods UnsafeUtilities.As<T>(object?) Constructors PointerSimulated(InputSourceSimulated) public PointerSimulated(InputSourceSimulated source) Parameters source InputSourceSimulated Properties Id The unique identifier of this device public override Guid Id { get; } Property Value Guid Name The name of the device public override string Name { get; } Property Value string PointerState public PointerDeviceState PointerState { get; } Property Value PointerDeviceState Source The input source the device belongs to. public override IInputSource Source { get; } Property Value IInputSource Methods CancelPointer(Vector2, int) public void CancelPointer(Vector2 position, int id = 0) Parameters position Vector2 id int MovePointer(Vector2, int) public void MovePointer(Vector2 position, int id = 0) Parameters position Vector2 id int PressPointer(Vector2, int) public void PressPointer(Vector2 position, int id = 0) Parameters position Vector2 id int ReleasePointer(Vector2, int) public void ReleasePointer(Vector2 position, int id = 0) Parameters position Vector2 id int SimulatePointer(PointerEventType, Vector2, int) public void SimulatePointer(PointerEventType pointerEventType, Vector2 position, int id = 0) Parameters pointerEventType PointerEventType position Vector2 id int Update(List<InputEvent>) Updates the input device, filling the list inputEvents with input events that were generated by this device this frame public override void Update(List<InputEvent> inputEvents) Parameters inputEvents List<InputEvent> A list that gets filled with input events that were generated since the last frame Remarks Input devices are always updated after their respective input source"
  },
  "api/Stride.Input.SurfaceSizeChangedEventArgs.html": {
    "href": "api/Stride.Input.SurfaceSizeChangedEventArgs.html",
    "title": "Class SurfaceSizeChangedEventArgs | Stride API",
    "summary": "Class SurfaceSizeChangedEventArgs Namespace Stride.Input Assembly Stride.Input.dll An event for when the size of a pointer surface changed public class SurfaceSizeChangedEventArgs : EventArgs Inheritance object EventArgs SurfaceSizeChangedEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Fields NewSurfaceSize The new size of the surface public Vector2 NewSurfaceSize Field Value Vector2"
  },
  "api/Stride.Input.TextInputEvent.html": {
    "href": "api/Stride.Input.TextInputEvent.html",
    "title": "Class TextInputEvent | Stride API",
    "summary": "Class TextInputEvent Namespace Stride.Input Assembly Stride.Input.dll Input event used for text input and IME related events public class TextInputEvent : InputEvent, IInputEventArgs Inheritance object InputEvent TextInputEvent Implements IInputEventArgs Inherited Members InputEvent.Device Extension Methods UnsafeUtilities.As<T>(object?) Fields CompositionLength Length of the current part of the composition being edited public int CompositionLength Field Value int CompositionStart Start of the current composition being edited public int CompositionStart Field Value int Text The text that was entered public string Text Field Value string Type The type of text input event public TextInputEventType Type Field Value TextInputEventType Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.TextInputEventType.html": {
    "href": "api/Stride.Input.TextInputEventType.html",
    "title": "Enum TextInputEventType | Stride API",
    "summary": "Enum TextInputEventType Namespace Stride.Input Assembly Stride.Input.dll public enum TextInputEventType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Composition = 1 This the current text that has not yet been entered but is still being edited Input = 0 When new text is entered"
  },
  "api/Stride.Input.VirtualButton.GamePad.html": {
    "href": "api/Stride.Input.VirtualButton.GamePad.html",
    "title": "Class VirtualButton.GamePad | Stride API",
    "summary": "Class VirtualButton.GamePad Namespace Stride.Input Assembly Stride.Input.dll GamePad virtual button. public class VirtualButton.GamePad : VirtualButton, IVirtualButton Inheritance object VirtualButton VirtualButton.GamePad Implements IVirtualButton Inherited Members VirtualButton.Id VirtualButton.Name VirtualButton.ShortName VirtualButton.Type VirtualButton.IsPositiveAndNegative VirtualButton.Index VirtualButton.ToString() VirtualButton.Registered VirtualButton.Find(string) VirtualButton.Find(int) Extension Methods UnsafeUtilities.As<T>(object?) Constructors GamePad(string, int, int, bool) protected GamePad(string name, int id, int padIndex, bool isPositiveAndNegative) Parameters name string id int padIndex int isPositiveAndNegative bool Fields A Equivalent to A. public static readonly VirtualButton.GamePad A Field Value VirtualButton.GamePad B Equivalent to B. public static readonly VirtualButton.GamePad B Field Value VirtualButton.GamePad Back Equivalent to Back. public static readonly VirtualButton.GamePad Back Field Value VirtualButton.GamePad LeftShoulder Equivalent to LeftShoulder. public static readonly VirtualButton.GamePad LeftShoulder Field Value VirtualButton.GamePad LeftThumb Equivalent to LeftThumb. public static readonly VirtualButton.GamePad LeftThumb Field Value VirtualButton.GamePad LeftThumbAxisX Equivalent to the X Axis of LeftThumb. public static readonly VirtualButton.GamePad LeftThumbAxisX Field Value VirtualButton.GamePad LeftThumbAxisY Equivalent to the Y Axis of LeftThumb. public static readonly VirtualButton.GamePad LeftThumbAxisY Field Value VirtualButton.GamePad LeftTrigger Equivalent to LeftTrigger. public static readonly VirtualButton.GamePad LeftTrigger Field Value VirtualButton.GamePad PadDown Equivalent to PadDown. public static readonly VirtualButton.GamePad PadDown Field Value VirtualButton.GamePad PadIndex The pad index. public readonly int PadIndex Field Value int PadLeft Equivalent to PadLeft. public static readonly VirtualButton.GamePad PadLeft Field Value VirtualButton.GamePad PadRight Equivalent to PadRight. public static readonly VirtualButton.GamePad PadRight Field Value VirtualButton.GamePad PadUp Equivalent to PadUp. public static readonly VirtualButton.GamePad PadUp Field Value VirtualButton.GamePad RightShoulder Equivalent to RightShoulder. public static readonly VirtualButton.GamePad RightShoulder Field Value VirtualButton.GamePad RightThumb Equivalent to RightThumb. public static readonly VirtualButton.GamePad RightThumb Field Value VirtualButton.GamePad RightThumbAxisX Equivalent to the X Axis of RightThumb. public static readonly VirtualButton.GamePad RightThumbAxisX Field Value VirtualButton.GamePad RightThumbAxisY Equivalent to the Y Axis of RightThumb. public static readonly VirtualButton.GamePad RightThumbAxisY Field Value VirtualButton.GamePad RightTrigger Equivalent to RightTrigger. public static readonly VirtualButton.GamePad RightTrigger Field Value VirtualButton.GamePad Start Equivalent to Start. public static readonly VirtualButton.GamePad Start Field Value VirtualButton.GamePad X Equivalent to X. public static readonly VirtualButton.GamePad X Field Value VirtualButton.GamePad Y Equivalent to Y. public static readonly VirtualButton.GamePad Y Field Value VirtualButton.GamePad Methods BuildButtonName() protected override string BuildButtonName() Returns string GetValue(InputManager) Gets the value associated with this virtual button from an input manager. public override float GetValue(InputManager manager) Parameters manager InputManager The manager. Returns float System.Single. IsDown(InputManager) Indicate if the button is currently down public override bool IsDown(InputManager manager) Parameters manager InputManager The input manager Returns bool IsPressed(InputManager) Indicate if the button has been pressed since the last frame public override bool IsPressed(InputManager manager) Parameters manager InputManager The input manager Returns bool IsReleased(InputManager) Indicate if the button has been released since the last frame public override bool IsReleased(InputManager manager) Parameters manager InputManager The input manager Returns bool OfGamePad(int) Return an instance of a particular GamePad. public VirtualButton.GamePad OfGamePad(int index) Parameters index int The gamepad index. Returns VirtualButton.GamePad A new GamePad button linked to the gamepad index."
  },
  "api/Stride.Input.VirtualButton.Keyboard.html": {
    "href": "api/Stride.Input.VirtualButton.Keyboard.html",
    "title": "Class VirtualButton.Keyboard | Stride API",
    "summary": "Class VirtualButton.Keyboard Namespace Stride.Input Assembly Stride.Input.dll Keyboard virtual button. public class VirtualButton.Keyboard : VirtualButton, IVirtualButton Inheritance object VirtualButton VirtualButton.Keyboard Implements IVirtualButton Inherited Members VirtualButton.Id VirtualButton.Name VirtualButton.ShortName VirtualButton.Type VirtualButton.IsPositiveAndNegative VirtualButton.Index VirtualButton.ToString() VirtualButton.Registered VirtualButton.Find(string) VirtualButton.Find(int) VirtualButton.BuildButtonName() Extension Methods UnsafeUtilities.As<T>(object?) Constructors Keyboard(string, int, bool) protected Keyboard(string name, int id, bool isPositiveAndNegative = false) Parameters name string id int isPositiveAndNegative bool Fields A The 'a' key. public static readonly VirtualButton A Field Value VirtualButton Add The 'add' key. public static readonly VirtualButton Add Field Value VirtualButton Apps The 'apps' key. public static readonly VirtualButton Apps Field Value VirtualButton Attn The 'attn' key. public static readonly VirtualButton Attn Field Value VirtualButton B The 'b' key. public static readonly VirtualButton B Field Value VirtualButton Back The 'back' key. public static readonly VirtualButton Back Field Value VirtualButton BrowserBack The 'browserback' key. public static readonly VirtualButton BrowserBack Field Value VirtualButton BrowserFavorites The 'browserfavorites' key. public static readonly VirtualButton BrowserFavorites Field Value VirtualButton BrowserForward The 'browserforward' key. public static readonly VirtualButton BrowserForward Field Value VirtualButton BrowserHome The 'browserhome' key. public static readonly VirtualButton BrowserHome Field Value VirtualButton BrowserRefresh The 'browserrefresh' key. public static readonly VirtualButton BrowserRefresh Field Value VirtualButton BrowserSearch The 'browsersearch' key. public static readonly VirtualButton BrowserSearch Field Value VirtualButton BrowserStop The 'browserstop' key. public static readonly VirtualButton BrowserStop Field Value VirtualButton C The 'c' key. public static readonly VirtualButton C Field Value VirtualButton Cancel The 'cancel' key. public static readonly VirtualButton Cancel Field Value VirtualButton Capital The 'capital' key. public static readonly VirtualButton Capital Field Value VirtualButton CapsLock The 'capslock' key. public static readonly VirtualButton CapsLock Field Value VirtualButton Clear The 'clear' key. public static readonly VirtualButton Clear Field Value VirtualButton CrSel The 'crsel' key. public static readonly VirtualButton CrSel Field Value VirtualButton D The 'd' key. public static readonly VirtualButton D Field Value VirtualButton D0 The 'd0' key. public static readonly VirtualButton D0 Field Value VirtualButton D1 The 'd1' key. public static readonly VirtualButton D1 Field Value VirtualButton D2 The 'd2' key. public static readonly VirtualButton D2 Field Value VirtualButton D3 The 'd3' key. public static readonly VirtualButton D3 Field Value VirtualButton D4 The 'd4' key. public static readonly VirtualButton D4 Field Value VirtualButton D5 The 'd5' key. public static readonly VirtualButton D5 Field Value VirtualButton D6 The 'd6' key. public static readonly VirtualButton D6 Field Value VirtualButton D7 The 'd7' key. public static readonly VirtualButton D7 Field Value VirtualButton D8 The 'd8' key. public static readonly VirtualButton D8 Field Value VirtualButton D9 The 'd9' key. public static readonly VirtualButton D9 Field Value VirtualButton Decimal The 'decimal' key. public static readonly VirtualButton Decimal Field Value VirtualButton Delete The 'delete' key. public static readonly VirtualButton Delete Field Value VirtualButton Divide The 'divide' key. public static readonly VirtualButton Divide Field Value VirtualButton Down The 'down' key. public static readonly VirtualButton Down Field Value VirtualButton E The 'e' key. public static readonly VirtualButton E Field Value VirtualButton End The 'end' key. public static readonly VirtualButton End Field Value VirtualButton Enter The 'enter' key. public static readonly VirtualButton Enter Field Value VirtualButton EraseEof The 'eraseeof' key. public static readonly VirtualButton EraseEof Field Value VirtualButton Escape The 'escape' key. public static readonly VirtualButton Escape Field Value VirtualButton ExSel The 'exsel' key. public static readonly VirtualButton ExSel Field Value VirtualButton Execute The 'execute' key. public static readonly VirtualButton Execute Field Value VirtualButton F The 'f' key. public static readonly VirtualButton F Field Value VirtualButton F1 The 'f1' key. public static readonly VirtualButton F1 Field Value VirtualButton F10 The 'f10' key. public static readonly VirtualButton F10 Field Value VirtualButton F11 The 'f11' key. public static readonly VirtualButton F11 Field Value VirtualButton F12 The 'f12' key. public static readonly VirtualButton F12 Field Value VirtualButton F13 The 'f13' key. public static readonly VirtualButton F13 Field Value VirtualButton F14 The 'f14' key. public static readonly VirtualButton F14 Field Value VirtualButton F15 The 'f15' key. public static readonly VirtualButton F15 Field Value VirtualButton F16 The 'f16' key. public static readonly VirtualButton F16 Field Value VirtualButton F17 The 'f17' key. public static readonly VirtualButton F17 Field Value VirtualButton F18 The 'f18' key. public static readonly VirtualButton F18 Field Value VirtualButton F19 The 'f19' key. public static readonly VirtualButton F19 Field Value VirtualButton F2 The 'f2' key. public static readonly VirtualButton F2 Field Value VirtualButton F20 The 'f20' key. public static readonly VirtualButton F20 Field Value VirtualButton F21 The 'f21' key. public static readonly VirtualButton F21 Field Value VirtualButton F22 The 'f22' key. public static readonly VirtualButton F22 Field Value VirtualButton F23 The 'f23' key. public static readonly VirtualButton F23 Field Value VirtualButton F24 The 'f24' key. public static readonly VirtualButton F24 Field Value VirtualButton F3 The 'f3' key. public static readonly VirtualButton F3 Field Value VirtualButton F4 The 'f4' key. public static readonly VirtualButton F4 Field Value VirtualButton F5 The 'f5' key. public static readonly VirtualButton F5 Field Value VirtualButton F6 The 'f6' key. public static readonly VirtualButton F6 Field Value VirtualButton F7 The 'f7' key. public static readonly VirtualButton F7 Field Value VirtualButton F8 The 'f8' key. public static readonly VirtualButton F8 Field Value VirtualButton F9 The 'f9' key. public static readonly VirtualButton F9 Field Value VirtualButton FinalMode The 'finalmode' key. public static readonly VirtualButton FinalMode Field Value VirtualButton G The 'g' key. public static readonly VirtualButton G Field Value VirtualButton H The 'h' key. public static readonly VirtualButton H Field Value VirtualButton HangulMode The 'hangulmode' key. public static readonly VirtualButton HangulMode Field Value VirtualButton HanjaMode The 'hanjamode' key. public static readonly VirtualButton HanjaMode Field Value VirtualButton Help The 'help' key. public static readonly VirtualButton Help Field Value VirtualButton Home The 'home' key. public static readonly VirtualButton Home Field Value VirtualButton I The 'i' key. public static readonly VirtualButton I Field Value VirtualButton ImeAccept The 'imeaccept' key. public static readonly VirtualButton ImeAccept Field Value VirtualButton ImeConvert The 'imeconvert' key. public static readonly VirtualButton ImeConvert Field Value VirtualButton ImeModeChange The 'imemodechange' key. public static readonly VirtualButton ImeModeChange Field Value VirtualButton ImeNonConvert The 'imenonconvert' key. public static readonly VirtualButton ImeNonConvert Field Value VirtualButton Insert The 'insert' key. public static readonly VirtualButton Insert Field Value VirtualButton J The 'j' key. public static readonly VirtualButton J Field Value VirtualButton JunjaMode The 'junjamode' key. public static readonly VirtualButton JunjaMode Field Value VirtualButton K The 'k' key. public static readonly VirtualButton K Field Value VirtualButton KanaMode The 'kanamode' key. public static readonly VirtualButton KanaMode Field Value VirtualButton KanjiMode The 'kanjimode' key. public static readonly VirtualButton KanjiMode Field Value VirtualButton L The 'l' key. public static readonly VirtualButton L Field Value VirtualButton LaunchApplication1 The 'launchapplication1' key. public static readonly VirtualButton LaunchApplication1 Field Value VirtualButton LaunchApplication2 The 'launchapplication2' key. public static readonly VirtualButton LaunchApplication2 Field Value VirtualButton LaunchMail The 'launchmail' key. public static readonly VirtualButton LaunchMail Field Value VirtualButton Left The 'left' key. public static readonly VirtualButton Left Field Value VirtualButton LeftAlt The 'leftalt' key. public static readonly VirtualButton LeftAlt Field Value VirtualButton LeftCtrl The 'leftctrl' key. public static readonly VirtualButton LeftCtrl Field Value VirtualButton LeftShift The 'leftshift' key. public static readonly VirtualButton LeftShift Field Value VirtualButton LeftWin The 'leftwin' key. public static readonly VirtualButton LeftWin Field Value VirtualButton LineFeed The 'linefeed' key. public static readonly VirtualButton LineFeed Field Value VirtualButton M The 'm' key. public static readonly VirtualButton M Field Value VirtualButton MediaNextTrack The 'medianexttrack' key. public static readonly VirtualButton MediaNextTrack Field Value VirtualButton MediaPlayPause The 'mediaplaypause' key. public static readonly VirtualButton MediaPlayPause Field Value VirtualButton MediaPreviousTrack The 'mediaprevioustrack' key. public static readonly VirtualButton MediaPreviousTrack Field Value VirtualButton MediaStop The 'mediastop' key. public static readonly VirtualButton MediaStop Field Value VirtualButton Multiply The 'multiply' key. public static readonly VirtualButton Multiply Field Value VirtualButton N The 'n' key. public static readonly VirtualButton N Field Value VirtualButton Next The 'next' key. public static readonly VirtualButton Next Field Value VirtualButton NoName The 'noname' key. public static readonly VirtualButton NoName Field Value VirtualButton None The 'none' key. public static readonly VirtualButton None Field Value VirtualButton NumLock The 'numlock' key. public static readonly VirtualButton NumLock Field Value VirtualButton NumPad0 The 'numpad0' key. public static readonly VirtualButton NumPad0 Field Value VirtualButton NumPad1 The 'numpad1' key. public static readonly VirtualButton NumPad1 Field Value VirtualButton NumPad2 The 'numpad2' key. public static readonly VirtualButton NumPad2 Field Value VirtualButton NumPad3 The 'numpad3' key. public static readonly VirtualButton NumPad3 Field Value VirtualButton NumPad4 The 'numpad4' key. public static readonly VirtualButton NumPad4 Field Value VirtualButton NumPad5 The 'numpad5' key. public static readonly VirtualButton NumPad5 Field Value VirtualButton NumPad6 The 'numpad6' key. public static readonly VirtualButton NumPad6 Field Value VirtualButton NumPad7 The 'numpad7' key. public static readonly VirtualButton NumPad7 Field Value VirtualButton NumPad8 The 'numpad8' key. public static readonly VirtualButton NumPad8 Field Value VirtualButton NumPad9 The 'numpad9' key. public static readonly VirtualButton NumPad9 Field Value VirtualButton O The 'o' key. public static readonly VirtualButton O Field Value VirtualButton Oem1 The 'oem1' key. public static readonly VirtualButton Oem1 Field Value VirtualButton Oem102 The 'oem102' key. public static readonly VirtualButton Oem102 Field Value VirtualButton Oem2 The 'oem2' key. public static readonly VirtualButton Oem2 Field Value VirtualButton Oem3 The 'oem3' key. public static readonly VirtualButton Oem3 Field Value VirtualButton Oem4 The 'oem4' key. public static readonly VirtualButton Oem4 Field Value VirtualButton Oem5 The 'oem5' key. public static readonly VirtualButton Oem5 Field Value VirtualButton Oem6 The 'oem6' key. public static readonly VirtualButton Oem6 Field Value VirtualButton Oem7 The 'oem7' key. public static readonly VirtualButton Oem7 Field Value VirtualButton Oem8 The 'oem8' key. public static readonly VirtualButton Oem8 Field Value VirtualButton OemBackslash The 'oembackslash' key. public static readonly VirtualButton OemBackslash Field Value VirtualButton OemClear The 'oemclear' key. public static readonly VirtualButton OemClear Field Value VirtualButton OemCloseBrackets The 'oemclosebrackets' key. public static readonly VirtualButton OemCloseBrackets Field Value VirtualButton OemComma The 'oemcomma' key. public static readonly VirtualButton OemComma Field Value VirtualButton OemMinus The 'oemminus' key. public static readonly VirtualButton OemMinus Field Value VirtualButton OemOpenBrackets The 'oemopenbrackets' key. public static readonly VirtualButton OemOpenBrackets Field Value VirtualButton OemPeriod The 'oemperiod' key. public static readonly VirtualButton OemPeriod Field Value VirtualButton OemPipe The 'oempipe' key. public static readonly VirtualButton OemPipe Field Value VirtualButton OemPlus The 'oemplus' key. public static readonly VirtualButton OemPlus Field Value VirtualButton OemQuestion The 'oemquestion' key. public static readonly VirtualButton OemQuestion Field Value VirtualButton OemQuotes The 'oemquotes' key. public static readonly VirtualButton OemQuotes Field Value VirtualButton OemSemicolon The 'oemsemicolon' key. public static readonly VirtualButton OemSemicolon Field Value VirtualButton OemTilde The 'oemtilde' key. public static readonly VirtualButton OemTilde Field Value VirtualButton P The 'p' key. public static readonly VirtualButton P Field Value VirtualButton Pa1 The 'pa1' key. public static readonly VirtualButton Pa1 Field Value VirtualButton PageDown The 'pagedown' key. public static readonly VirtualButton PageDown Field Value VirtualButton PageUp The 'pageup' key. public static readonly VirtualButton PageUp Field Value VirtualButton Pause The 'pause' key. public static readonly VirtualButton Pause Field Value VirtualButton Play The 'play' key. public static readonly VirtualButton Play Field Value VirtualButton Print The 'print' key. public static readonly VirtualButton Print Field Value VirtualButton PrintScreen The 'printscreen' key. public static readonly VirtualButton PrintScreen Field Value VirtualButton Prior The 'prior' key. public static readonly VirtualButton Prior Field Value VirtualButton Q The 'q' key. public static readonly VirtualButton Q Field Value VirtualButton R The 'r' key. public static readonly VirtualButton R Field Value VirtualButton Return The 'return' key. public static readonly VirtualButton Return Field Value VirtualButton Right The 'right' key. public static readonly VirtualButton Right Field Value VirtualButton RightAlt The 'rightalt' key. public static readonly VirtualButton RightAlt Field Value VirtualButton RightCtrl The 'rightctrl' key. public static readonly VirtualButton RightCtrl Field Value VirtualButton RightShift The 'rightshift' key. public static readonly VirtualButton RightShift Field Value VirtualButton RightWin The 'rightwin' key. public static readonly VirtualButton RightWin Field Value VirtualButton S The 's' key. public static readonly VirtualButton S Field Value VirtualButton Scroll The 'scroll' key. public static readonly VirtualButton Scroll Field Value VirtualButton Select The 'select' key. public static readonly VirtualButton Select Field Value VirtualButton SelectMedia The 'selectmedia' key. public static readonly VirtualButton SelectMedia Field Value VirtualButton Separator The 'separator' key. public static readonly VirtualButton Separator Field Value VirtualButton Sleep The 'sleep' key. public static readonly VirtualButton Sleep Field Value VirtualButton Snapshot The 'snapshot' key. public static readonly VirtualButton Snapshot Field Value VirtualButton Space The 'space' key. public static readonly VirtualButton Space Field Value VirtualButton Subtract The 'subtract' key. public static readonly VirtualButton Subtract Field Value VirtualButton T The 't' key. public static readonly VirtualButton T Field Value VirtualButton Tab The 'tab' key. public static readonly VirtualButton Tab Field Value VirtualButton U The 'u' key. public static readonly VirtualButton U Field Value VirtualButton Up The 'up' key. public static readonly VirtualButton Up Field Value VirtualButton V The 'v' key. public static readonly VirtualButton V Field Value VirtualButton VolumeDown The 'volumedown' key. public static readonly VirtualButton VolumeDown Field Value VirtualButton VolumeMute The 'volumemute' key. public static readonly VirtualButton VolumeMute Field Value VirtualButton VolumeUp The 'volumeup' key. public static readonly VirtualButton VolumeUp Field Value VirtualButton W The 'w' key. public static readonly VirtualButton W Field Value VirtualButton X The 'x' key. public static readonly VirtualButton X Field Value VirtualButton Y The 'y' key. public static readonly VirtualButton Y Field Value VirtualButton Z The 'z' key. public static readonly VirtualButton Z Field Value VirtualButton Zoom The 'zoom' key. public static readonly VirtualButton Zoom Field Value VirtualButton Methods GetValue(InputManager) Gets the value associated with this virtual button from an input manager. public override float GetValue(InputManager manager) Parameters manager InputManager The manager. Returns float System.Single. IsDown(InputManager) Indicate if the button is currently down public override bool IsDown(InputManager manager) Parameters manager InputManager The input manager Returns bool IsPressed(InputManager) Indicate if the button has been pressed since the last frame public override bool IsPressed(InputManager manager) Parameters manager InputManager The input manager Returns bool IsReleased(InputManager) Indicate if the button has been released since the last frame public override bool IsReleased(InputManager manager) Parameters manager InputManager The input manager Returns bool"
  },
  "api/Stride.Input.VirtualButton.Mouse.html": {
    "href": "api/Stride.Input.VirtualButton.Mouse.html",
    "title": "Class VirtualButton.Mouse | Stride API",
    "summary": "Class VirtualButton.Mouse Namespace Stride.Input Assembly Stride.Input.dll Mouse virtual button. public class VirtualButton.Mouse : VirtualButton, IVirtualButton Inheritance object VirtualButton VirtualButton.Mouse Implements IVirtualButton Inherited Members VirtualButton.Id VirtualButton.Name VirtualButton.ShortName VirtualButton.Type VirtualButton.IsPositiveAndNegative VirtualButton.Index VirtualButton.ToString() VirtualButton.Registered VirtualButton.Find(string) VirtualButton.Find(int) VirtualButton.BuildButtonName() Extension Methods UnsafeUtilities.As<T>(object?) Constructors Mouse(string, int, bool) protected Mouse(string name, int id, bool isPositiveAndNegative) Parameters name string id int isPositiveAndNegative bool Fields DeltaX Equivalent to X Axis delta of MousePosition. public static readonly VirtualButton.Mouse DeltaX Field Value VirtualButton.Mouse DeltaY Equivalent to Y Axis delta of MousePosition. public static readonly VirtualButton.Mouse DeltaY Field Value VirtualButton.Mouse Extended1 Equivalent to Extended1. public static readonly VirtualButton.Mouse Extended1 Field Value VirtualButton.Mouse Extended2 Equivalent to Extended2. public static readonly VirtualButton.Mouse Extended2 Field Value VirtualButton.Mouse Left Equivalent to Left. public static readonly VirtualButton.Mouse Left Field Value VirtualButton.Mouse Middle Equivalent to Middle. public static readonly VirtualButton.Mouse Middle Field Value VirtualButton.Mouse PositionX Equivalent to X Axis of MousePosition. public static readonly VirtualButton.Mouse PositionX Field Value VirtualButton.Mouse PositionY Equivalent to Y Axis of MousePosition. public static readonly VirtualButton.Mouse PositionY Field Value VirtualButton.Mouse Right Equivalent to Right. public static readonly VirtualButton.Mouse Right Field Value VirtualButton.Mouse WheelDelta Equivalent to MouseWheelDelta. public static readonly VirtualButton.Mouse WheelDelta Field Value VirtualButton.Mouse Methods GetValue(InputManager) Gets the value associated with this virtual button from an input manager. public override float GetValue(InputManager manager) Parameters manager InputManager The manager. Returns float System.Single. IsDown(InputManager) Indicate if the button is currently down public override bool IsDown(InputManager manager) Parameters manager InputManager The input manager Returns bool IsPressed(InputManager) Indicate if the button has been pressed since the last frame public override bool IsPressed(InputManager manager) Parameters manager InputManager The input manager Returns bool IsReleased(InputManager) Indicate if the button has been released since the last frame public override bool IsReleased(InputManager manager) Parameters manager InputManager The input manager Returns bool"
  },
  "api/Stride.Input.VirtualButton.Pointer.html": {
    "href": "api/Stride.Input.VirtualButton.Pointer.html",
    "title": "Class VirtualButton.Pointer | Stride API",
    "summary": "Class VirtualButton.Pointer Namespace Stride.Input Assembly Stride.Input.dll Mouse virtual button. public class VirtualButton.Pointer : VirtualButton, IVirtualButton Inheritance object VirtualButton VirtualButton.Pointer Implements IVirtualButton Inherited Members VirtualButton.Id VirtualButton.Name VirtualButton.ShortName VirtualButton.Type VirtualButton.IsPositiveAndNegative VirtualButton.Index VirtualButton.ToString() VirtualButton.Registered VirtualButton.Find(string) VirtualButton.Find(int) Extension Methods UnsafeUtilities.As<T>(object?) Constructors Pointer(string, int, int, bool) protected Pointer(string name, int id, int pointerId, bool isPositiveAndNegative) Parameters name string id int pointerId int isPositiveAndNegative bool Fields DeltaX The X component of the Pointer Delta. public static readonly VirtualButton.Pointer DeltaX Field Value VirtualButton.Pointer DeltaY The Y component of the Pointer Delta. public static readonly VirtualButton.Pointer DeltaY Field Value VirtualButton.Pointer PointerId The pad index. public readonly int PointerId Field Value int PositionX The X component of the Pointer Position. public static readonly VirtualButton.Pointer PositionX Field Value VirtualButton.Pointer PositionY The Y component of the Pointer Position. public static readonly VirtualButton.Pointer PositionY Field Value VirtualButton.Pointer State The current state of pointers. public static readonly VirtualButton.Pointer State Field Value VirtualButton.Pointer Methods BuildButtonName() protected override string BuildButtonName() Returns string GetValue(InputManager) Gets the value associated with this virtual button from an input manager. public override float GetValue(InputManager manager) Parameters manager InputManager The manager. Returns float System.Single. IsDown(InputManager) Indicate if the button is currently down public override bool IsDown(InputManager manager) Parameters manager InputManager The input manager Returns bool IsPressed(InputManager) Indicate if the button has been pressed since the last frame public override bool IsPressed(InputManager manager) Parameters manager InputManager The input manager Returns bool IsReleased(InputManager) Indicate if the button has been released since the last frame public override bool IsReleased(InputManager manager) Parameters manager InputManager The input manager Returns bool WithId(int) Return a pointer button for the given point Id. public VirtualButton.Pointer WithId(int pointerId) Parameters pointerId int the Id of the pointer Returns VirtualButton.Pointer An pointer button for the given pointer Id."
  },
  "api/Stride.Input.VirtualButton.html": {
    "href": "api/Stride.Input.VirtualButton.html",
    "title": "Class VirtualButton | Stride API",
    "summary": "Class VirtualButton Namespace Stride.Input Assembly Stride.Input.dll Describes a virtual button (a key from a keyboard, a mouse button, an axis of a joystick...etc.). public abstract class VirtualButton : IVirtualButton Inheritance object VirtualButton Implements IVirtualButton Derived VirtualButton.GamePad VirtualButton.Keyboard VirtualButton.Mouse VirtualButton.Pointer Extension Methods UnsafeUtilities.As<T>(object?) Constructors VirtualButton(string, VirtualButtonType, int, bool) Initializes a new instance of the VirtualButton class. protected VirtualButton(string shortName, VirtualButtonType type, int id, bool isPositiveAndNegative = false) Parameters shortName string The name. type VirtualButtonType The type. id int The id. isPositiveAndNegative bool if set to true [is positive and negative]. Fields Id Unique Id for a particular button Type. public readonly int Id Field Value int Index protected readonly int Index Field Value int IsPositiveAndNegative A boolean indicating whether this button supports positive and negative value. public readonly bool IsPositiveAndNegative Field Value bool ShortName The short name of this button. public readonly string ShortName Field Value string Type Type of this button. public readonly VirtualButtonType Type Field Value VirtualButtonType Properties Name The full name of this button. public string Name { get; } Property Value string Registered Gets all registered VirtualButton. public static IReadOnlyCollection<VirtualButton> Registered { get; } Property Value IReadOnlyCollection<VirtualButton> The registered virtual buttons. Methods BuildButtonName() protected virtual string BuildButtonName() Returns string Find(int) Finds a virtual button by the specified id. public static VirtualButton Find(int id) Parameters id int The id. Returns VirtualButton An instance of VirtualButton or null if no match. Find(string) Finds a virtual button by the specified name. public static VirtualButton Find(string name) Parameters name string The name. Returns VirtualButton An instance of VirtualButton or null if no match. GetValue(InputManager) Gets the value associated with this virtual button from an input manager. public abstract float GetValue(InputManager manager) Parameters manager InputManager The manager. Returns float System.Single. IsDown(InputManager) Indicate if the button is currently down public abstract bool IsDown(InputManager manager) Parameters manager InputManager The input manager Returns bool IsPressed(InputManager) Indicate if the button has been pressed since the last frame public abstract bool IsPressed(InputManager manager) Parameters manager InputManager The input manager Returns bool IsReleased(InputManager) Indicate if the button has been released since the last frame public abstract bool IsReleased(InputManager manager) Parameters manager InputManager The input manager Returns bool ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. Operators operator +(IVirtualButton, VirtualButton) Implements the + operator to combine to VirtualButton. public static IVirtualButton operator +(IVirtualButton left, VirtualButton right) Parameters left IVirtualButton The left virtual button. right VirtualButton The right virtual button. Returns IVirtualButton A set containting the two virtual buttons."
  },
  "api/Stride.Input.VirtualButtonBinding.html": {
    "href": "api/Stride.Input.VirtualButtonBinding.html",
    "title": "Class VirtualButtonBinding | Stride API",
    "summary": "Class VirtualButtonBinding Namespace Stride.Input Assembly Stride.Input.dll Describes a binding between a name and a IVirtualButton. public class VirtualButtonBinding Inheritance object VirtualButtonBinding Extension Methods UnsafeUtilities.As<T>(object?) Constructors VirtualButtonBinding() Initializes a new instance of the VirtualButtonBinding class. public VirtualButtonBinding() VirtualButtonBinding(object, IVirtualButton) Initializes a new instance of the VirtualButtonBinding class. public VirtualButtonBinding(object name, IVirtualButton button = null) Parameters name object The name. button IVirtualButton The button. Properties Button Gets or sets the virtual button. public IVirtualButton Button { get; set; } Property Value IVirtualButton The virtual button. Name Gets or sets the name of this virtual button. public object Name { get; set; } Property Value object The name. Methods GetValue(InputManager) Gets the value for a particular binding. public virtual float GetValue(InputManager manager) Parameters manager InputManager Returns float Value of the binding IsDown(InputManager) Gets the held down state for a particular binding. public virtual bool IsDown(InputManager manager) Parameters manager InputManager Returns bool true when currently held down; otherwise, false. IsPressed(InputManager) Gets the pressed state for a particular binding. public virtual bool IsPressed(InputManager manager) Parameters manager InputManager Returns bool true when pressed since the last frame; otherwise, false. IsReleased(InputManager) Gets the pressed state for a particular binding. public virtual bool IsReleased(InputManager manager) Parameters manager InputManager Returns bool true when released since the last frame; otherwise, false. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.VirtualButtonConfig.html": {
    "href": "api/Stride.Input.VirtualButtonConfig.html",
    "title": "Class VirtualButtonConfig | Stride API",
    "summary": "Class VirtualButtonConfig Namespace Stride.Input Assembly Stride.Input.dll Describes the configuration composed by a collection of VirtualButtonBinding. public class VirtualButtonConfig : TrackingCollection<VirtualButtonBinding>, IList<VirtualButtonBinding>, ICollection<VirtualButtonBinding>, IReadOnlyList<VirtualButtonBinding>, IReadOnlyCollection<VirtualButtonBinding>, IEnumerable<VirtualButtonBinding>, IEnumerable, ITrackingCollectionChanged Inheritance object FastCollection<VirtualButtonBinding> TrackingCollection<VirtualButtonBinding> VirtualButtonConfig Implements IList<VirtualButtonBinding> ICollection<VirtualButtonBinding> IReadOnlyList<VirtualButtonBinding> IReadOnlyCollection<VirtualButtonBinding> IEnumerable<VirtualButtonBinding> IEnumerable ITrackingCollectionChanged Inherited Members TrackingCollection<VirtualButtonBinding>.CollectionChanged TrackingCollection<VirtualButtonBinding>.InsertItem(int, VirtualButtonBinding) TrackingCollection<VirtualButtonBinding>.RemoveItem(int) TrackingCollection<VirtualButtonBinding>.ClearItems() TrackingCollection<VirtualButtonBinding>.ClearItemsEvents() TrackingCollection<VirtualButtonBinding>.SetItem(int, VirtualButtonBinding) FastCollection<VirtualButtonBinding>.Capacity FastCollection<VirtualButtonBinding>.Count FastCollection<VirtualButtonBinding>.this[int] FastCollection<VirtualButtonBinding>.Add(VirtualButtonBinding) FastCollection<VirtualButtonBinding>.Clear() FastCollection<VirtualButtonBinding>.Contains(VirtualButtonBinding) FastCollection<VirtualButtonBinding>.CopyTo(VirtualButtonBinding[], int) FastCollection<VirtualButtonBinding>.IndexOf(VirtualButtonBinding) FastCollection<VirtualButtonBinding>.Insert(int, VirtualButtonBinding) FastCollection<VirtualButtonBinding>.Remove(VirtualButtonBinding) FastCollection<VirtualButtonBinding>.RemoveAt(int) FastCollection<VirtualButtonBinding>.AddRange<TE>(TE) FastCollection<VirtualButtonBinding>.GetEnumerator() FastCollection<VirtualButtonBinding>.Sort() FastCollection<VirtualButtonBinding>.Sort(IComparer<VirtualButtonBinding>) FastCollection<VirtualButtonBinding>.Sort(int, int, IComparer<VirtualButtonBinding>) FastCollection<VirtualButtonBinding>.IsReadOnly FastCollection<VirtualButtonBinding>.EnsureCapacity(int) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors VirtualButtonConfig() Initializes a new instance of the VirtualButtonConfig class. public VirtualButtonConfig() Properties BindingNames Gets the binding names. public IEnumerable<object> BindingNames { get; } Property Value IEnumerable<object> The binding names. Methods GetValue(InputManager, object) Gets the value for a particular binding. public virtual float GetValue(InputManager inputManager, object name) Parameters inputManager InputManager name object Returns float Value of the binding IsDown(InputManager, object) Gets the held down state for a particular binding. public virtual bool IsDown(InputManager inputManager, object name) Parameters inputManager InputManager name object Returns bool true when currently held down; otherwise, false. IsPressed(InputManager, object) Gets the pressed state for a particular binding. public virtual bool IsPressed(InputManager inputManager, object name) Parameters inputManager InputManager name object Returns bool true when pressed since the last frame; otherwise, false. IsReleased(InputManager, object) Gets the pressed state for a particular binding. public virtual bool IsReleased(InputManager inputManager, object name) Parameters inputManager InputManager name object Returns bool true when released since the last frame; otherwise, false."
  },
  "api/Stride.Input.VirtualButtonConfigSet.html": {
    "href": "api/Stride.Input.VirtualButtonConfigSet.html",
    "title": "Class VirtualButtonConfigSet | Stride API",
    "summary": "Class VirtualButtonConfigSet Namespace Stride.Input Assembly Stride.Input.dll A collection of VirtualButtonConfig. public class VirtualButtonConfigSet : Collection<VirtualButtonConfig>, IList<VirtualButtonConfig>, ICollection<VirtualButtonConfig>, IReadOnlyList<VirtualButtonConfig>, IReadOnlyCollection<VirtualButtonConfig>, IEnumerable<VirtualButtonConfig>, IList, ICollection, IEnumerable Inheritance object Collection<VirtualButtonConfig> VirtualButtonConfigSet Implements IList<VirtualButtonConfig> ICollection<VirtualButtonConfig> IReadOnlyList<VirtualButtonConfig> IReadOnlyCollection<VirtualButtonConfig> IEnumerable<VirtualButtonConfig> IList ICollection IEnumerable Inherited Members Collection<VirtualButtonConfig>.Add(VirtualButtonConfig) Collection<VirtualButtonConfig>.Clear() Collection<VirtualButtonConfig>.ClearItems() Collection<VirtualButtonConfig>.Contains(VirtualButtonConfig) Collection<VirtualButtonConfig>.CopyTo(VirtualButtonConfig[], int) Collection<VirtualButtonConfig>.GetEnumerator() Collection<VirtualButtonConfig>.IndexOf(VirtualButtonConfig) Collection<VirtualButtonConfig>.Insert(int, VirtualButtonConfig) Collection<VirtualButtonConfig>.InsertItem(int, VirtualButtonConfig) Collection<VirtualButtonConfig>.Remove(VirtualButtonConfig) Collection<VirtualButtonConfig>.RemoveAt(int) Collection<VirtualButtonConfig>.RemoveItem(int) Collection<VirtualButtonConfig>.SetItem(int, VirtualButtonConfig) Collection<VirtualButtonConfig>.Count Collection<VirtualButtonConfig>.this[int] Collection<VirtualButtonConfig>.Items Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Remarks Several virtual button configurations can be stored in this instance. For example, User0 config could be stored on index 0, User1 on index 1...etc. Constructors VirtualButtonConfigSet() Initializes a new instance of the VirtualButtonConfigSet class. public VirtualButtonConfigSet() Methods GetValue(InputManager, int, object) Gets a binding value for the specified name and the specified config extract from the VirtualButtonConfigSet. public virtual float GetValue(InputManager inputManager, int configIndex, object name) Parameters inputManager InputManager The InputManager to used to get the device input. configIndex int An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet. name object Name of the binding. Returns float The value of the binding. IsDown(InputManager, int, object) Determines whether the specified binding in the specified config in the VirtualButtonConfigSet is currently pressed down. public virtual bool IsDown(InputManager inputManager, int configIndex, object name) Parameters inputManager InputManager The InputManager to used to get device input. configIndex int An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet. name object Name of the binding. Returns bool true if the binding is currently pressed down; otherwise, false. IsPressed(InputManager, int, object) Determines whether the specified binding in the specified config in the VirtualButtonConfigSet was pressed since the previous Update. public virtual bool IsPressed(InputManager inputManager, int configIndex, object name) Parameters inputManager InputManager The InputManager to used to get device input. configIndex int An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet. name object Name of the binding. Returns bool true if the binding was pressed; otherwise, false. IsReleased(InputManager, int, object) Determines whether the specified binding in the specified config in the VirtualButtonConfigSet was released since the previous Update. public virtual bool IsReleased(InputManager inputManager, int configIndex, object name) Parameters inputManager InputManager The InputManager to used to get device input. configIndex int An index to a VirtualButtonConfig stored in the VirtualButtonConfigSet. name object Name of the binding. Returns bool true if the binding was released; otherwise, false."
  },
  "api/Stride.Input.VirtualButtonGroup.html": {
    "href": "api/Stride.Input.VirtualButtonGroup.html",
    "title": "Class VirtualButtonGroup | Stride API",
    "summary": "Class VirtualButtonGroup Namespace Stride.Input Assembly Stride.Input.dll A combination IVirtualButton, by default evaluated as the operator '&&' to produce a value if all buttons are pressed. public class VirtualButtonGroup : Collection<IVirtualButton>, IList<IVirtualButton>, ICollection<IVirtualButton>, IReadOnlyList<IVirtualButton>, IReadOnlyCollection<IVirtualButton>, IEnumerable<IVirtualButton>, IList, ICollection, IEnumerable, IVirtualButton Inheritance object Collection<IVirtualButton> VirtualButtonGroup Implements IList<IVirtualButton> ICollection<IVirtualButton> IReadOnlyList<IVirtualButton> IReadOnlyCollection<IVirtualButton> IEnumerable<IVirtualButton> IList ICollection IEnumerable IVirtualButton Inherited Members Collection<IVirtualButton>.Add(IVirtualButton) Collection<IVirtualButton>.Clear() Collection<IVirtualButton>.ClearItems() Collection<IVirtualButton>.Contains(IVirtualButton) Collection<IVirtualButton>.CopyTo(IVirtualButton[], int) Collection<IVirtualButton>.GetEnumerator() Collection<IVirtualButton>.IndexOf(IVirtualButton) Collection<IVirtualButton>.Insert(int, IVirtualButton) Collection<IVirtualButton>.Remove(IVirtualButton) Collection<IVirtualButton>.RemoveAt(int) Collection<IVirtualButton>.RemoveItem(int) Collection<IVirtualButton>.Count Collection<IVirtualButton>.this[int] Collection<IVirtualButton>.Items Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors VirtualButtonGroup(bool) public VirtualButtonGroup(bool isDisjunction = false) Parameters isDisjunction bool Properties IsDisjunction Gets or sets a value indicating whether this instance is determining the value as a disjunction ('||' operator between buttons), false by default ('&&' operator). public bool IsDisjunction { get; set; } Property Value bool true if this instance is disjunction; otherwise, false. Methods GetValue(InputManager) Gets the value associated with this virtual button from an input manager. public virtual float GetValue(InputManager manager) Parameters manager InputManager The manager. Returns float System.Single. InsertItem(int, IVirtualButton) Inserts an element into the Collection<T> at the specified index. protected override void InsertItem(int index, IVirtualButton item) Parameters index int The zero-based index at which item should be inserted. item IVirtualButton The object to insert. The value can be null for reference types. Exceptions ArgumentOutOfRangeException index is less than zero. -or- index is greater than Count. IsDown(InputManager) Indicate if the button is currently down public bool IsDown(InputManager manager) Parameters manager InputManager The input manager Returns bool IsPressed(InputManager) Indicate if the button has been pressed since the last frame public bool IsPressed(InputManager manager) Parameters manager InputManager The input manager Returns bool IsReleased(InputManager) Indicate if the button has been released since the last frame public bool IsReleased(InputManager manager) Parameters manager InputManager The input manager Returns bool SetItem(int, IVirtualButton) Replaces the element at the specified index. protected override void SetItem(int index, IVirtualButton item) Parameters index int The zero-based index of the element to replace. item IVirtualButton The new value for the element at the specified index. The value can be null for reference types. Exceptions ArgumentOutOfRangeException index is less than zero. -or- index is greater than Count. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. Operators operator +(VirtualButtonGroup, IVirtualButton) Implements the + operator. public static VirtualButtonGroup operator +(VirtualButtonGroup combination, IVirtualButton virtualButton) Parameters combination VirtualButtonGroup The combination. virtualButton IVirtualButton The virtual button. Returns VirtualButtonGroup The result of the operator."
  },
  "api/Stride.Input.VirtualButtonTwoWay.html": {
    "href": "api/Stride.Input.VirtualButtonTwoWay.html",
    "title": "Class VirtualButtonTwoWay | Stride API",
    "summary": "Class VirtualButtonTwoWay Namespace Stride.Input Assembly Stride.Input.dll Describes a IVirtualButton using the sum of a negative and positive button. public class VirtualButtonTwoWay : IVirtualButton Inheritance object VirtualButtonTwoWay Implements IVirtualButton Extension Methods UnsafeUtilities.As<T>(object?) Remarks This virtual button is for example useful to bind a key to a negative value (key 'left') and another key to a positive value (key 'right') thus simulating an axis button. The result of this virtual Result = PositiveButton.GetValue - NegativeButton.GetValue; Constructors VirtualButtonTwoWay() Initializes a new instance of the VirtualButtonTwoWay class. public VirtualButtonTwoWay() VirtualButtonTwoWay(IVirtualButton, IVirtualButton) Initializes a new instance of the VirtualButtonTwoWay class. public VirtualButtonTwoWay(IVirtualButton negativeButton, IVirtualButton positiveButton) Parameters negativeButton IVirtualButton The negative button. positiveButton IVirtualButton The positive button. Properties NegativeButton Gets or sets the negative button that will generate a 'negative' value if it is pressed. public IVirtualButton NegativeButton { get; set; } Property Value IVirtualButton The negative button. PositiveButton Gets or sets the positive button that will generate a 'positive' value if it is pressed. public IVirtualButton PositiveButton { get; set; } Property Value IVirtualButton The positive button. Methods GetValue(InputManager) Gets the value associated with this virtual button from an input manager. public virtual float GetValue(InputManager manager) Parameters manager InputManager The manager. Returns float System.Single. IsDown(InputManager) Indicate if the button is currently down public bool IsDown(InputManager manager) Parameters manager InputManager The input manager Returns bool IsPressed(InputManager) Indicate if the button has been pressed since the last frame public bool IsPressed(InputManager manager) Parameters manager InputManager The input manager Returns bool IsReleased(InputManager) Indicate if the button has been released since the last frame public bool IsReleased(InputManager manager) Parameters manager InputManager The input manager Returns bool ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Input.VirtualButtonType.html": {
    "href": "api/Stride.Input.VirtualButtonType.html",
    "title": "Enum VirtualButtonType | Stride API",
    "summary": "Enum VirtualButtonType Namespace Stride.Input Assembly Stride.Input.dll Type of a VirtualButton. public enum VirtualButtonType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields GamePad = 1073741824 A gamepad virtual button. Keyboard = 268435456 A keyboard virtual button. Mouse = 536870912 A mouse virtual button. Pointer = 805306368 A pointer virtual button."
  },
  "api/Stride.Input.html": {
    "href": "api/Stride.Input.html",
    "title": "Namespace Stride.Input | Stride API",
    "summary": "Namespace Stride.Input Classes AxisEvent Event for an axis changing state on a device ButtonEvent Event for a button changing state on a device DeviceChangedEventArgs An event used when a device was changed GameControllerAxisEvent An event to describe a change in a game controller axis state GameControllerAxisInfo Provides information about a gamepad axis GameControllerButtonEvent An event to describe a change in game controller button state GameControllerButtonInfo Provides information about a gamepad button GameControllerDeviceBase Base class for gamepads, contains common functionality for gamepad devices GameControllerDeviceExtensions Provides easier ways to set vibration levels on a controller, rather than setting 4 motors GameControllerDirectionEvent An event to describe a change in game controller direction state GameControllerDirectionInfo Provides information about a gamepad direction input GameControllerExtensions GameControllerObjectInfo Provides information about an object exposed by a gamepad GameControllerUtils Provides some useful functions relating to game controllers GamePadAxisEvent An event to describe a change in a gamepad axis GamePadButtonEvent An event to describe a change in gamepad button state GamePadDeviceBase GamePadDeviceExtensions Provides easier ways to set vibration levels on a controller, rather than setting 4 motors GamePadFromLayout A IGamePadDevice from a IGameControllerDevice using a GamePadLayout to create a mapping between the two GamePadIndexChangedEventArgs Event for when a IGamePadDevice's index changed GamePadLayout Provides a IGameControllerDevice to IGamePadDevice mapping GamePadLayoutDS4 A gamepad layout for a DualShock4 controller GamePadLayoutXInput Layout for XInput devices so that they can be used by SDL or other systems that do not have the XInput API but do support joysticks in some other way GamePadLayouts Keeps track of GamePadLayout GamePadSimulated GestureConfig This represents the base class for all gesture configuration. GestureConfigComposite Configuration class for the Composite gesture. GestureConfigDrag Configuration class for the Drag gesture. GestureConfigFlick Configuration class for the Flick gesture. GestureConfigLongPress Configuration class the Long Press gestures. GestureConfigTap Configuration class for the Tap gesture. GestureEvent Base class for the gesture events. GestureEventComposite Event class for the Composite gesture. GestureEventDrag Event class for the Drag gesture. GestureEventFlick Event class for the Flick gesture. GestureEventLongPress Event class for the LongPress gesture. GestureEventTap Event class for the Tap gesture. GestureEventTranslation Event class for the Drag gesture. InputDeviceUtils Utilities for input devices InputEvent An event that was generated from an IInputDevice InputEventPool<TEventType> Pools input events of a given type InputManager Manages collecting input from connected input device in the form of IInputDevice objects. Also provides some convenience functions for most commonly used devices InputPreUpdateEventArgs Arguments for input pre update event InputSourceBase Base class for input sources, implements common parts of the IInputSource interface and keeps track of registered devices through RegisterDevice(IInputDevice) and UnregisterDevice(IInputDevice) InputSourceFactory Given a GameContext creates the corresponding IInputSource for the platform specific window. InputSourceSimulated Provides a virtual mouse and keyboard that generate input events like a normal mouse/keyboard when any of the functions (Simulate...) are called KeyEvent Event for a keyboard button changing state KeyboardDeviceBase Base class for keyboard devices KeyboardDeviceExtensions KeyboardSimulated MouseButtonEvent Describes a button on a mouse changing state MouseDeviceBase Base class for mouse devices, implements some common functionality of IMouseDevice, inherits from PointerDeviceBase MouseDeviceExtensions MouseDeviceState An extension to PointerDeviceState that handle mouse input and translates it to pointer input MouseSimulated MouseWheelEvent Event for a mouse wheel being used PointerDeviceBase Base class for pointer devices PointerDeviceState Contains logic to generate pointer events and store the resulting state PointerDeviceState.PointerData Some additional data kept on top of PointerPoint for the purpose of generating PointerEvent PointerEvent A pointer event. PointerPoint Represents a unique pointer that is or was on the screen and information about it PointerSimulated Simulation of PointerEvents SurfaceSizeChangedEventArgs An event for when the size of a pointer surface changed TextInputEvent Input event used for text input and IME related events VirtualButton Describes a virtual button (a key from a keyboard, a mouse button, an axis of a joystick...etc.). VirtualButton.GamePad GamePad virtual button. VirtualButton.Keyboard Keyboard virtual button. VirtualButton.Mouse Mouse virtual button. VirtualButton.Pointer Mouse virtual button. VirtualButtonBinding Describes a binding between a name and a IVirtualButton. VirtualButtonConfig Describes the configuration composed by a collection of VirtualButtonBinding. VirtualButtonConfigSet A collection of VirtualButtonConfig. VirtualButtonGroup A combination IVirtualButton, by default evaluated as the operator '&&' to produce a value if all buttons are pressed. VirtualButtonTwoWay Describes a IVirtualButton using the sum of a negative and positive button. Structs Direction Represents a direction or neutral position GamePadState Describes the state of a typical gamepad. PointerDeviceState.InputEvent Simplified event data used to generate the full events when Update(List<InputEvent>) gets called Interfaces IAccelerometerSensor This class represents a sensor of type Accelerometer. It measures the acceleration forces (including gravity) applying on the device. ICompassSensor This class represents a sensor of type compass. It measures the angle between the device and the north. IGameControllerDevice This interface is used for interacting with game controller devices. IGamePadDevice A gamepad is a game controller that has a fixed button mapping, stored in State IGravitySensor This class represents a sensor of type Gravity. It measures the gravity force applying on the device. IGyroscopeSensor This class represents a sensor of type Gyroscope. It measures the rotation speed of device along the x/y/z axis. IInputDevice IInputEventArgs IInputEventListener Does not listen to any event but is used to pass around a type that might potentially listen for input events IInputEventListener<TEventType> Interface for classes that want to listen to input event of a certain type IInputSource An abstraction for a platform specific mechanism that provides input in the form of one of multiple IInputDevice(s). An input source is responsible for cleaning up it's own devices at cleanup IKeyboardDevice A keyboard device IMouseDevice Represents functionality specific to mouse input such as buttons, wheels, mouse locking and setting cursor position IOrientationSensor This class represents a sensor of type Orientation. It measures the orientation of device in the real world. IPointerDevice Provides an interface for interacting with pointer devices, this can be a mouse, pen, touch screen, etc. ISensorDevice Interface for a sensor device, use more specific interfaces to retrieve sensor data ITextInputDevice A device such as a keyboard that supports text input. This can be a windows keyboard with IME support or a touch keyboard on a smartphone device IUserAccelerationSensor This class represents a sensor of type user acceleration. It measures the acceleration applied by the user (no gravity) onto the device. IVirtualButton Interface IVirtualButton Enums DeviceChangedEventType GameControllerButtonType The types of gamepad buttons GamePadAxis Axis for gamepad returned by GamePadState. GamePadButton Buttons for gamepad returned by GamePadState. GestureShape Gesture possible shapes. GestureState The different possible states of a gestures. GestureType List all the available type of Gestures. Keys Enumeration for keys. MouseAxis Mouse axes MouseButton Mouse buttons. PointerEventType State of a pointer event. TextInputEventType VirtualButtonType Type of a VirtualButton."
  },
  "api/Stride.Media.IMediaExtractor.html": {
    "href": "api/Stride.Media.IMediaExtractor.html",
    "title": "Interface IMediaExtractor | Stride API",
    "summary": "Interface IMediaExtractor Namespace Stride.Media Assembly Stride.dll public interface IMediaExtractor : IMediaReader Inherited Members IMediaReader.IsDisposed IMediaReader.SpeedFactor IMediaReader.Seek(TimeSpan) Extension Methods UnsafeUtilities.As<T>(object?) Properties MediaCurrentTime Gets the current presentation time of the media TimeSpan MediaCurrentTime { get; } Property Value TimeSpan MediaDuration Returns the total duration of the media TimeSpan MediaDuration { get; } Property Value TimeSpan MediaType Returns the type of media that is extracted MediaType MediaType { get; } Property Value MediaType Methods ReachedEndOfMedia() Specifies if the end of the media has been reached. bool ReachedEndOfMedia() Returns bool SeekRequestCompleted() Indicate if a previous seek request has been completed. bool SeekRequestCompleted() Returns bool"
  },
  "api/Stride.Media.IMediaPlayer.html": {
    "href": "api/Stride.Media.IMediaPlayer.html",
    "title": "Interface IMediaPlayer | Stride API",
    "summary": "Interface IMediaPlayer Namespace Stride.Media Assembly Stride.dll Interface for playable media public interface IMediaPlayer : IMediaReader Inherited Members IMediaReader.IsDisposed IMediaReader.SpeedFactor IMediaReader.Seek(TimeSpan) Extension Methods UnsafeUtilities.As<T>(object?) Methods Pause() Pause the media. void Pause() Remarks A call to Pause when the media is already paused or stopped has no effects. Play() Start or resume playing the media. void Play() Remarks A call to Play when the media is already playing has no effects. Stop() Stop playing the media immediately and reset the media to the beginning of the source. void Stop() Remarks A call to Stop when the media is already stopped has no effects"
  },
  "api/Stride.Media.IMediaReader.html": {
    "href": "api/Stride.Media.IMediaReader.html",
    "title": "Interface IMediaReader | Stride API",
    "summary": "Interface IMediaReader Namespace Stride.Media Assembly Stride.dll public interface IMediaReader Extension Methods UnsafeUtilities.As<T>(object?) Properties IsDisposed Specifies if the extractor has been disposed bool IsDisposed { get; } Property Value bool SpeedFactor Set the play speed of the media float SpeedFactor { get; set; } Property Value float Methods Seek(TimeSpan) Seek to provided position in the media source. void Seek(TimeSpan mediaTime) Parameters mediaTime TimeSpan"
  },
  "api/Stride.Media.MediaSynchronizer.html": {
    "href": "api/Stride.Media.MediaSynchronizer.html",
    "title": "Class MediaSynchronizer | Stride API",
    "summary": "Class MediaSynchronizer Namespace Stride.Media Assembly Stride.dll public class MediaSynchronizer Inheritance object MediaSynchronizer Extension Methods UnsafeUtilities.As<T>(object?) Fields Logger public static readonly Logger Logger Field Value Logger Properties CurrentPresentationTime public TimeSpan CurrentPresentationTime { get; } Property Value TimeSpan IsLooping public bool IsLooping { get; set; } Property Value bool LoopRange public PlayRange LoopRange { get; set; } Property Value PlayRange MediaDuration public TimeSpan MediaDuration { get; } Property Value TimeSpan PlayRange public PlayRange PlayRange { get; set; } Property Value PlayRange ReachedEndOfStream public bool ReachedEndOfStream { get; } Property Value bool SpeedFactor public float SpeedFactor { get; set; } Property Value float State public PlayState State { get; } Property Value PlayState Methods IsWaitingForSynchronization() public bool IsWaitingForSynchronization() Returns bool Pause() public void Pause() Play() public void Play() RegisterExtractor(IMediaExtractor) public void RegisterExtractor(IMediaExtractor extractor) Parameters extractor IMediaExtractor RegisterPlayer(IMediaPlayer) public void RegisterPlayer(IMediaPlayer player) Parameters player IMediaPlayer RegisterReader(IMediaReader) public void RegisterReader(IMediaReader reader) Parameters reader IMediaReader Seek(double) public void Seek(double timePercentage) Parameters timePercentage double Seek(TimeSpan) public void Seek(TimeSpan seekTime) Parameters seekTime TimeSpan Stop() public void Stop() UnregisterExtractor(IMediaExtractor) public void UnregisterExtractor(IMediaExtractor extractor) Parameters extractor IMediaExtractor UnregisterReader(IMediaPlayer) public void UnregisterReader(IMediaPlayer player) Parameters player IMediaPlayer UnregisterReader(IMediaReader) public void UnregisterReader(IMediaReader reader) Parameters reader IMediaReader Unregister<T>(List<T>, T) public void Unregister<T>(List<T> list, T item) Parameters list List<T> item T Type Parameters T Update(TimeSpan) public void Update(TimeSpan timeElapsed) Parameters timeElapsed TimeSpan"
  },
  "api/Stride.Media.MediaType.html": {
    "href": "api/Stride.Media.MediaType.html",
    "title": "Enum MediaType | Stride API",
    "summary": "Enum MediaType Namespace Stride.Media Assembly Stride.dll public enum MediaType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Audio = 0 Video = 1"
  },
  "api/Stride.Media.PlayRange.html": {
    "href": "api/Stride.Media.PlayRange.html",
    "title": "Struct PlayRange | Stride API",
    "summary": "Struct PlayRange Namespace Stride.Media Assembly Stride.dll Describes the range of audio samples to play, in time unit. public struct PlayRange Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors PlayRange(TimeSpan, TimeSpan) Creates a new PlayRange structure. public PlayRange(TimeSpan start, TimeSpan length) Parameters start TimeSpan The Stating time. length TimeSpan The Length of the audio extract to play. Fields Length The Length of the audio extract to play. public TimeSpan Length Field Value TimeSpan Start The Stating time. public TimeSpan Start Field Value TimeSpan Properties End The Ending time. public TimeSpan End { get; set; } Property Value TimeSpan Methods Equals(PlayRange) public bool Equals(PlayRange other) Parameters other PlayRange Returns bool Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. IsValid() Returns true if the range specifies a valid play range. This is Start is positive and Length is strictly positive. public bool IsValid() Returns bool Operators operator ==(PlayRange, PlayRange) public static bool operator ==(PlayRange left, PlayRange right) Parameters left PlayRange right PlayRange Returns bool operator !=(PlayRange, PlayRange) public static bool operator !=(PlayRange left, PlayRange right) Parameters left PlayRange right PlayRange Returns bool"
  },
  "api/Stride.Media.PlayState.html": {
    "href": "api/Stride.Media.PlayState.html",
    "title": "Enum PlayState | Stride API",
    "summary": "Enum PlayState Namespace Stride.Media Assembly Stride.dll Current state (playing, paused, or stopped) of a media. public enum PlayState Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Paused = 1 The media is currently paused. Playing = 0 The media is currently being played. Stopped = 2 The media is currently stopped."
  },
  "api/Stride.Media.html": {
    "href": "api/Stride.Media.html",
    "title": "Namespace Stride.Media | Stride API",
    "summary": "Namespace Stride.Media Classes MediaSynchronizer Structs PlayRange Describes the range of audio samples to play, in time unit. Interfaces IMediaExtractor IMediaPlayer Interface for playable media IMediaReader Enums MediaType PlayState Current state (playing, paused, or stopped) of a media."
  },
  "api/Stride.Navigation.DynamicNavigationMeshSystem.html": {
    "href": "api/Stride.Navigation.DynamicNavigationMeshSystem.html",
    "title": "Class DynamicNavigationMeshSystem | Stride API",
    "summary": "Class DynamicNavigationMeshSystem Namespace Stride.Navigation Assembly Stride.Navigation.dll System that handles building of navigation meshes at runtime public class DynamicNavigationMeshSystem : GameSystem, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase GameSystem DynamicNavigationMeshSystem Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Inherited Members GameSystem.Game GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.Draw(GameTime) GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) GameSystemBase.LoadContent() GameSystemBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DynamicNavigationMeshSystem(IServiceRegistry) public DynamicNavigationMeshSystem(IServiceRegistry registry) Parameters registry IServiceRegistry Properties AutomaticRebuild If true, this will automatically rebuild on addition/removal of static collider components [DataMember(5)] public bool AutomaticRebuild { get; set; } Property Value bool BuildSettings Build settings used by Recast [DataMember(20)] public NavigationMeshBuildSettings BuildSettings { get; set; } Property Value NavigationMeshBuildSettings CurrentNavigationMesh The most recently built navigation mesh public NavigationMesh CurrentNavigationMesh { get; } Property Value NavigationMesh Groups Settings for agents used with the dynamic navigation mesh [DataMember(30)] public List<NavigationMeshGroup> Groups { get; } Property Value List<NavigationMeshGroup> IncludedCollisionGroups Collision filter that indicates which colliders are used in navmesh generation [DataMember(10)] public CollisionFilterGroupFlags IncludedCollisionGroups { get; set; } Property Value CollisionFilterGroupFlags Methods Initialize() Initializes the Game System. public override void Initialize() Remarks This method is called when the component is added to the Game. This can be used for tasks like querying for services the component needs and setting up non-graphics resources (as here the Graphics Device may have not been initialized yet). InitializeSettingsFromGameSettings(GameSettings) Copies the default settings from the GameSettings for building navigation public void InitializeSettingsFromGameSettings(GameSettings gameSettings) Parameters gameSettings GameSettings Rebuild() Starts an asynchronous rebuild of the navigation mesh public Task<NavigationMeshBuildResult> Rebuild() Returns Task<NavigationMeshBuildResult> Update(GameTime) This method is called when this game component is updated. public override void Update(GameTime gameTime) Parameters gameTime GameTime The current timing. Events NavigationMeshUpdated Raised when the navigation mesh for the current scene is updated public event EventHandler<NavigationMeshUpdatedEventArgs> NavigationMeshUpdated Event Type EventHandler<NavigationMeshUpdatedEventArgs>"
  },
  "api/Stride.Navigation.NavigationAgentSettings.html": {
    "href": "api/Stride.Navigation.NavigationAgentSettings.html",
    "title": "Class NavigationAgentSettings | Stride API",
    "summary": "Class NavigationAgentSettings Namespace Stride.Navigation Assembly Stride.Navigation.dll Navigation agent [DataContract] [ObjectFactory(typeof(NavigationAgentSettingsFactory))] public class NavigationAgentSettings Inheritance object NavigationAgentSettings Extension Methods UnsafeUtilities.As<T>(object?) Fields Height Height of the actor [DataMember(0)] [DataMemberRange(0, 3)] public float Height Field Value float MaxClimb Maximum vertical distance this agent can climb [DataMember(1)] [Display(\"Maximum climb height\", null)] [DataMemberRange(0, 3)] public float MaxClimb Field Value float MaxSlope Maximum slope angle this agent can climb [Display(\"Maximum slope\", null)] [DataMember(2)] public AngleSingle MaxSlope Field Value AngleSingle Radius Radius of the actor [DataMember(3)] [DataMemberRange(0, 3)] public float Radius Field Value float"
  },
  "api/Stride.Navigation.NavigationAgentSettingsFactory.html": {
    "href": "api/Stride.Navigation.NavigationAgentSettingsFactory.html",
    "title": "Class NavigationAgentSettingsFactory | Stride API",
    "summary": "Class NavigationAgentSettingsFactory Namespace Stride.Navigation Assembly Stride.Navigation.dll public class NavigationAgentSettingsFactory : IObjectFactory Inheritance object NavigationAgentSettingsFactory Implements IObjectFactory Extension Methods UnsafeUtilities.As<T>(object?) Methods New(Type) Creates a new instance of a type. public object New(Type type) Parameters type Type The type of the instance to create. Returns object A new default instance of a type."
  },
  "api/Stride.Navigation.NavigationBoundingBoxComponent.html": {
    "href": "api/Stride.Navigation.NavigationBoundingBoxComponent.html",
    "title": "Class NavigationBoundingBoxComponent | Stride API",
    "summary": "Class NavigationBoundingBoxComponent Namespace Stride.Navigation Assembly Stride.Navigation.dll A three dimensional bounding box using the scale of the owning entity as the box extent. This is used to limit the area in which navigation meshes are generated [DataContract] [DefaultEntityComponentProcessor(typeof(BoundingBoxProcessor), ExecutionMode = ExecutionMode.All)] [Display(\"Navigation bounding box\", null)] [ComponentCategory(\"Navigation\")] public class NavigationBoundingBoxComponent : EntityComponent, IIdentifiable Inheritance object EntityComponent NavigationBoundingBoxComponent Implements IIdentifiable Inherited Members EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties Size The size of one edge of the bounding box [DataMember(0)] public Vector3 Size { get; set; } Property Value Vector3"
  },
  "api/Stride.Navigation.NavigationBuildSettingsFactory.html": {
    "href": "api/Stride.Navigation.NavigationBuildSettingsFactory.html",
    "title": "Class NavigationBuildSettingsFactory | Stride API",
    "summary": "Class NavigationBuildSettingsFactory Namespace Stride.Navigation Assembly Stride.Navigation.dll public class NavigationBuildSettingsFactory : IObjectFactory Inheritance object NavigationBuildSettingsFactory Implements IObjectFactory Extension Methods UnsafeUtilities.As<T>(object?) Methods New(Type) Creates a new instance of a type. public object New(Type type) Parameters type Type The type of the instance to create. Returns object A new default instance of a type."
  },
  "api/Stride.Navigation.NavigationComponent.html": {
    "href": "api/Stride.Navigation.NavigationComponent.html",
    "title": "Class NavigationComponent | Stride API",
    "summary": "Class NavigationComponent Namespace Stride.Navigation Assembly Stride.Navigation.dll This is used to interface with the navigation mesh. Supports TryFindPath and Raycast [DataContract(\"NavigationComponent\")] [Display(\"Navigation\", null, Expand = ExpandRule.Once)] [ComponentOrder(20000)] [DefaultEntityComponentProcessor(typeof(NavigationProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentCategory(\"Navigation\")] public class NavigationComponent : EntityComponent, IIdentifiable Inheritance object EntityComponent NavigationComponent Implements IIdentifiable Inherited Members EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties GroupId The navigation mesh group to use [DataMember(20)] [Display(\"Group\", null)] public Guid GroupId { get; set; } Property Value Guid NavigationMesh The navigation mesh which is being used. Setting this to null will load the dynamic navigation mesh for the current game (if enabled) [DataMember(10)] public NavigationMesh NavigationMesh { get; set; } Property Value NavigationMesh Methods Raycast(Vector3) Performs a raycast on the navigation mesh to perform line of sight or similar checks. Starts from the entity's current world position public NavigationRaycastResult Raycast(Vector3 end) Parameters end Vector3 Ending point Returns NavigationRaycastResult The found raycast hit if Hit is true Raycast(Vector3, Vector3) Performs a raycast on the navigation mesh to perform line of sight or similar checks. public NavigationRaycastResult Raycast(Vector3 start, Vector3 end) Parameters start Vector3 Starting point end Vector3 Ending point Returns NavigationRaycastResult The found raycast hit if Hit is true Raycast(Vector3, Vector3, NavigationQuerySettings) Performs a raycast on the navigation mesh to perform line of sight or similar checks public NavigationRaycastResult Raycast(Vector3 start, Vector3 end, NavigationQuerySettings querySettings) Parameters start Vector3 Starting point end Vector3 Ending point querySettings NavigationQuerySettings Advanced settings to be provided to the navigation mesh query Returns NavigationRaycastResult The found raycast hit if Hit is true Raycast(Vector3, NavigationQuerySettings) Performs a raycast on the navigation mesh to perform line of sight or similar checks. Starts from the entity's current world position public NavigationRaycastResult Raycast(Vector3 end, NavigationQuerySettings querySettings) Parameters end Vector3 Ending point querySettings NavigationQuerySettings Advanced settings to be provided to the navigation mesh query Returns NavigationRaycastResult The found raycast hit if Hit is true TryFindPath(Vector3, Vector3, IList<Vector3>) Finds a path from point to public bool TryFindPath(Vector3 start, Vector3 end, IList<Vector3> path) Parameters start Vector3 The starting location of the pathfinding query end Vector3 The ending location of the pathfinding query path IList<Vector3> The resulting collection of waypoints for the found path, if any (at least 2 if a path was found) Returns bool True if a valid path was found TryFindPath(Vector3, Vector3, IList<Vector3>, NavigationQuerySettings) Finds a path from point to public bool TryFindPath(Vector3 start, Vector3 end, IList<Vector3> path, NavigationQuerySettings querySettings) Parameters start Vector3 The starting location of the pathfinding query end Vector3 The ending location of the pathfinding query path IList<Vector3> The resulting collection of waypoints for the found path, if any (at least 2 if a path was found) querySettings NavigationQuerySettings Advanced settings to be provided to the navigation mesh query Returns bool True if a valid path was found TryFindPath(Vector3, IList<Vector3>) Finds a path from the entity's current location to public bool TryFindPath(Vector3 end, IList<Vector3> path) Parameters end Vector3 The ending location of the pathfinding query path IList<Vector3> The resulting collection of waypoints for the found path, if any (at least 2 if a path was found) Returns bool The found path points or null TryFindPath(Vector3, IList<Vector3>, NavigationQuerySettings) Finds a path from the entity's current location to public bool TryFindPath(Vector3 end, IList<Vector3> path, NavigationQuerySettings querySettings) Parameters end Vector3 The ending location of the pathfinding query path IList<Vector3> The resulting collection of waypoints for the found path, if any (at least 2 if a path was found) querySettings NavigationQuerySettings Advanced settings to be provided to the navigation mesh query Returns bool True if a valid path was found"
  },
  "api/Stride.Navigation.NavigationMesh.html": {
    "href": "api/Stride.Navigation.NavigationMesh.html",
    "title": "Class NavigationMesh | Stride API",
    "summary": "Class NavigationMesh Namespace Stride.Navigation Assembly Stride.Navigation.dll A Navigation Mesh, can be used for pathfinding. [DataContract(\"NavigationMesh\")] [DataSerializerGlobal(typeof(ReferenceSerializer<NavigationMesh>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] [DataSerializer(typeof(NavigationMesh.NavigationMeshSerializer))] [ContentSerializer(typeof(DataContentSerializer<NavigationMesh>))] public class NavigationMesh Inheritance object NavigationMesh Extension Methods UnsafeUtilities.As<T>(object?) Properties Layers The layers of this navigation mesh, there will be one layer for each enabled group that a navigation mesh is selected to build for [DataMember] public IReadOnlyDictionary<Guid, NavigationMeshLayer> Layers { get; } Property Value IReadOnlyDictionary<Guid, NavigationMeshLayer>"
  },
  "api/Stride.Navigation.NavigationMeshBuildResult.html": {
    "href": "api/Stride.Navigation.NavigationMeshBuildResult.html",
    "title": "Class NavigationMeshBuildResult | Stride API",
    "summary": "Class NavigationMeshBuildResult Namespace Stride.Navigation Assembly Stride.Navigation.dll The result of building a navigation mesh public class NavigationMeshBuildResult Inheritance object NavigationMeshBuildResult Extension Methods UnsafeUtilities.As<T>(object?) Fields NavigationMesh The generated navigation mesh public NavigationMesh NavigationMesh Field Value NavigationMesh Success true if the build was successful public bool Success Field Value bool UpdatedLayers List of updated layers + tiles public readonly List<NavigationMeshLayerUpdateInfo> UpdatedLayers Field Value List<NavigationMeshLayerUpdateInfo>"
  },
  "api/Stride.Navigation.NavigationMeshBuildSettings.html": {
    "href": "api/Stride.Navigation.NavigationMeshBuildSettings.html",
    "title": "Struct NavigationMeshBuildSettings | Stride API",
    "summary": "Struct NavigationMeshBuildSettings Namespace Stride.Navigation Assembly Stride.Navigation.dll Provides settings for the navigation mesh builder to control granularity and error margins [DataContract] [ObjectFactory(typeof(NavigationBuildSettingsFactory))] public struct NavigationMeshBuildSettings Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields CellHeight The Height of a grid cell in the navigation mesh building steps using heightfields. A lower number means higher precision on the vertical axis but longer build times [DataMemberRange(0.01, 4)] public float CellHeight Field Value float CellSize The Width/Height of a grid cell in the navigation mesh building steps using heightfields. A lower number means higher precision on the horizontal axes but longer build times [DataMemberRange(0.01, 4)] public float CellSize Field Value float DetailSamplingDistance Sets the sampling distance to use when generating the detail mesh. (For height detail only.) [DataMemberRange(1, 3)] public float DetailSamplingDistance Field Value float MaxDetailSamplingError The maximum distance the detail mesh surface should deviate from heightfield data. (For height detail only.) [Display(\"Maximum Detail Sampling Error\", null)] [DataMemberRange(0, 3)] public float MaxDetailSamplingError Field Value float MaxEdgeError The maximum distance a simplfied contour's border edges should deviate from the original raw contour. [Display(\"Maximum Edge Error\", null)] [DataMemberRange(0.1, 4)] public float MaxEdgeError Field Value float MaxEdgeLen The maximum allowed length for contour edges along the border of the mesh. [Display(\"Maximum Edge Length\", null)] [DataMemberRange(0, 0)] public float MaxEdgeLen Field Value float MinRegionArea The minimum number of cells allowed to form isolated island areas [Display(\"Minimum Region Area\", null)] [DataMemberRange(0, 0)] public int MinRegionArea Field Value int RegionMergeArea Any regions with a span count smaller than this value will, if possible, be merged with larger regions. [DataMemberRange(0, 0)] public int RegionMergeArea Field Value int TileSize Tile size used for Navigation mesh tiles, the final size of a tile is CellSize*TileSize [DataMemberRange(8, 4096, 1, 8, 0)] public int TileSize Field Value int Methods Equals(NavigationMeshBuildSettings) public bool Equals(NavigationMeshBuildSettings other) Parameters other NavigationMeshBuildSettings Returns bool Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance."
  },
  "api/Stride.Navigation.NavigationMeshBuildUtils.html": {
    "href": "api/Stride.Navigation.NavigationMeshBuildUtils.html",
    "title": "Class NavigationMeshBuildUtils | Stride API",
    "summary": "Class NavigationMeshBuildUtils Namespace Stride.Navigation Assembly Stride.Navigation.dll Utility function for navigation mesh building public class NavigationMeshBuildUtils Inheritance object NavigationMeshBuildUtils Extension Methods UnsafeUtilities.As<T>(object?) Methods BuildPlanePoints(ref Plane, float, out Vector3[], out int[]) Generates vertices and indices for an infinite size, limited by the parameter public static void BuildPlanePoints(ref Plane plane, float size, out Vector3[] points, out int[] inds) Parameters plane Plane size float the amount from the origin the plane points are placed points Vector3[] inds int[] CalculateTileBoundingBox(NavigationMeshBuildSettings, Point) Calculates X-Z span for a navigation mesh tile. The Y-axis will span from MinValue to MaxValue public static BoundingBox CalculateTileBoundingBox(NavigationMeshBuildSettings settings, Point tileCoord) Parameters settings NavigationMeshBuildSettings tileCoord Point Returns BoundingBox CheckColliderFilter(StaticColliderComponent, CollisionFilterGroupFlags) Checks if a static collider passes the given filter group public static bool CheckColliderFilter(StaticColliderComponent collider, CollisionFilterGroupFlags includedCollisionGroups) Parameters collider StaticColliderComponent The collider to check includedCollisionGroups CollisionFilterGroupFlags The collision filter Returns bool true if the collider passes the filter, false otherwise ExtendBoundingBox(ref BoundingBox, Vector3) Applies an offset vector to a bounding box to make it bigger or smaller public static void ExtendBoundingBox(ref BoundingBox boundingBox, Vector3 offsets) Parameters boundingBox BoundingBox offsets Vector3 GenerateTangentBinormal(Vector3, out Vector3, out Vector3) Generates a random tangent and binormal for a given normal, usefull for creating plane vertices or orienting objects (lookat) where the rotation along the normal doesn't matter public static void GenerateTangentBinormal(Vector3 normal, out Vector3 tangent, out Vector3 binormal) Parameters normal Vector3 tangent Vector3 binormal Vector3 GetOverlappingTiles(NavigationMeshBuildSettings, BoundingBox) Check which tiles overlap a given bounding box public static List<Point> GetOverlappingTiles(NavigationMeshBuildSettings settings, BoundingBox boundingBox) Parameters settings NavigationMeshBuildSettings boundingBox BoundingBox Returns List<Point> HasLatestColliderShape(StaticColliderComponent) Checks if a static collider has latest collider shape public static bool HasLatestColliderShape(StaticColliderComponent collider) Parameters collider StaticColliderComponent The collider to check Returns bool true if the collider has latest collider shape, false otherwise HashEntityCollider(StaticColliderComponent, CollisionFilterGroupFlags) Hashes and entity's transform and it's collider shape settings public static int HashEntityCollider(StaticColliderComponent collider, CollisionFilterGroupFlags includedCollisionGroups) Parameters collider StaticColliderComponent The collider to hash includedCollisionGroups CollisionFilterGroupFlags The filter group for active collides, which is used to hash if this colliders participates in the navigation mesh build Returns int SnapBoundingBoxToCellHeight(NavigationMeshBuildSettings, ref BoundingBox) Snaps a BoundingBox's height according to the given NavigationMeshBuildSettings public static void SnapBoundingBoxToCellHeight(NavigationMeshBuildSettings settings, ref BoundingBox boundingBox) Parameters settings NavigationMeshBuildSettings The build settings boundingBox BoundingBox Reference to the bounding box to snap"
  },
  "api/Stride.Navigation.NavigationMeshBuilder.html": {
    "href": "api/Stride.Navigation.NavigationMeshBuilder.html",
    "title": "Class NavigationMeshBuilder | Stride API",
    "summary": "Class NavigationMeshBuilder Namespace Stride.Navigation Assembly Stride.Navigation.dll Incremental navigation mesh builder. Builds the navigation mesh in individual tiles public class NavigationMeshBuilder Inheritance object NavigationMeshBuilder Extension Methods UnsafeUtilities.As<T>(object?) Constructors NavigationMeshBuilder(NavigationMesh) Initializes the builder, optionally with a previous navigation mesh when building incrementally public NavigationMeshBuilder(NavigationMesh oldNavigationMesh = null) Parameters oldNavigationMesh NavigationMesh The previous navigation mesh, to allow incremental builds Fields Logger The logger to send additional information to public Logger Logger Field Value Logger Methods Add(StaticColliderData) Adds information about a collider to this builder public void Add(StaticColliderData colliderData) Parameters colliderData StaticColliderData A collider data object to add Remarks You can only register a single StaticColliderComponent once Exceptions InvalidOperationException When trying to register collider data with the same StaticColliderComponent twice Build(NavigationMeshBuildSettings, ICollection<NavigationMeshGroup>, CollisionFilterGroupFlags, ICollection<BoundingBox>, CancellationToken) Performs the build of a navigation mesh public NavigationMeshBuildResult Build(NavigationMeshBuildSettings buildSettings, ICollection<NavigationMeshGroup> groups, CollisionFilterGroupFlags includedCollisionGroups, ICollection<BoundingBox> boundingBoxes, CancellationToken cancellationToken) Parameters buildSettings NavigationMeshBuildSettings The build settings to pass to recast groups ICollection<NavigationMeshGroup> A collection of agent settings to use, this will generate a layer in the navigation mesh for every agent settings in this collection (in the same order) includedCollisionGroups CollisionFilterGroupFlags The collision groups that will affect which colliders are considered solid boundingBoxes ICollection<BoundingBox> A collection of bounding boxes to use as the region for which to generate navigation mesh tiles cancellationToken CancellationToken A cancellation token to interrupt the build process Returns NavigationMeshBuildResult The build result Remove(StaticColliderData) Removes a specific collider from the builder public void Remove(StaticColliderData colliderData) Parameters colliderData StaticColliderData The collider data object to remove"
  },
  "api/Stride.Navigation.NavigationMeshGroup.html": {
    "href": "api/Stride.Navigation.NavigationMeshGroup.html",
    "title": "Class NavigationMeshGroup | Stride API",
    "summary": "Class NavigationMeshGroup Namespace Stride.Navigation Assembly Stride.Navigation.dll A group that is used to distinguish between different agent types with it's Id used at run-time to acquire the navigation mesh for a group [DataContract] [ObjectFactory(typeof(NavigationMeshGroupFactory))] public class NavigationMeshGroup : IIdentifiable Inheritance object NavigationMeshGroup Implements IIdentifiable Extension Methods UnsafeUtilities.As<T>(object?) Fields AgentSettings Agent settings for this group [DataMember(5)] public NavigationAgentSettings AgentSettings Field Value NavigationAgentSettings Properties Id Gets the id of this instance [DataMember(-10)] [Display(null, null, Browsable = false)] public Guid Id { get; set; } Property Value Guid Name Display name [DataMember(0)] public string Name { get; set; } Property Value string Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Navigation.NavigationMeshGroupFactory.html": {
    "href": "api/Stride.Navigation.NavigationMeshGroupFactory.html",
    "title": "Class NavigationMeshGroupFactory | Stride API",
    "summary": "Class NavigationMeshGroupFactory Namespace Stride.Navigation Assembly Stride.Navigation.dll public class NavigationMeshGroupFactory : IObjectFactory Inheritance object NavigationMeshGroupFactory Implements IObjectFactory Extension Methods UnsafeUtilities.As<T>(object?) Methods New(Type) Creates a new instance of a type. public object New(Type type) Parameters type Type The type of the instance to create. Returns object A new default instance of a type."
  },
  "api/Stride.Navigation.NavigationMeshLayer.html": {
    "href": "api/Stride.Navigation.NavigationMeshLayer.html",
    "title": "Class NavigationMeshLayer | Stride API",
    "summary": "Class NavigationMeshLayer Namespace Stride.Navigation Assembly Stride.Navigation.dll Layer containing built tiles for a single NavigationAgentSettings [DataSerializer(typeof(NavigationMeshLayer.NavigationMeshLayerSerializer))] [ContentSerializer(typeof(DataContentSerializer<NavigationMesh>))] public class NavigationMeshLayer Inheritance object NavigationMeshLayer Extension Methods UnsafeUtilities.As<T>(object?) Properties Tiles Contains all the built tiles mapped to their tile coordinates public IReadOnlyDictionary<Point, NavigationMeshTile> Tiles { get; } Property Value IReadOnlyDictionary<Point, NavigationMeshTile> Methods FindTile(Point) Tries to find a built tile inside this layer public NavigationMeshTile FindTile(Point tileCoordinate) Parameters tileCoordinate Point The coordinate of the tile Returns NavigationMeshTile The found tile or null"
  },
  "api/Stride.Navigation.NavigationMeshLayerUpdateInfo.html": {
    "href": "api/Stride.Navigation.NavigationMeshLayerUpdateInfo.html",
    "title": "Class NavigationMeshLayerUpdateInfo | Stride API",
    "summary": "Class NavigationMeshLayerUpdateInfo Namespace Stride.Navigation Assembly Stride.Navigation.dll Information about what tiles changes after building a navigation mesh public class NavigationMeshLayerUpdateInfo Inheritance object NavigationMeshLayerUpdateInfo Extension Methods UnsafeUtilities.As<T>(object?) Fields GroupId The id of the group public Guid GroupId Field Value Guid UpdatedTiles Coordinates of the tiles that were updated public List<Point> UpdatedTiles Field Value List<Point>"
  },
  "api/Stride.Navigation.NavigationMeshTile.html": {
    "href": "api/Stride.Navigation.NavigationMeshTile.html",
    "title": "Class NavigationMeshTile | Stride API",
    "summary": "Class NavigationMeshTile Namespace Stride.Navigation Assembly Stride.Navigation.dll Tiles contained within NavigationMeshLayer [DataContract(\"NavigationMeshTile\")] [DataSerializer(typeof(NavigationMeshTile.NavigationMeshTileSerializer))] public class NavigationMeshTile Inheritance object NavigationMeshTile Extension Methods UnsafeUtilities.As<T>(object?) Fields Data Binary data of the built navigation mesh tile public DtMeshData Data Field Value DtMeshData"
  },
  "api/Stride.Navigation.NavigationMeshUpdatedEventArgs.html": {
    "href": "api/Stride.Navigation.NavigationMeshUpdatedEventArgs.html",
    "title": "Class NavigationMeshUpdatedEventArgs | Stride API",
    "summary": "Class NavigationMeshUpdatedEventArgs Namespace Stride.Navigation Assembly Stride.Navigation.dll public class NavigationMeshUpdatedEventArgs : EventArgs Inheritance object EventArgs NavigationMeshUpdatedEventArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Fields BuildResult public NavigationMeshBuildResult BuildResult Field Value NavigationMeshBuildResult OldNavigationMesh public NavigationMesh OldNavigationMesh Field Value NavigationMesh"
  },
  "api/Stride.Navigation.NavigationQuerySettings.html": {
    "href": "api/Stride.Navigation.NavigationQuerySettings.html",
    "title": "Struct NavigationQuerySettings | Stride API",
    "summary": "Struct NavigationQuerySettings Namespace Stride.Navigation Assembly Stride.Navigation.dll Provides advanced settings to be passed to navigation mesh queries public struct NavigationQuerySettings Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Default The default settings that are used when querying navigation meshes public static readonly NavigationQuerySettings Default Field Value NavigationQuerySettings FindNearestPolyExtent Used as the extend for the find nearest poly bounding box used when scanning for a polygon corresponding to the given starting/ending position. Making this bigger will allow you to find paths that allow the entity to start further away or higher from the navigation mesh bounds for example public Vector3 FindNearestPolyExtent Field Value Vector3 MaxPathPoints The maximum number of path points used internally and also the maximum number of output points public int MaxPathPoints Field Value int"
  },
  "api/Stride.Navigation.NavigationRaycastResult.html": {
    "href": "api/Stride.Navigation.NavigationRaycastResult.html",
    "title": "Struct NavigationRaycastResult | Stride API",
    "summary": "Struct NavigationRaycastResult Namespace Stride.Navigation Assembly Stride.Navigation.dll Result for a raycast query on a navigation mesh public struct NavigationRaycastResult Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Hit true if the raycast hit something public bool Hit Field Value bool Normal Normal of the non-walkable area boundary that was hit public Vector3 Normal Field Value Vector3 Position Position where the ray hit a non-walkable area boundary public Vector3 Position Field Value Vector3"
  },
  "api/Stride.Navigation.NavigationSettings.html": {
    "href": "api/Stride.Navigation.NavigationSettings.html",
    "title": "Class NavigationSettings | Stride API",
    "summary": "Class NavigationSettings Namespace Stride.Navigation Assembly Stride.Navigation.dll Settings for the dynamic navigation mesh builder (DynamicNavigationMeshSystem) [DataContract] [Display(\"Navigation\", null)] [ObjectFactory(typeof(NavigationSettingsFactory))] [CategoryOrder(0, \"Dynamic navigation mesh\", Expand = ExpandRule.Never)] public class NavigationSettings : Configuration Inheritance object Configuration NavigationSettings Inherited Members Configuration.OfflineOnly Extension Methods NavigationSettingsExtensions.ComputeGroupsHash(NavigationSettings) UnsafeUtilities.As<T>(object?) Fields Groups Settings for agents used with the dynamic navigation mesh [DataMember(30)] public List<NavigationMeshGroup> Groups Field Value List<NavigationMeshGroup> Properties BuildSettings Build settings used by Recast [DataMember(20)] [Display(null, \"Dynamic navigation mesh\")] public NavigationMeshBuildSettings BuildSettings { get; set; } Property Value NavigationMeshBuildSettings EnableDynamicNavigationMesh If set to true, navigation meshes will be built at runtime. This allows for scene streaming and dynamic obstacles [DataMember(0)] [Display(\"Enabled\", \"Dynamic navigation mesh\")] public bool EnableDynamicNavigationMesh { get; set; } Property Value bool IncludedCollisionGroups Collision filter that indicates which colliders are used in navmesh generation [DataMember(10)] [Display(null, \"Dynamic navigation mesh\")] public CollisionFilterGroupFlags IncludedCollisionGroups { get; set; } Property Value CollisionFilterGroupFlags"
  },
  "api/Stride.Navigation.NavigationSettingsExtensions.html": {
    "href": "api/Stride.Navigation.NavigationSettingsExtensions.html",
    "title": "Class NavigationSettingsExtensions | Stride API",
    "summary": "Class NavigationSettingsExtensions Namespace Stride.Navigation Assembly Stride.Navigation.dll public static class NavigationSettingsExtensions Inheritance object NavigationSettingsExtensions Methods ComputeGroupsHash(NavigationSettings) Computes the hash of the Groups field public static ObjectId ComputeGroupsHash(this NavigationSettings settings) Parameters settings NavigationSettings Returns ObjectId"
  },
  "api/Stride.Navigation.NavigationSettingsFactory.html": {
    "href": "api/Stride.Navigation.NavigationSettingsFactory.html",
    "title": "Class NavigationSettingsFactory | Stride API",
    "summary": "Class NavigationSettingsFactory Namespace Stride.Navigation Assembly Stride.Navigation.dll public class NavigationSettingsFactory : IObjectFactory Inheritance object NavigationSettingsFactory Implements IObjectFactory Extension Methods UnsafeUtilities.As<T>(object?) Methods New(Type) Creates a new instance of a type. public object New(Type type) Parameters type Type The type of the instance to create. Returns object A new default instance of a type."
  },
  "api/Stride.Navigation.Processors.NavigationProcessor.AssociatedData.html": {
    "href": "api/Stride.Navigation.Processors.NavigationProcessor.AssociatedData.html",
    "title": "Class NavigationProcessor.AssociatedData | Stride API",
    "summary": "Class NavigationProcessor.AssociatedData Namespace Stride.Navigation.Processors Assembly Stride.Navigation.dll Associated data for navigation mesh components public class NavigationProcessor.AssociatedData Inheritance object NavigationProcessor.AssociatedData Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Navigation.Processors.NavigationProcessor.html": {
    "href": "api/Stride.Navigation.Processors.NavigationProcessor.html",
    "title": "Class NavigationProcessor | Stride API",
    "summary": "Class NavigationProcessor Namespace Stride.Navigation.Processors Assembly Stride.Navigation.dll Manages the loading of the native side navigation meshes. Will only load one version of the navigation mesh if it is referenced by multiple components public class NavigationProcessor : EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData> Inheritance object EntityProcessor EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData> NavigationProcessor Inherited Members EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData>.ComponentDatas EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData>.OnSystemAdd() EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData>.OnSystemRemove() EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData>.RemoveAllEntities() EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData>.GenerateComponentData(Entity, NavigationComponent) EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData>.IsAssociatedDataValid(Entity, NavigationComponent, NavigationProcessor.AssociatedData) EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData>.OnEntityComponentAdding(Entity, NavigationComponent, NavigationProcessor.AssociatedData) EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData>.OnEntityComponentRemoved(Entity, NavigationComponent, NavigationProcessor.AssociatedData) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Draw(RenderContext) EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Methods GenerateComponentData(Entity, NavigationComponent) Generates associated data to the given entity. protected override NavigationProcessor.AssociatedData GenerateComponentData(Entity entity, NavigationComponent component) Parameters entity Entity The entity. component NavigationComponent Returns NavigationProcessor.AssociatedData The associated data. IsAssociatedDataValid(Entity, NavigationComponent, AssociatedData) Checks if the current associated data is valid, or if readding the entity is required. protected override bool IsAssociatedDataValid(Entity entity, NavigationComponent component, NavigationProcessor.AssociatedData associatedData) Parameters entity Entity The entity. component NavigationComponent associatedData NavigationProcessor.AssociatedData The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise. OnEntityComponentAdding(Entity, NavigationComponent, AssociatedData) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, NavigationComponent component, NavigationProcessor.AssociatedData data) Parameters entity Entity The entity. component NavigationComponent data NavigationProcessor.AssociatedData The associated data. OnEntityComponentRemoved(Entity, NavigationComponent, AssociatedData) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, NavigationComponent component, NavigationProcessor.AssociatedData data) Parameters entity Entity The entity. component NavigationComponent data NavigationProcessor.AssociatedData The associated data. OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd() OnSystemRemove() Run when this EntityProcessor is removed from an EntityManager. protected override void OnSystemRemove() Update(GameTime) Performs work related to this processor. public override void Update(GameTime time) Parameters time GameTime"
  },
  "api/Stride.Navigation.Processors.RecastNavigationMesh.html": {
    "href": "api/Stride.Navigation.Processors.RecastNavigationMesh.html",
    "title": "Class RecastNavigationMesh | Stride API",
    "summary": "Class RecastNavigationMesh Namespace Stride.Navigation.Processors Assembly Stride.Navigation.dll Recast native navigation mesh wrapper public class RecastNavigationMesh Inheritance object RecastNavigationMesh Extension Methods UnsafeUtilities.As<T>(object?) Constructors RecastNavigationMesh(NavigationMesh) Recast native navigation mesh wrapper public RecastNavigationMesh(NavigationMesh navigationMesh) Parameters navigationMesh NavigationMesh Methods AddOrReplaceTile(DtMeshData) Adds or replaces a tile in the navigation mesh public bool AddOrReplaceTile(DtMeshData data) Parameters data DtMeshData Returns bool Remarks The coordinate of the tile is embedded inside the tile data header Raycast(Vector3, Vector3, NavigationQuerySettings) Performs a raycast on the navigation mesh to perform line of sight or similar checks public NavigationRaycastResult Raycast(Vector3 start, Vector3 end, NavigationQuerySettings querySettings) Parameters start Vector3 Starting point end Vector3 Ending point querySettings NavigationQuerySettings Advanced settings to be provided to the navigation mesh query Returns NavigationRaycastResult The found raycast hit if Hit is true RemoveTile(Point) Removes a tile at given coordinate public bool RemoveTile(Point coord) Parameters coord Point The tile coordinate Returns bool TryFindPath(Vector3, Vector3, ICollection<Vector3>, NavigationQuerySettings) Finds a path from point to public bool TryFindPath(Vector3 start, Vector3 end, ICollection<Vector3> path, NavigationQuerySettings querySettings) Parameters start Vector3 The starting location of the pathfinding query end Vector3 The ending location of the pathfinding query path ICollection<Vector3> The waypoints for the found path, if any (at least 2 if a path was found) querySettings NavigationQuerySettings Advanced settings to be provided to the navigation mesh query Returns bool The found path points or null"
  },
  "api/Stride.Navigation.Processors.html": {
    "href": "api/Stride.Navigation.Processors.html",
    "title": "Namespace Stride.Navigation.Processors | Stride API",
    "summary": "Namespace Stride.Navigation.Processors Classes NavigationProcessor Manages the loading of the native side navigation meshes. Will only load one version of the navigation mesh if it is referenced by multiple components NavigationProcessor.AssociatedData Associated data for navigation mesh components RecastNavigationMesh Recast native navigation mesh wrapper"
  },
  "api/Stride.Navigation.StaticColliderData.html": {
    "href": "api/Stride.Navigation.StaticColliderData.html",
    "title": "Class StaticColliderData | Stride API",
    "summary": "Class StaticColliderData Namespace Stride.Navigation Assembly Stride.Navigation.dll Data associated with static colliders for incremental building of navigation meshes public class StaticColliderData Inheritance object StaticColliderData Extension Methods UnsafeUtilities.As<T>(object?) Fields Component public StaticColliderComponent Component Field Value StaticColliderComponent"
  },
  "api/Stride.Navigation.html": {
    "href": "api/Stride.Navigation.html",
    "title": "Namespace Stride.Navigation | Stride API",
    "summary": "Namespace Stride.Navigation Classes DynamicNavigationMeshSystem System that handles building of navigation meshes at runtime NavigationAgentSettings Navigation agent NavigationAgentSettingsFactory NavigationBoundingBoxComponent A three dimensional bounding box using the scale of the owning entity as the box extent. This is used to limit the area in which navigation meshes are generated NavigationBuildSettingsFactory NavigationComponent This is used to interface with the navigation mesh. Supports TryFindPath and Raycast NavigationMesh A Navigation Mesh, can be used for pathfinding. NavigationMeshBuildResult The result of building a navigation mesh NavigationMeshBuildUtils Utility function for navigation mesh building NavigationMeshBuilder Incremental navigation mesh builder. Builds the navigation mesh in individual tiles NavigationMeshGroup A group that is used to distinguish between different agent types with it's Id used at run-time to acquire the navigation mesh for a group NavigationMeshGroupFactory NavigationMeshLayer Layer containing built tiles for a single NavigationAgentSettings NavigationMeshLayerUpdateInfo Information about what tiles changes after building a navigation mesh NavigationMeshTile Tiles contained within NavigationMeshLayer NavigationMeshUpdatedEventArgs NavigationSettings Settings for the dynamic navigation mesh builder (DynamicNavigationMeshSystem) NavigationSettingsExtensions NavigationSettingsFactory StaticColliderData Data associated with static colliders for incremental building of navigation meshes Structs NavigationMeshBuildSettings Provides settings for the navigation mesh builder to control granularity and error margins NavigationQuerySettings Provides advanced settings to be passed to navigation mesh queries NavigationRaycastResult Result for a raycast query on a navigation mesh"
  },
  "api/Stride.Particles.BoundingShapes.BoundingBoxStatic.html": {
    "href": "api/Stride.Particles.BoundingShapes.BoundingBoxStatic.html",
    "title": "Class BoundingBoxStatic | Stride API",
    "summary": "Class BoundingBoxStatic Namespace Stride.Particles.BoundingShapes Assembly Stride.Particles.dll [DataContract(\"BoundingBoxStatic\")] [Display(\"Rotated AABB\", null)] public class BoundingBoxStatic : BoundingShape Inheritance object BoundingShape BoundingBoxStatic Inherited Members BoundingShape.Dirty BoundingShape.DebugDraw Extension Methods UnsafeUtilities.As<T>(object?) Properties Maximum Upper corner of the AABB [DataMember(40)] [Display(\"Upper corner\", null)] public Vector3 Maximum { get; set; } Property Value Vector3 Minimum Lower corner of the AABB [DataMember(20)] [Display(\"Lower corner\", null)] public Vector3 Minimum { get; set; } Property Value Vector3 Methods GetAABB(Vector3, Quaternion, float) public override BoundingBox GetAABB(Vector3 translation, Quaternion rotation, float scale) Parameters translation Vector3 rotation Quaternion scale float Returns BoundingBox TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) public override bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale) Parameters debugDrawShape DebugDrawShape translation Vector3 rotation Quaternion scale Vector3 Returns bool"
  },
  "api/Stride.Particles.BoundingShapes.BoundingShape.html": {
    "href": "api/Stride.Particles.BoundingShapes.BoundingShape.html",
    "title": "Class BoundingShape | Stride API",
    "summary": "Class BoundingShape Namespace Stride.Particles.BoundingShapes Assembly Stride.Particles.dll [DataContract(\"BoundingShape\")] public abstract class BoundingShape Inheritance object BoundingShape Derived BoundingBoxStatic BoundingSphereStatic Extension Methods UnsafeUtilities.As<T>(object?) Properties DebugDraw Should the Bounding shape's bounds be displayed as a debug draw [DataMember(-1)] public bool DebugDraw { get; set; } Property Value bool Dirty public bool Dirty { get; set; } Property Value bool Methods GetAABB(Vector3, Quaternion, float) public abstract BoundingBox GetAABB(Vector3 translation, Quaternion rotation, float scale) Parameters translation Vector3 rotation Quaternion scale float Returns BoundingBox TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) public virtual bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale) Parameters debugDrawShape DebugDrawShape translation Vector3 rotation Quaternion scale Vector3 Returns bool"
  },
  "api/Stride.Particles.BoundingShapes.BoundingSphereStatic.html": {
    "href": "api/Stride.Particles.BoundingShapes.BoundingSphereStatic.html",
    "title": "Class BoundingSphereStatic | Stride API",
    "summary": "Class BoundingSphereStatic Namespace Stride.Particles.BoundingShapes Assembly Stride.Particles.dll [DataContract(\"BoundingSpheretatic\")] [Display(\"Uniform AABB\", null)] public class BoundingSphereStatic : BoundingShape Inheritance object BoundingShape BoundingSphereStatic Inherited Members BoundingShape.Dirty BoundingShape.DebugDraw Extension Methods UnsafeUtilities.As<T>(object?) Properties Radius Fixed radius of the BoundingSphereStatic [DataMember(20)] [Display(\"Distance\", null)] public float Radius { get; set; } Property Value float Methods GetAABB(Vector3, Quaternion, float) public override BoundingBox GetAABB(Vector3 translation, Quaternion rotation, float scale) Parameters translation Vector3 rotation Quaternion scale float Returns BoundingBox TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) public override bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale) Parameters debugDrawShape DebugDrawShape translation Vector3 rotation Quaternion scale Vector3 Returns bool"
  },
  "api/Stride.Particles.BoundingShapes.html": {
    "href": "api/Stride.Particles.BoundingShapes.html",
    "title": "Namespace Stride.Particles.BoundingShapes | Stride API",
    "summary": "Namespace Stride.Particles.BoundingShapes Classes BoundingBoxStatic BoundingShape BoundingSphereStatic"
  },
  "api/Stride.Particles.Components.ParticleSystemComponent.html": {
    "href": "api/Stride.Particles.Components.ParticleSystemComponent.html",
    "title": "Class ParticleSystemComponent | Stride API",
    "summary": "Class ParticleSystemComponent Namespace Stride.Particles.Components Assembly Stride.Particles.dll Add a ParticleSystem to an Entity [DataContract(\"ParticleSystemComponent\")] [Display(\"Particle system\", null, Expand = ExpandRule.Once)] [DefaultEntityComponentProcessor(typeof(ParticleSystemSimulationProcessor))] [DefaultEntityComponentRenderer(typeof(ParticleSystemRenderProcessor))] [ComponentOrder(10200)] [ComponentCategory(\"Particles\")] public sealed class ParticleSystemComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent ParticleSystemComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleSystemComponent() public ParticleSystemComponent() Fields Color The color shade will be applied to all particles (via their materials) during rendering. The shade acts as a color scale multiplication, making the color darker. White shade is neutral. [DataMember(4)] [Display(\"Color shade\", null)] public Color4 Color Field Value Color4 Control [DataMember(1)] [Display(\"Editor control\", null)] public ParticleSystemControl Control Field Value ParticleSystemControl Properties ParticleSystem The particle system associated with this component [DataMember(10)] [Display(\"Source\", null)] public ParticleSystem ParticleSystem { get; } Property Value ParticleSystem RenderGroup The render group for this component. [DataMember(50)] [Display(\"Render group\", null)] public RenderGroup RenderGroup { get; set; } Property Value RenderGroup Speed The speed scale at which the particle simulation runs. Increasing the scale increases the simulation speed, while setting it to 0 effectively pauses the simulation. [DataMember(5)] [DataMemberRange(0, 10, 0.01, 1, 3)] [Display(\"Speed scale\", null)] public float Speed { get; set; } Property Value float Methods ~ParticleSystemComponent() protected ~ParticleSystemComponent()"
  },
  "api/Stride.Particles.Components.ParticleSystemControl.html": {
    "href": "api/Stride.Particles.Components.ParticleSystemControl.html",
    "title": "Class ParticleSystemControl | Stride API",
    "summary": "Class ParticleSystemControl Namespace Stride.Particles.Components Assembly Stride.Particles.dll Edit-time controls for the ParticleSystemComponent [DataContract(\"ParticleSystemControl\")] public class ParticleSystemControl Inheritance object ParticleSystemControl Extension Methods UnsafeUtilities.As<T>(object?) Properties Control State control used to Play, Pause or Stop the ParticleSystem [DataMember(30)] public StateControl Control { get; set; } Property Value StateControl ResetSeconds Resets the ParticleSystem every X seconds, starting the simulation over again. Setting it to 0 means the particle system won't be resetted [DataMember(20)] [Display(\"Reset after (seconds)\", null)] public float ResetSeconds { get; set; } Property Value float ThumbnailWarmupTime Warm-up time is the amount of time the system should spend in background pre-simulation when capturing the thumbnail [DataMember(40)] [Display(\"Thumbnail Warm-up\", null)] [DataMemberRange(0, 5, 0.01, 1, 3)] public float ThumbnailWarmupTime { get; set; } Property Value float Methods Update(float, ParticleSystem) Update the control with delta time. It will pause or restart the ParticleSystem if necessary public void Update(float dt, ParticleSystem particleSystem) Parameters dt float Delta time elapsed since the last update call particleSystem ParticleSystem The ParticleSystem which this control should manage"
  },
  "api/Stride.Particles.Components.StateControl.html": {
    "href": "api/Stride.Particles.Components.StateControl.html",
    "title": "Enum StateControl | Stride API",
    "summary": "Enum StateControl Namespace Stride.Particles.Components Assembly Stride.Particles.dll State control for the particle system [DataContract] public enum StateControl Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Pause = 1 The state is active, but currently not playing (paused) Play = 0 The state is active and currently playing Stop = 2 The state is inactive"
  },
  "api/Stride.Particles.Components.html": {
    "href": "api/Stride.Particles.Components.html",
    "title": "Namespace Stride.Particles.Components | Stride API",
    "summary": "Namespace Stride.Particles.Components Classes ParticleSystemComponent Add a ParticleSystem to an Entity ParticleSystemControl Edit-time controls for the ParticleSystemComponent Enums StateControl State control for the particle system"
  },
  "api/Stride.Particles.DebugDraw.DebugDrawShape.html": {
    "href": "api/Stride.Particles.DebugDraw.DebugDrawShape.html",
    "title": "Enum DebugDrawShape | Stride API",
    "summary": "Enum DebugDrawShape Namespace Stride.Particles.DebugDraw Assembly Stride.Particles.dll public enum DebugDrawShape Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Cone = 3 Cube = 2 Cylinder = 4 None = 0 Sphere = 1 Torus = 5"
  },
  "api/Stride.Particles.DebugDraw.html": {
    "href": "api/Stride.Particles.DebugDraw.html",
    "title": "Namespace Stride.Particles.DebugDraw | Stride API",
    "summary": "Namespace Stride.Particles.DebugDraw Enums DebugDrawShape"
  },
  "api/Stride.Particles.EmitterRandomSeedMethod.html": {
    "href": "api/Stride.Particles.EmitterRandomSeedMethod.html",
    "title": "Enum EmitterRandomSeedMethod | Stride API",
    "summary": "Enum EmitterRandomSeedMethod Namespace Stride.Particles Assembly Stride.Particles.dll public enum EmitterRandomSeedMethod : byte Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Fixed = 1 Position = 2 Time = 0"
  },
  "api/Stride.Particles.EmitterSimulationSpace.html": {
    "href": "api/Stride.Particles.EmitterSimulationSpace.html",
    "title": "Enum EmitterSimulationSpace | Stride API",
    "summary": "Enum EmitterSimulationSpace Namespace Stride.Particles Assembly Stride.Particles.dll public enum EmitterSimulationSpace : byte Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Local = 1 World = 0"
  },
  "api/Stride.Particles.EmitterSortingPolicy.html": {
    "href": "api/Stride.Particles.EmitterSortingPolicy.html",
    "title": "Enum EmitterSortingPolicy | Stride API",
    "summary": "Enum EmitterSortingPolicy Namespace Stride.Particles Assembly Stride.Particles.dll public enum EmitterSortingPolicy : byte Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ByAge = 2 ByDepth = 1 ByOrder = 3 None = 0"
  },
  "api/Stride.Particles.Initializers.Initial3DRotationSeed.html": {
    "href": "api/Stride.Particles.Initializers.Initial3DRotationSeed.html",
    "title": "Class Initial3DRotationSeed | Stride API",
    "summary": "Class Initial3DRotationSeed Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll [DataContract(\"Initial3DRotationSeed\")] [Display(\"3D Orientation\", null)] public class Initial3DRotationSeed : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer Initial3DRotationSeed Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors Initial3DRotationSeed() public Initial3DRotationSeed() Properties RotationQuaternionMax The second orientation to interpolate to [DataMember(40)] [Display(\"Orientation B\", null)] public Quaternion RotationQuaternionMax { get; set; } Property Value Quaternion RotationQuaternionMin The first orientation to interpolate from [DataMember(30)] [Display(\"Orientation A\", null)] public Quaternion RotationQuaternionMin { get; set; } Property Value Quaternion SeedOffset The seed offset used to match or separate random values [DataMember(8)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx)"
  },
  "api/Stride.Particles.Initializers.InitialColorParent.html": {
    "href": "api/Stride.Particles.Initializers.InitialColorParent.html",
    "title": "Class InitialColorParent | Stride API",
    "summary": "Class InitialColorParent Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll The InitialColorParent is an initializer which sets the particle's initial color based on a followed (parent) particle's color [DataContract(\"InitialColorParent\")] [Display(\"Color (parent)\", null)] public class InitialColorParent : ParticleChildInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer ParticleChildInitializer InitialColorParent Inherited Members ParticleChildInitializer.Parent ParticleChildInitializer.ParentName ParticleChildInitializer.ParentSeedOffset ParticleChildInitializer.ParentControlFlag ParticleChildInitializer.GetSpawnControlField() ParticleChildInitializer.SetParentTRS(ParticleTransform, ParticleSystem) ParticleChildInitializer.InvalidateRelations() ParticleChildInitializer.RemoveControlGroup() ParticleChildInitializer.AddControlGroup() ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialColorParent() Default constructor which also registers the fields required by this updater public InitialColorParent() Properties ColorMax The second color to interpolate to [DataMember(40)] [Display(\"Color B\", null)] public Color4 ColorMax { get; set; } Property Value Color4 ColorMin The first color to interpolate from [DataMember(30)] [Display(\"Color A\", null)] public Color4 ColorMin { get; set; } Property Value Color4 SeedOffset The seed offset used to match or separate random values [DataMember(20)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx)"
  },
  "api/Stride.Particles.Initializers.InitialColorSeed.html": {
    "href": "api/Stride.Particles.Initializers.InitialColorSeed.html",
    "title": "Class InitialColorSeed | Stride API",
    "summary": "Class InitialColorSeed Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll [DataContract(\"InitialColorSeed\")] [Display(\"Color\", null)] public class InitialColorSeed : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer InitialColorSeed Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialColorSeed() public InitialColorSeed() Properties ColorMax The second color to interpolate to [DataMember(40)] [Display(\"Color B\", null)] public Color4 ColorMax { get; set; } Property Value Color4 ColorMin The first color to interpolate from [DataMember(30)] [Display(\"Color A\", null)] public Color4 ColorMin { get; set; } Property Value Color4 SeedOffset The seed offset used to match or separate random values [DataMember(8)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx)"
  },
  "api/Stride.Particles.Initializers.InitialDefaultFields.html": {
    "href": "api/Stride.Particles.Initializers.InitialDefaultFields.html",
    "title": "Class InitialDefaultFields | Stride API",
    "summary": "Class InitialDefaultFields Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll This initializer sets each field to its default value in case a custom initializer is not present. public class InitialDefaultFields Inheritance object InitialDefaultFields Extension Methods UnsafeUtilities.As<T>(object?) Properties WorldPosition public Vector3 WorldPosition { get; } Property Value Vector3 WorldRotation public Quaternion WorldRotation { get; } Property Value Quaternion WorldScale public float WorldScale { get; } Property Value float Methods Initialize(ParticlePool, int, int, int) public void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool startIdx int endIdx int maxCapacity int SetParentTRS(ref Vector3, ref Quaternion, float) public void SetParentTRS(ref Vector3 translation, ref Quaternion rotation, float scale) Parameters translation Vector3 rotation Quaternion scale float"
  },
  "api/Stride.Particles.Initializers.InitialDirectionSeed.html": {
    "href": "api/Stride.Particles.Initializers.InitialDirectionSeed.html",
    "title": "Class InitialDirectionSeed | Stride API",
    "summary": "Class InitialDirectionSeed Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll Initializer which sets the initial velocity for particles based on RandomSeed information [DataContract(\"InitialDirectionSeed\")] [Display(\"Direction\", null)] public class InitialDirectionSeed : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer InitialDirectionSeed Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialDirectionSeed() public InitialDirectionSeed() Properties DebugDraw Should this Particle Module's bounds be displayed as a debug draw [DataMember(-1)] public bool DebugDraw { get; set; } Property Value bool DirectionMax Upper direction value [DataMember(40)] [Display(\"Direction max\", null)] public Vector3 DirectionMax { get; set; } Property Value Vector3 DirectionMin Lower direction value [DataMember(30)] [Display(\"Direction min\", null)] public Vector3 DirectionMin { get; set; } Property Value Vector3 SeedOffset The seed offset used to match or separate random values [DataMember(8)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx) TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) Attepmts to get a debug shape (shape type and location matrix) for the current module in order to display its boundaries better public override bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale) Parameters debugDrawShape DebugDrawShape Type of the debug draw shape translation Vector3 Translation of the shape rotation Quaternion Rotation of the shape scale Vector3 Scaling of the shape Returns bool"
  },
  "api/Stride.Particles.Initializers.InitialOrderParent.html": {
    "href": "api/Stride.Particles.Initializers.InitialOrderParent.html",
    "title": "Class InitialOrderParent | Stride API",
    "summary": "Class InitialOrderParent Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll The InitialOrderParent is an initializer which sets the particle's spawn order based on a followed (parent) particle's order [DataContract(\"InitialOrderParent\")] [Display(\"Spawn Order (parent)\", null)] public class InitialOrderParent : ParticleChildInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer ParticleChildInitializer InitialOrderParent Inherited Members ParticleChildInitializer.Parent ParticleChildInitializer.ParentName ParticleChildInitializer.ParentSeedOffset ParticleChildInitializer.ParentControlFlag ParticleChildInitializer.GetSpawnControlField() ParticleChildInitializer.SetParentTRS(ParticleTransform, ParticleSystem) ParticleChildInitializer.InvalidateRelations() ParticleModule.Enabled ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialOrderParent() Default constructor which also registers the fields required by this updater public InitialOrderParent() Methods AddControlGroup() Adds the required control group field to the parent emitter's pool protected override void AddControlGroup() Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx) RemoveControlGroup() Removes the old required control group field from the parent emitter's pool protected override void RemoveControlGroup() ResetSimulation() Resets the current state to the module's initial state public override void ResetSimulation()"
  },
  "api/Stride.Particles.Initializers.InitialPositionArc.html": {
    "href": "api/Stride.Particles.Initializers.InitialPositionArc.html",
    "title": "Class InitialPositionArc | Stride API",
    "summary": "Class InitialPositionArc Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll The InitialPositionArc is an initializer which sets the particle's initial position along a line or an arc [DataContract(\"InitialPositionArc\")] [Display(\"Position (Arc)\", null)] public class InitialPositionArc : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer InitialPositionArc Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialPositionArc() Default constructor which also registers the fields required by this updater public InitialPositionArc() Fields ArcHeight The height of the arc in the center, which is also subject to scale and rotation if inherited [DataMember(20)] [Display(\"Arc Height\", null)] public float ArcHeight Field Value float FallbackTarget In case the Target is null, the FallbackTarget offset will be used [DataMember(12)] [Display(\"Fallback Target\", null)] public Vector3 FallbackTarget Field Value Vector3 FixedLength If positive, it will limit the number of possible positions where the particles can appear along the arc to the specified count. More particles will start appearing over from the biginning of the arc path. [DataMember(35)] [Display(\"Fixed Count\", null)] public int FixedLength Field Value int Sequential If true the particles will appear along the arc path in the order they are added. Otherwise, their positions will be random along the arc, not preserving the order of appearance. [DataMember(30)] [Display(\"Ordered\", null)] public bool Sequential Field Value bool Target An arc initializer needs a second point so that it can position the particles in a line or arc between two locators [DataMember(10)] [Display(\"Target\", null)] public TransformComponent Target Field Value TransformComponent Properties PositionMax The right upper front corner of the box [DataMember(42)] [Display(\"Position max\", null)] public Vector3 PositionMax { get; set; } Property Value Vector3 PositionMin The left bottom back corner of the box [DataMember(40)] [Display(\"Position min\", null)] public Vector3 PositionMin { get; set; } Property Value Vector3 SeedOffset The seed offset used to match or separate random values [DataMember(50)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx)"
  },
  "api/Stride.Particles.Initializers.InitialPositionParent.html": {
    "href": "api/Stride.Particles.Initializers.InitialPositionParent.html",
    "title": "Class InitialPositionParent | Stride API",
    "summary": "Class InitialPositionParent Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll The InitialPositionParent is an initializer which sets the particle's initial position at the time of spawning [DataContract(\"InitialPositionParent\")] [Display(\"Position (parent)\", null)] public class InitialPositionParent : ParticleChildInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer ParticleChildInitializer InitialPositionParent Inherited Members ParticleChildInitializer.Parent ParticleChildInitializer.ParentName ParticleChildInitializer.ParentSeedOffset ParticleChildInitializer.ParentControlFlag ParticleChildInitializer.GetSpawnControlField() ParticleChildInitializer.SetParentTRS(ParticleTransform, ParticleSystem) ParticleChildInitializer.InvalidateRelations() ParticleChildInitializer.RemoveControlGroup() ParticleChildInitializer.AddControlGroup() ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialPositionParent() Default constructor which also registers the fields required by this updater public InitialPositionParent() Properties PositionMax The right upper front corner of the box [DataMember(40)] [Display(\"Position max\", null)] public Vector3 PositionMax { get; set; } Property Value Vector3 PositionMin The left bottom back corner of the box [DataMember(30)] [Display(\"Position min\", null)] public Vector3 PositionMin { get; set; } Property Value Vector3 SeedOffset The seed offset used to match or separate random values [DataMember(20)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx)"
  },
  "api/Stride.Particles.Initializers.InitialPositionSeed.html": {
    "href": "api/Stride.Particles.Initializers.InitialPositionSeed.html",
    "title": "Class InitialPositionSeed | Stride API",
    "summary": "Class InitialPositionSeed Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll The InitialPositionSeed is an initializer which sets the particle's initial position at the time of spawning [DataContract(\"InitialPositionSeed\")] [Display(\"Position\", null)] public class InitialPositionSeed : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer InitialPositionSeed Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialPositionSeed() Default constructor which also registers the fields required by this updater public InitialPositionSeed() Fields Interpolate If set to true it will interpolate the particles between the old and the new position, rather than using only the new one [DataMember(50)] [Display(\"Interpolate\", null)] public bool Interpolate Field Value bool Properties DebugDraw Should this Particle Module's bounds be displayed as a debug draw [DataMember(-1)] public bool DebugDraw { get; set; } Property Value bool PositionMax The right upper front corner of the box [DataMember(40)] [Display(\"Position max\", null)] public Vector3 PositionMax { get; set; } Property Value Vector3 PositionMin The left bottom back corner of the box [DataMember(30)] [Display(\"Position min\", null)] public Vector3 PositionMin { get; set; } Property Value Vector3 SeedOffset The seed offset used to match or separate random values [DataMember(8)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx) TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) Attepmts to get a debug shape (shape type and location matrix) for the current module in order to display its boundaries better public override bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale) Parameters debugDrawShape DebugDrawShape Type of the debug draw shape translation Vector3 Translation of the shape rotation Quaternion Rotation of the shape scale Vector3 Scaling of the shape Returns bool"
  },
  "api/Stride.Particles.Initializers.InitialRotationSeed.html": {
    "href": "api/Stride.Particles.Initializers.InitialRotationSeed.html",
    "title": "Class InitialRotationSeed | Stride API",
    "summary": "Class InitialRotationSeed Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll The InitialRotationSeed is an initializer which sets the particle's rotation around the Z axis in clip space (camera-facing) [DataContract(\"InitialRotationSeed\")] [Display(\"Rotation\", null)] public class InitialRotationSeed : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer InitialRotationSeed Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialRotationSeed() Default constructor which also registers the fields required by this updater public InitialRotationSeed() Properties AngularRotation Angular rotation in degrees, positive value means clockwise [DataMember(30)] [Display(\"Angle (degrees) min\", null)] public Vector2 AngularRotation { get; set; } Property Value Vector2 SeedOffset The seed offset used to match or separate random values [DataMember(8)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx)"
  },
  "api/Stride.Particles.Initializers.InitialSizeParent.html": {
    "href": "api/Stride.Particles.Initializers.InitialSizeParent.html",
    "title": "Class InitialSizeParent | Stride API",
    "summary": "Class InitialSizeParent Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll The InitialSizeParent is an initializer which sets the particle's size based on a followed (parent) particle's size [DataContract(\"InitialSizeParent\")] [Display(\"Size (parent)\", null)] public class InitialSizeParent : ParticleChildInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer ParticleChildInitializer InitialSizeParent Inherited Members ParticleChildInitializer.Parent ParticleChildInitializer.ParentName ParticleChildInitializer.ParentSeedOffset ParticleChildInitializer.ParentControlFlag ParticleChildInitializer.GetSpawnControlField() ParticleChildInitializer.SetParentTRS(ParticleTransform, ParticleSystem) ParticleChildInitializer.InvalidateRelations() ParticleChildInitializer.RemoveControlGroup() ParticleChildInitializer.AddControlGroup() ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialSizeParent() Default constructor which also registers the fields required by this updater public InitialSizeParent() Properties RandomSize Minimum and maximum values for the size field [DataMember(30)] [Display(\"Random size\", null)] public Vector2 RandomSize { get; set; } Property Value Vector2 SeedOffset The seed offset used to match or separate random values [DataMember(20)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx)"
  },
  "api/Stride.Particles.Initializers.InitialSizeSeed.html": {
    "href": "api/Stride.Particles.Initializers.InitialSizeSeed.html",
    "title": "Class InitialSizeSeed | Stride API",
    "summary": "Class InitialSizeSeed Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll [DataContract(\"InitialSizeSeed\")] [Display(\"Size\", null)] public class InitialSizeSeed : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer InitialSizeSeed Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialSizeSeed() public InitialSizeSeed() Properties RandomSize Minimum and maximum values for the size field [DataMember(30)] [Display(\"Random size\", null)] public Vector2 RandomSize { get; set; } Property Value Vector2 SeedOffset The seed offset used to match or separate random values [DataMember(8)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx)"
  },
  "api/Stride.Particles.Initializers.InitialSpawnOrder.html": {
    "href": "api/Stride.Particles.Initializers.InitialSpawnOrder.html",
    "title": "Class InitialSpawnOrder | Stride API",
    "summary": "Class InitialSpawnOrder Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll The InitialSpawnOrder is an initializer which assigns all particles an increasing number based on the order of their spawning [DataContract(\"InitialSpawnOrder\")] [Display(\"Spawn Order\", null)] public class InitialSpawnOrder : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer InitialSpawnOrder Inherited Members ParticleModule.Enabled ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialSpawnOrder() Default constructor which also registers the fields required by this updater public InitialSpawnOrder() Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx) ResetSimulation() Resets the current state to the module's initial state public override void ResetSimulation()"
  },
  "api/Stride.Particles.Initializers.InitialSpawnOrderGroup.html": {
    "href": "api/Stride.Particles.Initializers.InitialSpawnOrderGroup.html",
    "title": "Class InitialSpawnOrderGroup | Stride API",
    "summary": "Class InitialSpawnOrderGroup Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll The InitialSpawnOrderGroup is an initializer which assigns all particles an increasing number based on the order of their spawning while keeping all particles spawned in the same frame in a separate spawn group (this is important for ribbons) [DataContract(\"InitialSpawnOrderGroup\")] [Display(\"Spawn Order (Group)\", null)] public class InitialSpawnOrderGroup : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer InitialSpawnOrderGroup Inherited Members ParticleModule.Enabled ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialSpawnOrderGroup() Default constructor which also registers the fields required by this updater public InitialSpawnOrderGroup() Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx) ResetSimulation() Resets the current state to the module's initial state public override void ResetSimulation()"
  },
  "api/Stride.Particles.Initializers.InitialVelocityParent.html": {
    "href": "api/Stride.Particles.Initializers.InitialVelocityParent.html",
    "title": "Class InitialVelocityParent | Stride API",
    "summary": "Class InitialVelocityParent Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll The InitialVelocityParent is an initializer which sets the particle's velocity based on a followed (parent) particle's velocity [DataContract(\"InitialVelocityParent\")] [Display(\"Velocity (parent)\", null)] public class InitialVelocityParent : ParticleChildInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer ParticleChildInitializer InitialVelocityParent Inherited Members ParticleChildInitializer.Parent ParticleChildInitializer.ParentName ParticleChildInitializer.ParentSeedOffset ParticleChildInitializer.ParentControlFlag ParticleChildInitializer.GetSpawnControlField() ParticleChildInitializer.SetParentTRS(ParticleTransform, ParticleSystem) ParticleChildInitializer.InvalidateRelations() ParticleChildInitializer.RemoveControlGroup() ParticleChildInitializer.AddControlGroup() ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialVelocityParent() Default constructor which also registers the fields required by this updater public InitialVelocityParent() Properties ParentVelocityFactor The factor (percentage) for parent's velocity inheritance [DataMember(25)] [Display(\"Velocity factor\", null)] public float ParentVelocityFactor { get; set; } Property Value float SeedOffset The seed offset used to match or separate random values [DataMember(20)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint VelocityMax The right upper front corner of the box [DataMember(40)] [Display(\"Velocity max\", null)] public Vector3 VelocityMax { get; set; } Property Value Vector3 VelocityMin The left bottom back corner of the box [DataMember(30)] [Display(\"Velocity min\", null)] public Vector3 VelocityMin { get; set; } Property Value Vector3 Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx)"
  },
  "api/Stride.Particles.Initializers.InitialVelocitySeed.html": {
    "href": "api/Stride.Particles.Initializers.InitialVelocitySeed.html",
    "title": "Class InitialVelocitySeed | Stride API",
    "summary": "Class InitialVelocitySeed Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll Initializer which sets the initial velocity for particles based on RandomSeed information [DataContract(\"InitialVelocitySeed\")] [Display(\"Velocity\", null)] public class InitialVelocitySeed : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer InitialVelocitySeed Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors InitialVelocitySeed() public InitialVelocitySeed() Properties DebugDraw Should this Particle Module's bounds be displayed as a debug draw [DataMember(-1)] public bool DebugDraw { get; set; } Property Value bool SeedOffset The seed offset used to match or separate random values [DataMember(8)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint VelocityMax Upper velocity value [DataMember(40)] [Display(\"Velocity max\", null)] public Vector3 VelocityMax { get; set; } Property Value Vector3 VelocityMin Lower velocity value [DataMember(30)] [Display(\"Velocity min\", null)] public Vector3 VelocityMin { get; set; } Property Value Vector3 Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx) TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) Attepmts to get a debug shape (shape type and location matrix) for the current module in order to display its boundaries better public override bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale) Parameters debugDrawShape DebugDrawShape Type of the debug draw shape translation Vector3 Translation of the shape rotation Quaternion Rotation of the shape scale Vector3 Scaling of the shape Returns bool"
  },
  "api/Stride.Particles.Initializers.ParticleChildInitializer.html": {
    "href": "api/Stride.Particles.Initializers.ParticleChildInitializer.html",
    "title": "Class ParticleChildInitializer | Stride API",
    "summary": "Class ParticleChildInitializer Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll Base class for initializers which reference a parent particle emitter [DataContract(\"ParticleChildInitializer\")] public abstract class ParticleChildInitializer : ParticleInitializer Inheritance object ParticleTransform ParticleModule ParticleInitializer ParticleChildInitializer Derived InitialColorParent InitialOrderParent InitialPositionParent InitialSizeParent InitialVelocityParent Inherited Members ParticleInitializer.Initialize(ParticlePool, int, int, int) ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Fields Parent Referenced parent emitter protected ParticleEmitter Parent Field Value ParticleEmitter Properties ParentControlFlag Some initializers require fine control between parent and child emitters. Use the control group to assign such meta-fields. [DataMember(13)] [Display(\"Spawn Control Group\", null)] public ParentControlFlag ParentControlFlag { get; set; } Property Value ParentControlFlag ParentName Name by which to reference a followed (parent) emitter [DataMember(11)] [Display(\"Parent emitter\", null)] public string ParentName { get; set; } Property Value string ParentSeedOffset The parent seed offset is used to determine which particle from the pool should be picked as a parent in case there is no control group [DataMember(12)] [Display(\"Parent Offset\", null)] public uint ParentSeedOffset { get; set; } Property Value uint Methods AddControlGroup() Adds the required control group field to the parent emitter's pool protected virtual void AddControlGroup() GetSpawnControlField() Gets a field accessor to the parent emitter's spawn control field, if it exists protected ParticleFieldAccessor<ParticleChildrenAttribute> GetSpawnControlField() Returns ParticleFieldAccessor<ParticleChildrenAttribute> InvalidateRelations() Invalidates relation of this emitter to any other emitters that might be referenced public override void InvalidateRelations() RemoveControlGroup() Removes the old required control group field from the parent emitter's pool protected virtual void RemoveControlGroup() SetParentTRS(ParticleTransform, ParticleSystem) Sets the parent (particle system's) translation, rotation and scale (uniform) The module can choose to inherit, use or ignore any of the elements public override void SetParentTRS(ParticleTransform transform, ParticleSystem parentSystem) Parameters transform ParticleTransform ParticleSystem's transform (from the Transform component) or identity if local space is used parentSystem ParticleSystem"
  },
  "api/Stride.Particles.Initializers.ParticleInitializer.html": {
    "href": "api/Stride.Particles.Initializers.ParticleInitializer.html",
    "title": "Class ParticleInitializer | Stride API",
    "summary": "Class ParticleInitializer Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll [DataContract(\"ParticleInitializer\")] public abstract class ParticleInitializer : ParticleModule Inheritance object ParticleTransform ParticleModule ParticleInitializer Derived Initial3DRotationSeed InitialColorSeed InitialDirectionSeed InitialPositionArc InitialPositionSeed InitialRotationSeed InitialSizeSeed InitialSpawnOrder InitialSpawnOrderGroup InitialVelocitySeed ParticleChildInitializer Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(ParticlePool, int, int, int) Override Initialize if your module acts as an Initializer and change its type to Initializer public abstract void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity) Parameters pool ParticlePool Particle pool to target startIdx int Starting index (included from the array) endIdx int End index (excluded from the array) maxCapacity int Max pool capacity (loops after this point) so that it's possible for (endIdx < startIdx)"
  },
  "api/Stride.Particles.Initializers.SpawnOrderConst.html": {
    "href": "api/Stride.Particles.Initializers.SpawnOrderConst.html",
    "title": "Class SpawnOrderConst | Stride API",
    "summary": "Class SpawnOrderConst Namespace Stride.Particles.Initializers Assembly Stride.Particles.dll Spawn order can be additionally subdivided in groups public static class SpawnOrderConst Inheritance object SpawnOrderConst Fields AuxiliaryBitMask public const uint AuxiliaryBitMask = 65535 Field Value uint GroupBitMask public const uint GroupBitMask = 4294901760 Field Value uint GroupBitOffset public const int GroupBitOffset = 16 Field Value int LargeAuxiliaryBitMask public const uint LargeAuxiliaryBitMask = 1048575 Field Value uint LargeGroupBitMask public const uint LargeGroupBitMask = 4293918720 Field Value uint LargeGroupBitOffset public const int LargeGroupBitOffset = 20 Field Value int"
  },
  "api/Stride.Particles.Initializers.html": {
    "href": "api/Stride.Particles.Initializers.html",
    "title": "Namespace Stride.Particles.Initializers | Stride API",
    "summary": "Namespace Stride.Particles.Initializers Classes Initial3DRotationSeed InitialColorParent The InitialColorParent is an initializer which sets the particle's initial color based on a followed (parent) particle's color InitialColorSeed InitialDefaultFields This initializer sets each field to its default value in case a custom initializer is not present. InitialDirectionSeed Initializer which sets the initial velocity for particles based on RandomSeed information InitialOrderParent The InitialOrderParent is an initializer which sets the particle's spawn order based on a followed (parent) particle's order InitialPositionArc The InitialPositionArc is an initializer which sets the particle's initial position along a line or an arc InitialPositionParent The InitialPositionParent is an initializer which sets the particle's initial position at the time of spawning InitialPositionSeed The InitialPositionSeed is an initializer which sets the particle's initial position at the time of spawning InitialRotationSeed The InitialRotationSeed is an initializer which sets the particle's rotation around the Z axis in clip space (camera-facing) InitialSizeParent The InitialSizeParent is an initializer which sets the particle's size based on a followed (parent) particle's size InitialSizeSeed InitialSpawnOrder The InitialSpawnOrder is an initializer which assigns all particles an increasing number based on the order of their spawning InitialSpawnOrderGroup The InitialSpawnOrderGroup is an initializer which assigns all particles an increasing number based on the order of their spawning while keeping all particles spawned in the same frame in a separate spawn group (this is important for ribbons) InitialVelocityParent The InitialVelocityParent is an initializer which sets the particle's velocity based on a followed (parent) particle's velocity InitialVelocitySeed Initializer which sets the initial velocity for particles based on RandomSeed information ParticleChildInitializer Base class for initializers which reference a parent particle emitter ParticleInitializer SpawnOrderConst Spawn order can be additionally subdivided in groups"
  },
  "api/Stride.Particles.Materials.ParticleMaterial.html": {
    "href": "api/Stride.Particles.Materials.ParticleMaterial.html",
    "title": "Class ParticleMaterial | Stride API",
    "summary": "Class ParticleMaterial Namespace Stride.Particles.Materials Assembly Stride.Particles.dll Base class for the particle materials which uses a dynamic effect compiler to generate shaders at runtime [DataContract(\"ParticleMaterial\")] public abstract class ParticleMaterial Inheritance object ParticleMaterial Derived ParticleMaterialSimple Extension Methods UnsafeUtilities.As<T>(object?) Fields Parameters public readonly ParameterCollection Parameters Field Value ParameterCollection Properties EffectName Sets the name of the effect or shader which the material will use public abstract string EffectName { get; protected set; } Property Value string HasVertexLayoutChanged Indicates if the vertex layout required by this material has changed since the last time UpdateVertexBuilder(ParticleVertexBuilder) was called public bool HasVertexLayoutChanged { get; protected set; } Property Value bool IsInitialized True if InitializeCore(RenderContext) has been called protected bool IsInitialized { get; } Property Value bool Methods ForceUpdate() Forces the material update, potentionally recreating the effect public virtual void ForceUpdate() InitializeCore(RenderContext) Initializes the core of the material, such as the shader generator and the parameter collection protected virtual void InitializeCore(RenderContext context) Parameters context RenderContext The current RenderContext PatchVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref ParticleList) Patch the particle's vertex buffer which was already built by the ShapeBuilder This involes animating hte uv coordinates and filling per-particle fields, such as the color field public virtual void PatchVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref ParticleList sortedList) Parameters bufferState ParticleBufferState The particle buffer state which is used to build the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix sortedList ParticleList PrepareVertexLayout(ParticlePoolFieldsList) Prepares the material for drawing the current frame with the current ParticleVertexBuilder and ParticleList public virtual void PrepareVertexLayout(ParticlePoolFieldsList fieldsList) Parameters fieldsList ParticlePoolFieldsList A container for the ParticlePool which can poll if a certain field exists as an attribute Setup(RenderContext) Setups the current material using the graphics device. public virtual void Setup(RenderContext context) Parameters context RenderContext SetupPipeline(RenderContext, PipelineStateDescription) Setup the pipeline state object. public virtual void SetupPipeline(RenderContext renderContext, PipelineStateDescription pipelineState) Parameters renderContext RenderContext pipelineState PipelineStateDescription UpdateVertexBuilder(ParticleVertexBuilder) Updates the required fields for this frame in the vertex buffer builder. If nothing has changed since the last frame and the vertex layout is the same, do not add any new required fields public virtual void UpdateVertexBuilder(ParticleVertexBuilder vertexBuilder) Parameters vertexBuilder ParticleVertexBuilder The target vertex buffer builder ValidateEffect(RenderContext, ref EffectValidator) public virtual void ValidateEffect(RenderContext context, ref EffectValidator effectValidator) Parameters context RenderContext effectValidator EffectValidator"
  },
  "api/Stride.Particles.Materials.ParticleMaterialComputeColor.html": {
    "href": "api/Stride.Particles.Materials.ParticleMaterialComputeColor.html",
    "title": "Class ParticleMaterialComputeColor | Stride API",
    "summary": "Class ParticleMaterialComputeColor Namespace Stride.Particles.Materials Assembly Stride.Particles.dll ParticleMaterialComputeColor uses a IComputeColor tree to calculate the pixel's emissive value [DataContract(\"ParticleMaterialComputeColor\")] [Display(\"Emissive Map\", null)] public class ParticleMaterialComputeColor : ParticleMaterialSimple Inheritance object ParticleMaterial ParticleMaterialSimple ParticleMaterialComputeColor Inherited Members ParticleMaterialSimple.AlphaAdditive ParticleMaterialSimple.ZOffset ParticleMaterialSimple.SoftEdgeDistance ParticleMaterialSimple.FaceCulling ParticleMaterialSimple.HasColorField ParticleMaterialSimple.PrepareVertexLayout(ParticlePoolFieldsList) ParticleMaterialSimple.ForceUpdate() ParticleMaterialSimple.SetupPipeline(RenderContext, PipelineStateDescription) ParticleMaterial.Parameters ParticleMaterial.IsInitialized ParticleMaterial.HasVertexLayoutChanged Extension Methods UnsafeUtilities.As<T>(object?) Properties ComputeColor IComputeColor allows several channels to be blended together, including textures, vertex streams and fixed values. Emissive Map should be allowed to be None because some particles might not need to render, but be used as parents for other particle systems [DataMember(100)] [Display(\"Emissive Map\", null)] public IComputeColor ComputeColor { get; set; } Property Value IComputeColor EffectName Sets the name of the effect or shader which the material will use public override string EffectName { get; protected set; } Property Value string ForceTexCoords Forces the creation of texture coordinates as vertex attribute [DataMember(300)] [Display(\"Force texcoords\", null)] public bool ForceTexCoords { get; set; } Property Value bool UVBuilder UVBuilder defines how the base coordinates of the particle shape should be modified for texture scrolling, animation, etc. [DataMember(200)] [Display(\"UV coords\", null)] public UVBuilder UVBuilder { get; set; } Property Value UVBuilder Methods InitializeCore(RenderContext) Initializes the core of the material, such as the shader generator and the parameter collection protected override void InitializeCore(RenderContext context) Parameters context RenderContext The current RenderContext PatchVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref ParticleList) Patch the particle's vertex buffer which was already built by the ShapeBuilder This involes animating hte uv coordinates and filling per-particle fields, such as the color field public override void PatchVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref ParticleList sorter) Parameters bufferState ParticleBufferState The particle buffer state which is used to build the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix sorter ParticleList Particle enumerator which can be iterated and returns sported particles Setup(RenderContext) Setups the current material using the graphics device. public override void Setup(RenderContext context) Parameters context RenderContext UpdateVertexBuilder(ParticleVertexBuilder) Updates the required fields for this frame in the vertex buffer builder. If nothing has changed since the last frame and the vertex layout is the same, do not add any new required fields public override void UpdateVertexBuilder(ParticleVertexBuilder vertexBuilder) Parameters vertexBuilder ParticleVertexBuilder The target vertex buffer builder ValidateEffect(RenderContext, ref EffectValidator) public override void ValidateEffect(RenderContext context, ref EffectValidator effectValidator) Parameters context RenderContext effectValidator EffectValidator"
  },
  "api/Stride.Particles.Materials.ParticleMaterialCulling.html": {
    "href": "api/Stride.Particles.Materials.ParticleMaterialCulling.html",
    "title": "Enum ParticleMaterialCulling | Stride API",
    "summary": "Enum ParticleMaterialCulling Namespace Stride.Particles.Materials Assembly Stride.Particles.dll public enum ParticleMaterialCulling : byte Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields CullBack = 1 CullFront = 2 CullNone = 0"
  },
  "api/Stride.Particles.Materials.ParticleMaterialSimple.html": {
    "href": "api/Stride.Particles.Materials.ParticleMaterialSimple.html",
    "title": "Class ParticleMaterialSimple | Stride API",
    "summary": "Class ParticleMaterialSimple Namespace Stride.Particles.Materials Assembly Stride.Particles.dll Simple base for most of the particle material classes which uses additive-alpha blending, face culling and setups the color vertex stream [DataContract(\"ParticleMaterialSimple\")] public abstract class ParticleMaterialSimple : ParticleMaterial Inheritance object ParticleMaterial ParticleMaterialSimple Derived ParticleMaterialComputeColor Inherited Members ParticleMaterial.Parameters ParticleMaterial.IsInitialized ParticleMaterial.HasVertexLayoutChanged ParticleMaterial.EffectName ParticleMaterial.UpdateVertexBuilder(ParticleVertexBuilder) ParticleMaterial.InitializeCore(RenderContext) Extension Methods UnsafeUtilities.As<T>(object?) Properties AlphaAdditive Shows if the particles should be rendered as alhpa-blended, additive or something in-between (lerp between the two methods) [DataMember(20)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Alpha-Add\", null)] public float AlphaAdditive { get; set; } Property Value float FaceCulling Allows the particle shape to be back- or front-face culled. [DataMember(40)] [Display(\"Culling\", null)] public ParticleMaterialCulling FaceCulling { get; set; } Property Value ParticleMaterialCulling HasColorField Indicates if this material requires a color field in the vertex stream protected bool HasColorField { get; } Property Value bool SoftEdgeDistance If positive, soft particle edges will be calculated with maximum distance of the value set. [DataMember(35)] [Display(\"Soft Edge\", null)] public float SoftEdgeDistance { get; set; } Property Value float ZOffset Adjusts the depth of the particle in regard to opaque objects [DataMember(30)] [Display(\"Z Offset\", null)] public float ZOffset { get; set; } Property Value float Methods ForceUpdate() Forces the material update, potentionally recreating the effect public override void ForceUpdate() PatchVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref ParticleList) Patch the particle's vertex buffer which was already built by the ShapeBuilder This involes animating hte uv coordinates and filling per-particle fields, such as the color field public override void PatchVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref ParticleList sorter) Parameters bufferState ParticleBufferState The particle buffer state which is used to build the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix sorter ParticleList Particle enumerator which can be iterated and returns sported particles PrepareVertexLayout(ParticlePoolFieldsList) Prepares the material for drawing the current frame with the current ParticleVertexBuilder and ParticleList public override void PrepareVertexLayout(ParticlePoolFieldsList fieldsList) Parameters fieldsList ParticlePoolFieldsList A container for the ParticlePool which can poll if a certain field exists as an attribute Setup(RenderContext) Setups the current material using the graphics device. public override void Setup(RenderContext context) Parameters context RenderContext SetupPipeline(RenderContext, PipelineStateDescription) Setup the pipeline state object. public override void SetupPipeline(RenderContext renderContext, PipelineStateDescription pipelineState) Parameters renderContext RenderContext pipelineState PipelineStateDescription ValidateEffect(RenderContext, ref EffectValidator) public override void ValidateEffect(RenderContext context, ref EffectValidator effectValidator) Parameters context RenderContext effectValidator EffectValidator"
  },
  "api/Stride.Particles.Materials.UVBuilder.html": {
    "href": "api/Stride.Particles.Materials.UVBuilder.html",
    "title": "Class UVBuilder | Stride API",
    "summary": "Class UVBuilder Namespace Stride.Particles.Materials Assembly Stride.Particles.dll Base class for building and animating the texture coordinates in a particle vertex buffer stream [DataContract(\"UVBuilder\")] public abstract class UVBuilder Inheritance object UVBuilder Derived UVBuilderFlipbook UVBuilderScroll Extension Methods UnsafeUtilities.As<T>(object?) Methods BuildUVCoordinates(ref ParticleBufferState, ref ParticleList, AttributeDescription) Enhances or animates the texture coordinates using already existing base coordinates of (0, 0, 1, 1) or similar (base texture coordinates may differ depending on the actual shape) public abstract void BuildUVCoordinates(ref ParticleBufferState bufferState, ref ParticleList sorter, AttributeDescription texCoordsDescription) Parameters bufferState ParticleBufferState The particle buffer state which is used to build the assigned vertex buffer sorter ParticleList ParticleList to use to iterate over all particles drawn this frame texCoordsDescription AttributeDescription Attribute description of the texture coordinates in the current vertex layout"
  },
  "api/Stride.Particles.Materials.UVBuilderFlipbook.html": {
    "href": "api/Stride.Particles.Materials.UVBuilderFlipbook.html",
    "title": "Class UVBuilderFlipbook | Stride API",
    "summary": "Class UVBuilderFlipbook Namespace Stride.Particles.Materials Assembly Stride.Particles.dll Animates the texture coordinates in a flipbook fashion, based on the particle's life The order of the frames is left to right, top to bottom The flipbook assumes uniform sizes for all frames [DataContract(\"UVBuilderFlipbook\")] [Display(\"Flipbook\", null)] public class UVBuilderFlipbook : UVBuilder, IAttributeTransformer<Vector2, Vector4> Inheritance object UVBuilder UVBuilderFlipbook Implements IAttributeTransformer<Vector2, Vector4> Extension Methods UnsafeUtilities.As<T>(object?) Properties AnimationSpeed Number of frames to change over the particle life [DataMember(320)] [Display(\"Animation speed\", null)] public uint AnimationSpeed { get; set; } Property Value uint StartingFrame Position of the starting frame, 0-based indexing [DataMember(280)] [Display(\"Starting frame\", null)] public uint StartingFrame { get; set; } Property Value uint XDivisions Number of columns (cells per row) [DataMember(200)] [Display(\"X divisions\", null)] public uint XDivisions { get; set; } Property Value uint YDivisions Number of rows (cells per column) [DataMember(240)] [Display(\"Y divisions\", null)] public uint YDivisions { get; set; } Property Value uint Methods BuildUVCoordinates(ref ParticleBufferState, ref ParticleList, AttributeDescription) Enhances or animates the texture coordinates using already existing base coordinates of (0, 0, 1, 1) or similar (base texture coordinates may differ depending on the actual shape) public override void BuildUVCoordinates(ref ParticleBufferState bufferState, ref ParticleList sorter, AttributeDescription texCoordsDescription) Parameters bufferState ParticleBufferState The particle buffer state which is used to build the assigned vertex buffer sorter ParticleList ParticleList to use to iterate over all particles drawn this frame texCoordsDescription AttributeDescription Attribute description of the texture coordinates in the current vertex layout Transform(ref Vector2, ref Vector4) public void Transform(ref Vector2 attribute, ref Vector4 uvTransform) Parameters attribute Vector2 uvTransform Vector4"
  },
  "api/Stride.Particles.Materials.UVBuilderScroll.html": {
    "href": "api/Stride.Particles.Materials.UVBuilderScroll.html",
    "title": "Class UVBuilderScroll | Stride API",
    "summary": "Class UVBuilderScroll Namespace Stride.Particles.Materials Assembly Stride.Particles.dll Animates the texture coordinates starting with one rectangle and scrolling/zooming it to an ending rectangle over the particle's life [DataContract(\"UVBuilderScroll\")] [Display(\"Scrolling\", null)] public class UVBuilderScroll : UVBuilder, IAttributeTransformer<Vector2, Vector4> Inheritance object UVBuilder UVBuilderScroll Implements IAttributeTransformer<Vector2, Vector4> Extension Methods UnsafeUtilities.As<T>(object?) Properties EndFrame Ending sub-region (rectangle) for the scroll [DataMember(240)] [Display(\"End frame\", null)] public Vector4 EndFrame { get; set; } Property Value Vector4 StartFrame Starting sub-region (rectangle) for the scroll [DataMember(200)] [Display(\"Start frame\", null)] public Vector4 StartFrame { get; set; } Property Value Vector4 Methods BuildUVCoordinates(ref ParticleBufferState, ref ParticleList, AttributeDescription) Enhances or animates the texture coordinates using already existing base coordinates of (0, 0, 1, 1) or similar (base texture coordinates may differ depending on the actual shape) public override void BuildUVCoordinates(ref ParticleBufferState bufferState, ref ParticleList sorter, AttributeDescription texCoordsDescription) Parameters bufferState ParticleBufferState The particle buffer state which is used to build the assigned vertex buffer sorter ParticleList ParticleList to use to iterate over all particles drawn this frame texCoordsDescription AttributeDescription Attribute description of the texture coordinates in the current vertex layout Transform(ref Vector2, ref Vector4) public void Transform(ref Vector2 attribute, ref Vector4 uvTransform) Parameters attribute Vector2 uvTransform Vector4"
  },
  "api/Stride.Particles.Materials.html": {
    "href": "api/Stride.Particles.Materials.html",
    "title": "Namespace Stride.Particles.Materials | Stride API",
    "summary": "Namespace Stride.Particles.Materials Classes ParticleMaterial Base class for the particle materials which uses a dynamic effect compiler to generate shaders at runtime ParticleMaterialComputeColor ParticleMaterialComputeColor uses a IComputeColor tree to calculate the pixel's emissive value ParticleMaterialSimple Simple base for most of the particle material classes which uses additive-alpha blending, face culling and setups the color vertex stream UVBuilder Base class for building and animating the texture coordinates in a particle vertex buffer stream UVBuilderFlipbook Animates the texture coordinates in a flipbook fashion, based on the particle's life The order of the frames is left to right, top to bottom The flipbook assumes uniform sizes for all frames UVBuilderScroll Animates the texture coordinates starting with one rectangle and scrolling/zooming it to an ending rectangle over the particle's life Enums ParticleMaterialCulling"
  },
  "api/Stride.Particles.Modules.ParticleUpdater.html": {
    "href": "api/Stride.Particles.Modules.ParticleUpdater.html",
    "title": "Class ParticleUpdater | Stride API",
    "summary": "Class ParticleUpdater Namespace Stride.Particles.Modules Assembly Stride.Particles.dll The ParticleUpdater updates one or more fields, such as velocity or position, in all living particles in a target ParticlePool [DataContract(\"ParticleUpdater\")] public abstract class ParticleUpdater : ParticleModule Inheritance object ParticleTransform ParticleModule ParticleUpdater Derived UpdaterCollider UpdaterForceField UpdaterGravity UpdaterSpeedToDirection UpdaterColorOverTime UpdaterRotationOverTime UpdaterSizeOverTime Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Properties IsPostUpdater All updaters are called exactly once during each ParticleEmitter's update. Most updaters are called before spawning the new particles for the frame, but post updaters are called after that. public virtual bool IsPostUpdater { get; } Property Value bool Methods Update(float, ParticlePool) Updates all particles in the ParticlePool using this updater public abstract void Update(float dt, ParticlePool pool) Parameters dt float Delta time in seconds which has passed since the last update call pool ParticlePool The target ParticlePool which needs to be updated"
  },
  "api/Stride.Particles.Modules.UpdaterCollider.html": {
    "href": "api/Stride.Particles.Modules.UpdaterCollider.html",
    "title": "Class UpdaterCollider | Stride API",
    "summary": "Class UpdaterCollider Namespace Stride.Particles.Modules Assembly Stride.Particles.dll The UpdaterCollider is an updater which tests the particles against a preset surface or shape, making them bounce off it when they collide [DataContract(\"UpdaterCollider\")] [Display(\"Collider\", null)] public class UpdaterCollider : ParticleUpdater Inheritance object ParticleTransform ParticleModule ParticleUpdater UpdaterCollider Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors UpdaterCollider() Default constructor which also registers the fields required by this updater public UpdaterCollider() Properties DebugDraw Should this Particle Module's bounds be displayed as a debug draw [DataMember(-1)] public bool DebugDraw { get; set; } Property Value bool FieldShape The type of the shape which defines this collider [DataMember(10)] [Display(\"Shape\", null)] public FieldShape FieldShape { get; set; } Property Value FieldShape Friction How much of the horizontal (normal-perpendicular) kinetic energy is lost after impact [DataMember(90)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Friction\", null)] public float Friction { get; set; } Property Value float IsHollow Shows if the collider shape is hollow on the inside or solid [DataMember(50)] [Display(\"Is hollow\", null)] public bool IsHollow { get; set; } Property Value bool IsPostUpdater All updaters are called exactly once during each ParticleEmitter's update. Most updaters are called before spawning the new particles for the frame, but post updaters are called after that. public override bool IsPostUpdater { get; } Property Value bool KillParticles Kill particles when they collide with the shape [DataMember(60)] [Display(\"Kill particles\", null)] public bool KillParticles { get; set; } Property Value bool Restitution How much of the vertical (normal-oriented) kinetic energy is preserved after impact [DataMember(70)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Restitution\", null)] public float Restitution { get; set; } Property Value float Methods TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) Attepmts to get a debug shape (shape type and location matrix) for the current module in order to display its boundaries better public override bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale) Parameters debugDrawShape DebugDrawShape Type of the debug draw shape translation Vector3 Translation of the shape rotation Quaternion Rotation of the shape scale Vector3 Scaling of the shape Returns bool Update(float, ParticlePool) Updates all particles in the ParticlePool using this updater public override void Update(float dt, ParticlePool pool) Parameters dt float Delta time in seconds which has passed since the last update call pool ParticlePool The target ParticlePool which needs to be updated"
  },
  "api/Stride.Particles.Modules.UpdaterForceField.html": {
    "href": "api/Stride.Particles.Modules.UpdaterForceField.html",
    "title": "Class UpdaterForceField | Stride API",
    "summary": "Class UpdaterForceField Namespace Stride.Particles.Modules Assembly Stride.Particles.dll The UpdaterForceField updates the particles' positions and velocity based on proximity and relative position to a bounding force field [DataContract(\"UpdaterForceField\")] [Display(\"Force Field\", null)] public class UpdaterForceField : ParticleUpdater Inheritance object ParticleTransform ParticleModule ParticleUpdater UpdaterForceField Inherited Members ParticleUpdater.IsPostUpdater ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.RequiredFields ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors UpdaterForceField() Default constructor which also registers the fields required by this updater public UpdaterForceField() Properties DebugDraw Should this Particle Module's bounds be displayed as a debug draw [DataMember(-1)] public bool DebugDraw { get; set; } Property Value bool EnergyConservation How much of the force should be applied as conserved energy (acceleration) [DataMember(50)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Energy conservation\", null)] public float EnergyConservation { get; set; } Property Value float FieldFalloff Defines how and if the total magnitude of the force should change depending of how far away the particle is from the central axis [DataMember(40)] [Display(\"Falloff\", null)] public FieldFalloff FieldFalloff { get; set; } Property Value FieldFalloff FieldShape The shape defines the force field's bounding shape, which influences the force vectors and magnitude for every given particle [DataMember(10)] [Display(\"Shape\", null)] public FieldShape FieldShape { get; set; } Property Value FieldShape ForceDirected The force ALONG the bounding shape's axis. [DataMember(60)] [Display(\"Directed force\", null)] public float ForceDirected { get; set; } Property Value float ForceFixed The fixed force doesn't scale or rotate with the the bounding shape [DataMember(100)] [Display(\"Fixed force\", null)] public Vector3 ForceFixed { get; set; } Property Value Vector3 ForceRepulsive The force AWAY from the bounding shape's axis. [DataMember(80)] [Display(\"Repulsive force\", null)] public float ForceRepulsive { get; set; } Property Value float ForceVortex The force AROUND the bounding shape's axis. [DataMember(70)] [Display(\"Vortex force\", null)] public float ForceVortex { get; set; } Property Value float Methods SetParentTRS(ParticleTransform, ParticleSystem) Sets the parent (particle system's) translation, rotation and scale (uniform) The module can choose to inherit, use or ignore any of the elements public override void SetParentTRS(ParticleTransform transform, ParticleSystem parent) Parameters transform ParticleTransform ParticleSystem's transform (from the Transform component) or identity if local space is used parent ParticleSystem The parent ParticleSystem TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) Attepmts to get a debug shape (shape type and location matrix) for the current module in order to display its boundaries better public override bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale) Parameters debugDrawShape DebugDrawShape Type of the debug draw shape translation Vector3 Translation of the shape rotation Quaternion Rotation of the shape scale Vector3 Scaling of the shape Returns bool Update(float, ParticlePool) Updates all particles in the ParticlePool using this updater public override void Update(float dt, ParticlePool pool) Parameters dt float Delta time in seconds which has passed since the last update call pool ParticlePool The target ParticlePool which needs to be updated"
  },
  "api/Stride.Particles.Modules.UpdaterGravity.html": {
    "href": "api/Stride.Particles.Modules.UpdaterGravity.html",
    "title": "Class UpdaterGravity | Stride API",
    "summary": "Class UpdaterGravity Namespace Stride.Particles.Modules Assembly Stride.Particles.dll The UpdaterGravity is a simple version of a force field which updates the particles' velocity over time and acts as a gravitational force [DataContract(\"UpdaterGravity\")] [Display(\"Gravity\", null)] public class UpdaterGravity : ParticleUpdater Inheritance object ParticleTransform ParticleModule ParticleUpdater UpdaterGravity Inherited Members ParticleUpdater.IsPostUpdater ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors UpdaterGravity() public UpdaterGravity() Fields GravitationalAcceleration Direction and magnitude of the gravitational acceleration [DataMember(9)] public Vector3 GravitationalAcceleration Field Value Vector3 Methods Update(float, ParticlePool) Updates all particles in the ParticlePool using this updater public override void Update(float dt, ParticlePool pool) Parameters dt float Delta time in seconds which has passed since the last update call pool ParticlePool The target ParticlePool which needs to be updated"
  },
  "api/Stride.Particles.Modules.UpdaterSpeedToDirection.html": {
    "href": "api/Stride.Particles.Modules.UpdaterSpeedToDirection.html",
    "title": "Class UpdaterSpeedToDirection | Stride API",
    "summary": "Class UpdaterSpeedToDirection Namespace Stride.Particles.Modules Assembly Stride.Particles.dll The UpdaterSpeedToDirection calculates the particle's direction (not normalized) based on its delta position [DataContract(\"UpdaterSpeedToDirection\")] [Display(\"Direction from Speed\", null)] public class UpdaterSpeedToDirection : ParticleUpdater Inheritance object ParticleTransform ParticleModule ParticleUpdater UpdaterSpeedToDirection Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleModule.PreUpdate() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors UpdaterSpeedToDirection() public UpdaterSpeedToDirection() Properties IsPostUpdater All updaters are called exactly once during each ParticleEmitter's update. Most updaters are called before spawning the new particles for the frame, but post updaters are called after that. public override bool IsPostUpdater { get; } Property Value bool Methods Update(float, ParticlePool) Updates all particles in the ParticlePool using this updater public override void Update(float dt, ParticlePool pool) Parameters dt float Delta time in seconds which has passed since the last update call pool ParticlePool The target ParticlePool which needs to be updated"
  },
  "api/Stride.Particles.Modules.html": {
    "href": "api/Stride.Particles.Modules.html",
    "title": "Namespace Stride.Particles.Modules | Stride API",
    "summary": "Namespace Stride.Particles.Modules Classes ParticleUpdater The ParticleUpdater updates one or more fields, such as velocity or position, in all living particles in a target ParticlePool UpdaterCollider The UpdaterCollider is an updater which tests the particles against a preset surface or shape, making them bounce off it when they collide UpdaterForceField The UpdaterForceField updates the particles' positions and velocity based on proximity and relative position to a bounding force field UpdaterGravity The UpdaterGravity is a simple version of a force field which updates the particles' velocity over time and acts as a gravitational force UpdaterSpeedToDirection The UpdaterSpeedToDirection calculates the particle's direction (not normalized) based on its delta position"
  },
  "api/Stride.Particles.Particle.html": {
    "href": "api/Stride.Particles.Particle.html",
    "title": "Struct Particle | Stride API",
    "summary": "Struct Particle Namespace Stride.Particles Assembly Stride.Particles.dll The most basic unit of a ParticleSystem You can access individual fields with a ParticleFieldAccessor public struct Particle Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Particle(nint) Creates a particle from a raw pointer, assuming the pointer references valid particle data block public Particle(nint pointer) Parameters pointer nint Fields Pointer Pointer to the particle data block public readonly nint Pointer Field Value nint Properties this[ParticleFieldAccessor] public nint this[ParticleFieldAccessor accessor] { get; } Parameters accessor ParticleFieldAccessor Property Value nint Methods Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object other) Parameters other object Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Get<T>(ParticleFieldAccessor<T>) Gets the particle's field value. However, you should try to use the indexer wherever possible. public T Get<T>(ParticleFieldAccessor<T> accessor) where T : struct Parameters accessor ParticleFieldAccessor<T> The field accessor Returns T The field value. Type Parameters T The field type. Set<T>(ParticleFieldAccessor<T>, T) Sets the particle's field to a value. However, you should try to use the indexer wherever possible. public void Set<T>(ParticleFieldAccessor<T> accessor, T value) where T : struct Parameters accessor ParticleFieldAccessor<T> The field accessor value T The value to set Type Parameters T The field type. Set<T>(ParticleFieldAccessor<T>, ref T) Sets the particle's field to a value. However, you should try to use the indexer wherever possible. public void Set<T>(ParticleFieldAccessor<T> accessor, ref T value) where T : struct Parameters accessor ParticleFieldAccessor<T> The field accessor value T The value to set Type Parameters T The field type. Operators operator ==(Particle, Particle) Checks if the two particles point to the same pointer. public static bool operator ==(Particle particleLeft, Particle particleRight) Parameters particleLeft Particle Left side particle to compare particleRight Particle Right side particle to compare Returns bool operator !=(Particle, Particle) public static bool operator !=(Particle particleLeft, Particle particleRight) Parameters particleLeft Particle particleRight Particle Returns bool"
  },
  "api/Stride.Particles.ParticleEmitter.html": {
    "href": "api/Stride.Particles.ParticleEmitter.html",
    "title": "Class ParticleEmitter | Stride API",
    "summary": "Class ParticleEmitter Namespace Stride.Particles Assembly Stride.Particles.dll The ParticleEmitter is the base manager for any given pool of particles, holding all particles and initializers, updaters, spawners, materials and shape builders associated with the particles. [DataContract(\"ParticleEmitter\")] public class ParticleEmitter : IDisposable Inheritance object ParticleEmitter Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ParticleEmitter() Default constructor. Initializes the pool and all collections contained in the ParticleEmitter public ParticleEmitter() Fields Initializers List of ParticleInitializer within this ParticleEmitter. Adjusts the required fields automatically. [DataMember(200)] [Display(\"Initializers\", null)] public readonly FastTrackingCollection<ParticleInitializer> Initializers Field Value FastTrackingCollection<ParticleInitializer> Spawners List of ParticleSpawner to spawn particles in this ParticleEmitter [DataMember(55)] [Display(\"Spawners\", null)] public readonly FastTrackingCollection<ParticleSpawner> Spawners Field Value FastTrackingCollection<ParticleSpawner> Updaters List of ParticleUpdater within this ParticleEmitter. Adjusts the required fields automatically. [DataMember(300)] [Display(\"Updaters\", null)] public readonly FastTrackingCollection<ParticleUpdater> Updaters Field Value FastTrackingCollection<ParticleUpdater> Properties CanEmitParticles Indicates if the emitter is allowed to emit new particles or not. public bool CanEmitParticles { get; set; } Property Value bool DelayParticleDeath If positive, forces particles to stay one frame more when they are about ot expire public int DelayParticleDeath { get; set; } Property Value int DrawPriority DrawPriority is used to sort emitters at the same position based on a user defined key and determine the order in which they will be drawn [DataMember(33)] [Display(\"Draw Priority\", null)] public byte DrawPriority { get; set; } Property Value byte EmitterName The emitter name is used to uniquely identify this emitter within the same particle system [DataMember(1)] [Display(\"Emitter Name\", null)] public string EmitterName { get; set; } Property Value string Enabled Gets or sets a value indicating whether this ParticleEmitter is enabled. [DataMember(-10)] public bool Enabled { get; set; } Property Value bool true if enabled; otherwise, false. LivingParticles Gets the current living particles from this emitter's pool public int LivingParticles { get; } Property Value int Material The ParticleMaterial may update the vertex buffer, and it also applies the Effect required for rendering [DataMember(50)] [Display(\"Material\", null)] public ParticleMaterial Material { get; set; } Property Value ParticleMaterial MaxParticles Maximum number of particles this ParticleEmitter can have at any given time public int MaxParticles { get; } Property Value int MaxParticlesOverride Maximum particles (if positive) overrides the maximum particle count limitation [DataMember(5)] [Display(\"Max particles\", null)] public int MaxParticlesOverride { get; set; } Property Value int ParticleLifetime [DataMember(7)] [Display(\"Lifespan\", null)] public Vector2 ParticleLifetime { get; set; } Property Value Vector2 RandomSeedMethod Random numbers in the ParticleSystem are generated based on a seed, which in turn can be generated using several methods. [DataMember(12)] [Display(\"Randomize\", null)] public EmitterRandomSeedMethod RandomSeedMethod { get; set; } Property Value EmitterRandomSeedMethod ShapeBuilder The ShapeBuilder expands all living particles to vertex buffers for rendering [DataMember(40)] [Display(\"Shape\", null)] public ShapeBuilder ShapeBuilder { get; set; } Property Value ShapeBuilder SimulationSpace Simulation space defines if the particles should be born in world space, or local to the emitter [DataMember(11)] [Display(\"Space\", null)] public EmitterSimulationSpace SimulationSpace { get; set; } Property Value EmitterSimulationSpace SortingPolicy How and if particles are sorted, and how they are access during rendering [DataMember(35)] [Display(\"Sorting\", null)] public EmitterSortingPolicy SortingPolicy { get; set; } Property Value EmitterSortingPolicy Methods BuildVertexBuffer(nint, ref Matrix, ref Matrix) Build the vertex buffer from particle data public void BuildVertexBuffer(nint sharedBufferPtr, ref Matrix invViewMatrix, ref Matrix viewProj) Parameters sharedBufferPtr nint The shared vertex buffer position where the particle data should be output invViewMatrix Matrix The current camera's inverse view matrix viewProj Matrix DelayedInitialization(ParticleSystem) Some parameters should be initialized when the emitter first runs, rather than in the constructor protected void DelayedInitialization(ParticleSystem parentSystem) Parameters parentSystem ParticleSystem Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() EmitParticles(int) Requests the emitter to spawn several new particles. The particles are buffered and will be spawned during the Update(float, ParticleSystem) step public void EmitParticles(int count) Parameters count int InvalidateRelations() Invalidates relation of this emitter to any other emitters that might be referenced public void InvalidateRelations() PreUpdate() Updates all data changes before the emitter is updated this frame. This method is not thread-safe! public void PreUpdate() PrepareForDraw(out bool, out int, out int) PrepareForDraw(out bool, out int, out int) prepares and updates the Material, ShapeBuilder and VertexBuilder if necessary public void PrepareForDraw(out bool vertexBufferHasChanged, out int vertexSize, out int vertexCount) Parameters vertexBufferHasChanged bool vertexSize int vertexCount int ResetSimulation() Resets the simulation, deleting all particles and starting from Time = 0 public void ResetSimulation() Update(float, ParticleSystem) Updates the emitter and all its particles, and applies all updaters and spawners. public void Update(float dt, ParticleSystem parentSystem) Parameters dt float Delta time, elapsed time since the last call, in seconds parentSystem ParticleSystem The parent ParticleSystem containing this emitter UpdatePaused(ParticleSystem) Call this update when the ParticleSystem is paused to only update the renreding information public void UpdatePaused(ParticleSystem parentSystem) Parameters parentSystem ParticleSystem The parent ParticleSystem containing this emitter"
  },
  "api/Stride.Particles.ParticleFieldAccessor-1.html": {
    "href": "api/Stride.Particles.ParticleFieldAccessor-1.html",
    "title": "Struct ParticleFieldAccessor<T> | Stride API",
    "summary": "Struct ParticleFieldAccessor<T> Namespace Stride.Particles Assembly Stride.Particles.dll public struct ParticleFieldAccessor<T> Type Parameters T Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ParticleFieldAccessor(int) public ParticleFieldAccessor(int offset) Parameters offset int Methods Invalid() public static ParticleFieldAccessor<T> Invalid() Returns ParticleFieldAccessor<T> IsValid() public bool IsValid() Returns bool Operators implicit operator ParticleFieldAccessor(ParticleFieldAccessor<T>) public static implicit operator ParticleFieldAccessor(ParticleFieldAccessor<T> accessor) Parameters accessor ParticleFieldAccessor<T> Returns ParticleFieldAccessor implicit operator int(ParticleFieldAccessor<T>) public static implicit operator int(ParticleFieldAccessor<T> accessor) Parameters accessor ParticleFieldAccessor<T> Returns int"
  },
  "api/Stride.Particles.ParticleFieldAccessor.html": {
    "href": "api/Stride.Particles.ParticleFieldAccessor.html",
    "title": "Struct ParticleFieldAccessor | Stride API",
    "summary": "Struct ParticleFieldAccessor Namespace Stride.Particles Assembly Stride.Particles.dll public struct ParticleFieldAccessor Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ParticleFieldAccessor(int) public ParticleFieldAccessor(int offset) Parameters offset int Methods Invalid() public static ParticleFieldAccessor Invalid() Returns ParticleFieldAccessor IsValid() public bool IsValid() Returns bool Operators implicit operator int(ParticleFieldAccessor) public static implicit operator int(ParticleFieldAccessor accessor) Parameters accessor ParticleFieldAccessor Returns int"
  },
  "api/Stride.Particles.ParticleFieldDescription-1.html": {
    "href": "api/Stride.Particles.ParticleFieldDescription-1.html",
    "title": "Class ParticleFieldDescription<T> | Stride API",
    "summary": "Class ParticleFieldDescription<T> Namespace Stride.Particles Assembly Stride.Particles.dll public class ParticleFieldDescription<T> : ParticleFieldDescription where T : struct Type Parameters T Inheritance object ParticleFieldDescription ParticleFieldDescription<T> Inherited Members ParticleFieldDescription.GetHashCode() ParticleFieldDescription.FieldSize ParticleFieldDescription.Name Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleFieldDescription(string) public ParticleFieldDescription(string name) Parameters name string ParticleFieldDescription(string, T) public ParticleFieldDescription(string name, T defaultValue) Parameters name string defaultValue T Properties DefaultValue public T DefaultValue { get; } Property Value T"
  },
  "api/Stride.Particles.ParticleFieldDescription.html": {
    "href": "api/Stride.Particles.ParticleFieldDescription.html",
    "title": "Class ParticleFieldDescription | Stride API",
    "summary": "Class ParticleFieldDescription Namespace Stride.Particles Assembly Stride.Particles.dll public abstract class ParticleFieldDescription Inheritance object ParticleFieldDescription Derived ParticleFieldDescription<T> Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleFieldDescription(string) protected ParticleFieldDescription(string name) Parameters name string Properties FieldSize public int FieldSize { get; protected set; } Property Value int Name public string Name { get; } Property Value string Methods GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object."
  },
  "api/Stride.Particles.ParticleFields.html": {
    "href": "api/Stride.Particles.ParticleFields.html",
    "title": "Class ParticleFields | Stride API",
    "summary": "Class ParticleFields Namespace Stride.Particles Assembly Stride.Particles.dll public static class ParticleFields Inheritance object ParticleFields Fields Angle public static readonly ParticleFieldDescription<float> Angle Field Value ParticleFieldDescription<float> ChildOrder Order of the particle's children, which is based on their spawn order public static readonly ParticleFieldDescription<uint> ChildOrder Field Value ParticleFieldDescription<uint> ChildrenFlags ChildrenFlags is used to store meta-data for the dependent particles public static readonly ParticleFieldDescription<ParticleChildrenAttribute>[] ChildrenFlags Field Value ParticleFieldDescription<ParticleChildrenAttribute>[] ChildrenFlagsLength public static readonly int ChildrenFlagsLength Field Value int CollisionControl Provides control flags for particles which have collision enabled public static readonly ParticleFieldDescription<ParticleCollisionAttribute> CollisionControl Field Value ParticleFieldDescription<ParticleCollisionAttribute> Color public static readonly ParticleFieldDescription<Color4> Color Field Value ParticleFieldDescription<Color4> Color4 public static readonly ParticleFieldDescription<Color4> Color4 Field Value ParticleFieldDescription<Color4> Direction Particle direction, or offset, in 3D space, calculated from the particle's position public static readonly ParticleFieldDescription<Vector3> Direction Field Value ParticleFieldDescription<Vector3> Life public static readonly ParticleFieldDescription<float> Life Field Value ParticleFieldDescription<float> OldPosition Particle position from the last frame in 3D space, updated every frame if the particle has a Position field public static readonly ParticleFieldDescription<Vector3> OldPosition Field Value ParticleFieldDescription<Vector3> Order Order of the particle, which can be based on spawn order or something else public static readonly ParticleFieldDescription<uint> Order Field Value ParticleFieldDescription<uint> Position Particle position in 3D space public static readonly ParticleFieldDescription<Vector3> Position Field Value ParticleFieldDescription<Vector3> Quaternion Quaternion rotation, for particles which have rotation in 3D public static readonly ParticleFieldDescription<Quaternion> Quaternion Field Value ParticleFieldDescription<Quaternion> RandomSeed Random seed, for generating fast random values in runtime. public static readonly ParticleFieldDescription<RandomSeed> RandomSeed Field Value ParticleFieldDescription<RandomSeed> RemainingLife Particle remaining lifetime. When it reaches 0, the particle dies. Remaining life is easier to work with because it is an absolute value. Total life needs to know what the maximum life is. public static readonly ParticleFieldDescription<float> RemainingLife Field Value ParticleFieldDescription<float> Rgba Particle color, in RGBA. public static readonly ParticleFieldDescription<Color4> Rgba Field Value ParticleFieldDescription<Color4> Rotation Angular rotation, in RADIANS, for particles which only have 1 axis of rotation public static readonly ParticleFieldDescription<float> Rotation Field Value ParticleFieldDescription<float> Rotation1D public static readonly ParticleFieldDescription<float> Rotation1D Field Value ParticleFieldDescription<float> Rotation3D public static readonly ParticleFieldDescription<Quaternion> Rotation3D Field Value ParticleFieldDescription<Quaternion> Scale public static readonly ParticleFieldDescription<float> Scale Field Value ParticleFieldDescription<float> Size Particle uniform size. If particles are rendered as a 2D quads or 3D meshes, these extra dimensions can be set on the material side. public static readonly ParticleFieldDescription<float> Size Field Value ParticleFieldDescription<float> Speed public static readonly ParticleFieldDescription<Vector3> Speed Field Value ParticleFieldDescription<Vector3> Velocity Particle velocity in 3D space public static readonly ParticleFieldDescription<Vector3> Velocity Field Value ParticleFieldDescription<Vector3>"
  },
  "api/Stride.Particles.ParticleModule.html": {
    "href": "api/Stride.Particles.ParticleModule.html",
    "title": "Class ParticleModule | Stride API",
    "summary": "Class ParticleModule Namespace Stride.Particles Assembly Stride.Particles.dll The ParticleModule is a base class for all plugins (initializers and updaters) used by the emitter Each plugin operates over one or several ParticleFields updating or setting up the particle state Additionally, each plugin can inherit some properties from the parent particle system, which are usually passed by the user. [DataContract(\"PaticleModule\")] public abstract class ParticleModule : ParticleTransform Inheritance object ParticleTransform ParticleModule Derived ParticleInitializer ParticleUpdater Inherited Members ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Fields RequiredFields A list of fields required by the module to operate properly. Please fill it during construction time. public List<ParticleFieldDescription> RequiredFields Field Value List<ParticleFieldDescription> Properties Enabled Gets or sets a value indicating whether this ParticleModule is enabled. [DataMember(-10)] public bool Enabled { get; set; } Property Value bool true if enabled; otherwise, false. Methods InvalidateRelations() Invalidates relation of this emitter to any other emitters that might be referenced public virtual void InvalidateRelations() PreUpdate() public virtual void PreUpdate() ResetSimulation() Resets the current state to the module's initial state public virtual void ResetSimulation() SetParentTRS(ParticleTransform, ParticleSystem) Sets the parent (particle system's) translation, rotation and scale (uniform) The module can choose to inherit, use or ignore any of the elements public virtual void SetParentTRS(ParticleTransform transform, ParticleSystem parent) Parameters transform ParticleTransform ParticleSystem's transform (from the Transform component) or identity if local space is used parent ParticleSystem The parent ParticleSystem TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) Attepmts to get a debug shape (shape type and location matrix) for the current module in order to display its boundaries better public virtual bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale) Parameters debugDrawShape DebugDrawShape Type of the debug draw shape translation Vector3 Translation of the shape rotation Quaternion Rotation of the shape scale Vector3 Scaling of the shape Returns bool"
  },
  "api/Stride.Particles.ParticlePool.CopyParticlePoolDelegate.html": {
    "href": "api/Stride.Particles.ParticlePool.CopyParticlePoolDelegate.html",
    "title": "Delegate ParticlePool.CopyParticlePoolDelegate | Stride API",
    "summary": "Delegate ParticlePool.CopyParticlePoolDelegate Namespace Stride.Particles Assembly Stride.Particles.dll public delegate void ParticlePool.CopyParticlePoolDelegate(nint oldPool, int oldCapacity, int oldSize, nint newPool, int newCapacity, int newSize) Parameters oldPool nint oldCapacity int oldSize int newPool nint newCapacity int newSize int Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Particles.ParticlePool.Enumerator.html": {
    "href": "api/Stride.Particles.ParticlePool.Enumerator.html",
    "title": "Struct ParticlePool.Enumerator | Stride API",
    "summary": "Struct ParticlePool.Enumerator Namespace Stride.Particles Assembly Stride.Particles.dll public struct ParticlePool.Enumerator : IEnumerator<Particle>, IEnumerator, IDisposable Implements IEnumerator<Particle> IEnumerator IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Enumerator(ParticlePool) Creates an enumarator which iterates over all particles (living and dead) in the particle pool. public Enumerator(ParticlePool particlePool) Parameters particlePool ParticlePool Particle pool to iterate Enumerator(ParticlePool, int, int) ParticlePool.Enumerator to the particles in this ParticlePool public Enumerator(ParticlePool particlePool, int idxFrom, int idxTo) Parameters particlePool ParticlePool Particle pool to iterate idxFrom int First valid particle index idxTo int Last valid particle index Properties Current Gets the element in the collection at the current position of the enumerator. public Particle Current { get; } Property Value Particle The element in the collection at the current position of the enumerator. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() MoveNext() Advances the enumerator to the next element of the collection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created. RemoveCurrent(ref Particle) Removes the current particle. A reference to the particle is required so that the addressing can be updated and prevent illegal access. public void RemoveCurrent(ref Particle particle) Parameters particle Particle Reference to the particle being removed Reset() Sets the enumerator to its initial position, which is before the first element in the collection. public void Reset() Exceptions InvalidOperationException The collection was modified after the enumerator was created. NotSupportedException The enumerator does not support being reset."
  },
  "api/Stride.Particles.ParticlePool.ListPolicy.html": {
    "href": "api/Stride.Particles.ParticlePool.ListPolicy.html",
    "title": "Enum ParticlePool.ListPolicy | Stride API",
    "summary": "Enum ParticlePool.ListPolicy Namespace Stride.Particles Assembly Stride.Particles.dll public enum ParticlePool.ListPolicy Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Ring = 0 New particles are allocated from the next free index which loops when it reaches the end of the list. The pool doesn't care about dead particles - they don't move and get overwritten by new particles. Stack = 1 New particles are allocated at the top of the stack. Dead particles are swapped out with the top particle. The stack stays small but order of the particles gets scrambled."
  },
  "api/Stride.Particles.ParticlePool.html": {
    "href": "api/Stride.Particles.ParticlePool.html",
    "title": "Class ParticlePool | Stride API",
    "summary": "Class ParticlePool Namespace Stride.Particles Assembly Stride.Particles.dll The ParticlePool is a class which manages an unmanaged memory block used for the particles. The maximum required size calculated on the number of particles and their fields' sizes is calculated every time the sizes or the count change public class ParticlePool : IDisposable, IEnumerable Inheritance object ParticlePool Implements IDisposable IEnumerable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors ParticlePool(int, int, ListPolicy) ParticlePool constructor public ParticlePool(int size, int capacity, ParticlePool.ListPolicy listPolicy = ListPolicy.Stack) Parameters size int Initial size in bytes of a single particle capacity int Initial capacity (maximum number of particles) of the pool listPolicy ParticlePool.ListPolicy List policy - stack (living particles are in the front) or ring Fields DefaultMaxFielsPerPool public const int DefaultMaxFielsPerPool = 16 Field Value int Properties AvailableParticles Gets how many more particles can be spawned public int AvailableParticles { get; } Property Value int LivingParticles Get the number of living (active) particles public int LivingParticles { get; } Property Value int NextFreeIndex NextFreeIndex points to the next index ready for allocation, between 0 and ParticleCapacity - 1. In case of stack list the NextFreeIndex equals the number of living particles in the pool. public int NextFreeIndex { get; } Property Value int ParticleCapacity The maximum allowed number of particles in this ParticlePool. Use SetCapacity(int) if you need to change it. public int ParticleCapacity { get; } Property Value int ParticleData ParticleData is where the memory block (particle pool) actually resides. Its size equals ParticleSize * ParticleCapacity public nint ParticleData { get; } Property Value nint ParticleSize Returns the size of a single Particle. If PARTICLES_SOA is defined, the size of the Particle is the sum of all field strides. Otherwise, the size of the Particle is the pool's stride. public int ParticleSize { get; } Property Value int Methods AddParticle() Add a new particle to the pool. Doesn't worry about initialization. public Particle AddParticle() Returns Particle Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool DisposeParticleData() protected void DisposeParticleData() FieldExists(ParticleFieldDescription, bool) Polls if a filed with this description exists in the pool and optionally forces creation of a new field public bool FieldExists(ParticleFieldDescription fieldDesc, bool forceCreate = false) Parameters fieldDesc ParticleFieldDescription Description of the field forceCreate bool Force the creation of non-existing fields if true Returns bool ~ParticlePool() protected ~ParticlePool() FromIndex(int) Get a particle from its index in the pool public Particle FromIndex(int idx) Parameters idx int Returns Particle GetEnumerator() Returns an ParticlePool.Enumerator to the particles in this ParticlePool In case of Ring dead particles are returned too, so the calling entity should handle such cases. public ParticlePool.Enumerator GetEnumerator() Returns ParticlePool.Enumerator GetField<T>(ParticleFieldDescription<T>) Unsafe method for getting a ParticleFieldAccessor. If the field doesn't exist an invalid accessor is returned to the user. public ParticleFieldAccessor<T> GetField<T>(ParticleFieldDescription<T> fieldDesc) where T : struct Parameters fieldDesc ParticleFieldDescription<T> Returns ParticleFieldAccessor<T> Type Parameters T RemoveField(ParticleFieldDescription) Removes a particle field from this pool with the specified description, or gets an existing one public bool RemoveField(ParticleFieldDescription fieldDesc) Parameters fieldDesc ParticleFieldDescription Description of the field Returns bool true if the field was successfully removed, false otherwise Reset() Clears all particle fields, but keeps the particle capacity the same. public void Reset() SetCapacity(int) Set a different capacity (maximum Particle count for this pool) Whenever possible, existing particles will be copied and continue simulation public void SetCapacity(int newCapacity) Parameters newCapacity int New maximum capacity TryGetField<T>(ParticleFieldDescription<T>, out ParticleFieldAccessor<T>) Gets the particle field with the specified description if the field exists in this pool public bool TryGetField<T>(ParticleFieldDescription<T> fieldDesc, out ParticleFieldAccessor<T> accessor) where T : struct Parameters fieldDesc ParticleFieldDescription<T> Field's decription accessor ParticleFieldAccessor<T> Accessor for the field Returns bool Type Parameters T Type data for the field"
  },
  "api/Stride.Particles.ParticlePoolFieldsList.html": {
    "href": "api/Stride.Particles.ParticlePoolFieldsList.html",
    "title": "Struct ParticlePoolFieldsList | Stride API",
    "summary": "Struct ParticlePoolFieldsList Namespace Stride.Particles Assembly Stride.Particles.dll public struct ParticlePoolFieldsList Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ParticlePoolFieldsList(ParticlePool) public ParticlePoolFieldsList(ParticlePool pool) Parameters pool ParticlePool Methods GetField<T>(ParticleFieldDescription<T>) Returns a particle field accessor for the contained ParticlePool public ParticleFieldAccessor<T> GetField<T>(ParticleFieldDescription<T> fieldDesc) where T : struct Parameters fieldDesc ParticleFieldDescription<T> The field description Returns ParticleFieldAccessor<T> Type Parameters T Type data for the field"
  },
  "api/Stride.Particles.ParticleRandomSeedGenerator.html": {
    "href": "api/Stride.Particles.ParticleRandomSeedGenerator.html",
    "title": "Class ParticleRandomSeedGenerator | Stride API",
    "summary": "Class ParticleRandomSeedGenerator Namespace Stride.Particles Assembly Stride.Particles.dll public class ParticleRandomSeedGenerator Inheritance object ParticleRandomSeedGenerator Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleRandomSeedGenerator(uint) public ParticleRandomSeedGenerator(uint seed) Parameters seed uint Methods GetNextDouble() public double GetNextDouble() Returns double GetNextSeed() public RandomSeed GetNextSeed() Returns RandomSeed"
  },
  "api/Stride.Particles.ParticleSystem.html": {
    "href": "api/Stride.Particles.ParticleSystem.html",
    "title": "Class ParticleSystem | Stride API",
    "summary": "Class ParticleSystem Namespace Stride.Particles Assembly Stride.Particles.dll [DataContract(\"ParticleSystem\")] public class ParticleSystem : IDisposable Inheritance object ParticleSystem Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ParticleSystem() Default constructor public ParticleSystem() Fields Rotation Rotation of the ParticleSystem, expressed as a quaternion rotation. Usually inherited directly from the ParticleSystemComponent or can be directly set. public Quaternion Rotation Field Value Quaternion Translation Translation of the ParticleSystem. Usually inherited directly from the ParticleSystemComponent or can be directly set. public Vector3 Translation Field Value Vector3 UniformScale Scale of the ParticleSystem. Only uniform scale is supported. Usually inherited directly from the ParticleSystemComponent or can be directly set. public float UniformScale Field Value float Properties BoundingShape AABB of this Particle System [DataMember(5)] [Display(\"Culling AABB\", null)] public BoundingShape BoundingShape { get; set; } Property Value BoundingShape Emitters List of Emitters in this ParticleSystem. Each Emitter has a separate ParticlePool (group) of Particles in it [DataMember(10)] [Display(\"Emitters\", null)] public SafeList<ParticleEmitter> Emitters { get; } Property Value SafeList<ParticleEmitter> Enabled Gets or sets a value indicating whether this ParticleSystem is enabled. [DataMember(-10)] public bool Enabled { get; set; } Property Value bool true if enabled; otherwise, false. IsPaused public bool IsPaused { get; } Property Value bool Settings Settings class which contains miscellaneous settings for the particle system [DataMember(3)] [Display(\"Settings\", null)] public ParticleSystemSettings Settings { get; set; } Property Value ParticleSystemSettings Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool ~ParticleSystem() protected ~ParticleSystem() GetAABB() Gets the current AABB of the ParticleSystem public BoundingBox GetAABB() Returns BoundingBox GetEmitterByName(string) Gets the first emitter with matching name which is contained in this ParticleSystem public ParticleEmitter GetEmitterByName(string name) Parameters name string Name of the emitter. Some emitters might not have a name and cannot be referenced Returns ParticleEmitter ParticleEmitter with the same EmitterName or null if not found InvalidateRelations() Invalidates relation of this emitter to any other emitters that might be referenced public void InvalidateRelations() Pause() Pauses the particle system simulation public void Pause() Play() Use to both start a new simulation or continue a paused one public void Play() ResetSimulation() Resets the particle system, resetting all values to their initial state public void ResetSimulation() Stop() Stops the particle simulation by resetting it to its initial state and pausing it public void Stop() StopEmitters() Use to stop emitting new particles, but continue updating existing ones public void StopEmitters() Timeout(float) Disables emission of new particles and sets a time limit on the system. After the time expires, the system stops. public void Timeout(float timeLimit) Parameters timeLimit float TryGetDebugDrawShape(ref DebugDrawShape, ref Vector3, ref Quaternion, ref Vector3) Tries to acquire and draw a debug shape for better feedback and visualization. public bool TryGetDebugDrawShape(ref DebugDrawShape debugDrawShape, ref Vector3 translation, ref Quaternion rotation, ref Vector3 scale) Parameters debugDrawShape DebugDrawShape The type of the debug shape (sphere, cone, etc.) translation Vector3 The shape's translation rotation Quaternion The shape's rotation scale Vector3 The shape's non-uniform scaling Returns bool true if debug shape can be displayed Update(float) Updates the particles public void Update(float dt) Parameters dt float Delta time - time, in seconds, elapsed since the last Update call to this particle system"
  },
  "api/Stride.Particles.ParticleSystemSettings.html": {
    "href": "api/Stride.Particles.ParticleSystemSettings.html",
    "title": "Class ParticleSystemSettings | Stride API",
    "summary": "Class ParticleSystemSettings Namespace Stride.Particles Assembly Stride.Particles.dll [DataContract(\"ParticleSystemSettings\")] [Display(\"Settings\", null)] public class ParticleSystemSettings Inheritance object ParticleSystemSettings Extension Methods UnsafeUtilities.As<T>(object?) Properties WarmupTime Warm-up time is the amount of time the system should spend in the background pre-simulation the first time it is started [DataMember(10)] [Display(\"Warm-up time\", null)] [DataMemberRange(0, 5, 0.01, 1, 3)] public float WarmupTime { get; set; } Property Value float"
  },
  "api/Stride.Particles.ParticleTransform.html": {
    "href": "api/Stride.Particles.ParticleTransform.html",
    "title": "Class ParticleTransform | Stride API",
    "summary": "Class ParticleTransform Namespace Stride.Particles Assembly Stride.Particles.dll [DataContract(\"ParticleTransform\")] public class ParticleTransform Inheritance object ParticleTransform Derived ParticleModule Extension Methods UnsafeUtilities.As<T>(object?) Fields DisplayParticlePosition [DataMember(10)] public bool DisplayParticlePosition Field Value bool DisplayParticleRotation [DataMember(11)] public bool DisplayParticleRotation Field Value bool DisplayParticleScale [DataMember(12)] public bool DisplayParticleScale Field Value bool DisplayParticleScaleUniform [DataMember(13)] public bool DisplayParticleScaleUniform Field Value bool Properties InheritPosition [DataMember(0)] [Display(\"Position inheritance\", null)] public bool InheritPosition { get; set; } Property Value bool InheritRotation [DataMember(2)] [Display(\"Rotation inheritance\", null)] public bool InheritRotation { get; set; } Property Value bool InheritScale [DataMember(4)] [Display(\"Scale inheritance\", null)] public bool InheritScale { get; set; } Property Value bool Position [DataMember(1)] [Display(\"Position offset\", null)] public Vector3 Position { get; set; } Property Value Vector3 Rotation [DataMember(3)] [Display(\"Rotation offset\", null)] public Quaternion Rotation { get; set; } Property Value Quaternion Scale [DataMember(5)] [Display(\"Scale offset\", null)] public Vector3 Scale { get; set; } Property Value Vector3 ScaleUniform [DataMember(6)] [Display(\"Uniform Scale\", null)] public float ScaleUniform { get; set; } Property Value float WorldPosition public Vector3 WorldPosition { get; } Property Value Vector3 WorldRotation public Quaternion WorldRotation { get; } Property Value Quaternion WorldScale public Vector3 WorldScale { get; } Property Value Vector3 Methods SetParentTransform(ParticleTransform) public void SetParentTransform(ParticleTransform parentTransform) Parameters parentTransform ParticleTransform"
  },
  "api/Stride.Particles.ParticleUtilities.html": {
    "href": "api/Stride.Particles.ParticleUtilities.html",
    "title": "Class ParticleUtilities | Stride API",
    "summary": "Class ParticleUtilities Namespace Stride.Particles Assembly Stride.Particles.dll public static class ParticleUtilities Inheritance object ParticleUtilities Methods AlignedSize(int, int) public static int AlignedSize(int size, int alignment) Parameters size int alignment int Returns int"
  },
  "api/Stride.Particles.RandomOffset.html": {
    "href": "api/Stride.Particles.RandomOffset.html",
    "title": "Class RandomOffset | Stride API",
    "summary": "Class RandomOffset Namespace Stride.Particles Assembly Stride.Particles.dll public static class RandomOffset Inheritance object RandomOffset Fields Lifetime Lifetime offset should always be 0 so that it can easily be retrieved from the random seed. public const uint Lifetime = 0 Field Value uint Offset1A Random seed offset used for coupling 1-dimensional random values public const uint Offset1A = 1112 Field Value uint Offset2A Random seed offset used for coupling 2-dimensional random values public const uint Offset2A = 2223 Field Value uint Offset2B public const uint Offset2B = 3334 Field Value uint Offset3A Random seed offset used for coupling 3-dimensional random values public const uint Offset3A = 4445 Field Value uint Offset3B public const uint Offset3B = 5556 Field Value uint Offset3C public const uint Offset3C = 6667 Field Value uint"
  },
  "api/Stride.Particles.Rendering.ParticleEmitterRenderFeature.html": {
    "href": "api/Stride.Particles.Rendering.ParticleEmitterRenderFeature.html",
    "title": "Class ParticleEmitterRenderFeature | Stride API",
    "summary": "Class ParticleEmitterRenderFeature Namespace Stride.Particles.Rendering Assembly Stride.Particles.dll Renders RenderParticleEmitter. public class ParticleEmitterRenderFeature : RootEffectRenderFeature, IComponent, IReferencable, ICollectorHolder, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RenderFeature RootRenderFeature RootEffectRenderFeature ParticleEmitterRenderFeature Implements IComponent IReferencable ICollectorHolder IGraphicsRendererCore IDisposable Inherited Members RootEffectRenderFeature.EffectObjectNodes RootEffectRenderFeature.ComputeFallbackEffect RootEffectRenderFeature.ResourceGroupPool RootEffectRenderFeature.FrameLayouts RootEffectRenderFeature.EffectCompiled RootEffectRenderFeature.PipelineProcessors RootEffectRenderFeature.EffectDescriptorSetSlotCount RootEffectRenderFeature.EffectPermutationSlotCount RootEffectRenderFeature.RenderEffectKey RootEffectRenderFeature.InstantiatedEffects RootEffectRenderFeature.ComputeResourceGroupOffset(RenderNodeReference) RootEffectRenderFeature.GetOrCreateEffectDescriptorSetSlot(string) RootEffectRenderFeature.CreateFrameCBufferOffsetSlot(string) RootEffectRenderFeature.CreateViewCBufferOffsetSlot(string) RootEffectRenderFeature.RemoveViewCBufferOffsetSlot(ConstantBufferOffsetReference) RootEffectRenderFeature.CreateFrameLogicalGroup(string) RootEffectRenderFeature.CreateViewLogicalGroup(string) RootEffectRenderFeature.CreateDrawLogicalGroup(string) RootEffectRenderFeature.CreateDrawCBufferOffsetSlot(string) RootEffectRenderFeature.GetEffectPermutationSlot(RenderStage) RootEffectRenderFeature.CreateEffectPermutationSlot(string) RootEffectRenderFeature.PrepareEffectPermutations(RenderDrawContext) RootEffectRenderFeature.InvalidateEffectPermutation(RenderObject, RenderEffect) RootEffectRenderFeature.Reset() RootEffectRenderFeature.CreateUniqueDescriptorSetLayout(DescriptorSetLayoutBuilder) RootEffectRenderFeature.ComputeDataArrayExpectedSize(DataType) RootEffectRenderFeature.BindPerViewShaderResource(string, RenderView, GraphicsResource) RootRenderFeature.RenderData RootRenderFeature.Index RootRenderFeature.SortKey RootRenderFeature.RenderObjects RootRenderFeature.ObjectNodeReferences RootRenderFeature.RenderNodes RootRenderFeature.RenderStageSelectors RootRenderFeature.Unload() RootRenderFeature.GetRenderNode(RenderNodeReference) RootRenderFeature.GetViewObjectNode(ViewObjectNodeReference) RootRenderFeature.GetObjectNode(ObjectNodeReference) RootRenderFeature.CreateViewObjectNode(RenderView, RenderObject) RootRenderFeature.OnAddRenderObject(RenderObject) RootRenderFeature.OnRemoveRenderObject(RenderObject) RootRenderFeature.PrepareDataArrays() RenderFeature.Context RenderFeature.RenderSystem RenderFeature.Initialized RenderFeature.Enabled RenderFeature.Initialize(RenderContext) RenderFeature.Collect() RenderFeature.Draw(RenderDrawContext, RenderView, RenderViewStage) RenderFeature.OnRenderSystemChanged() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties SupportedRenderObjectType Gets the type of render object supported by this RootRenderFeature. public override Type SupportedRenderObjectType { get; } Property Value Type Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. Draw(RenderDrawContext, RenderView, RenderViewStage, int, int) Performs GPU updates and/or draw. public override void Draw(RenderDrawContext context, RenderView renderView, RenderViewStage renderViewStage, int startIndex, int endIndex) Parameters context RenderDrawContext renderView RenderView renderViewStage RenderViewStage startIndex int endIndex int Extract() Extract data from entities, should be as fast as possible to not block simulation loop. It should be mostly copies, and the actual processing should be part of Prepare(). public override void Extract() Flush(RenderDrawContext) Releases temporary resources and cleans the state. Should be called once after all Draw(RenderDrawContext, RenderView, RenderViewStage) calls have finished. public override void Flush(RenderDrawContext context) Parameters context RenderDrawContext InitializeCore() Initializes this instance. Query for specific cbuffer (either new one, like PerMaterial, or parts of an existing one, like PerObject=>Skinning) protected override void InitializeCore() Prepare(RenderDrawContext) Performs most of the work (computation and resource preparation). Later game simulation might be running during that step. public override void Prepare(RenderDrawContext context) Parameters context RenderDrawContext PrepareEffectPermutationsImpl(RenderDrawContext) Actual implementation of PrepareEffectPermutations(RenderDrawContext). public override void PrepareEffectPermutationsImpl(RenderDrawContext context) Parameters context RenderDrawContext ProcessPipelineState(RenderContext, RenderNodeReference, ref RenderNode, RenderObject, PipelineStateDescription) protected override void ProcessPipelineState(RenderContext context, RenderNodeReference renderNodeReference, ref RenderNode renderNode, RenderObject renderObject, PipelineStateDescription pipelineState) Parameters context RenderContext renderNodeReference RenderNodeReference renderNode RenderNode renderObject RenderObject pipelineState PipelineStateDescription"
  },
  "api/Stride.Particles.Rendering.ParticleEmitterTransparentRenderStageSelector.html": {
    "href": "api/Stride.Particles.Rendering.ParticleEmitterTransparentRenderStageSelector.html",
    "title": "Class ParticleEmitterTransparentRenderStageSelector | Stride API",
    "summary": "Class ParticleEmitterTransparentRenderStageSelector Namespace Stride.Particles.Rendering Assembly Stride.Particles.dll public class ParticleEmitterTransparentRenderStageSelector : TransparentRenderStageSelector Inheritance object RenderStageSelector TransparentRenderStageSelector ParticleEmitterTransparentRenderStageSelector Inherited Members TransparentRenderStageSelector.RenderGroup TransparentRenderStageSelector.OpaqueRenderStage TransparentRenderStageSelector.TransparentRenderStage TransparentRenderStageSelector.EffectName Extension Methods UnsafeUtilities.As<T>(object?) Methods Process(RenderObject) public override void Process(RenderObject renderObject) Parameters renderObject RenderObject"
  },
  "api/Stride.Particles.Rendering.ParticleSystemRenderProcessor.html": {
    "href": "api/Stride.Particles.Rendering.ParticleSystemRenderProcessor.html",
    "title": "Class ParticleSystemRenderProcessor | Stride API",
    "summary": "Class ParticleSystemRenderProcessor Namespace Stride.Particles.Rendering Assembly Stride.Particles.dll The processor in charge of updating and drawing the entities having sprite components. public class ParticleSystemRenderProcessor : EntityProcessor<ParticleSystemComponent, RenderParticleSystem>, IEntityComponentRenderProcessor Inheritance object EntityProcessor EntityProcessor<ParticleSystemComponent, RenderParticleSystem> ParticleSystemRenderProcessor Implements IEntityComponentRenderProcessor Inherited Members EntityProcessor<ParticleSystemComponent, RenderParticleSystem>.ComponentDatas EntityProcessor<ParticleSystemComponent, RenderParticleSystem>.OnSystemAdd() EntityProcessor<ParticleSystemComponent, RenderParticleSystem>.OnSystemRemove() EntityProcessor<ParticleSystemComponent, RenderParticleSystem>.RemoveAllEntities() EntityProcessor<ParticleSystemComponent, RenderParticleSystem>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<ParticleSystemComponent, RenderParticleSystem>.GenerateComponentData(Entity, ParticleSystemComponent) EntityProcessor<ParticleSystemComponent, RenderParticleSystem>.IsAssociatedDataValid(Entity, ParticleSystemComponent, RenderParticleSystem) EntityProcessor<ParticleSystemComponent, RenderParticleSystem>.OnEntityComponentAdding(Entity, ParticleSystemComponent, RenderParticleSystem) EntityProcessor<ParticleSystemComponent, RenderParticleSystem>.OnEntityComponentRemoved(Entity, ParticleSystemComponent, RenderParticleSystem) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.OnSystemAdd() EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleSystemRenderProcessor() Initializes a new instance of the ParticleSystemRenderProcessor class. public ParticleSystemRenderProcessor() Properties VisibilityGroup public VisibilityGroup VisibilityGroup { get; set; } Property Value VisibilityGroup Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext GenerateComponentData(Entity, ParticleSystemComponent) Generates associated data to the given entity. protected override RenderParticleSystem GenerateComponentData(Entity entity, ParticleSystemComponent particleSystemComponent) Parameters entity Entity The entity. particleSystemComponent ParticleSystemComponent Returns RenderParticleSystem The associated data. IsAssociatedDataValid(Entity, ParticleSystemComponent, RenderParticleSystem) Checks if the current associated data is valid, or if readding the entity is required. protected override bool IsAssociatedDataValid(Entity entity, ParticleSystemComponent spriteComponent, RenderParticleSystem associatedData) Parameters entity Entity The entity. spriteComponent ParticleSystemComponent associatedData RenderParticleSystem The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise. OnEntityComponentAdding(Entity, ParticleSystemComponent, RenderParticleSystem) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, ParticleSystemComponent particleSystemComponent, RenderParticleSystem renderParticleSystem) Parameters entity Entity The entity. particleSystemComponent ParticleSystemComponent renderParticleSystem RenderParticleSystem OnEntityComponentRemoved(Entity, ParticleSystemComponent, RenderParticleSystem) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, ParticleSystemComponent particleSystemComponent, RenderParticleSystem renderParticleSystem) Parameters entity Entity The entity. particleSystemComponent ParticleSystemComponent renderParticleSystem RenderParticleSystem"
  },
  "api/Stride.Particles.Rendering.RenderParticleEmitter.html": {
    "href": "api/Stride.Particles.Rendering.RenderParticleEmitter.html",
    "title": "Class RenderParticleEmitter | Stride API",
    "summary": "Class RenderParticleEmitter Namespace Stride.Particles.Rendering Assembly Stride.Particles.dll Defines a particle emitter to render. public class RenderParticleEmitter : RenderObject Inheritance object RenderObject RenderParticleEmitter Inherited Members RenderObject.Enabled RenderObject.RenderGroup RenderObject.BoundingBox RenderObject.RenderFeature RenderObject.ObjectNode RenderObject.StaticObjectNode RenderObject.VisibilityObjectNode RenderObject.ActiveRenderStages RenderObject.StateSortKey RenderObject.Index RenderObject.Source Extension Methods UnsafeUtilities.As<T>(object?) Fields Color public Color4 Color Field Value Color4 HasVertexBufferChanged public bool HasVertexBufferChanged Field Value bool ParticleEmitter public ParticleEmitter ParticleEmitter Field Value ParticleEmitter RenderParticleSystem public RenderParticleSystem RenderParticleSystem Field Value RenderParticleSystem VertexCount public int VertexCount Field Value int VertexSize public int VertexSize Field Value int"
  },
  "api/Stride.Particles.Rendering.RenderParticleSystem.html": {
    "href": "api/Stride.Particles.Rendering.RenderParticleSystem.html",
    "title": "Class RenderParticleSystem | Stride API",
    "summary": "Class RenderParticleSystem Namespace Stride.Particles.Rendering Assembly Stride.Particles.dll Defines a particle system to render. public class RenderParticleSystem Inheritance object RenderParticleSystem Extension Methods UnsafeUtilities.As<T>(object?) Fields Emitters public RenderParticleEmitter[] Emitters Field Value RenderParticleEmitter[] ParticleSystem public ParticleSystem ParticleSystem Field Value ParticleSystem"
  },
  "api/Stride.Particles.Rendering.html": {
    "href": "api/Stride.Particles.Rendering.html",
    "title": "Namespace Stride.Particles.Rendering | Stride API",
    "summary": "Namespace Stride.Particles.Rendering Classes ParticleEmitterRenderFeature Renders RenderParticleEmitter. ParticleEmitterTransparentRenderStageSelector ParticleSystemRenderProcessor The processor in charge of updating and drawing the entities having sprite components. RenderParticleEmitter Defines a particle emitter to render. RenderParticleSystem Defines a particle system to render."
  },
  "api/Stride.Particles.ShapeBuilders.EdgePolicy.html": {
    "href": "api/Stride.Particles.ShapeBuilders.EdgePolicy.html",
    "title": "Enum EdgePolicy | Stride API",
    "summary": "Enum EdgePolicy Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll Specifies if the trail lies on one edge on the axis or is the axis in its center. [DataContract(\"EdgePolicy\")] [Display(\"Edge\", null)] public enum EdgePolicy Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Center = 1 The line between the control points will be used as a central axis for the trail or ribbon Edge = 0 The line between the control points will be used as an edge for the trail or ribbon"
  },
  "api/Stride.Particles.ShapeBuilders.ShapeBuilder.html": {
    "href": "api/Stride.Particles.ShapeBuilders.ShapeBuilder.html",
    "title": "Class ShapeBuilder | Stride API",
    "summary": "Class ShapeBuilder Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll The ShapeBuilder base class is responsible for generating shapes (procedural mesh) ready for rendering from the particle data [DataContract(\"ShapeBuilder\")] public abstract class ShapeBuilder Inheritance object ShapeBuilder Derived ShapeBuilderCommon ShapeBuilderRibbon ShapeBuilderTrail Extension Methods UnsafeUtilities.As<T>(object?) Properties QuadsPerParticle Returns the number of quads required per particle to draw all particles. Assuming 1 Quad = 4 Vertices = 6 Indices public abstract int QuadsPerParticle { get; protected set; } Property Value int VertexLayoutHasChanged Indicates that the required vertex layout has changed and UpdateVertexBuilder(ParticleVertexBuilder) should be called public bool VertexLayoutHasChanged { get; protected set; } Property Value bool Methods BuildVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref Vector3, ref Quaternion, float, ref ParticleList, ref Matrix) Builds the actual vertex buffer for the current frame using the particle data public abstract int BuildVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref Vector3 spaceTranslation, ref Quaternion spaceRotation, float spaceScale, ref ParticleList sorter, ref Matrix viewProj) Parameters bufferState ParticleBufferState Target particle buffer state, used to populate the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix spaceTranslation Vector3 Translation of the target draw space in regard to the particle data (world or local) spaceRotation Quaternion Rotation of the target draw space in regard to the particle data (world or local) spaceScale float Uniform scale of the target draw space in regard to the particle data (world or local) sorter ParticleList Particle enumerator which can be iterated and returns sported particles viewProj Matrix The View-Projection matrix which is used for some shape builders Returns int Circumcenter(ref Vector3, ref Vector3, ref Vector3) Finds the circumcenter coordinates for triangle ABC public static Vector3 Circumcenter(ref Vector3 A, ref Vector3 B, ref Vector3 C) Parameters A Vector3 B Vector3 C Vector3 Returns Vector3 PreUpdate() public virtual void PreUpdate() PrepareVertexLayout(ParticlePoolFieldsList) Check if ParticleVertexElements should be changed and set HasVertexLayoutChanged = true; if they do public virtual void PrepareVertexLayout(ParticlePoolFieldsList fieldsList) Parameters fieldsList ParticlePoolFieldsList A container for the ParticlePool which can poll if a certain field exists as an attribute SetRequiredQuads(int, int, int) Sets the required quads per particle and number of particles so that a sufficiently big buffer can be allocated public virtual void SetRequiredQuads(int quadsPerParticle, int livingParticles, int totalParticles) Parameters quadsPerParticle int Required quads per particle, assuming 1 quad = 4 vertices = 6 indices livingParticles int Number of living particles this frame totalParticles int Number of total number of possible particles for the parent emitter UpdateVertexBuilder(ParticleVertexBuilder) Should be invoked if the VertexLayoutHasChanged was true so that new layout fields can be added to the buffer builder public virtual void UpdateVertexBuilder(ParticleVertexBuilder vertexBuilder) Parameters vertexBuilder ParticleVertexBuilder Target vertex buffer stream builder which will be used for the current frame"
  },
  "api/Stride.Particles.ShapeBuilders.ShapeBuilderBillboard.html": {
    "href": "api/Stride.Particles.ShapeBuilders.ShapeBuilderBillboard.html",
    "title": "Class ShapeBuilderBillboard | Stride API",
    "summary": "Class ShapeBuilderBillboard Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll Shape builder which builds each particle as a camera-facing quad [DataContract(\"ShapeBuilderBillboard\")] [Display(\"Billboard\", null)] public class ShapeBuilderBillboard : ShapeBuilderCommon Inheritance object ShapeBuilder ShapeBuilderCommon ShapeBuilderBillboard Inherited Members ShapeBuilderCommon.SamplerPosition ShapeBuilderCommon.SamplerSize ShapeBuilderCommon.GetParticlePosition(Particle, ParticleFieldAccessor<Vector3>, ParticleFieldAccessor<float>) ShapeBuilderCommon.GetParticleSize(Particle, ParticleFieldAccessor<float>, ParticleFieldAccessor<float>) ShapeBuilder.VertexLayoutHasChanged ShapeBuilder.PrepareVertexLayout(ParticlePoolFieldsList) ShapeBuilder.UpdateVertexBuilder(ParticleVertexBuilder) ShapeBuilder.SetRequiredQuads(int, int, int) ShapeBuilder.Circumcenter(ref Vector3, ref Vector3, ref Vector3) Extension Methods UnsafeUtilities.As<T>(object?) Properties QuadsPerParticle Returns the number of quads required per particle to draw all particles. Assuming 1 Quad = 4 Vertices = 6 Indices public override int QuadsPerParticle { get; protected set; } Property Value int SamplerRotation Additive animation for the particle rotation. If present, particle's own rotation will be added to the sampled curve value [DataMember(300)] [Display(\"Additive Rotation Animation\", null)] public ComputeCurveSampler<float> SamplerRotation { get; set; } Property Value ComputeCurveSampler<float> Methods BuildVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref Vector3, ref Quaternion, float, ref ParticleList, ref Matrix) Builds the actual vertex buffer for the current frame using the particle data public override int BuildVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref Vector3 spaceTranslation, ref Quaternion spaceRotation, float spaceScale, ref ParticleList sorter, ref Matrix viewProj) Parameters bufferState ParticleBufferState Target particle buffer state, used to populate the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix spaceTranslation Vector3 Translation of the target draw space in regard to the particle data (world or local) spaceRotation Quaternion Rotation of the target draw space in regard to the particle data (world or local) spaceScale float Uniform scale of the target draw space in regard to the particle data (world or local) sorter ParticleList Particle enumerator which can be iterated and returns sported particles viewProj Matrix The View-Projection matrix which is used for some shape builders Returns int GetParticleRotation(Particle, ParticleFieldAccessor<float>, ParticleFieldAccessor<float>) Gets the combined rotation for the particle, adding its field value (if any) to its sampled value from the curve protected float GetParticleRotation(Particle particle, ParticleFieldAccessor<float> rotationField, ParticleFieldAccessor<float> lifeField) Parameters particle Particle Target particle rotationField ParticleFieldAccessor<float> Rotation field accessor lifeField ParticleFieldAccessor<float> Normalized particle life for sampling Returns float Screenspace rotation in radians, positive is clockwise PreUpdate() public override void PreUpdate()"
  },
  "api/Stride.Particles.ShapeBuilders.ShapeBuilderCommon.html": {
    "href": "api/Stride.Particles.ShapeBuilders.ShapeBuilderCommon.html",
    "title": "Class ShapeBuilderCommon | Stride API",
    "summary": "Class ShapeBuilderCommon Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll The common shape builder provides additive animation for the particle's position and size fields, assuming that all derived shape builders will have position and size fields [DataContract(\"ShapeBuilderCommon\")] public abstract class ShapeBuilderCommon : ShapeBuilder Inheritance object ShapeBuilder ShapeBuilderCommon Derived ShapeBuilderBillboard ShapeBuilderHexagon ShapeBuilderOrientedQuad ShapeBuilderQuad Inherited Members ShapeBuilder.QuadsPerParticle ShapeBuilder.VertexLayoutHasChanged ShapeBuilder.PrepareVertexLayout(ParticlePoolFieldsList) ShapeBuilder.UpdateVertexBuilder(ParticleVertexBuilder) ShapeBuilder.SetRequiredQuads(int, int, int) ShapeBuilder.Circumcenter(ref Vector3, ref Vector3, ref Vector3) Extension Methods UnsafeUtilities.As<T>(object?) Properties SamplerPosition Additive animation for the particle position. If present, particle's own position will be added to the sampled curve value [DataMember(100)] [Display(\"Additive Position Animation\", null)] public ComputeCurveSampler<Vector3> SamplerPosition { get; set; } Property Value ComputeCurveSampler<Vector3> SamplerSize Additive animation for the particle size. If present, particle's own size will be multiplied with the sampled curve value [DataMember(200)] [Display(\"Additive Size Animation\", null)] public ComputeCurveSampler<float> SamplerSize { get; set; } Property Value ComputeCurveSampler<float> Methods BuildVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref Vector3, ref Quaternion, float, ref ParticleList, ref Matrix) Builds the actual vertex buffer for the current frame using the particle data public override int BuildVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref Vector3 spaceTranslation, ref Quaternion spaceRotation, float spaceScale, ref ParticleList sorter, ref Matrix viewProj) Parameters bufferState ParticleBufferState Target particle buffer state, used to populate the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix spaceTranslation Vector3 Translation of the target draw space in regard to the particle data (world or local) spaceRotation Quaternion Rotation of the target draw space in regard to the particle data (world or local) spaceScale float Uniform scale of the target draw space in regard to the particle data (world or local) sorter ParticleList Particle enumerator which can be iterated and returns sported particles viewProj Matrix The View-Projection matrix which is used for some shape builders Returns int GetParticlePosition(Particle, ParticleFieldAccessor<Vector3>, ParticleFieldAccessor<float>) Gets the combined position for the particle, adding its field value (if any) to its sampled value from the curve protected Vector3 GetParticlePosition(Particle particle, ParticleFieldAccessor<Vector3> positionField, ParticleFieldAccessor<float> lifeField) Parameters particle Particle positionField ParticleFieldAccessor<Vector3> lifeField ParticleFieldAccessor<float> Normalized life for sampling Returns Vector3 Particle's current 3D position GetParticleSize(Particle, ParticleFieldAccessor<float>, ParticleFieldAccessor<float>) Gets the combined size for the particle, adding its field value (if any) to its sampled value from the curve protected float GetParticleSize(Particle particle, ParticleFieldAccessor<float> sizeField, ParticleFieldAccessor<float> lifeField) Parameters particle Particle Target particle sizeField ParticleFieldAccessor<float> Size field accessor lifeField ParticleFieldAccessor<float> Normalized life for sampling Returns float Particle's current uniform size PreUpdate() public override void PreUpdate()"
  },
  "api/Stride.Particles.ShapeBuilders.ShapeBuilderHexagon.html": {
    "href": "api/Stride.Particles.ShapeBuilders.ShapeBuilderHexagon.html",
    "title": "Class ShapeBuilderHexagon | Stride API",
    "summary": "Class ShapeBuilderHexagon Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll Shape builder which builds each particle as a camera-facing hexagon [DataContract(\"ShapeBuilderHexagon\")] [Display(\"Hexagon\", null)] public class ShapeBuilderHexagon : ShapeBuilderCommon Inheritance object ShapeBuilder ShapeBuilderCommon ShapeBuilderHexagon Inherited Members ShapeBuilderCommon.SamplerPosition ShapeBuilderCommon.SamplerSize ShapeBuilderCommon.GetParticlePosition(Particle, ParticleFieldAccessor<Vector3>, ParticleFieldAccessor<float>) ShapeBuilderCommon.GetParticleSize(Particle, ParticleFieldAccessor<float>, ParticleFieldAccessor<float>) ShapeBuilder.VertexLayoutHasChanged ShapeBuilder.PrepareVertexLayout(ParticlePoolFieldsList) ShapeBuilder.UpdateVertexBuilder(ParticleVertexBuilder) ShapeBuilder.SetRequiredQuads(int, int, int) ShapeBuilder.Circumcenter(ref Vector3, ref Vector3, ref Vector3) Extension Methods UnsafeUtilities.As<T>(object?) Properties QuadsPerParticle Returns the number of quads required per particle to draw all particles. Assuming 1 Quad = 4 Vertices = 6 Indices public override int QuadsPerParticle { get; protected set; } Property Value int SamplerRotation Additive animation for the particle rotation. If present, particle's own rotation will be added to the sampled curve value [DataMember(300)] [Display(\"Additive Rotation Animation\", null)] public ComputeCurveSampler<float> SamplerRotation { get; set; } Property Value ComputeCurveSampler<float> Methods BuildVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref Vector3, ref Quaternion, float, ref ParticleList, ref Matrix) Builds the actual vertex buffer for the current frame using the particle data public override int BuildVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref Vector3 spaceTranslation, ref Quaternion spaceRotation, float spaceScale, ref ParticleList sorter, ref Matrix viewProj) Parameters bufferState ParticleBufferState Target particle buffer state, used to populate the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix spaceTranslation Vector3 Translation of the target draw space in regard to the particle data (world or local) spaceRotation Quaternion Rotation of the target draw space in regard to the particle data (world or local) spaceScale float Uniform scale of the target draw space in regard to the particle data (world or local) sorter ParticleList Particle enumerator which can be iterated and returns sported particles viewProj Matrix The View-Projection matrix which is used for some shape builders Returns int GetParticleRotation(Particle, ParticleFieldAccessor<float>, ParticleFieldAccessor<float>) Gets the combined rotation for the particle, adding its field value (if any) to its sampled value from the curve protected float GetParticleRotation(Particle particle, ParticleFieldAccessor<float> rotationField, ParticleFieldAccessor<float> lifeField) Parameters particle Particle Target particle rotationField ParticleFieldAccessor<float> Rotation field accessor lifeField ParticleFieldAccessor<float> Normalized particle life for sampling Returns float Screen space rotation in radians, positive is clockwise PreUpdate() public override void PreUpdate()"
  },
  "api/Stride.Particles.ShapeBuilders.ShapeBuilderOrientedQuad.html": {
    "href": "api/Stride.Particles.ShapeBuilders.ShapeBuilderOrientedQuad.html",
    "title": "Class ShapeBuilderOrientedQuad | Stride API",
    "summary": "Class ShapeBuilderOrientedQuad Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll Shape builder which builds each particle as a non-uniform quad oriented along an axis [DataContract(\"ShapeBuilderOrientedQuad\")] [Display(\"Direction Aligned Sprite\", null)] public class ShapeBuilderOrientedQuad : ShapeBuilderCommon Inheritance object ShapeBuilder ShapeBuilderCommon ShapeBuilderOrientedQuad Inherited Members ShapeBuilderCommon.PreUpdate() ShapeBuilderCommon.SamplerPosition ShapeBuilderCommon.SamplerSize ShapeBuilderCommon.GetParticlePosition(Particle, ParticleFieldAccessor<Vector3>, ParticleFieldAccessor<float>) ShapeBuilderCommon.GetParticleSize(Particle, ParticleFieldAccessor<float>, ParticleFieldAccessor<float>) ShapeBuilder.VertexLayoutHasChanged ShapeBuilder.PrepareVertexLayout(ParticlePoolFieldsList) ShapeBuilder.UpdateVertexBuilder(ParticleVertexBuilder) ShapeBuilder.SetRequiredQuads(int, int, int) ShapeBuilder.Circumcenter(ref Vector3, ref Vector3, ref Vector3) Extension Methods UnsafeUtilities.As<T>(object?) Properties LengthFactor Length will be modified with this factor [DataMember(310)] [Display(\"Length factor\", null)] public float LengthFactor { get; set; } Property Value float QuadsPerParticle Returns the number of quads required per particle to draw all particles. Assuming 1 Quad = 4 Vertices = 6 Indices public override int QuadsPerParticle { get; protected set; } Property Value int ScaleLength If true, length will scale with particle size [DataMember(300)] [Display(\"Size to Length\", null)] public bool ScaleLength { get; set; } Property Value bool Methods BuildVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref Vector3, ref Quaternion, float, ref ParticleList, ref Matrix) Builds the actual vertex buffer for the current frame using the particle data public override int BuildVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref Vector3 spaceTranslation, ref Quaternion spaceRotation, float spaceScale, ref ParticleList sorter, ref Matrix viewProj) Parameters bufferState ParticleBufferState Target particle buffer state, used to populate the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix spaceTranslation Vector3 Translation of the target draw space in regard to the particle data (world or local) spaceRotation Quaternion Rotation of the target draw space in regard to the particle data (world or local) spaceScale float Uniform scale of the target draw space in regard to the particle data (world or local) sorter ParticleList Particle enumerator which can be iterated and returns sported particles viewProj Matrix The View-Projection matrix which is used for some shape builders Returns int"
  },
  "api/Stride.Particles.ShapeBuilders.ShapeBuilderQuad.html": {
    "href": "api/Stride.Particles.ShapeBuilders.ShapeBuilderQuad.html",
    "title": "Class ShapeBuilderQuad | Stride API",
    "summary": "Class ShapeBuilderQuad Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll Shape builder which builds each particle as a up-facing quad, further rotated by the particle's rotation in 3d space [DataContract(\"ShapeBuilderQuad\")] [Display(\"Quad\", null)] public class ShapeBuilderQuad : ShapeBuilderCommon Inheritance object ShapeBuilder ShapeBuilderCommon ShapeBuilderQuad Inherited Members ShapeBuilderCommon.SamplerPosition ShapeBuilderCommon.SamplerSize ShapeBuilderCommon.GetParticlePosition(Particle, ParticleFieldAccessor<Vector3>, ParticleFieldAccessor<float>) ShapeBuilderCommon.GetParticleSize(Particle, ParticleFieldAccessor<float>, ParticleFieldAccessor<float>) ShapeBuilder.VertexLayoutHasChanged ShapeBuilder.PrepareVertexLayout(ParticlePoolFieldsList) ShapeBuilder.UpdateVertexBuilder(ParticleVertexBuilder) ShapeBuilder.SetRequiredQuads(int, int, int) ShapeBuilder.Circumcenter(ref Vector3, ref Vector3, ref Vector3) Extension Methods UnsafeUtilities.As<T>(object?) Properties QuadsPerParticle Returns the number of quads required per particle to draw all particles. Assuming 1 Quad = 4 Vertices = 6 Indices public override int QuadsPerParticle { get; protected set; } Property Value int SamplerRotation Additive animation for the particle rotation. If present, particle's own rotation will be added to the sampled curve value [DataMember(300)] [Display(\"Additive Rotation Animation\", null)] public ComputeCurveSampler<Quaternion> SamplerRotation { get; set; } Property Value ComputeCurveSampler<Quaternion> Methods BuildVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref Vector3, ref Quaternion, float, ref ParticleList, ref Matrix) Builds the actual vertex buffer for the current frame using the particle data public override int BuildVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref Vector3 spaceTranslation, ref Quaternion spaceRotation, float spaceScale, ref ParticleList sorter, ref Matrix viewProj) Parameters bufferState ParticleBufferState Target particle buffer state, used to populate the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix spaceTranslation Vector3 Translation of the target draw space in regard to the particle data (world or local) spaceRotation Quaternion Rotation of the target draw space in regard to the particle data (world or local) spaceScale float Uniform scale of the target draw space in regard to the particle data (world or local) sorter ParticleList Particle enumerator which can be iterated and returns sported particles viewProj Matrix The View-Projection matrix which is used for some shape builders Returns int GetParticleRotation(Particle, ParticleFieldAccessor<Quaternion>, ParticleFieldAccessor<float>) Gets the combined rotation for the particle, adding its field value (if any) to its sampled value from the curve protected Quaternion GetParticleRotation(Particle particle, ParticleFieldAccessor<Quaternion> rotationField, ParticleFieldAccessor<float> lifeField) Parameters particle Particle Target particle rotationField ParticleFieldAccessor<Quaternion> Rotation field accessor lifeField ParticleFieldAccessor<float> Normalized particle life for sampling Returns Quaternion Quaternion rotation of the quad particle, assuming flat horizontal square at neutral rotation PreUpdate() public override void PreUpdate()"
  },
  "api/Stride.Particles.ShapeBuilders.ShapeBuilderRibbon.html": {
    "href": "api/Stride.Particles.ShapeBuilders.ShapeBuilderRibbon.html",
    "title": "Class ShapeBuilderRibbon | Stride API",
    "summary": "Class ShapeBuilderRibbon Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll Shape builder which builds all particles as a ribbon, connecting adjacent particles with camera-facing quads [DataContract(\"ShapeBuilderRibbon\")] [Display(\"Ribbon\", null)] public class ShapeBuilderRibbon : ShapeBuilder Inheritance object ShapeBuilder ShapeBuilderRibbon Inherited Members ShapeBuilder.VertexLayoutHasChanged ShapeBuilder.PreUpdate() ShapeBuilder.PrepareVertexLayout(ParticlePoolFieldsList) ShapeBuilder.UpdateVertexBuilder(ParticleVertexBuilder) ShapeBuilder.Circumcenter(ref Vector3, ref Vector3, ref Vector3) Extension Methods UnsafeUtilities.As<T>(object?) Properties QuadsPerParticle Returns the number of quads required per particle to draw all particles. Assuming 1 Quad = 4 Vertices = 6 Indices public override int QuadsPerParticle { get; protected set; } Property Value int Segments If the ribbon is smotthed, how many segments should be used between each two particles [DataMember(6)] [Display(\"Segments\", null)] public int Segments { get; set; } Property Value int SmoothingPolicy Smoothing provides the option to additionally smooth the ribbon, enhancing visual quality for sharp angles [DataMember(5)] [Display(\"Smoothing\", null)] public SmoothingPolicy SmoothingPolicy { get; set; } Property Value SmoothingPolicy TexCoordsFactor The factor (coefficient) for length to use when building texture coordinates [DataMember(20)] [Display(\"UV Factor\", null)] public float TexCoordsFactor { get; set; } Property Value float TextureCoordinatePolicy Specifies how texture coordinates for the ribbons should be built [DataMember(10)] [Display(\"UV Coords\", null)] public TextureCoordinatePolicy TextureCoordinatePolicy { get; set; } Property Value TextureCoordinatePolicy UVRotate Texture coordinates flip and rotate policy [DataMember(30)] [Display(\"UV Rotate\", null)] public UVRotate UVRotate { get; set; } Property Value UVRotate Methods BuildVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref Vector3, ref Quaternion, float, ref ParticleList, ref Matrix) Builds the actual vertex buffer for the current frame using the particle data public override int BuildVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref Vector3 spaceTranslation, ref Quaternion spaceRotation, float spaceScale, ref ParticleList sorter, ref Matrix viewProj) Parameters bufferState ParticleBufferState Target particle buffer state, used to populate the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix spaceTranslation Vector3 Translation of the target draw space in regard to the particle data (world or local) spaceRotation Quaternion Rotation of the target draw space in regard to the particle data (world or local) spaceScale float Uniform scale of the target draw space in regard to the particle data (world or local) sorter ParticleList Particle enumerator which can be iterated and returns sported particles viewProj Matrix The View-Projection matrix which is used for some shape builders Returns int SetRequiredQuads(int, int, int) Sets the required quads per particle and number of particles so that a sufficiently big buffer can be allocated public override void SetRequiredQuads(int quadsPerParticle, int livingParticles, int totalParticles) Parameters quadsPerParticle int Required quads per particle, assuming 1 quad = 4 vertices = 6 indices livingParticles int Number of living particles this frame totalParticles int Number of total number of possible particles for the parent emitter"
  },
  "api/Stride.Particles.ShapeBuilders.ShapeBuilderTrail.html": {
    "href": "api/Stride.Particles.ShapeBuilders.ShapeBuilderTrail.html",
    "title": "Class ShapeBuilderTrail | Stride API",
    "summary": "Class ShapeBuilderTrail Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll Shape builder which builds all particles as a trail, connecting adjacent particles in a ribbon defined by a fixed 3d axis [DataContract(\"ShapeBuilderTrail\")] [Display(\"Trail\", null)] public class ShapeBuilderTrail : ShapeBuilder Inheritance object ShapeBuilder ShapeBuilderTrail Inherited Members ShapeBuilder.VertexLayoutHasChanged ShapeBuilder.PreUpdate() ShapeBuilder.PrepareVertexLayout(ParticlePoolFieldsList) ShapeBuilder.UpdateVertexBuilder(ParticleVertexBuilder) ShapeBuilder.Circumcenter(ref Vector3, ref Vector3, ref Vector3) Extension Methods UnsafeUtilities.As<T>(object?) Properties EdgePolicy Should the axis of control point be treated as the trail's edge or the trail's center [DataMember(8)] [Display(\"Axis\", null)] public EdgePolicy EdgePolicy { get; set; } Property Value EdgePolicy QuadsPerParticle Returns the number of quads required per particle to draw all particles. Assuming 1 Quad = 4 Vertices = 6 Indices public override int QuadsPerParticle { get; protected set; } Property Value int Segments If the ribbon is smotthed, how many segments should be used between each two particles [DataMember(6)] [Display(\"Segments\", null)] public int Segments { get; set; } Property Value int SmoothingPolicy Smoothing provides the option to additionally smooth the ribbon, enhancing visual quality for sharp angles [DataMember(5)] [Display(\"Smoothing\", null)] public SmoothingPolicy SmoothingPolicy { get; set; } Property Value SmoothingPolicy TexCoordsFactor The factor (coefficient) for length to use when building texture coordinates [DataMember(20)] [Display(\"UV Factor\", null)] public float TexCoordsFactor { get; set; } Property Value float TextureCoordinatePolicy Specifies how texture coordinates for the ribbons should be built [DataMember(10)] [Display(\"UV Coords\", null)] public TextureCoordinatePolicy TextureCoordinatePolicy { get; set; } Property Value TextureCoordinatePolicy UVRotate Texture coordinates flip and rotate policy [DataMember(30)] [Display(\"UV Rotate\", null)] public UVRotate UVRotate { get; set; } Property Value UVRotate Methods BuildVertexBuffer(ref ParticleBufferState, Vector3, Vector3, ref Vector3, ref Quaternion, float, ref ParticleList, ref Matrix) Builds the actual vertex buffer for the current frame using the particle data public override int BuildVertexBuffer(ref ParticleBufferState bufferState, Vector3 invViewX, Vector3 invViewY, ref Vector3 spaceTranslation, ref Quaternion spaceRotation, float spaceScale, ref ParticleList sorter, ref Matrix viewProj) Parameters bufferState ParticleBufferState Target particle buffer state, used to populate the assigned vertex buffer invViewX Vector3 Unit vector X (right) in camera space, extracted from the inverse view matrix invViewY Vector3 Unit vector Y (up) in camera space, extracted from the inverse view matrix spaceTranslation Vector3 Translation of the target draw space in regard to the particle data (world or local) spaceRotation Quaternion Rotation of the target draw space in regard to the particle data (world or local) spaceScale float Uniform scale of the target draw space in regard to the particle data (world or local) sorter ParticleList Particle enumerator which can be iterated and returns sported particles viewProj Matrix The View-Projection matrix which is used for some shape builders Returns int SetRequiredQuads(int, int, int) Sets the required quads per particle and number of particles so that a sufficiently big buffer can be allocated public override void SetRequiredQuads(int quadsPerParticle, int livingParticles, int totalParticles) Parameters quadsPerParticle int Required quads per particle, assuming 1 quad = 4 vertices = 6 indices livingParticles int Number of living particles this frame totalParticles int Number of total number of possible particles for the parent emitter"
  },
  "api/Stride.Particles.ShapeBuilders.SmoothingPolicy.html": {
    "href": "api/Stride.Particles.ShapeBuilders.SmoothingPolicy.html",
    "title": "Enum SmoothingPolicy | Stride API",
    "summary": "Enum SmoothingPolicy Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll Specifies if the ribbon should be additionally smoothed or rendered as is. [DataContract(\"SmoothingPolicy\")] [Display(\"Smoothing\", null)] public enum SmoothingPolicy Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Best = 2 Smoothing based on circumcircles generated around every three adjacent points. Best suited for rapid, circular motions Fast = 1 Smoothing using Catmull-Rom interpolation. Generally looks good None = 0 Ribbons only use control points and edges are hard. Good for straight lines"
  },
  "api/Stride.Particles.ShapeBuilders.TextureCoordinatePolicy.html": {
    "href": "api/Stride.Particles.ShapeBuilders.TextureCoordinatePolicy.html",
    "title": "Enum TextureCoordinatePolicy | Stride API",
    "summary": "Enum TextureCoordinatePolicy Namespace Stride.Particles.ShapeBuilders Assembly Stride.Particles.dll Specifies how texture coordinates should be assigned to the ribbonized mesh. [DataContract(\"TextureCoordinatePolicy\")] [Display(\"Tex Coordinates\", null)] public enum TextureCoordinatePolicy Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AsIs = 0 AsIs will assign a (0, 0, 1, 1) quad to each segment along the ribbon. DistanceBased = 2 DistanceBased will assign a (0, 0, 1, Length) quad stretched over the entire ribbon, where Length is the actual length of the ribbon. Stretched = 1 Stretched will assign a (0, 0, 1, X) quad stretched over the entire ribbon, where X is user-defined."
  },
  "api/Stride.Particles.ShapeBuilders.Tools.UVClockwiseRotation.html": {
    "href": "api/Stride.Particles.ShapeBuilders.Tools.UVClockwiseRotation.html",
    "title": "Enum UVClockwiseRotation | Stride API",
    "summary": "Enum UVClockwiseRotation Namespace Stride.Particles.ShapeBuilders.Tools Assembly Stride.Particles.dll public enum UVClockwiseRotation Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"No rotation\", null)] Degree0 = 0 [Display(\"180 degrees\", null)] Degree180 = 2 [Display(\"270 degrees\", null)] Degree270 = 3 [Display(\"90 degrees\", null)] Degree90 = 1"
  },
  "api/Stride.Particles.ShapeBuilders.Tools.UVRotate.html": {
    "href": "api/Stride.Particles.ShapeBuilders.Tools.UVRotate.html",
    "title": "Struct UVRotate | Stride API",
    "summary": "Struct UVRotate Namespace Stride.Particles.ShapeBuilders.Tools Assembly Stride.Particles.dll Struct used to rotate and/or flip texture coordinates [DataContract(\"UVRotate\")] [Display(\"UV Rotate\", null)] public struct UVRotate Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties FlipX If True, the texture coordinates will be flipped horizontally prior to texture sampling. [Display(\"Flip Hor\", null)] public bool FlipX { get; set; } Property Value bool FlipY If True, the texture coordinates will be flipped vertically prior to texture sampling. [Display(\"Flip Ver\", null)] public bool FlipY { get; set; } Property Value bool UVClockwise If True, the texture coordinates will be rotated clockwise by the specified angle prior to texture sampling. [Display(\"Clockwise\", null)] public UVClockwiseRotation UVClockwise { get; set; } Property Value UVClockwiseRotation Methods GetCoords(Vector2) Returns the rotated texture coordinates for base input texture coordinates public Vector2 GetCoords(Vector2 inVector) Parameters inVector Vector2 Base texture coordinates Returns Vector2 Rotated and flipped coordinates"
  },
  "api/Stride.Particles.ShapeBuilders.Tools.html": {
    "href": "api/Stride.Particles.ShapeBuilders.Tools.html",
    "title": "Namespace Stride.Particles.ShapeBuilders.Tools | Stride API",
    "summary": "Namespace Stride.Particles.ShapeBuilders.Tools Structs UVRotate Struct used to rotate and/or flip texture coordinates Enums UVClockwiseRotation"
  },
  "api/Stride.Particles.ShapeBuilders.html": {
    "href": "api/Stride.Particles.ShapeBuilders.html",
    "title": "Namespace Stride.Particles.ShapeBuilders | Stride API",
    "summary": "Namespace Stride.Particles.ShapeBuilders Classes ShapeBuilder The ShapeBuilder base class is responsible for generating shapes (procedural mesh) ready for rendering from the particle data ShapeBuilderBillboard Shape builder which builds each particle as a camera-facing quad ShapeBuilderCommon The common shape builder provides additive animation for the particle's position and size fields, assuming that all derived shape builders will have position and size fields ShapeBuilderHexagon Shape builder which builds each particle as a camera-facing hexagon ShapeBuilderOrientedQuad Shape builder which builds each particle as a non-uniform quad oriented along an axis ShapeBuilderQuad Shape builder which builds each particle as a up-facing quad, further rotated by the particle's rotation in 3d space ShapeBuilderRibbon Shape builder which builds all particles as a ribbon, connecting adjacent particles with camera-facing quads ShapeBuilderTrail Shape builder which builds all particles as a trail, connecting adjacent particles in a ribbon defined by a fixed 3d axis Enums EdgePolicy Specifies if the trail lies on one edge on the axis or is the axis in its center. SmoothingPolicy Specifies if the ribbon should be additionally smoothed or rendered as is. TextureCoordinatePolicy Specifies how texture coordinates should be assigned to the ribbonized mesh."
  },
  "api/Stride.Particles.Sorters.ArrayPool-1.html": {
    "href": "api/Stride.Particles.Sorters.ArrayPool-1.html",
    "title": "Class ArrayPool<T> | Stride API",
    "summary": "Class ArrayPool<T> Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll public class ArrayPool<T> where T : struct Type Parameters T Inheritance object ArrayPool<T> Derived ConcurrentArrayPool<T> Extension Methods UnsafeUtilities.As<T>(object?) Fields Empty public static readonly T[] Empty Field Value T[] Methods Allocate(int) public virtual T[] Allocate(int size) Parameters size int Returns T[] Clear() public virtual void Clear() Free(T[]) public virtual void Free(T[] array) Parameters array T[]"
  },
  "api/Stride.Particles.Sorters.ConcurrentArrayPool-1.html": {
    "href": "api/Stride.Particles.Sorters.ConcurrentArrayPool-1.html",
    "title": "Class ConcurrentArrayPool<T> | Stride API",
    "summary": "Class ConcurrentArrayPool<T> Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll public class ConcurrentArrayPool<T> : ArrayPool<T> where T : struct Type Parameters T Inheritance object ArrayPool<T> ConcurrentArrayPool<T> Inherited Members ArrayPool<T>.Empty Extension Methods UnsafeUtilities.As<T>(object?) Methods Allocate(int) public override T[] Allocate(int size) Parameters size int Returns T[] Clear() public override void Clear() Free(T[]) public override void Free(T[] array) Parameters array T[]"
  },
  "api/Stride.Particles.Sorters.Enumerator.html": {
    "href": "api/Stride.Particles.Sorters.Enumerator.html",
    "title": "Struct Enumerator | Stride API",
    "summary": "Struct Enumerator Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll public struct Enumerator : IEnumerator<Particle>, IEnumerator, IDisposable Implements IEnumerator<Particle> IEnumerator IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Current Gets the element in the collection at the current position of the enumerator. public Particle Current { get; } Property Value Particle The element in the collection at the current position of the enumerator. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() MoveNext() Advances the enumerator to the next element of the collection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created. Reset() Sets the enumerator to its initial position, which is before the first element in the collection. public void Reset() Exceptions InvalidOperationException The collection was modified after the enumerator was created. NotSupportedException The enumerator does not support being reset."
  },
  "api/Stride.Particles.Sorters.IParticleSorter.html": {
    "href": "api/Stride.Particles.Sorters.IParticleSorter.html",
    "title": "Interface IParticleSorter | Stride API",
    "summary": "Interface IParticleSorter Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll public interface IParticleSorter Extension Methods UnsafeUtilities.As<T>(object?) Methods FreeSortedList(ref ParticleList) void FreeSortedList(ref ParticleList sortedList) Parameters sortedList ParticleList GetSortedList(Vector3) ParticleList GetSortedList(Vector3 depth) Parameters depth Vector3 Returns ParticleList"
  },
  "api/Stride.Particles.Sorters.ISortValueCalculator-1.html": {
    "href": "api/Stride.Particles.Sorters.ISortValueCalculator-1.html",
    "title": "Interface ISortValueCalculator<T> | Stride API",
    "summary": "Interface ISortValueCalculator<T> Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll public interface ISortValueCalculator<T> where T : struct Type Parameters T Extension Methods UnsafeUtilities.As<T>(object?) Methods GetSortValue(T) float GetSortValue(T value) Parameters value T Returns float"
  },
  "api/Stride.Particles.Sorters.ParticleList.Enumerator.html": {
    "href": "api/Stride.Particles.Sorters.ParticleList.Enumerator.html",
    "title": "Struct ParticleList.Enumerator | Stride API",
    "summary": "Struct ParticleList.Enumerator Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll public struct ParticleList.Enumerator : IEnumerator<Particle>, IEnumerator, IDisposable Implements IEnumerator<Particle> IEnumerator IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties Current Gets the element in the collection at the current position of the enumerator. public readonly Particle Current { get; } Property Value Particle The element in the collection at the current position of the enumerator. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() MoveNext() Advances the enumerator to the next element of the collection. public bool MoveNext() Returns bool true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Exceptions InvalidOperationException The collection was modified after the enumerator was created. Reset() Sets the enumerator to its initial position, which is before the first element in the collection. public void Reset() Exceptions InvalidOperationException The collection was modified after the enumerator was created. NotSupportedException The enumerator does not support being reset."
  },
  "api/Stride.Particles.Sorters.ParticleList.html": {
    "href": "api/Stride.Particles.Sorters.ParticleList.html",
    "title": "Struct ParticleList | Stride API",
    "summary": "Struct ParticleList Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll public struct ParticleList : IEnumerable Implements IEnumerable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Constructors ParticleList(ParticlePool, int, SortedParticle[]) public ParticleList(ParticlePool pool, int capacity, SortedParticle[] list = null) Parameters pool ParticlePool capacity int list SortedParticle[] Methods Free(ConcurrentArrayPool<SortedParticle>) public void Free(ConcurrentArrayPool<SortedParticle> sortedArrayPool) Parameters sortedArrayPool ConcurrentArrayPool<SortedParticle> GetEnumerator() public ParticleList.Enumerator GetEnumerator() Returns ParticleList.Enumerator GetField<T>(ParticleFieldDescription<T>) Returns a particle field accessor for the contained ParticlePool public ParticleFieldAccessor<T> GetField<T>(ParticleFieldDescription<T> fieldDesc) where T : struct Parameters fieldDesc ParticleFieldDescription<T> The field description Returns ParticleFieldAccessor<T> Type Parameters T Type data for the field"
  },
  "api/Stride.Particles.Sorters.ParticleSorterAge.html": {
    "href": "api/Stride.Particles.Sorters.ParticleSorterAge.html",
    "title": "Class ParticleSorterAge | Stride API",
    "summary": "Class ParticleSorterAge Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll Sorts the particles by descending order of their remaining Life public class ParticleSorterAge : ParticleSorterCustom<float>, IParticleSorter Inheritance object ParticleSorterCustom<float> ParticleSorterAge Implements IParticleSorter Inherited Members ParticleSorterCustom<float>.fieldDesc ParticleSorterCustom<float>.ArrayPool ParticleSorterCustom<float>.ParticlePool Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleSorterAge(ParticlePool) public ParticleSorterAge(ParticlePool pool) Parameters pool ParticlePool Methods FreeSortedList(ref ParticleList) In case an array was used it must be freed back to the pool public void FreeSortedList(ref ParticleList sortedList) Parameters sortedList ParticleList Reference to the ParticleList to be freed GetSortedList(Vector3) public ParticleList GetSortedList(Vector3 depth) Parameters depth Vector3 Returns ParticleList"
  },
  "api/Stride.Particles.Sorters.ParticleSorterCustom-1.html": {
    "href": "api/Stride.Particles.Sorters.ParticleSorterCustom-1.html",
    "title": "Class ParticleSorterCustom<T> | Stride API",
    "summary": "Class ParticleSorterCustom<T> Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll The custom sorter uses a user-defined method for generating sort index from a user-defined field public abstract class ParticleSorterCustom<T> where T : struct Type Parameters T Inheritance object ParticleSorterCustom<T> Derived ParticleSorterAge ParticleSorterDepth ParticleSorterOrder Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleSorterCustom(ParticlePool, ParticleFieldDescription<T>) protected ParticleSorterCustom(ParticlePool pool, ParticleFieldDescription<T> fieldDesc) Parameters pool ParticlePool fieldDesc ParticleFieldDescription<T> Fields ArrayPool protected readonly ConcurrentArrayPool<SortedParticle> ArrayPool Field Value ConcurrentArrayPool<SortedParticle> ParticlePool protected readonly ParticlePool ParticlePool Field Value ParticlePool fieldDesc protected readonly ParticleFieldDescription<T> fieldDesc Field Value ParticleFieldDescription<T>"
  },
  "api/Stride.Particles.Sorters.ParticleSorterDefault.html": {
    "href": "api/Stride.Particles.Sorters.ParticleSorterDefault.html",
    "title": "Class ParticleSorterDefault | Stride API",
    "summary": "Class ParticleSorterDefault Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll The default sorter doesn not sort the particles, but only passes them directly to the renderer public class ParticleSorterDefault : IParticleSorter Inheritance object ParticleSorterDefault Implements IParticleSorter Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleSorterDefault(ParticlePool) public ParticleSorterDefault(ParticlePool pool) Parameters pool ParticlePool Fields ParticlePool Target ParticlePool to iterate and sort protected readonly ParticlePool ParticlePool Field Value ParticlePool Methods FreeSortedList(ref ParticleList) The default sorter does not allocate any resources so there is nothing to free public void FreeSortedList(ref ParticleList sortedList) Parameters sortedList ParticleList Reference to the ParticleList to be freed GetSortedList(Vector3) public ParticleList GetSortedList(Vector3 depth) Parameters depth Vector3 Returns ParticleList"
  },
  "api/Stride.Particles.Sorters.ParticleSorterDepth.html": {
    "href": "api/Stride.Particles.Sorters.ParticleSorterDepth.html",
    "title": "Class ParticleSorterDepth | Stride API",
    "summary": "Class ParticleSorterDepth Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll Sorts the particles by ascending order of their Depth (position on the camera's Z axis) public class ParticleSorterDepth : ParticleSorterCustom<Vector3>, IParticleSorter Inheritance object ParticleSorterCustom<Vector3> ParticleSorterDepth Implements IParticleSorter Inherited Members ParticleSorterCustom<Vector3>.fieldDesc ParticleSorterCustom<Vector3>.ArrayPool ParticleSorterCustom<Vector3>.ParticlePool Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleSorterDepth(ParticlePool) public ParticleSorterDepth(ParticlePool pool) Parameters pool ParticlePool Methods FreeSortedList(ref ParticleList) In case an array was used it must be freed back to the pool public void FreeSortedList(ref ParticleList sortedList) Parameters sortedList ParticleList Reference to the ParticleList to be freed GetSortedList(Vector3) public ParticleList GetSortedList(Vector3 depth) Parameters depth Vector3 Returns ParticleList"
  },
  "api/Stride.Particles.Sorters.ParticleSorterOrder.html": {
    "href": "api/Stride.Particles.Sorters.ParticleSorterOrder.html",
    "title": "Class ParticleSorterOrder | Stride API",
    "summary": "Class ParticleSorterOrder Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll Sorts the particles by ascending order of their Order attribute public class ParticleSorterOrder : ParticleSorterCustom<uint>, IParticleSorter Inheritance object ParticleSorterCustom<uint> ParticleSorterOrder Implements IParticleSorter Inherited Members ParticleSorterCustom<uint>.fieldDesc ParticleSorterCustom<uint>.ArrayPool ParticleSorterCustom<uint>.ParticlePool Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleSorterOrder(ParticlePool) public ParticleSorterOrder(ParticlePool pool) Parameters pool ParticlePool Methods FreeSortedList(ref ParticleList) In case an array was used it must be freed back to the pool public void FreeSortedList(ref ParticleList sortedList) Parameters sortedList ParticleList Reference to the ParticleList to be freed GetSortedList(Vector3) public ParticleList GetSortedList(Vector3 depth) Parameters depth Vector3 Returns ParticleList"
  },
  "api/Stride.Particles.Sorters.SortedParticle.html": {
    "href": "api/Stride.Particles.Sorters.SortedParticle.html",
    "title": "Struct SortedParticle | Stride API",
    "summary": "Struct SortedParticle Namespace Stride.Particles.Sorters Assembly Stride.Particles.dll public struct SortedParticle : IComparable<SortedParticle> Implements IComparable<SortedParticle> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors SortedParticle(Particle, float) public SortedParticle(Particle particle, float sortIndex) Parameters particle Particle sortIndex float Fields Particle public readonly Particle Particle Field Value Particle SortIndex public readonly float SortIndex Field Value float Methods Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(SortedParticle, SortedParticle) public static bool operator ==(SortedParticle left, SortedParticle right) Parameters left SortedParticle right SortedParticle Returns bool operator >(SortedParticle, SortedParticle) public static bool operator >(SortedParticle left, SortedParticle right) Parameters left SortedParticle right SortedParticle Returns bool operator >=(SortedParticle, SortedParticle) public static bool operator >=(SortedParticle left, SortedParticle right) Parameters left SortedParticle right SortedParticle Returns bool operator !=(SortedParticle, SortedParticle) public static bool operator !=(SortedParticle left, SortedParticle right) Parameters left SortedParticle right SortedParticle Returns bool operator <(SortedParticle, SortedParticle) public static bool operator <(SortedParticle left, SortedParticle right) Parameters left SortedParticle right SortedParticle Returns bool operator <=(SortedParticle, SortedParticle) public static bool operator <=(SortedParticle left, SortedParticle right) Parameters left SortedParticle right SortedParticle Returns bool"
  },
  "api/Stride.Particles.Sorters.html": {
    "href": "api/Stride.Particles.Sorters.html",
    "title": "Namespace Stride.Particles.Sorters | Stride API",
    "summary": "Namespace Stride.Particles.Sorters Classes ArrayPool<T> ConcurrentArrayPool<T> ParticleSorterAge Sorts the particles by descending order of their remaining Life ParticleSorterCustom<T> The custom sorter uses a user-defined method for generating sort index from a user-defined field ParticleSorterDefault The default sorter doesn not sort the particles, but only passes them directly to the renderer ParticleSorterDepth Sorts the particles by ascending order of their Depth (position on the camera's Z axis) ParticleSorterOrder Sorts the particles by ascending order of their Order attribute Structs Enumerator ParticleList ParticleList.Enumerator SortedParticle Interfaces IParticleSorter ISortValueCalculator<T>"
  },
  "api/Stride.Particles.Spawners.ParentControlFlag.html": {
    "href": "api/Stride.Particles.Spawners.ParentControlFlag.html",
    "title": "Enum ParentControlFlag | Stride API",
    "summary": "Enum ParentControlFlag Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll Some initializers require fine control between parent and child emitters. Use the control group to assign such meta-fields. [DataContract(\"ParentControlFlag\")] [Display(\"Control group\", null)] public enum ParentControlFlag Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"Group 0\", null)] Group00 = 0 Use a meta-data control group with index 0 [Display(\"Group 1\", null)] Group01 = 1 Use a meta-data control group with index 1 [Display(\"Group 2\", null)] Group02 = 2 Use a meta-data control group with index 2 [Display(\"Group 3\", null)] Group03 = 3 Use a meta-data control group with index 3 [Display(\"None\", null)] None = 2147483647 Do not use meta-data control groups"
  },
  "api/Stride.Particles.Spawners.ParticleChildrenAttribute.html": {
    "href": "api/Stride.Particles.Spawners.ParticleChildrenAttribute.html",
    "title": "Struct ParticleChildrenAttribute | Stride API",
    "summary": "Struct ParticleChildrenAttribute Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll public struct ParticleChildrenAttribute Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ParticleChildrenAttribute(ParticleChildrenAttribute) public ParticleChildrenAttribute(ParticleChildrenAttribute other) Parameters other ParticleChildrenAttribute Fields Empty public static ParticleChildrenAttribute Empty Field Value ParticleChildrenAttribute Properties CarryOver public float CarryOver { get; set; } Property Value float ParticlesToEmit public uint ParticlesToEmit { get; set; } Property Value uint"
  },
  "api/Stride.Particles.Spawners.ParticleSpawnTrigger-1.html": {
    "href": "api/Stride.Particles.Spawners.ParticleSpawnTrigger-1.html",
    "title": "Class ParticleSpawnTrigger<T> | Stride API",
    "summary": "Class ParticleSpawnTrigger<T> Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll ParticleSpawnTrigger governs the condition under which particle emission is triggered for spawners like SpawnerFromParent public abstract class ParticleSpawnTrigger<T> : ParticleSpawnTrigger where T : struct Type Parameters T Inheritance object ParticleSpawnTrigger ParticleSpawnTrigger<T> Derived ParticleSpawnTriggerBirth ParticleSpawnTriggerCollision ParticleSpawnTriggerDeath ParticleSpawnTriggerDistance ParticleSpawnTriggerLifetime Inherited Members ParticleSpawnTrigger.PrepareFromPool(ParticlePool) ParticleSpawnTrigger.HasTriggered(Particle) ParticleSpawnTrigger.AddRequiredParentFields(ParticleEmitter) ParticleSpawnTrigger.RemoveRequiredParentFields(ParticleEmitter) Extension Methods UnsafeUtilities.As<T>(object?) Fields FieldAccessor protected ParticleFieldAccessor<T> FieldAccessor Field Value ParticleFieldAccessor<T>"
  },
  "api/Stride.Particles.Spawners.ParticleSpawnTrigger.html": {
    "href": "api/Stride.Particles.Spawners.ParticleSpawnTrigger.html",
    "title": "Class ParticleSpawnTrigger | Stride API",
    "summary": "Class ParticleSpawnTrigger Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll ParticleSpawnTrigger governs the condition under which particle emission is triggered for spawners like SpawnerFromParent public abstract class ParticleSpawnTrigger Inheritance object ParticleSpawnTrigger Derived ParticleSpawnTrigger<T> Extension Methods UnsafeUtilities.As<T>(object?) Methods AddRequiredParentFields(ParticleEmitter) Override to add the required fields to the parent emitter public virtual void AddRequiredParentFields(ParticleEmitter parentEmitter) Parameters parentEmitter ParticleEmitter Parent emitter to which required fields should be added HasTriggered(Particle) For positive values, shows if the condition was met and how much is the magnitude public abstract float HasTriggered(Particle parentParticle) Parameters parentParticle Particle Parent particle which attributes are used for testing Returns float 0f if it hasn't triggered, positive value otherwise, which also indicates the magnitude of the trigger PrepareFromPool(ParticlePool) Prepares fields accessors before the public abstract void PrepareFromPool(ParticlePool pool) Parameters pool ParticlePool RemoveRequiredParentFields(ParticleEmitter) Override to remove the required fields from the parent emitter public virtual void RemoveRequiredParentFields(ParticleEmitter parentEmitter) Parameters parentEmitter ParticleEmitter Parent emitter from which required fields should be removed"
  },
  "api/Stride.Particles.Spawners.ParticleSpawnTriggerBirth.html": {
    "href": "api/Stride.Particles.Spawners.ParticleSpawnTriggerBirth.html",
    "title": "Class ParticleSpawnTriggerBirth | Stride API",
    "summary": "Class ParticleSpawnTriggerBirth Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll ParticleSpawnTriggerBirth triggers when the parent particle is first spawned [DataContract(\"ParticleSpawnTriggerBirth\")] [Display(\"On Birth\", null)] public class ParticleSpawnTriggerBirth : ParticleSpawnTrigger<float> Inheritance object ParticleSpawnTrigger ParticleSpawnTrigger<float> ParticleSpawnTriggerBirth Inherited Members ParticleSpawnTrigger<float>.FieldAccessor ParticleSpawnTrigger.AddRequiredParentFields(ParticleEmitter) ParticleSpawnTrigger.RemoveRequiredParentFields(ParticleEmitter) Extension Methods UnsafeUtilities.As<T>(object?) Methods HasTriggered(Particle) For positive values, shows if the condition was met and how much is the magnitude public override float HasTriggered(Particle parentParticle) Parameters parentParticle Particle Parent particle which attributes are used for testing Returns float 0f if it hasn't triggered, positive value otherwise, which also indicates the magnitude of the trigger PrepareFromPool(ParticlePool) Prepares fields accessors before the public override void PrepareFromPool(ParticlePool pool) Parameters pool ParticlePool"
  },
  "api/Stride.Particles.Spawners.ParticleSpawnTriggerCollision.html": {
    "href": "api/Stride.Particles.Spawners.ParticleSpawnTriggerCollision.html",
    "title": "Class ParticleSpawnTriggerCollision | Stride API",
    "summary": "Class ParticleSpawnTriggerCollision Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll ParticleSpawnTriggerCollision triggers when the parent particle collides with a surface [DataContract(\"ParticleSpawnTriggerCollision\")] [Display(\"On Hit\", null)] public class ParticleSpawnTriggerCollision : ParticleSpawnTrigger<ParticleCollisionAttribute> Inheritance object ParticleSpawnTrigger ParticleSpawnTrigger<ParticleCollisionAttribute> ParticleSpawnTriggerCollision Inherited Members ParticleSpawnTrigger<ParticleCollisionAttribute>.FieldAccessor ParticleSpawnTrigger.AddRequiredParentFields(ParticleEmitter) ParticleSpawnTrigger.RemoveRequiredParentFields(ParticleEmitter) Extension Methods UnsafeUtilities.As<T>(object?) Methods HasTriggered(Particle) For positive values, shows if the condition was met and how much is the magnitude public override float HasTriggered(Particle parentParticle) Parameters parentParticle Particle Parent particle which attributes are used for testing Returns float 0f if it hasn't triggered, positive value otherwise, which also indicates the magnitude of the trigger PrepareFromPool(ParticlePool) Prepares fields accessors before the public override void PrepareFromPool(ParticlePool pool) Parameters pool ParticlePool"
  },
  "api/Stride.Particles.Spawners.ParticleSpawnTriggerDeath.html": {
    "href": "api/Stride.Particles.Spawners.ParticleSpawnTriggerDeath.html",
    "title": "Class ParticleSpawnTriggerDeath | Stride API",
    "summary": "Class ParticleSpawnTriggerDeath Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll ParticleSpawnTriggerDeath triggers when the parent particle dies [DataContract(\"ParticleSpawnTriggerDeath\")] [Display(\"On Death\", null)] public class ParticleSpawnTriggerDeath : ParticleSpawnTrigger<float> Inheritance object ParticleSpawnTrigger ParticleSpawnTrigger<float> ParticleSpawnTriggerDeath Inherited Members ParticleSpawnTrigger<float>.FieldAccessor ParticleSpawnTrigger.AddRequiredParentFields(ParticleEmitter) ParticleSpawnTrigger.RemoveRequiredParentFields(ParticleEmitter) Extension Methods UnsafeUtilities.As<T>(object?) Methods HasTriggered(Particle) For positive values, shows if the condition was met and how much is the magnitude public override float HasTriggered(Particle parentParticle) Parameters parentParticle Particle Parent particle which attributes are used for testing Returns float 0f if it hasn't triggered, positive value otherwise, which also indicates the magnitude of the trigger PrepareFromPool(ParticlePool) Prepares fields accessors before the public override void PrepareFromPool(ParticlePool pool) Parameters pool ParticlePool"
  },
  "api/Stride.Particles.Spawners.ParticleSpawnTriggerDistance.html": {
    "href": "api/Stride.Particles.Spawners.ParticleSpawnTriggerDistance.html",
    "title": "Class ParticleSpawnTriggerDistance | Stride API",
    "summary": "Class ParticleSpawnTriggerDistance Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll ParticleSpawnTriggerDistance triggers when the parent particle tarvels beyond set distance [DataContract(\"ParticleSpawnTriggerDistance\")] [Display(\"Distance\", null)] public class ParticleSpawnTriggerDistance : ParticleSpawnTrigger<Vector3> Inheritance object ParticleSpawnTrigger ParticleSpawnTrigger<Vector3> ParticleSpawnTriggerDistance Inherited Members ParticleSpawnTrigger<Vector3>.FieldAccessor Extension Methods UnsafeUtilities.As<T>(object?) Fields SecondFieldAccessor protected ParticleFieldAccessor<Vector3> SecondFieldAccessor Field Value ParticleFieldAccessor<Vector3> Methods AddRequiredParentFields(ParticleEmitter) Override to add the required fields to the parent emitter public override void AddRequiredParentFields(ParticleEmitter parentEmitter) Parameters parentEmitter ParticleEmitter Parent emitter to which required fields should be added HasTriggered(Particle) For positive values, shows if the condition was met and how much is the magnitude public override float HasTriggered(Particle parentParticle) Parameters parentParticle Particle Parent particle which attributes are used for testing Returns float 0f if it hasn't triggered, positive value otherwise, which also indicates the magnitude of the trigger PrepareFromPool(ParticlePool) Prepares fields accessors before the public override void PrepareFromPool(ParticlePool pool) Parameters pool ParticlePool RemoveRequiredParentFields(ParticleEmitter) Override to remove the required fields from the parent emitter public override void RemoveRequiredParentFields(ParticleEmitter parentEmitter) Parameters parentEmitter ParticleEmitter Parent emitter from which required fields should be removed"
  },
  "api/Stride.Particles.Spawners.ParticleSpawnTriggerLifetime.html": {
    "href": "api/Stride.Particles.Spawners.ParticleSpawnTriggerLifetime.html",
    "title": "Class ParticleSpawnTriggerLifetime | Stride API",
    "summary": "Class ParticleSpawnTriggerLifetime Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll ParticleSpawnTriggerLifetime triggers when the parent particle's remaining lifetime is within the specified limit [DataContract(\"ParticleSpawnTriggerLifetime\")] [Display(\"Lifetime\", null)] public class ParticleSpawnTriggerLifetime : ParticleSpawnTrigger<float> Inheritance object ParticleSpawnTrigger ParticleSpawnTrigger<float> ParticleSpawnTriggerLifetime Inherited Members ParticleSpawnTrigger<float>.FieldAccessor ParticleSpawnTrigger.AddRequiredParentFields(ParticleEmitter) ParticleSpawnTrigger.RemoveRequiredParentFields(ParticleEmitter) Extension Methods UnsafeUtilities.As<T>(object?) Properties LifetimeLowerLimit If the parent particle is younger than the lower limit, it won't spawn children. When the lower limit is higher than the upper limit the condition is reversed. [DataMember(10)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Lower Limit\", null)] public float LifetimeLowerLimit { get; set; } Property Value float LifetimeUpperLimit If the parent particle is older than the upper limit, it won't spawn children. When the upper limit is smaller than the lower limit the condition is reversed. [DataMember(20)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Upper Limit\", null)] public float LifetimeUpperLimit { get; set; } Property Value float Methods HasTriggered(Particle) For positive values, shows if the condition was met and how much is the magnitude public override float HasTriggered(Particle parentParticle) Parameters parentParticle Particle Parent particle which attributes are used for testing Returns float 0f if it hasn't triggered, positive value otherwise, which also indicates the magnitude of the trigger PrepareFromPool(ParticlePool) Prepares fields accessors before the public override void PrepareFromPool(ParticlePool pool) Parameters pool ParticlePool"
  },
  "api/Stride.Particles.Spawners.ParticleSpawner.html": {
    "href": "api/Stride.Particles.Spawners.ParticleSpawner.html",
    "title": "Class ParticleSpawner | Stride API",
    "summary": "Class ParticleSpawner Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll ParticleSpawner governs the rate at which new particles are emitted into the ParticleEmitter Multiple spawners with different triggering conditions can be part of the same ParticleEmitter [DataContract(\"ParticleSpawner\")] public abstract class ParticleSpawner Inheritance object ParticleSpawner Derived SpawnerBurst SpawnerFromDistance SpawnerFromParent SpawnerPerFrame SpawnerPerSecond Extension Methods UnsafeUtilities.As<T>(object?) Properties Delay The minimum and maximum time the spawner should wait before starting to emit particles [DataMember(10)] [Display(\"Delay\", null)] public Vector2 Delay { get; set; } Property Value Vector2 Duration The minimum and maximum duration the spawner will be active once it starts spawning particles [DataMember(15)] [Display(\"Duration\", null)] public Vector2 Duration { get; set; } Property Value Vector2 Enabled Gets or sets a value indicating whether this ParticleSpawner is enabled. [DataMember(-10)] public bool Enabled { get; set; } Property Value bool true if enabled; otherwise, false. LoopCondition Indicates if the spawner should loop, and if there is a delay every time it loops [DataMember(5)] [Display(\"Loop\", null)] public SpawnerLoopCondition LoopCondition { get; set; } Property Value SpawnerLoopCondition Methods GetMaxParticlesPerSecond() Get the maximum number of particles this spawner can emit in one second public abstract int GetMaxParticlesPerSecond() Returns int Peak particles per second GetUpdatedState(float, ParticleEmitter) Updates and gets the current internal state protected SpawnerState GetUpdatedState(float dt, ParticleEmitter emitter) Parameters dt float Delta time in seconds since the last GetUpdatedState(float, ParticleEmitter) was called emitter ParticleEmitter Parent ParticleEmitter for this spawner Returns SpawnerState InvalidateRelations() Invalidates relation of this emitter to any other emitters that might be referenced public virtual void InvalidateRelations() MarkAsDirty() Marking the spawner as dirty will notify the parent emitter that the maximum number of particles need to be recalculated protected void MarkAsDirty() NotifyStateSwitch(SpawnerState) Will be called when the state changes. Override if you need to set/reset variables based on state changes protected virtual void NotifyStateSwitch(SpawnerState newState) Parameters newState SpawnerState The new state SpawnNew(float, ParticleEmitter) This method will be called form the emitter when it needs to poll how many particles to spawn (usually once per frame) public abstract void SpawnNew(float dt, ParticleEmitter emitter) Parameters dt float Time it has past since the last update (in seconds) emitter ParticleEmitter Parent emitter in which new particles should be emitter"
  },
  "api/Stride.Particles.Spawners.SpawnerBurst.html": {
    "href": "api/Stride.Particles.Spawners.SpawnerBurst.html",
    "title": "Class SpawnerBurst | Stride API",
    "summary": "Class SpawnerBurst Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll A particle spawner which continuously spawns particles. Number of particles to be spawned is given in seconds. [DataContract(\"SpawnerBurst\")] [Display(\"Burst\", null)] public sealed class SpawnerBurst : ParticleSpawner Inheritance object ParticleSpawner SpawnerBurst Inherited Members ParticleSpawner.Enabled ParticleSpawner.LoopCondition ParticleSpawner.Delay ParticleSpawner.Duration ParticleSpawner.InvalidateRelations() Extension Methods UnsafeUtilities.As<T>(object?) Constructors SpawnerBurst() public SpawnerBurst() Properties SpawnCount The amount of particles this spawner will emit in one burst when it activates [DataMember(40)] [Display(\"Particles/burst\", null)] public int SpawnCount { get; set; } Property Value int Methods GetMaxParticlesPerSecond() Get the maximum number of particles this spawner can emit in one second public override int GetMaxParticlesPerSecond() Returns int Peak particles per second NotifyStateSwitch(SpawnerState) Will be called when the state changes. Override if you need to set/reset variables based on state changes protected override void NotifyStateSwitch(SpawnerState newState) Parameters newState SpawnerState The new state SpawnNew(float, ParticleEmitter) This method will be called form the emitter when it needs to poll how many particles to spawn (usually once per frame) public override void SpawnNew(float dt, ParticleEmitter emitter) Parameters dt float Time it has past since the last update (in seconds) emitter ParticleEmitter Parent emitter in which new particles should be emitter"
  },
  "api/Stride.Particles.Spawners.SpawnerFromDistance.html": {
    "href": "api/Stride.Particles.Spawners.SpawnerFromDistance.html",
    "title": "Class SpawnerFromDistance | Stride API",
    "summary": "Class SpawnerFromDistance Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll A particle spawner which continuously spawns particles. Number of particles to be spawned is given in seconds. [DataContract(\"SpawnerFromDistance\")] [Display(\"Distance\", null)] public sealed class SpawnerFromDistance : ParticleSpawner Inheritance object ParticleSpawner SpawnerFromDistance Inherited Members ParticleSpawner.Enabled ParticleSpawner.LoopCondition ParticleSpawner.Delay ParticleSpawner.Duration ParticleSpawner.InvalidateRelations() Extension Methods UnsafeUtilities.As<T>(object?) Constructors SpawnerFromDistance() public SpawnerFromDistance() Properties SpawnCount The amount of particles this spawner will emit over one second, every second [DataMember(40)] [Display(\"Particles/unit\", null)] public float SpawnCount { get; set; } Property Value float Methods GetMaxParticlesPerSecond() Get the maximum number of particles this spawner can emit in one second public override int GetMaxParticlesPerSecond() Returns int Peak particles per second SpawnNew(float, ParticleEmitter) This method will be called form the emitter when it needs to poll how many particles to spawn (usually once per frame) public override void SpawnNew(float dt, ParticleEmitter emitter) Parameters dt float Time it has past since the last update (in seconds) emitter ParticleEmitter Parent emitter in which new particles should be emitter"
  },
  "api/Stride.Particles.Spawners.SpawnerFromParent.html": {
    "href": "api/Stride.Particles.Spawners.SpawnerFromParent.html",
    "title": "Class SpawnerFromParent | Stride API",
    "summary": "Class SpawnerFromParent Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll A particle spawner which continuously spawns particles based on a condition set in a followed (parent) emitter [DataContract(\"SpawnerFromParent\")] [Display(\"From parent\", null)] public sealed class SpawnerFromParent : ParticleSpawner Inheritance object ParticleSpawner SpawnerFromParent Inherited Members ParticleSpawner.Enabled ParticleSpawner.LoopCondition ParticleSpawner.Delay ParticleSpawner.Duration Extension Methods UnsafeUtilities.As<T>(object?) Constructors SpawnerFromParent() Default constructor public SpawnerFromParent() Properties ParentControlFlag Some initializers require fine control between parent and child emitters. Use the control group to assign such meta-fields. [DataMember(40)] [Display(\"Spawn Control Group\", null)] public ParentControlFlag ParentControlFlag { get; set; } Property Value ParentControlFlag ParentName Name by which to reference a followed (parent) emitter [DataMember(30)] [Display(\"Parent emitter\", null)] public string ParentName { get; set; } Property Value string ParticleSpawnTrigger ParticleSpawnTrigger provides a class which checks if the spawning condition has triggered [DataMember(45)] public ParticleSpawnTrigger ParticleSpawnTrigger { get; set; } Property Value ParticleSpawnTrigger SpawnCount The amount of particles this spawner will emit when the event is triggered [DataMember(50)] [Display(\"Particles/trigger\", null)] public Vector2 SpawnCount { get; set; } Property Value Vector2 Methods GetMaxParticlesPerSecond() Get the maximum number of particles this spawner can emit in one second public override int GetMaxParticlesPerSecond() Returns int Peak particles per second InvalidateRelations() Invalidates relation of this emitter to any other emitters that might be referenced public override void InvalidateRelations() SpawnNew(float, ParticleEmitter) This method will be called form the emitter when it needs to poll how many particles to spawn (usually once per frame) public override void SpawnNew(float dt, ParticleEmitter emitter) Parameters dt float Time it has past since the last update (in seconds) emitter ParticleEmitter Parent emitter in which new particles should be emitter"
  },
  "api/Stride.Particles.Spawners.SpawnerLoopCondition.html": {
    "href": "api/Stride.Particles.Spawners.SpawnerLoopCondition.html",
    "title": "Enum SpawnerLoopCondition | Stride API",
    "summary": "Enum SpawnerLoopCondition Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll public enum SpawnerLoopCondition : byte Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"Looping\", null)] Looping = 0 Looping spawner will loop to the beginning of its Delay state when its Duration is over If there is no delay it's indistinguishable from LoopingNoDelay [Display(\"Looping, no delay\", null)] LoopingNoDelay = 1 LoopingNoDelay spawner will loop to the beginning of its Active state when its Duration is over essentially skipping the Delay state after the first loop If there is no delay it's indistinguishable from Looping [Display(\"One shot\", null)] OneShot = 2 OneShot particle spawners will not loop and will only be ative for a period of time equal to its Duration"
  },
  "api/Stride.Particles.Spawners.SpawnerPerFrame.html": {
    "href": "api/Stride.Particles.Spawners.SpawnerPerFrame.html",
    "title": "Class SpawnerPerFrame | Stride API",
    "summary": "Class SpawnerPerFrame Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll A particle spawner which continuously spawns particles. Number of particles to be spawned is given in seconds. [DataContract(\"SpawnerPerFrame\")] [Display(\"Per frame\", null)] public sealed class SpawnerPerFrame : ParticleSpawner Inheritance object ParticleSpawner SpawnerPerFrame Inherited Members ParticleSpawner.Enabled ParticleSpawner.LoopCondition ParticleSpawner.Delay ParticleSpawner.Duration ParticleSpawner.InvalidateRelations() Extension Methods UnsafeUtilities.As<T>(object?) Constructors SpawnerPerFrame() Default constructor public SpawnerPerFrame() Properties Framerate The maximum framerate you expect your game to achieve. It is only used for maximum particles estimation, not for actual spawning rate [DataMember(45)] [Display(\"Framerate\", null)] public float Framerate { get; set; } Property Value float SpawnCount The amount of particles this spawner will emit each frame [DataMember(40)] [Display(\"Particles/frame\", null)] public float SpawnCount { get; set; } Property Value float Methods GetMaxParticlesPerSecond() Get the maximum number of particles this spawner can emit in one second public override int GetMaxParticlesPerSecond() Returns int Peak particles per second SpawnNew(float, ParticleEmitter) This method will be called form the emitter when it needs to poll how many particles to spawn (usually once per frame) public override void SpawnNew(float dt, ParticleEmitter emitter) Parameters dt float Time it has past since the last update (in seconds) emitter ParticleEmitter Parent emitter in which new particles should be emitter"
  },
  "api/Stride.Particles.Spawners.SpawnerPerSecond.html": {
    "href": "api/Stride.Particles.Spawners.SpawnerPerSecond.html",
    "title": "Class SpawnerPerSecond | Stride API",
    "summary": "Class SpawnerPerSecond Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll A particle spawner which continuously spawns particles. Number of particles to be spawned is given in seconds. [DataContract(\"SpawnerPerSecond\")] [Display(\"Per second\", null)] public sealed class SpawnerPerSecond : ParticleSpawner Inheritance object ParticleSpawner SpawnerPerSecond Inherited Members ParticleSpawner.Enabled ParticleSpawner.LoopCondition ParticleSpawner.Delay ParticleSpawner.Duration ParticleSpawner.InvalidateRelations() Extension Methods UnsafeUtilities.As<T>(object?) Constructors SpawnerPerSecond() public SpawnerPerSecond() Properties SpawnCount The amount of particles this spawner will emit over one second, every second [DataMember(40)] [Display(\"Particles/second\", null)] public float SpawnCount { get; set; } Property Value float Methods GetMaxParticlesPerSecond() Get the maximum number of particles this spawner can emit in one second public override int GetMaxParticlesPerSecond() Returns int Peak particles per second SpawnNew(float, ParticleEmitter) This method will be called form the emitter when it needs to poll how many particles to spawn (usually once per frame) public override void SpawnNew(float dt, ParticleEmitter emitter) Parameters dt float Time it has past since the last update (in seconds) emitter ParticleEmitter Parent emitter in which new particles should be emitter"
  },
  "api/Stride.Particles.Spawners.SpawnerState.html": {
    "href": "api/Stride.Particles.Spawners.SpawnerState.html",
    "title": "Enum SpawnerState | Stride API",
    "summary": "Enum SpawnerState Namespace Stride.Particles.Spawners Assembly Stride.Particles.dll public enum SpawnerState : byte Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Active = 2 A spawner in Active state emits particles. After the Active state expires, the spawner can switch to Rest, Active or Dead state depending on its looping condition. Dead = 3 A spawner in Dead state is not emitting particles and likely not switching to Rest or Active anymore. Inactive = 0 A spawner in Inactive state hasn't been updated yet. Upon constructing, the Spawner is Inactive, but can't return to this state anymore Rest = 1 A spawner starts in Rest state and stays in this state for as long as it is delayed. While in Rest state it doesn't emit particles and switches to Active state after the Rest state is over"
  },
  "api/Stride.Particles.Spawners.html": {
    "href": "api/Stride.Particles.Spawners.html",
    "title": "Namespace Stride.Particles.Spawners | Stride API",
    "summary": "Namespace Stride.Particles.Spawners Classes ParticleSpawnTrigger ParticleSpawnTrigger governs the condition under which particle emission is triggered for spawners like SpawnerFromParent ParticleSpawnTriggerBirth ParticleSpawnTriggerBirth triggers when the parent particle is first spawned ParticleSpawnTriggerCollision ParticleSpawnTriggerCollision triggers when the parent particle collides with a surface ParticleSpawnTriggerDeath ParticleSpawnTriggerDeath triggers when the parent particle dies ParticleSpawnTriggerDistance ParticleSpawnTriggerDistance triggers when the parent particle tarvels beyond set distance ParticleSpawnTriggerLifetime ParticleSpawnTriggerLifetime triggers when the parent particle's remaining lifetime is within the specified limit ParticleSpawnTrigger<T> ParticleSpawnTrigger governs the condition under which particle emission is triggered for spawners like SpawnerFromParent ParticleSpawner ParticleSpawner governs the rate at which new particles are emitted into the ParticleEmitter Multiple spawners with different triggering conditions can be part of the same ParticleEmitter SpawnerBurst A particle spawner which continuously spawns particles. Number of particles to be spawned is given in seconds. SpawnerFromDistance A particle spawner which continuously spawns particles. Number of particles to be spawned is given in seconds. SpawnerFromParent A particle spawner which continuously spawns particles based on a condition set in a followed (parent) emitter SpawnerPerFrame A particle spawner which continuously spawns particles. Number of particles to be spawned is given in seconds. SpawnerPerSecond A particle spawner which continuously spawns particles. Number of particles to be spawned is given in seconds. Structs ParticleChildrenAttribute Enums ParentControlFlag Some initializers require fine control between parent and child emitters. Use the control group to assign such meta-fields. SpawnerLoopCondition SpawnerState"
  },
  "api/Stride.Particles.Updaters.FieldShapes.Cube.html": {
    "href": "api/Stride.Particles.Updaters.FieldShapes.Cube.html",
    "title": "Class Cube | Stride API",
    "summary": "Class Cube Namespace Stride.Particles.Updaters.FieldShapes Assembly Stride.Particles.dll [DataContract(\"FieldShapeCube\")] public class Cube : FieldShape Inheritance object FieldShape Cube Extension Methods UnsafeUtilities.As<T>(object?) Properties HalfSideX The maximum distance from the origin along the X axis. The X side is twice as big. [DataMember(10)] [DataMemberRange(0, 3)] [Display(\"Half X\", null)] public float HalfSideX { get; set; } Property Value float HalfSideY The maximum distance from the origin along the Y axis. The Y side is twice as big. [DataMember(20)] [DataMemberRange(0, 3)] [Display(\"Half Y\", null)] public float HalfSideY { get; set; } Property Value float HalfSideZ The maximum distance from the origin along the Z axis. The Z side is twice as big. [DataMember(30)] [DataMemberRange(0, 3)] [Display(\"Half Z\", null)] public float HalfSideZ { get; set; } Property Value float Methods GetDebugDrawShape(out Vector3, out Quaternion, out Vector3) public override DebugDrawShape GetDebugDrawShape(out Vector3 pos, out Quaternion rot, out Vector3 scl) Parameters pos Vector3 rot Quaternion scl Vector3 Returns DebugDrawShape GetDistanceToCenter(Vector3, Vector3, out Vector3, out Vector3, out Vector3) public override float GetDistanceToCenter(Vector3 particlePosition, Vector3 particleVelocity, out Vector3 alongAxis, out Vector3 aroundAxis, out Vector3 awayAxis) Parameters particlePosition Vector3 particleVelocity Vector3 alongAxis Vector3 aroundAxis Vector3 awayAxis Vector3 Returns float IsPointInside(Vector3, out Vector3, out Vector3) public override bool IsPointInside(Vector3 particlePosition, out Vector3 surfacePoint, out Vector3 surfaceNormal) Parameters particlePosition Vector3 surfacePoint Vector3 surfaceNormal Vector3 Returns bool PreUpdateField(Vector3, Quaternion, Vector3) public override void PreUpdateField(Vector3 position, Quaternion rotation, Vector3 size) Parameters position Vector3 rotation Quaternion size Vector3"
  },
  "api/Stride.Particles.Updaters.FieldShapes.Cylinder.html": {
    "href": "api/Stride.Particles.Updaters.FieldShapes.Cylinder.html",
    "title": "Class Cylinder | Stride API",
    "summary": "Class Cylinder Namespace Stride.Particles.Updaters.FieldShapes Assembly Stride.Particles.dll [DataContract(\"FieldShapeCylinder\")] public class Cylinder : FieldShape Inheritance object FieldShape Cylinder Extension Methods UnsafeUtilities.As<T>(object?) Properties HalfHeight The maximum distance from the origin along the Y axis. The height is twice as big. [DataMember(10)] [Display(\"Half height\", null)] public float HalfHeight { get; set; } Property Value float Radius The maximum distance from the central axis. [DataMember(20)] [Display(\"Radius\", null)] public float Radius { get; set; } Property Value float Methods GetDebugDrawShape(out Vector3, out Quaternion, out Vector3) public override DebugDrawShape GetDebugDrawShape(out Vector3 pos, out Quaternion rot, out Vector3 scl) Parameters pos Vector3 rot Quaternion scl Vector3 Returns DebugDrawShape GetDistanceToCenter(Vector3, Vector3, out Vector3, out Vector3, out Vector3) public override float GetDistanceToCenter(Vector3 particlePosition, Vector3 particleVelocity, out Vector3 alongAxis, out Vector3 aroundAxis, out Vector3 awayAxis) Parameters particlePosition Vector3 particleVelocity Vector3 alongAxis Vector3 aroundAxis Vector3 awayAxis Vector3 Returns float IsPointInside(Vector3, out Vector3, out Vector3) public override bool IsPointInside(Vector3 particlePosition, out Vector3 surfacePoint, out Vector3 surfaceNormal) Parameters particlePosition Vector3 surfacePoint Vector3 surfaceNormal Vector3 Returns bool PreUpdateField(Vector3, Quaternion, Vector3) public override void PreUpdateField(Vector3 position, Quaternion rotation, Vector3 size) Parameters position Vector3 rotation Quaternion size Vector3"
  },
  "api/Stride.Particles.Updaters.FieldShapes.FieldFalloff.html": {
    "href": "api/Stride.Particles.Updaters.FieldShapes.FieldFalloff.html",
    "title": "Class FieldFalloff | Stride API",
    "summary": "Class FieldFalloff Namespace Stride.Particles.Updaters.FieldShapes Assembly Stride.Particles.dll [DataContract(\"FieldFalloff\")] [Display(\"Falloff\", null)] public class FieldFalloff Inheritance object FieldFalloff Extension Methods UnsafeUtilities.As<T>(object?) Properties FalloffEnd After this relative distance from the center, the force strength will be equal to [Strength outside] [DataMember(40)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Falloff end\", null)] public float FalloffEnd { get; set; } Property Value float FalloffStart After this relative distance from the center, the force strength will start to change [DataMember(20)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Falloff start\", null)] public float FalloffStart { get; set; } Property Value float StrengthInside The strength of the force in the center of the bounding shape. [DataMember(10)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Strength inside\", null)] public float StrengthInside { get; set; } Property Value float StrengthOutside The strength of the force outside the bounding shape. [DataMember(30)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Strength outside\", null)] public float StrengthOutside { get; set; } Property Value float Methods GetStrength(float) Get interpolated strength based on relative distance from the center (lerp) public float GetStrength(float inDistance) Parameters inDistance float Returns float"
  },
  "api/Stride.Particles.Updaters.FieldShapes.FieldShape.html": {
    "href": "api/Stride.Particles.Updaters.FieldShapes.FieldShape.html",
    "title": "Class FieldShape | Stride API",
    "summary": "Class FieldShape Namespace Stride.Particles.Updaters.FieldShapes Assembly Stride.Particles.dll [DataContract(\"FieldShape\")] public abstract class FieldShape Inheritance object FieldShape Derived Cube Cylinder Sphere Torus Extension Methods UnsafeUtilities.As<T>(object?) Methods GetDebugDrawShape(out Vector3, out Quaternion, out Vector3) public abstract DebugDrawShape GetDebugDrawShape(out Vector3 pos, out Quaternion rot, out Vector3 scl) Parameters pos Vector3 rot Quaternion scl Vector3 Returns DebugDrawShape GetDistanceToCenter(Vector3, Vector3, out Vector3, out Vector3, out Vector3) public abstract float GetDistanceToCenter(Vector3 particlePosition, Vector3 particleVelocity, out Vector3 alongAxis, out Vector3 aroundAxis, out Vector3 awayAxis) Parameters particlePosition Vector3 particleVelocity Vector3 alongAxis Vector3 aroundAxis Vector3 awayAxis Vector3 Returns float IsPointInside(Vector3, out Vector3, out Vector3) public abstract bool IsPointInside(Vector3 particlePosition, out Vector3 surfacePoint, out Vector3 surfaceNormal) Parameters particlePosition Vector3 surfacePoint Vector3 surfaceNormal Vector3 Returns bool PreUpdateField(Vector3, Quaternion, Vector3) public abstract void PreUpdateField(Vector3 position, Quaternion rotation, Vector3 size) Parameters position Vector3 rotation Quaternion size Vector3"
  },
  "api/Stride.Particles.Updaters.FieldShapes.Sphere.html": {
    "href": "api/Stride.Particles.Updaters.FieldShapes.Sphere.html",
    "title": "Class Sphere | Stride API",
    "summary": "Class Sphere Namespace Stride.Particles.Updaters.FieldShapes Assembly Stride.Particles.dll [DataContract(\"FieldShapeSphere\")] public class Sphere : FieldShape Inheritance object FieldShape Sphere Extension Methods UnsafeUtilities.As<T>(object?) Properties Radius The maximum distance from the central point. [DataMember(20)] [DataMemberRange(0, 3)] [Display(\"Radius\", null)] public float Radius { get; set; } Property Value float Methods GetDebugDrawShape(out Vector3, out Quaternion, out Vector3) public override DebugDrawShape GetDebugDrawShape(out Vector3 pos, out Quaternion rot, out Vector3 scl) Parameters pos Vector3 rot Quaternion scl Vector3 Returns DebugDrawShape GetDistanceToCenter(Vector3, Vector3, out Vector3, out Vector3, out Vector3) public override float GetDistanceToCenter(Vector3 particlePosition, Vector3 particleVelocity, out Vector3 alongAxis, out Vector3 aroundAxis, out Vector3 awayAxis) Parameters particlePosition Vector3 particleVelocity Vector3 alongAxis Vector3 aroundAxis Vector3 awayAxis Vector3 Returns float IsPointInside(Vector3, out Vector3, out Vector3) public override bool IsPointInside(Vector3 particlePosition, out Vector3 surfacePoint, out Vector3 surfaceNormal) Parameters particlePosition Vector3 surfacePoint Vector3 surfaceNormal Vector3 Returns bool PreUpdateField(Vector3, Quaternion, Vector3) public override void PreUpdateField(Vector3 position, Quaternion rotation, Vector3 size) Parameters position Vector3 rotation Quaternion size Vector3"
  },
  "api/Stride.Particles.Updaters.FieldShapes.Torus.html": {
    "href": "api/Stride.Particles.Updaters.FieldShapes.Torus.html",
    "title": "Class Torus | Stride API",
    "summary": "Class Torus Namespace Stride.Particles.Updaters.FieldShapes Assembly Stride.Particles.dll [DataContract(\"FieldShapeTorus\")] public class Torus : FieldShape Inheritance object FieldShape Torus Extension Methods UnsafeUtilities.As<T>(object?) Properties BigRadius Big radius of the torus [DataMember(10)] [Display(\"Big radius\", null)] public float BigRadius { get; set; } Property Value float SmallRadius Small radius of the torus, given as a relative size to the big radius [DataMember(20)] [DataMemberRange(0, 1, 0.01, 0.1, 3)] [Display(\"Small radius\", null)] public float SmallRadius { get; set; } Property Value float Methods GetDebugDrawShape(out Vector3, out Quaternion, out Vector3) public override DebugDrawShape GetDebugDrawShape(out Vector3 pos, out Quaternion rot, out Vector3 scl) Parameters pos Vector3 rot Quaternion scl Vector3 Returns DebugDrawShape GetDistanceToCenter(Vector3, Vector3, out Vector3, out Vector3, out Vector3) public override float GetDistanceToCenter(Vector3 particlePosition, Vector3 particleVelocity, out Vector3 alongAxis, out Vector3 aroundAxis, out Vector3 awayAxis) Parameters particlePosition Vector3 particleVelocity Vector3 alongAxis Vector3 aroundAxis Vector3 awayAxis Vector3 Returns float IsPointInside(Vector3, out Vector3, out Vector3) public override bool IsPointInside(Vector3 particlePosition, out Vector3 surfacePoint, out Vector3 surfaceNormal) Parameters particlePosition Vector3 surfacePoint Vector3 surfaceNormal Vector3 Returns bool PreUpdateField(Vector3, Quaternion, Vector3) public override void PreUpdateField(Vector3 position, Quaternion rotation, Vector3 size) Parameters position Vector3 rotation Quaternion size Vector3"
  },
  "api/Stride.Particles.Updaters.FieldShapes.html": {
    "href": "api/Stride.Particles.Updaters.FieldShapes.html",
    "title": "Namespace Stride.Particles.Updaters.FieldShapes | Stride API",
    "summary": "Namespace Stride.Particles.Updaters.FieldShapes Classes Cube Cylinder FieldFalloff FieldShape Sphere Torus"
  },
  "api/Stride.Particles.Updaters.ParticleCollisionAttribute.html": {
    "href": "api/Stride.Particles.Updaters.ParticleCollisionAttribute.html",
    "title": "Struct ParticleCollisionAttribute | Stride API",
    "summary": "Struct ParticleCollisionAttribute Namespace Stride.Particles.Updaters Assembly Stride.Particles.dll public struct ParticleCollisionAttribute Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ParticleCollisionAttribute(ParticleCollisionAttribute) public ParticleCollisionAttribute(ParticleCollisionAttribute other) Parameters other ParticleCollisionAttribute Fields Empty public static ParticleCollisionAttribute Empty Field Value ParticleCollisionAttribute Properties HasColided public bool HasColided { get; set; } Property Value bool"
  },
  "api/Stride.Particles.Updaters.UpdaterColorOverTime.html": {
    "href": "api/Stride.Particles.Updaters.UpdaterColorOverTime.html",
    "title": "Class UpdaterColorOverTime | Stride API",
    "summary": "Class UpdaterColorOverTime Namespace Stride.Particles.Updaters Assembly Stride.Particles.dll Updater which sets the particle's color to a fixed value sampled based on the particle's normalized life value [DataContract(\"UpdaterColorOverTime\")] [Display(\"Color Animation\", null)] public class UpdaterColorOverTime : ParticleUpdater Inheritance object ParticleTransform ParticleModule ParticleUpdater UpdaterColorOverTime Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors UpdaterColorOverTime() Default constructor which also registers the fields required by this updater public UpdaterColorOverTime() Properties IsPostUpdater All updaters are called exactly once during each ParticleEmitter's update. Most updaters are called before spawning the new particles for the frame, but post updaters are called after that. public override bool IsPostUpdater { get; } Property Value bool SamplerMain The main curve sampler. Particles will change their value based on the sampled values [DataMember(100)] [Display(\"Main\", null)] public ComputeCurveSampler<Color4> SamplerMain { get; set; } Property Value ComputeCurveSampler<Color4> SamplerOptional Optional sampler. If present, particles will pick a random value between the two sampled curves [DataMember(200)] [Display(\"Optional\", null)] public ComputeCurveSampler<Color4> SamplerOptional { get; set; } Property Value ComputeCurveSampler<Color4> SeedOffset Seed offset. You can use this offset to bind the randomness to other random values, or to make them completely unrelated [DataMember(300)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods PreUpdate() public override void PreUpdate() Update(float, ParticlePool) Updates all particles in the ParticlePool using this updater public override void Update(float dt, ParticlePool pool) Parameters dt float Delta time in seconds which has passed since the last update call pool ParticlePool The target ParticlePool which needs to be updated"
  },
  "api/Stride.Particles.Updaters.UpdaterRotationOverTime.html": {
    "href": "api/Stride.Particles.Updaters.UpdaterRotationOverTime.html",
    "title": "Class UpdaterRotationOverTime | Stride API",
    "summary": "Class UpdaterRotationOverTime Namespace Stride.Particles.Updaters Assembly Stride.Particles.dll Updater which sets the particle's size to a fixed value sampled based on the particle's normalized life value [DataContract(\"UpdaterRotationOverTime\")] [Display(\"Rotation Animation\", null)] public class UpdaterRotationOverTime : ParticleUpdater Inheritance object ParticleTransform ParticleModule ParticleUpdater UpdaterRotationOverTime Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors UpdaterRotationOverTime() Default constructor which also registers the fields required by this updater public UpdaterRotationOverTime() Properties IsPostUpdater All updaters are called exactly once during each ParticleEmitter's update. Most updaters are called before spawning the new particles for the frame, but post updaters are called after that. public override bool IsPostUpdater { get; } Property Value bool SamplerMain The main curve sampler. Particles will change their value based on the sampled values [DataMember(100)] [Display(\"Main\", null)] public ComputeCurveSampler<float> SamplerMain { get; set; } Property Value ComputeCurveSampler<float> SamplerOptional Optional sampler. If present, particles will pick a random value between the two sampled curves [DataMember(200)] [Display(\"Optional\", null)] public ComputeCurveSampler<float> SamplerOptional { get; set; } Property Value ComputeCurveSampler<float> SeedOffset Seed offset. You can use this offset to bind the randomness to other random values, or to make them completely unrelated [DataMember(300)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods PreUpdate() public override void PreUpdate() Update(float, ParticlePool) Updates all particles in the ParticlePool using this updater public override void Update(float dt, ParticlePool pool) Parameters dt float Delta time in seconds which has passed since the last update call pool ParticlePool The target ParticlePool which needs to be updated"
  },
  "api/Stride.Particles.Updaters.UpdaterSizeOverTime.html": {
    "href": "api/Stride.Particles.Updaters.UpdaterSizeOverTime.html",
    "title": "Class UpdaterSizeOverTime | Stride API",
    "summary": "Class UpdaterSizeOverTime Namespace Stride.Particles.Updaters Assembly Stride.Particles.dll Updater which sets the particle's size to a fixed value sampled based on the particle's normalized life value [DataContract(\"UpdaterSizeOverTime\")] [Display(\"Size Animation\", null)] public class UpdaterSizeOverTime : ParticleUpdater Inheritance object ParticleTransform ParticleModule ParticleUpdater UpdaterSizeOverTime Inherited Members ParticleModule.Enabled ParticleModule.ResetSimulation() ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3) ParticleModule.RequiredFields ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem) ParticleModule.InvalidateRelations() ParticleTransform.InheritPosition ParticleTransform.Position ParticleTransform.InheritRotation ParticleTransform.Rotation ParticleTransform.InheritScale ParticleTransform.Scale ParticleTransform.ScaleUniform ParticleTransform.DisplayParticlePosition ParticleTransform.DisplayParticleRotation ParticleTransform.DisplayParticleScale ParticleTransform.DisplayParticleScaleUniform ParticleTransform.WorldPosition ParticleTransform.WorldRotation ParticleTransform.WorldScale ParticleTransform.SetParentTransform(ParticleTransform) Extension Methods UnsafeUtilities.As<T>(object?) Constructors UpdaterSizeOverTime() Default constructor which also registers the fields required by this updater public UpdaterSizeOverTime() Properties IsPostUpdater All updaters are called exactly once during each ParticleEmitter's update. Most updaters are called before spawning the new particles for the frame, but post updaters are called after that. public override bool IsPostUpdater { get; } Property Value bool SamplerMain The main curve sampler. Particles will change their value based on the sampled values [DataMember(100)] [Display(\"Main\", null)] public ComputeCurveSampler<float> SamplerMain { get; set; } Property Value ComputeCurveSampler<float> SamplerOptional Optional sampler. If present, particles will pick a random value between the two sampled curves [DataMember(200)] [Display(\"Optional\", null)] public ComputeCurveSampler<float> SamplerOptional { get; set; } Property Value ComputeCurveSampler<float> SeedOffset Seed offset. You can use this offset to bind the randomness to other random values, or to make them completely unrelated [DataMember(300)] [Display(\"Random Seed\", null)] public uint SeedOffset { get; set; } Property Value uint Methods PreUpdate() public override void PreUpdate() Update(float, ParticlePool) Updates all particles in the ParticlePool using this updater public override void Update(float dt, ParticlePool pool) Parameters dt float Delta time in seconds which has passed since the last update call pool ParticlePool The target ParticlePool which needs to be updated"
  },
  "api/Stride.Particles.Updaters.html": {
    "href": "api/Stride.Particles.Updaters.html",
    "title": "Namespace Stride.Particles.Updaters | Stride API",
    "summary": "Namespace Stride.Particles.Updaters Classes UpdaterColorOverTime Updater which sets the particle's color to a fixed value sampled based on the particle's normalized life value UpdaterRotationOverTime Updater which sets the particle's size to a fixed value sampled based on the particle's normalized life value UpdaterSizeOverTime Updater which sets the particle's size to a fixed value sampled based on the particle's normalized life value Structs ParticleCollisionAttribute"
  },
  "api/Stride.Particles.VertexLayouts.AttributeAccessor.html": {
    "href": "api/Stride.Particles.VertexLayouts.AttributeAccessor.html",
    "title": "Struct AttributeAccessor | Stride API",
    "summary": "Struct AttributeAccessor Namespace Stride.Particles.VertexLayouts Assembly Stride.Particles.dll AttributeAccessor is use to access and modify a particle vertex attribute. public struct AttributeAccessor Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Offset Offset of the attribute from the beginning of the vertex position public int Offset Field Value int Size Size of the attribute field public int Size Field Value int"
  },
  "api/Stride.Particles.VertexLayouts.AttributeDescription.html": {
    "href": "api/Stride.Particles.VertexLayouts.AttributeDescription.html",
    "title": "Class AttributeDescription | Stride API",
    "summary": "Class AttributeDescription Namespace Stride.Particles.VertexLayouts Assembly Stride.Particles.dll Attribute description code used for defining vertex attributes in the ParticleVertexBuilder public sealed class AttributeDescription : IEquatable<AttributeDescription> Inheritance object AttributeDescription Implements IEquatable<AttributeDescription> Extension Methods UnsafeUtilities.As<T>(object?) Constructors AttributeDescription(string) public AttributeDescription(string name) Parameters name string Properties Name public string Name { get; } Property Value string Methods Equals(AttributeDescription) Indicates whether the current object is equal to another object of the same type. public bool Equals(AttributeDescription other) Parameters other AttributeDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Determines whether the specified object is equal to the current object. public override bool Equals(object obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Operators operator ==(AttributeDescription, AttributeDescription) public static bool operator ==(AttributeDescription left, AttributeDescription right) Parameters left AttributeDescription right AttributeDescription Returns bool operator !=(AttributeDescription, AttributeDescription) public static bool operator !=(AttributeDescription left, AttributeDescription right) Parameters left AttributeDescription right AttributeDescription Returns bool"
  },
  "api/Stride.Particles.VertexLayouts.IAttributeTransformer-2.html": {
    "href": "api/Stride.Particles.VertexLayouts.IAttributeTransformer-2.html",
    "title": "Interface IAttributeTransformer<T, U> | Stride API",
    "summary": "Interface IAttributeTransformer<T, U> Namespace Stride.Particles.VertexLayouts Assembly Stride.Particles.dll public interface IAttributeTransformer<T, U> Type Parameters T U Extension Methods UnsafeUtilities.As<T>(object?) Methods Transform(ref T, ref U) void Transform(ref T attribute, ref U transformer) Parameters attribute T transformer U"
  },
  "api/Stride.Particles.VertexLayouts.ParticleBufferState.html": {
    "href": "api/Stride.Particles.VertexLayouts.ParticleBufferState.html",
    "title": "Struct ParticleBufferState | Stride API",
    "summary": "Struct ParticleBufferState Namespace Stride.Particles.VertexLayouts Assembly Stride.Particles.dll public struct ParticleBufferState Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ParticleBufferState(nint, ParticleVertexBuilder) public ParticleBufferState(nint vertexBufferPtr, ParticleVertexBuilder builder) Parameters vertexBufferPtr nint builder ParticleVertexBuilder Fields CurrentParticleIndex public int CurrentParticleIndex Field Value int CurrentVertex public int CurrentVertex Field Value int VertexBuffer public nint VertexBuffer Field Value nint VertexBufferOrigin public readonly nint VertexBufferOrigin Field Value nint VertexStride public int VertexStride Field Value int VerticesPerSegCurrent public int VerticesPerSegCurrent Field Value int VerticesPerSegFirst public int VerticesPerSegFirst Field Value int VerticesPerSegLast public int VerticesPerSegLast Field Value int VerticesPerSegMiddle public int VerticesPerSegMiddle Field Value int Properties DefaultTexCoords public AttributeDescription DefaultTexCoords { get; } Property Value AttributeDescription Methods GetAccessor(AttributeDescription) public AttributeAccessor GetAccessor(AttributeDescription desc) Parameters desc AttributeDescription Returns AttributeAccessor NextParticle() Advances the pointer to the next particle in the buffer, so that its first vertex can be written public void NextParticle() NextSegment() Advances the pointer to the next segment in the buffer, so that its first vertex can be written public void NextSegment() NextVertex() Advances the pointer to the next vertex in the buffer, so that it can be written public void NextVertex() SetAttribute(AttributeAccessor, nint) Sets the data for the current vertex using the provided AttributeAccessor public void SetAttribute(AttributeAccessor accessor, nint ptrRef) Parameters accessor AttributeAccessor Accessor to the vertex data ptrRef nint Pointer to the source data SetAttributePerParticle(AttributeAccessor, nint) Sets the same data for the all vertices in the current particle using the provided AttributeAccessor public void SetAttributePerParticle(AttributeAccessor accessor, nint ptrRef) Parameters accessor AttributeAccessor Accessor to the vertex data ptrRef nint Pointer to the source data SetAttributePerSegment(AttributeAccessor, nint) Sets the same data for the all vertices in the current particle using the provided AttributeAccessor public void SetAttributePerSegment(AttributeAccessor accessor, nint ptrRef) Parameters accessor AttributeAccessor Accessor to the vertex data ptrRef nint Pointer to the source data SetVerticesPerSegment(int, int, int) Sets how many vertices are associated with the first, middle and last quad segments of the buffer. In case of billboards 1 segment = 1 quad but other shapes might be laid out differently public void SetVerticesPerSegment(int verticesForFirstSegment, int verticesForMiddleSegment, int verticesForLastSegment) Parameters verticesForFirstSegment int Number of vertices for the first segment verticesForMiddleSegment int Number of vertices for the middle segments verticesForLastSegment int Number of vertices for the last segment StartOver() Moves the index to the beginning of the buffer so that the data can be filled from the first particle again public void StartOver() TransformAttributePerParticle<T, U>(AttributeAccessor, AttributeAccessor, IAttributeTransformer<T, U>, ref U) public void TransformAttributePerParticle<T, U>(AttributeAccessor accessorFrom, AttributeAccessor accessorTo, IAttributeTransformer<T, U> transformMethod, ref U transformer) where T : struct where U : struct Parameters accessorFrom AttributeAccessor accessorTo AttributeAccessor transformMethod IAttributeTransformer<T, U> transformer U Type Parameters T U TransformAttributePerSegment<T, U>(AttributeAccessor, AttributeAccessor, IAttributeTransformer<T, U>, ref U) Transforms attribute data using already written data from another attribute public void TransformAttributePerSegment<T, U>(AttributeAccessor accessorFrom, AttributeAccessor accessorTo, IAttributeTransformer<T, U> transformMethod, ref U transformer) where T : struct where U : struct Parameters accessorFrom AttributeAccessor Vertex attribute accessor to the source attribute accessorTo AttributeAccessor Vertex attribute accessor to the destination attribute transformMethod IAttributeTransformer<T, U> Transform method for the type data transformer U Type Parameters T Type data U"
  },
  "api/Stride.Particles.VertexLayouts.ParticleVertexBuilder.TransformAttributeDelegate-1.html": {
    "href": "api/Stride.Particles.VertexLayouts.ParticleVertexBuilder.TransformAttributeDelegate-1.html",
    "title": "Delegate ParticleVertexBuilder.TransformAttributeDelegate<T> | Stride API",
    "summary": "Delegate ParticleVertexBuilder.TransformAttributeDelegate<T> Namespace Stride.Particles.VertexLayouts Assembly Stride.Particles.dll public delegate void ParticleVertexBuilder.TransformAttributeDelegate<T>(ref T value) Parameters value T Type Parameters T Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Particles.VertexLayouts.ParticleVertexBuilder.html": {
    "href": "api/Stride.Particles.VertexLayouts.ParticleVertexBuilder.html",
    "title": "Class ParticleVertexBuilder | Stride API",
    "summary": "Class ParticleVertexBuilder Namespace Stride.Particles.VertexLayouts Assembly Stride.Particles.dll Manager class for the vertex buffer stream which can dynamically change the required vertex layout and rebuild the buffer based on the particle fields public class ParticleVertexBuilder Inheritance object ParticleVertexBuilder Extension Methods UnsafeUtilities.As<T>(object?) Constructors ParticleVertexBuilder() Default constructor public ParticleVertexBuilder() Fields IndicesPerQuad public readonly int IndicesPerQuad Field Value int Properties DefaultTexCoords The default texture coordinates will default to the first texture coordinates element added to the list in case there are two or more sets public AttributeDescription DefaultTexCoords { get; } Property Value AttributeDescription IsBufferDirty public bool IsBufferDirty { get; } Property Value bool LivingQuads public int LivingQuads { get; } Property Value int MaxParticles public int MaxParticles { get; } Property Value int VertexCount The current number of vertices which have to be drawn public int VertexCount { get; } Property Value int VertexDeclaration The current VertexDeclaration of the contained vertex buffer public VertexDeclaration VertexDeclaration { get; } Property Value VertexDeclaration VerticesPerParticle public int VerticesPerParticle { get; } Property Value int Methods AddVertexElement(VertexElement) Adds a new required element to the list of vertex elements, if it's not in the list already public void AddVertexElement(VertexElement element) Parameters element VertexElement New element to add Reset() Resets the ParticleVertexBuilder to its initial state, freeing any graphics memory used public void Reset() ResetVertexElementList() Resets the list of required vertex elements, setting it to the minimum mandatory length public void ResetVertexElementList() SetDirty(bool) public void SetDirty(bool dirty) Parameters dirty bool SetRequiredQuads(int, int, int) Sets the required quads per particle and number of particles so that a sufficiently big buffer can be allocated public void SetRequiredQuads(int quadsPerParticle, int livingParticles, int totalParticles) Parameters quadsPerParticle int Required quads per particle, assuming 1 quad = 4 vertices = 6 indices livingParticles int Number of living particles this frame totalParticles int Number of total number of possible particles for the parent emitter UpdateVertexLayout() Updates the vertex layout with the new list. Should be called only when there have been changes to the list. public void UpdateVertexLayout()"
  },
  "api/Stride.Particles.VertexLayouts.ParticleVertexElements.html": {
    "href": "api/Stride.Particles.VertexLayouts.ParticleVertexElements.html",
    "title": "Class ParticleVertexElements | Stride API",
    "summary": "Class ParticleVertexElements Namespace Stride.Particles.VertexLayouts Assembly Stride.Particles.dll A list of common VertexElement used in the particles' vertex layout public static class ParticleVertexElements Inheritance object ParticleVertexElements Fields Color public static VertexElement Color Field Value VertexElement Lifetime public static VertexElement Lifetime Field Value VertexElement Position public static VertexElement Position Field Value VertexElement RandSeed public static VertexElement RandSeed Field Value VertexElement TexCoord public static VertexElement[] TexCoord Field Value VertexElement[]"
  },
  "api/Stride.Particles.VertexLayouts.VertexAttributes.html": {
    "href": "api/Stride.Particles.VertexLayouts.VertexAttributes.html",
    "title": "Class VertexAttributes | Stride API",
    "summary": "Class VertexAttributes Namespace Stride.Particles.VertexLayouts Assembly Stride.Particles.dll A list of common AttributeDescription used to access the vertex fileds in a ParticleVertexBuilder public static class VertexAttributes Inheritance object VertexAttributes Fields Color public static AttributeDescription Color Field Value AttributeDescription Lifetime public static AttributeDescription Lifetime Field Value AttributeDescription Position public static AttributeDescription Position Field Value AttributeDescription RandomSeed public static AttributeDescription RandomSeed Field Value AttributeDescription"
  },
  "api/Stride.Particles.VertexLayouts.html": {
    "href": "api/Stride.Particles.VertexLayouts.html",
    "title": "Namespace Stride.Particles.VertexLayouts | Stride API",
    "summary": "Namespace Stride.Particles.VertexLayouts Classes AttributeDescription Attribute description code used for defining vertex attributes in the ParticleVertexBuilder ParticleVertexBuilder Manager class for the vertex buffer stream which can dynamically change the required vertex layout and rebuild the buffer based on the particle fields ParticleVertexElements A list of common VertexElement used in the particles' vertex layout VertexAttributes A list of common AttributeDescription used to access the vertex fileds in a ParticleVertexBuilder Structs AttributeAccessor AttributeAccessor is use to access and modify a particle vertex attribute. ParticleBufferState Interfaces IAttributeTransformer<T, U> Delegates ParticleVertexBuilder.TransformAttributeDelegate<T>"
  },
  "api/Stride.Particles.html": {
    "href": "api/Stride.Particles.html",
    "title": "Namespace Stride.Particles | Stride API",
    "summary": "Namespace Stride.Particles Classes ParticleEmitter The ParticleEmitter is the base manager for any given pool of particles, holding all particles and initializers, updaters, spawners, materials and shape builders associated with the particles. ParticleFieldDescription ParticleFieldDescription<T> ParticleFields ParticleModule The ParticleModule is a base class for all plugins (initializers and updaters) used by the emitter Each plugin operates over one or several ParticleFields updating or setting up the particle state Additionally, each plugin can inherit some properties from the parent particle system, which are usually passed by the user. ParticlePool The ParticlePool is a class which manages an unmanaged memory block used for the particles. The maximum required size calculated on the number of particles and their fields' sizes is calculated every time the sizes or the count change ParticleRandomSeedGenerator ParticleSystem ParticleSystemSettings ParticleTransform ParticleUtilities RandomOffset Structs Particle The most basic unit of a ParticleSystem You can access individual fields with a ParticleFieldAccessor ParticleFieldAccessor ParticleFieldAccessor<T> ParticlePool.Enumerator ParticlePoolFieldsList Enums EmitterRandomSeedMethod EmitterSimulationSpace EmitterSortingPolicy ParticlePool.ListPolicy Delegates ParticlePool.CopyParticlePoolDelegate"
  },
  "api/Stride.Physics.BoxColliderShape.html": {
    "href": "api/Stride.Physics.BoxColliderShape.html",
    "title": "Class BoxColliderShape | Stride API",
    "summary": "Class BoxColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class BoxColliderShape : ColliderShape, IDisposable Inheritance object ColliderShape BoxColliderShape Implements IDisposable Inherited Members ColliderShape.DebugScaling ColliderShape.Dispose() ColliderShape.Type ColliderShape.LocalOffset ColliderShape.LocalRotation ColliderShape.UpdateLocalTransformations() ColliderShape.PositiveCenterMatrix ColliderShape.NegativeCenterMatrix ColliderShape.cachedScaling ColliderShape.Scaling ColliderShape.Is2D ColliderShape.Description ColliderShape.CreateUpdatableDebugPrimitive(GraphicsDevice) ColliderShape.UpdateDebugPrimitive(CommandList, IDebugPrimitive) ColliderShape.Margin ColliderShape.DebugPrimitiveMatrix Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors BoxColliderShape(bool, Vector3) Initializes a new instance of the BoxColliderShape class. public BoxColliderShape(bool is2D, Vector3 size) Parameters is2D bool If this cube is a 2D quad size Vector3 The size of the cube Fields BoxSize public readonly Vector3 BoxSize Field Value Vector3 Methods CreateDebugPrimitive(GraphicsDevice) public override MeshDraw CreateDebugPrimitive(GraphicsDevice device) Parameters device GraphicsDevice Returns MeshDraw"
  },
  "api/Stride.Physics.BoxColliderShapeDesc.html": {
    "href": "api/Stride.Physics.BoxColliderShapeDesc.html",
    "title": "Class BoxColliderShapeDesc | Stride API",
    "summary": "Class BoxColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<BoxColliderShapeDesc>))] [DataContract(\"BoxColliderShapeDesc\")] [Display(50, \"Box\", null)] public class BoxColliderShapeDesc : IInlineColliderShapeDesc, IAssetColliderShapeDesc, IColliderShapeDesc Inheritance object BoxColliderShapeDesc Implements IInlineColliderShapeDesc IAssetColliderShapeDesc IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Fields Is2D [DataMember(5)] public bool Is2D Field Value bool LocalOffset [DataMember(20)] public Vector3 LocalOffset Field Value Vector3 LocalRotation [DataMember(30)] public Quaternion LocalRotation Field Value Quaternion Size [DataMember(10)] public Vector3 Size Field Value Vector3 Methods CreateShape(IServiceRegistry) public ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.Bullet2PhysicsSystem.html": {
    "href": "api/Stride.Physics.Bullet2PhysicsSystem.html",
    "title": "Class Bullet2PhysicsSystem | Stride API",
    "summary": "Class Bullet2PhysicsSystem Namespace Stride.Physics Assembly Stride.Physics.dll public class Bullet2PhysicsSystem : GameSystem, IDisposable, ICollectorHolder, IUpdateable, IDrawable, IContentable, IPhysicsSystem, IGameSystemBase, IComponent, IReferencable Inheritance object DisposeBase ComponentBase GameSystemBase GameSystem Bullet2PhysicsSystem Implements IDisposable ICollectorHolder IUpdateable IDrawable IContentable IPhysicsSystem IGameSystemBase IComponent IReferencable Inherited Members GameSystem.Game GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.Draw(GameTime) GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) GameSystemBase.LoadContent() GameSystemBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors Bullet2PhysicsSystem(IServiceRegistry) public Bullet2PhysicsSystem(IServiceRegistry registry) Parameters registry IServiceRegistry Methods Create(PhysicsProcessor, PhysicsEngineFlags) public Simulation Create(PhysicsProcessor sceneProcessor, PhysicsEngineFlags flags = PhysicsEngineFlags.None) Parameters sceneProcessor PhysicsProcessor flags PhysicsEngineFlags Returns Simulation Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. Initialize() Initializes the Game System. public override void Initialize() Remarks This method is called when the component is added to the Game. This can be used for tasks like querying for services the component needs and setting up non-graphics resources (as here the Graphics Device may have not been initialized yet). Release(PhysicsProcessor) public void Release(PhysicsProcessor processor) Parameters processor PhysicsProcessor Update(GameTime) This method is called when this game component is updated. public override void Update(GameTime gameTime) Parameters gameTime GameTime The current timing."
  },
  "api/Stride.Physics.ByteHeightStickArraySource.html": {
    "href": "api/Stride.Physics.ByteHeightStickArraySource.html",
    "title": "Class ByteHeightStickArraySource | Stride API",
    "summary": "Class ByteHeightStickArraySource Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract] [Display(\"Byte\", null)] public class ByteHeightStickArraySource : IHeightStickArraySource, IHeightStickParameters Inheritance object ByteHeightStickArraySource Implements IHeightStickArraySource IHeightStickParameters Extension Methods UnsafeUtilities.As<T>(object?) Properties HeightRange The range of the height. [DataMember(20)] public Vector2 HeightRange { get; set; } Property Value Vector2 Remarks X is min height and Y is max height. (height * HeightScale) should be in this range. Positive and negative heights can not be handle at the same time when the height type is Byte. HeightScale Used to calculate the height when the height type is Short or Byte. HeightScale should be 1 when the height type is Float. public float HeightScale { get; } Property Value float HeightScaleCalculator Select how to calculate HeightScale. [DataMember(30)] [Display(\"HeightScale\", null, Expand = ExpandRule.Always)] public IHeightScaleCalculator HeightScaleCalculator { get; set; } Property Value IHeightScaleCalculator HeightStickSize The size of the source. [DataMember(10)] [Display(\"Size\", null)] public Int2 HeightStickSize { get; set; } Property Value Int2 Remarks X is width and Y is length. They should be greater than or equal to 2. For example, this size should be 65 * 65 when you want 64 * 64 size in a scene. HeightType The type of the height. public HeightfieldTypes HeightType { get; } Property Value HeightfieldTypes InitialByte The value to fill the height stick array. [DataMember(40)] [DataMemberRange(0, 255, 1, 10, 0)] public byte InitialByte { get; set; } Property Value byte Methods CopyTo<T>(UnmanagedArray<T>, int) Copy the source data to the height stick array. public void CopyTo<T>(UnmanagedArray<T> heightStickArray, int index) where T : struct Parameters heightStickArray UnmanagedArray<T> The destination to copy the data. index int The start index of the destination to copy the data. Type Parameters T The data type of the height IsValid() public bool IsValid() Returns bool Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.CapsuleColliderShape.html": {
    "href": "api/Stride.Physics.CapsuleColliderShape.html",
    "title": "Class CapsuleColliderShape | Stride API",
    "summary": "Class CapsuleColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class CapsuleColliderShape : ColliderShape, IDisposable Inheritance object ColliderShape CapsuleColliderShape Implements IDisposable Inherited Members ColliderShape.DebugScaling ColliderShape.Dispose() ColliderShape.Type ColliderShape.LocalOffset ColliderShape.LocalRotation ColliderShape.UpdateLocalTransformations() ColliderShape.PositiveCenterMatrix ColliderShape.NegativeCenterMatrix ColliderShape.cachedScaling ColliderShape.Is2D ColliderShape.Description ColliderShape.CreateUpdatableDebugPrimitive(GraphicsDevice) ColliderShape.UpdateDebugPrimitive(CommandList, IDebugPrimitive) ColliderShape.Margin ColliderShape.DebugPrimitiveMatrix Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors CapsuleColliderShape(bool, float, float, ShapeOrientation) Initializes a new instance of the CapsuleColliderShape class. public CapsuleColliderShape(bool is2D, float radius, float length, ShapeOrientation orientation) Parameters is2D bool if set to true [is2 d]. radius float The radius. length float The length of the capsule. orientation ShapeOrientation Up axis. Fields Length public readonly float Length Field Value float Orientation public readonly ShapeOrientation Orientation Field Value ShapeOrientation Radius public readonly float Radius Field Value float Properties Scaling Gets or sets the scaling. Make sure that you manually created and assigned an exclusive ColliderShape to the Collider otherwise since the engine shares shapes among many Colliders, all the colliders will be scaled. Please note that this scaling has no relation to the TransformComponent scaling. public override Vector3 Scaling { get; set; } Property Value Vector3 The scaling. Methods CreateDebugPrimitive(GraphicsDevice) public override MeshDraw CreateDebugPrimitive(GraphicsDevice device) Parameters device GraphicsDevice Returns MeshDraw"
  },
  "api/Stride.Physics.CapsuleColliderShapeDesc.html": {
    "href": "api/Stride.Physics.CapsuleColliderShapeDesc.html",
    "title": "Class CapsuleColliderShapeDesc | Stride API",
    "summary": "Class CapsuleColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<CapsuleColliderShapeDesc>))] [DataContract(\"CapsuleColliderShapeDesc\")] [Display(50, \"Capsule\", null)] public class CapsuleColliderShapeDesc : IInlineColliderShapeDesc, IAssetColliderShapeDesc, IColliderShapeDesc Inheritance object CapsuleColliderShapeDesc Implements IInlineColliderShapeDesc IAssetColliderShapeDesc IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Fields Is2D [DataMember(10)] public bool Is2D Field Value bool Length [DataMember(20)] public float Length Field Value float LocalOffset [DataMember(50)] public Vector3 LocalOffset Field Value Vector3 LocalRotation [DataMember(60)] public Quaternion LocalRotation Field Value Quaternion Orientation [DataMember(40)] public ShapeOrientation Orientation Field Value ShapeOrientation Radius [DataMember(30)] public float Radius Field Value float Methods CreateShape(IServiceRegistry) public ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.CharacterComponent.html": {
    "href": "api/Stride.Physics.CharacterComponent.html",
    "title": "Class CharacterComponent | Stride API",
    "summary": "Class CharacterComponent Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract(\"CharacterComponent\")] [Display(\"Character\", null)] public sealed class CharacterComponent : PhysicsComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent PhysicsComponent CharacterComponent Implements IIdentifiable Inherited Members PhysicsComponent.ColliderShapes PhysicsComponent.CollisionGroup PhysicsComponent.CanCollideWith PhysicsComponent.ProcessCollisions PhysicsComponent.Enabled PhysicsComponent.CanSleep PhysicsComponent.IsActive PhysicsComponent.Activate(bool) PhysicsComponent.Restitution PhysicsComponent.Friction PhysicsComponent.RollingFriction PhysicsComponent.CcdMotionThreshold PhysicsComponent.CcdSweptSphereRadius PhysicsComponent.Collisions PhysicsComponent.NewCollision() PhysicsComponent.CollisionEnded() PhysicsComponent.Simulation PhysicsComponent.ColliderShapeChanged PhysicsComponent.ColliderShape PhysicsComponent.CanScaleShape PhysicsComponent.PhysicsWorldTransform PhysicsComponent.Tag PhysicsComponent.BoneWorldMatrix PhysicsComponent.BoneWorldMatrixOut PhysicsComponent.BoneIndex PhysicsComponent.DebugEntity PhysicsComponent.AddDebugEntity(Scene, RenderGroup, bool) PhysicsComponent.RemoveDebugEntity(Scene) PhysicsComponent.UpdatePhysicsTransformation(bool) PhysicsComponent.IgnoreCollisionWith(PhysicsComponent, CollisionState) PhysicsComponent.IsIgnoringCollisionWith(PhysicsComponent) EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors CharacterComponent() public CharacterComponent() Properties FallSpeed Gets or sets if this character element fall speed [DataMember(80)] public float FallSpeed { get; set; } Property Value float true, false Gravity Gets or sets if this character is affected by any gravity [Display(\"Gravity\", null)] [DataMember(95)] public Vector3 Gravity { get; set; } Property Value Vector3 A Vector3 representing directional gravity in Stride world units IsGrounded Gets a value indicating whether this instance is on the ground. public bool IsGrounded { get; } Property Value bool true if this instance is grounded; otherwise, false. JumpSpeed Gets or sets if this character jump speed [DataMember(90)] public float JumpSpeed { get; set; } Property Value float A float representing character jump speed in Stride world units LinearVelocity Gets the linear velocity from the kinematic character public Vector3 LinearVelocity { get; } Property Value Vector3 Vector3 MaxSlope Gets or sets if this character element max slope [Display(\"Maximum Slope\", null)] [DataMember(85)] public AngleSingle MaxSlope { get; set; } Property Value AngleSingle true, false Orientation Sets or gets the orientation of the Entity attached to this character controller public Quaternion Orientation { get; set; } Property Value Quaternion Remarks This orientation has no impact in the physics simulation StepHeight Gets or sets the height of the character step. [DataMember(75)] public float StepHeight { get; set; } Property Value float The height of the character step. Methods ComposeShape() Reconstruct of character controller to avoid possible UAF issues Context: On ColliderShape changes, when ComposeShape is ran to rebuild ColliderShape properties, disposing the old ColliderShape can cause UAF issues inside KinematicCharacter and inside Simulation discreteDynamicWorld due to old disposed references to the native object. public override void ComposeShape() Jump() Jumps this instance. public void Jump() Jump(Vector3) Jumps this instance. public void Jump(Vector3 jumpDirection) Parameters jumpDirection Vector3 Move(Vector3) Moves the character towards the specified movement vector. Motion will stay in place unless modified or canceled passing Vector3.Zero. [Obsolete(\"Please use SetVelocity instead. SetVelocity internally applies this.GetSimulation().FixedTimeStep\")] public void Move(Vector3 movement) Parameters movement Vector3 The velocity vector, typically direction * delta time var dt = this.GetSimulation().FixedTimeStep; * speed. OnAttach() Called whenever an entity with this component is added to scene. protected override void OnAttach() OnDetach() protected override void OnDetach() SetVelocity(Vector3) Sets the character velocity. Velocity will be applied every frame unless modified or canceled passing Vector3.Zero. public void SetVelocity(Vector3 velocity) Parameters velocity Vector3 The velocity vector, typically direction * speed. Remarks The engine internally will multiply velocity with the simulation fixed time step. Teleport(Vector3) Teleports the specified target position. public void Teleport(Vector3 targetPosition) Parameters targetPosition Vector3 The target position."
  },
  "api/Stride.Physics.ColliderShape.html": {
    "href": "api/Stride.Physics.ColliderShape.html",
    "title": "Class ColliderShape | Stride API",
    "summary": "Class ColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class ColliderShape : IDisposable Inheritance object ColliderShape Implements IDisposable Derived BoxColliderShape CapsuleColliderShape CompoundColliderShape ConeColliderShape ConvexHullColliderShape CylinderColliderShape HeightfieldColliderShape SphereColliderShape StaticMeshColliderShape StaticPlaneColliderShape Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields DebugPrimitiveMatrix public Matrix DebugPrimitiveMatrix Field Value Matrix DebugScaling protected const float DebugScaling = 1 Field Value float LocalOffset The local offset public Vector3 LocalOffset Field Value Vector3 LocalRotation The local rotation public Quaternion LocalRotation Field Value Quaternion NegativeCenterMatrix Gets the negative center matrix. public Matrix NegativeCenterMatrix Field Value Matrix The negative center matrix. PositiveCenterMatrix Gets the positive center matrix. public Matrix PositiveCenterMatrix Field Value Matrix The positive center matrix. cachedScaling protected Vector3 cachedScaling Field Value Vector3 Properties Description public IColliderShapeDesc Description { get; } Property Value IColliderShapeDesc Is2D Gets a value indicating whether the collider shape is 2D. public bool Is2D { get; } Property Value bool true if [is2 d]; otherwise, false. Margin public float Margin { get; set; } Property Value float Scaling Gets or sets the scaling. Make sure that you manually created and assigned an exclusive ColliderShape to the Collider otherwise since the engine shares shapes among many Colliders, all the colliders will be scaled. Please note that this scaling has no relation to the TransformComponent scaling. public virtual Vector3 Scaling { get; set; } Property Value Vector3 The scaling. Type Gets or sets the type. public ColliderShapeTypes Type { get; protected set; } Property Value ColliderShapeTypes The type. Methods CreateDebugPrimitive(GraphicsDevice) public virtual MeshDraw CreateDebugPrimitive(GraphicsDevice device) Parameters device GraphicsDevice Returns MeshDraw CreateUpdatableDebugPrimitive(GraphicsDevice) public virtual IDebugPrimitive CreateUpdatableDebugPrimitive(GraphicsDevice device) Parameters device GraphicsDevice Returns IDebugPrimitive Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public virtual void Dispose() UpdateDebugPrimitive(CommandList, IDebugPrimitive) public virtual void UpdateDebugPrimitive(CommandList commandList, IDebugPrimitive debugPrimitive) Parameters commandList CommandList debugPrimitive IDebugPrimitive UpdateLocalTransformations() Updates the local transformations, required if you change LocalOffset and/or LocalRotation. public virtual void UpdateLocalTransformations()"
  },
  "api/Stride.Physics.ColliderShapeAssetDesc.html": {
    "href": "api/Stride.Physics.ColliderShapeAssetDesc.html",
    "title": "Class ColliderShapeAssetDesc | Stride API",
    "summary": "Class ColliderShapeAssetDesc Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<ColliderShapeAssetDesc>))] [DataContract(\"ColliderShapeAssetDesc\")] [Display(50, \"Asset\", null)] public class ColliderShapeAssetDesc : IInlineColliderShapeDesc, IAssetColliderShapeDesc, IColliderShapeDesc Inheritance object ColliderShapeAssetDesc Implements IInlineColliderShapeDesc IAssetColliderShapeDesc IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Properties Shape [DataMember(10)] public PhysicsColliderShape Shape { get; set; } Property Value PhysicsColliderShape Methods CreateShape(IServiceRegistry) public ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.ColliderShapeTypes.html": {
    "href": "api/Stride.Physics.ColliderShapeTypes.html",
    "title": "Enum ColliderShapeTypes | Stride API",
    "summary": "Enum ColliderShapeTypes Namespace Stride.Physics Assembly Stride.Physics.dll public enum ColliderShapeTypes Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Box = 0 3D and 2D ( a plane ) Capsule = 3 3D and 2D Compound = 5 Cone = 8 ConvexHull = 4 Cylinder = 2 3D only Heightfield = 9 Sphere = 1 3D and 2D ( a circle ) StaticMesh = 7 StaticPlane = 6"
  },
  "api/Stride.Physics.Collision.html": {
    "href": "api/Stride.Physics.Collision.html",
    "title": "Struct Collision | Stride API",
    "summary": "Struct Collision Namespace Stride.Physics Assembly Stride.Physics.dll A pair of component colliding with each other. Pair of [b,a] is considered equal to [a,b]. public readonly struct Collision : IEquatable<Collision> Implements IEquatable<Collision> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors Collision(PhysicsComponent, PhysicsComponent) public Collision(PhysicsComponent a, PhysicsComponent b) Parameters a PhysicsComponent b PhysicsComponent Fields ColliderA public readonly PhysicsComponent ColliderA Field Value PhysicsComponent ColliderB public readonly PhysicsComponent ColliderB Field Value PhysicsComponent Properties AreColliding public bool AreColliding { get; } Property Value bool Contacts public HashSet<ContactPoint> Contacts { get; } Property Value HashSet<ContactPoint> HasEndedFromComponentRemoval True if the collision has ended because one of the colliders has been removed, either by removing the entity from the scene or by removing physics component from the entity. public bool HasEndedFromComponentRemoval { get; } Property Value bool Remarks If true, it is not safe to invoke further actions on the colliders. Only use colliders information to identify the entity that has been removed. Methods ContactChanged() The returned collection contains the previous contacts, new contacts are under Contacts public ChannelMicroThreadAwaiter<HashSet<ContactPoint>> ContactChanged() Returns ChannelMicroThreadAwaiter<HashSet<ContactPoint>> Ended() public Task Ended() Returns Task Equals(Collision) Indicates whether the current object is equal to another object of the same type. public bool Equals(Collision other) Parameters other Collision An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(in Collision, in Collision) public static bool operator ==(in Collision a, in Collision b) Parameters a Collision b Collision Returns bool operator !=(in Collision, in Collision) public static bool operator !=(in Collision a, in Collision b) Parameters a Collision b Collision Returns bool"
  },
  "api/Stride.Physics.CollisionFilterGroupFlags.html": {
    "href": "api/Stride.Physics.CollisionFilterGroupFlags.html",
    "title": "Enum CollisionFilterGroupFlags | Stride API",
    "summary": "Enum CollisionFilterGroupFlags Namespace Stride.Physics Assembly Stride.Physics.dll [Flags] public enum CollisionFilterGroupFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AllFilter = DefaultFilter | StaticFilter | KinematicFilter | DebrisFilter | SensorTrigger | CharacterFilter | CustomFilter1 | CustomFilter2 | CustomFilter3 | CustomFilter4 | CustomFilter5 | CustomFilter6 | CustomFilter7 | CustomFilter8 | CustomFilter9 | CustomFilter10 CharacterFilter = 32 CustomFilter1 = 64 CustomFilter10 = 32768 CustomFilter2 = 128 CustomFilter3 = 256 CustomFilter4 = 512 CustomFilter5 = 1024 CustomFilter6 = 2048 CustomFilter7 = 4096 CustomFilter8 = 8192 CustomFilter9 = 16384 DebrisFilter = 8 DefaultFilter = 1 KinematicFilter = 4 SensorTrigger = 16 StaticFilter = 2"
  },
  "api/Stride.Physics.CollisionFilterGroups.html": {
    "href": "api/Stride.Physics.CollisionFilterGroups.html",
    "title": "Enum CollisionFilterGroups | Stride API",
    "summary": "Enum CollisionFilterGroups Namespace Stride.Physics Assembly Stride.Physics.dll public enum CollisionFilterGroups Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AllFilter = 65535 CharacterFilter = 32 CustomFilter1 = 64 CustomFilter10 = 32768 CustomFilter2 = 128 CustomFilter3 = 256 CustomFilter4 = 512 CustomFilter5 = 1024 CustomFilter6 = 2048 CustomFilter7 = 4096 CustomFilter8 = 8192 CustomFilter9 = 16384 DebrisFilter = 8 DefaultFilter = 1 KinematicFilter = 4 SensorTrigger = 16 StaticFilter = 2"
  },
  "api/Stride.Physics.CompoundColliderShape.html": {
    "href": "api/Stride.Physics.CompoundColliderShape.html",
    "title": "Class CompoundColliderShape | Stride API",
    "summary": "Class CompoundColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class CompoundColliderShape : ColliderShape, IDisposable Inheritance object ColliderShape CompoundColliderShape Implements IDisposable Inherited Members ColliderShape.DebugScaling ColliderShape.Type ColliderShape.LocalOffset ColliderShape.LocalRotation ColliderShape.UpdateLocalTransformations() ColliderShape.PositiveCenterMatrix ColliderShape.NegativeCenterMatrix ColliderShape.cachedScaling ColliderShape.Is2D ColliderShape.Description ColliderShape.CreateDebugPrimitive(GraphicsDevice) ColliderShape.CreateUpdatableDebugPrimitive(GraphicsDevice) ColliderShape.UpdateDebugPrimitive(CommandList, IDebugPrimitive) ColliderShape.Margin ColliderShape.DebugPrimitiveMatrix Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors CompoundColliderShape() Initializes a new instance of the CompoundColliderShape class. public CompoundColliderShape() Properties Count Gets the count. public int Count { get; } Property Value int The count. this[int] Gets the ColliderShape with the specified i. public ColliderShape this[int i] { get; } Parameters i int The i. Property Value ColliderShape The ColliderShape. Scaling Gets or sets the scaling. Make sure that you manually created and assigned an exclusive ColliderShape to the Collider otherwise since the engine shares shapes among many Colliders, all the colliders will be scaled. Please note that this scaling has no relation to the TransformComponent scaling. public override Vector3 Scaling { get; set; } Property Value Vector3 The scaling. Methods AddChildShape(ColliderShape) Adds a child shape. public void AddChildShape(ColliderShape shape) Parameters shape ColliderShape The shape. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public override void Dispose() RemoveChildShape(ColliderShape) Removes a child shape. public void RemoveChildShape(ColliderShape shape) Parameters shape ColliderShape The shape."
  },
  "api/Stride.Physics.ConeColliderShape.html": {
    "href": "api/Stride.Physics.ConeColliderShape.html",
    "title": "Class ConeColliderShape | Stride API",
    "summary": "Class ConeColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class ConeColliderShape : ColliderShape, IDisposable Inheritance object ColliderShape ConeColliderShape Implements IDisposable Inherited Members ColliderShape.DebugScaling ColliderShape.Dispose() ColliderShape.Type ColliderShape.LocalOffset ColliderShape.LocalRotation ColliderShape.UpdateLocalTransformations() ColliderShape.PositiveCenterMatrix ColliderShape.NegativeCenterMatrix ColliderShape.cachedScaling ColliderShape.Scaling ColliderShape.Is2D ColliderShape.Description ColliderShape.CreateUpdatableDebugPrimitive(GraphicsDevice) ColliderShape.UpdateDebugPrimitive(CommandList, IDebugPrimitive) ColliderShape.Margin ColliderShape.DebugPrimitiveMatrix Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ConeColliderShape(float, float, ShapeOrientation) Initializes a new instance of the ConeColliderShape class. public ConeColliderShape(float heightParam, float radiusParam, ShapeOrientation orientationParam) Parameters heightParam float radiusParam float orientationParam ShapeOrientation Fields Height public readonly float Height Field Value float Orientation public readonly ShapeOrientation Orientation Field Value ShapeOrientation Radius public readonly float Radius Field Value float Methods CreateDebugPrimitive(GraphicsDevice) public override MeshDraw CreateDebugPrimitive(GraphicsDevice device) Parameters device GraphicsDevice Returns MeshDraw"
  },
  "api/Stride.Physics.ConeColliderShapeDesc.html": {
    "href": "api/Stride.Physics.ConeColliderShapeDesc.html",
    "title": "Class ConeColliderShapeDesc | Stride API",
    "summary": "Class ConeColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<ConeColliderShapeDesc>))] [DataContract(\"ConeColliderShapeDesc\")] [Display(50, \"Cone\", null)] public class ConeColliderShapeDesc : IInlineColliderShapeDesc, IAssetColliderShapeDesc, IColliderShapeDesc Inheritance object ConeColliderShapeDesc Implements IInlineColliderShapeDesc IAssetColliderShapeDesc IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Fields Height [DataMember(10)] public float Height Field Value float LocalOffset [DataMember(40)] public Vector3 LocalOffset Field Value Vector3 LocalRotation [DataMember(50)] public Quaternion LocalRotation Field Value Quaternion Orientation [DataMember(30)] public ShapeOrientation Orientation Field Value ShapeOrientation Radius [DataMember(20)] public float Radius Field Value float Methods CreateShape(IServiceRegistry) public ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.ConeTwistConstraint.html": {
    "href": "api/Stride.Physics.ConeTwistConstraint.html",
    "title": "Class ConeTwistConstraint | Stride API",
    "summary": "Class ConeTwistConstraint Namespace Stride.Physics Assembly Stride.Physics.dll public class ConeTwistConstraint : Constraint, IDisposable, IRelative Inheritance object Constraint ConeTwistConstraint Implements IDisposable IRelative Inherited Members Constraint.Dispose() Constraint.RigidBodyA Constraint.RigidBodyB Constraint.Enabled Constraint.BreakingImpulseThreshold Constraint.AppliedImpulse Constraint.Simulation Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties FixThresh Gets or sets the fix thresh. public float FixThresh { get; set; } Property Value float The fix thresh. IsPastSwingLimit Gets a value indicating whether this instance is past swing limit. public bool IsPastSwingLimit { get; } Property Value bool true if this instance is past swing limit; otherwise, false. SolveSwingLimit Gets the solve swing limit. public int SolveSwingLimit { get; } Property Value int The solve swing limit. SolveTwistLimit Gets the solve twist limit. public int SolveTwistLimit { get; } Property Value int The solve twist limit. SwingSpan1 Gets the swing span1. public float SwingSpan1 { get; } Property Value float The swing span1. SwingSpan2 Gets the swing span2. public float SwingSpan2 { get; } Property Value float The swing span2. TwistAngle Gets the twist angle. public float TwistAngle { get; } Property Value float The twist angle. TwistLimitSign Gets the twist limit sign. public float TwistLimitSign { get; } Property Value float The twist limit sign. TwistSpan Gets the twist span. public float TwistSpan { get; } Property Value float The twist span. Methods EnableMotor(bool) Enables the motor. public void EnableMotor(bool b) Parameters b bool if set to true [b]. SetAngularOnly(bool) Sets the angular only. public void SetAngularOnly(bool angularOnly) Parameters angularOnly bool if set to true [angular only]. SetDamping(float) Sets the damping. public void SetDamping(float damping) Parameters damping float The damping. SetFrames(Matrix, Matrix) Sets the frames. public void SetFrames(Matrix frameA, Matrix frameB) Parameters frameA Matrix The frame a. frameB Matrix The frame b. SetLimit(float, float, float) Sets the limit. public void SetLimit(float swingSpan1, float swingSpan2, float twistSpan) Parameters swingSpan1 float The swing span1. swingSpan2 float The swing span2. twistSpan float The twist span. SetLimit(float, float, float, float, float) Sets the limit. public void SetLimit(float swingSpan1, float swingSpan2, float twistSpan, float softness, float biasFactor) Parameters swingSpan1 float The swing span1. swingSpan2 float The swing span2. twistSpan float The twist span. softness float The softness. biasFactor float The bias factor. SetLimit(float, float, float, float, float, float) Sets the limit. public void SetLimit(float swingSpan1, float swingSpan2, float twistSpan, float softness, float biasFactor, float relaxationFactor) Parameters swingSpan1 float The swing span1. swingSpan2 float The swing span2. twistSpan float The twist span. softness float The softness. biasFactor float The bias factor. relaxationFactor float The relaxation factor. SetMaxMotorImpulse(float) Sets the maximum motor impulse. public void SetMaxMotorImpulse(float maxMotorImpulse) Parameters maxMotorImpulse float The maximum motor impulse. SetMaxMotorImpulseNormalized(float) Sets the maximum motor impulse normalized. public void SetMaxMotorImpulseNormalized(float maxMotorImpulse) Parameters maxMotorImpulse float The maximum motor impulse. SetMotorTarget(Quaternion) Sets the motor target. public void SetMotorTarget(Quaternion q) Parameters q Quaternion The q. SetMotorTargetInConstraintSpace(Quaternion) Sets the motor target in constraint space. public void SetMotorTargetInConstraintSpace(Quaternion q) Parameters q Quaternion The q."
  },
  "api/Stride.Physics.Constraint.html": {
    "href": "api/Stride.Physics.Constraint.html",
    "title": "Class Constraint | Stride API",
    "summary": "Class Constraint Namespace Stride.Physics Assembly Stride.Physics.dll public class Constraint : IDisposable, IRelative Inheritance object Constraint Implements IDisposable IRelative Derived ConeTwistConstraint GearConstraint Generic6DoFConstraint HingeConstraint Point2PointConstraint SliderConstraint Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties AppliedImpulse Gets the applied impulse. public float AppliedImpulse { get; } Property Value float The applied impulse. BreakingImpulseThreshold Gets or sets the breaking impulse threshold. public float BreakingImpulseThreshold { get; set; } Property Value float The breaking impulse threshold. Enabled Gets or sets a value indicating whether this Constraint is enabled. public bool Enabled { get; set; } Property Value bool true if enabled; otherwise, false. RigidBodyA Gets the rigid body a. public RigidbodyComponent RigidBodyA { get; } Property Value RigidbodyComponent The rigid body a. RigidBodyB Gets the rigid body b. public RigidbodyComponent RigidBodyB { get; } Property Value RigidbodyComponent The rigid body b. Simulation Gets the Simulation where this Constraint is being processed public Simulation Simulation { get; } Property Value Simulation Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public virtual void Dispose()"
  },
  "api/Stride.Physics.ConstraintTypes.html": {
    "href": "api/Stride.Physics.ConstraintTypes.html",
    "title": "Enum ConstraintTypes | Stride API",
    "summary": "Enum ConstraintTypes Namespace Stride.Physics Assembly Stride.Physics.dll public enum ConstraintTypes Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields ConeTwist = 3 Gear = 6 The translation vector of the matrix to create this will represent the axis, the rest is ignored Generic6DoF = 4 Generic6DoFSpring = 5 Hinge = 1 Point2Point = 0 The translation vector of the matrix to create this will represent the pivot, the rest is ignored Slider = 2"
  },
  "api/Stride.Physics.Constraints.ConeTwistConstraintDesc.LimitDesc.html": {
    "href": "api/Stride.Physics.Constraints.ConeTwistConstraintDesc.LimitDesc.html",
    "title": "Class ConeTwistConstraintDesc.LimitDesc | Stride API",
    "summary": "Class ConeTwistConstraintDesc.LimitDesc Namespace Stride.Physics.Constraints Assembly Stride.Physics.dll ConeTwist constraint properties regarding limits. [DataContract] public class ConeTwistConstraintDesc.LimitDesc Inheritance object ConeTwistConstraintDesc.LimitDesc Extension Methods UnsafeUtilities.As<T>(object?) Properties SetLimit If true there will be a limit set on the constraint. [Display(0, null, null)] public bool SetLimit { get; set; } Property Value bool SwingSpanY Limit on the swing in the direction of the constraint Y axis. [Display(2, null, null)] [DataMemberRange(0, 3.141592653589793, 0.0872664675116539, 0.7853981852531433, 3)] public float SwingSpanY { get; set; } Property Value float SwingSpanZ Limit on the swing in the direction of the constraint Z axis. [Display(1, null, null)] [DataMemberRange(0, 3.141592653589793, 0.0872664675116539, 0.7853981852531433, 3)] public float SwingSpanZ { get; set; } Property Value float TwistSpan Limit on the twist (rotation around constraint axis). [Display(3, null, null)] [DataMemberRange(0, 3.141592653589793, 0.0872664675116539, 0.7853981852531433, 3)] public float TwistSpan { get; set; } Property Value float"
  },
  "api/Stride.Physics.Constraints.ConeTwistConstraintDesc.html": {
    "href": "api/Stride.Physics.Constraints.ConeTwistConstraintDesc.html",
    "title": "Class ConeTwistConstraintDesc | Stride API",
    "summary": "Class ConeTwistConstraintDesc Namespace Stride.Physics.Constraints Assembly Stride.Physics.dll Description of a ConeTwistConstraint. [Display(\"Cone Twist\", null)] [DataContract(\"ConeTwistConstraintDesc\")] public class ConeTwistConstraintDesc : IConstraintDesc Inheritance object ConeTwistConstraintDesc Implements IConstraintDesc Extension Methods UnsafeUtilities.As<T>(object?) Properties AxisInA Axis on which the cone will twist relative to body A. [Display(2, null, null)] public Quaternion AxisInA { get; set; } Property Value Quaternion AxisInB Axis on which the cone will twist relative to body B. [Display(3, null, null)] public Quaternion AxisInB { get; set; } Property Value Quaternion Limit [Display(4, null, null)] public ConeTwistConstraintDesc.LimitDesc Limit { get; set; } Property Value ConeTwistConstraintDesc.LimitDesc PivotInA Position local to rigidbody A. [Display(0, null, null)] public Vector3 PivotInA { get; set; } Property Value Vector3 PivotInB Position local to rigidbody B. [Display(1, null, null)] public Vector3 PivotInB { get; set; } Property Value Vector3 Remarks Ignored when creating a body-world constraint. Type Type of the constraint description. public ConstraintTypes Type { get; } Property Value ConstraintTypes Methods Build(RigidbodyComponent, RigidbodyComponent) Create a new constraint according to the description properties between bodies A and B, or between A and World. public Constraint Build(RigidbodyComponent bodyA, RigidbodyComponent bodyB) Parameters bodyA RigidbodyComponent bodyB RigidbodyComponent Returns Constraint A new constraint constructed in the Simulation. Needs to be added with AddConstraint(Constraint) to take effect."
  },
  "api/Stride.Physics.Constraints.GearConstraintDesc.html": {
    "href": "api/Stride.Physics.Constraints.GearConstraintDesc.html",
    "title": "Class GearConstraintDesc | Stride API",
    "summary": "Class GearConstraintDesc Namespace Stride.Physics.Constraints Assembly Stride.Physics.dll Description of a GearConstraint. [Display(\"Gear\", null)] [DataContract(\"GearConstraintDesc\")] public class GearConstraintDesc : IConstraintDesc Inheritance object GearConstraintDesc Implements IConstraintDesc Extension Methods UnsafeUtilities.As<T>(object?) Properties AxisInA Axis on which the gear will rotate relative to body A. [Display(0, null, null)] public Quaternion AxisInA { get; set; } Property Value Quaternion AxisInB Axis on which the gear will rotate relative to body B. [Display(1, null, null)] public Quaternion AxisInB { get; set; } Property Value Quaternion PivotInA Position local to rigidbody A. public Vector3 PivotInA { get; } Property Value Vector3 Remarks Not used for the gear constraint. PivotInB Position local to rigidbody B. public Vector3 PivotInB { get; } Property Value Vector3 Remarks Ignored when creating a body-world constraint. Ratio Size ratio between the gears (rotating a bigger gear will rotate smaller gear quicker). [Display(2, null, null)] public float Ratio { get; set; } Property Value float Type Type of the constraint description. public ConstraintTypes Type { get; } Property Value ConstraintTypes Methods Build(RigidbodyComponent, RigidbodyComponent) Create a new constraint according to the description properties between bodies A and B, or between A and World. public Constraint Build(RigidbodyComponent bodyA, RigidbodyComponent bodyB) Parameters bodyA RigidbodyComponent bodyB RigidbodyComponent Returns Constraint A new constraint constructed in the Simulation. Needs to be added with AddConstraint(Constraint) to take effect."
  },
  "api/Stride.Physics.Constraints.HingeConstraintDesc.LimitDesc.html": {
    "href": "api/Stride.Physics.Constraints.HingeConstraintDesc.LimitDesc.html",
    "title": "Class HingeConstraintDesc.LimitDesc | Stride API",
    "summary": "Class HingeConstraintDesc.LimitDesc Namespace Stride.Physics.Constraints Assembly Stride.Physics.dll Hinge constraint properties regarding limits. [DataContract] public class HingeConstraintDesc.LimitDesc Inheritance object HingeConstraintDesc.LimitDesc Extension Methods UnsafeUtilities.As<T>(object?) Properties LowerLimit Negative limit (-Pi, 0). Left handed rotation when thumb points at positive X axis of the constraint. [Display(1, null, null)] [DataMemberRange(-3.141592653589793, 0, 0.0872664675116539, 0.7853981852531433, 3)] public float LowerLimit { get; set; } Property Value float SetLimit If true there will be a limit set on the constraint. [Display(0, null, null)] public bool SetLimit { get; set; } Property Value bool Remarks The limits are angles determining the area of freedom for the constraint, calculated from 0 to ±PI, with 0 being at the positive Z axis of the constraint (with X being the hinge axis). UpperLimit Positive limit (0, Pi). Right handed rotation when thumb points at positive X axis of the constraint. [Display(2, null, null)] [DataMemberRange(0, 3.141592653589793, 0.0872664675116539, 0.7853981852531433, 3)] public float UpperLimit { get; set; } Property Value float"
  },
  "api/Stride.Physics.Constraints.HingeConstraintDesc.MotorDesc.html": {
    "href": "api/Stride.Physics.Constraints.HingeConstraintDesc.MotorDesc.html",
    "title": "Struct HingeConstraintDesc.MotorDesc | Stride API",
    "summary": "Struct HingeConstraintDesc.MotorDesc Namespace Stride.Physics.Constraints Assembly Stride.Physics.dll Hinge constraint properties regarding the angular motor. [DataContract] public struct HingeConstraintDesc.MotorDesc Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties EnableMotor Enables an angular motor on the constraint. [Display(0, null, null)] public bool EnableMotor { readonly get; set; } Property Value bool MaxMotorImpulse Maximum motor impulse. [Display(2, null, null)] public float MaxMotorImpulse { readonly get; set; } Property Value float TargetVelocity Target angular velocity of the motor. [Display(1, null, null)] public float TargetVelocity { readonly get; set; } Property Value float"
  },
  "api/Stride.Physics.Constraints.HingeConstraintDesc.html": {
    "href": "api/Stride.Physics.Constraints.HingeConstraintDesc.html",
    "title": "Class HingeConstraintDesc | Stride API",
    "summary": "Class HingeConstraintDesc Namespace Stride.Physics.Constraints Assembly Stride.Physics.dll Description of a HingeConstraint. [Display(\"Hinge\", null)] [DataContract(\"HingeConstraintDesc\")] public class HingeConstraintDesc : IConstraintDesc Inheritance object HingeConstraintDesc Implements IConstraintDesc Extension Methods UnsafeUtilities.As<T>(object?) Properties AxisInA Axis on which the hinge will rotate relative to body A. [Display(2, null, null)] public Quaternion AxisInA { get; set; } Property Value Quaternion AxisInB Axis on which the hinge will rotate relative to body B. [Display(3, null, null)] public Quaternion AxisInB { get; set; } Property Value Quaternion Limit [Display(5, null, null)] public HingeConstraintDesc.LimitDesc Limit { get; set; } Property Value HingeConstraintDesc.LimitDesc Motor [Display(6, null, null)] public HingeConstraintDesc.MotorDesc Motor { get; set; } Property Value HingeConstraintDesc.MotorDesc PivotInA Position local to rigidbody A. [Display(0, null, null)] public Vector3 PivotInA { get; set; } Property Value Vector3 PivotInB Position local to rigidbody B. [Display(1, null, null)] public Vector3 PivotInB { get; set; } Property Value Vector3 Remarks Ignored when creating a body-world constraint. Type Type of the constraint description. public ConstraintTypes Type { get; } Property Value ConstraintTypes UseReferenceFrameA If true, UseReferenceFrameA sets the reference sign to -1, which is used in some correction computations regarding limits and when returning the current hinge angle. [Display(4, null, null)] public bool UseReferenceFrameA { get; set; } Property Value bool Methods Build(RigidbodyComponent, RigidbodyComponent) Create a new constraint according to the description properties between bodies A and B, or between A and World. public Constraint Build(RigidbodyComponent bodyA, RigidbodyComponent bodyB) Parameters bodyA RigidbodyComponent bodyB RigidbodyComponent Returns Constraint A new constraint constructed in the Simulation. Needs to be added with AddConstraint(Constraint) to take effect."
  },
  "api/Stride.Physics.Constraints.Point2PointConstraintDesc.html": {
    "href": "api/Stride.Physics.Constraints.Point2PointConstraintDesc.html",
    "title": "Class Point2PointConstraintDesc | Stride API",
    "summary": "Class Point2PointConstraintDesc Namespace Stride.Physics.Constraints Assembly Stride.Physics.dll Description of a Point2PointConstraint. [Display(\"Point to Point\", null)] [DataContract(\"Point2PointConstraintDesc\")] public class Point2PointConstraintDesc : IConstraintDesc Inheritance object Point2PointConstraintDesc Implements IConstraintDesc Extension Methods UnsafeUtilities.As<T>(object?) Properties PivotInA Position local to rigidbody A. public Vector3 PivotInA { get; set; } Property Value Vector3 PivotInB Position local to rigidbody B. public Vector3 PivotInB { get; set; } Property Value Vector3 Remarks Ignored when creating a body-world constraint. Type Type of the constraint description. public ConstraintTypes Type { get; } Property Value ConstraintTypes Methods Build(RigidbodyComponent, RigidbodyComponent) Create a new constraint according to the description properties between bodies A and B, or between A and World. public Constraint Build(RigidbodyComponent bodyA, RigidbodyComponent bodyB) Parameters bodyA RigidbodyComponent bodyB RigidbodyComponent Returns Constraint A new constraint constructed in the Simulation. Needs to be added with AddConstraint(Constraint) to take effect."
  },
  "api/Stride.Physics.Constraints.SliderConstraintDesc.LimitDesc.html": {
    "href": "api/Stride.Physics.Constraints.SliderConstraintDesc.LimitDesc.html",
    "title": "Class SliderConstraintDesc.LimitDesc | Stride API",
    "summary": "Class SliderConstraintDesc.LimitDesc Namespace Stride.Physics.Constraints Assembly Stride.Physics.dll Slider constraint properties regarding limits. [DataContract] public class SliderConstraintDesc.LimitDesc Inheritance object SliderConstraintDesc.LimitDesc Extension Methods UnsafeUtilities.As<T>(object?) Properties LowerAngularLimit Negative limit (-Pi, 0). Left handed rotation when thumb points at positive X axis of the constraint. [Display(2, null, null)] [DataMemberRange(-3.141592653589793, 0, 0.0872664675116539, 0.7853981852531433, 3)] public float LowerAngularLimit { get; set; } Property Value float LowerLinearLimit Lower linear limit along the constraint axis. [Display(0, null, null)] public float LowerLinearLimit { get; set; } Property Value float Remarks If Lower = Upper, the axis is locked; if Lower > Upper, the axis is free; if Lower < Upper, axis is limited in the range. UpperAngularLimit Positive limit (0, Pi). Right handed rotation when thumb points at positive X axis of the constraint. [Display(3, null, null)] [DataMemberRange(0, 3.141592653589793, 0.0872664675116539, 0.7853981852531433, 3)] public float UpperAngularLimit { get; set; } Property Value float UpperLinearLimit Upper linear limit along the constraint axis. [Display(1, null, null)] public float UpperLinearLimit { get; set; } Property Value float Remarks If Lower = Upper, the axis is locked; if Lower > Upper, the axis is free; if Lower < Upper, axis is limited in the range."
  },
  "api/Stride.Physics.Constraints.SliderConstraintDesc.html": {
    "href": "api/Stride.Physics.Constraints.SliderConstraintDesc.html",
    "title": "Class SliderConstraintDesc | Stride API",
    "summary": "Class SliderConstraintDesc Namespace Stride.Physics.Constraints Assembly Stride.Physics.dll Description of a SliderConstraint. [Display(\"Slider\", null)] [DataContract(\"SliderConstraintDesc\")] public class SliderConstraintDesc : IConstraintDesc Inheritance object SliderConstraintDesc Implements IConstraintDesc Extension Methods UnsafeUtilities.As<T>(object?) Properties AxisInA Axis on which the gear will rotate relative to body A. [Display(2, null, null)] public Quaternion AxisInA { get; set; } Property Value Quaternion AxisInB Axis on which the gear will rotate relative to body B. [Display(3, null, null)] public Quaternion AxisInB { get; set; } Property Value Quaternion Limit [Display(5, null, null)] public SliderConstraintDesc.LimitDesc Limit { get; set; } Property Value SliderConstraintDesc.LimitDesc PivotInA Position local to rigidbody A. [Display(0, null, null)] public Vector3 PivotInA { get; set; } Property Value Vector3 Remarks Not used for the gear constraint. PivotInB Position local to rigidbody B. [Display(1, null, null)] public Vector3 PivotInB { get; set; } Property Value Vector3 Remarks Ignored when creating a body-world constraint. Type Type of the constraint description. public ConstraintTypes Type { get; } Property Value ConstraintTypes UseLinearReferenceFrameA If true, UseLinearReferenceFrameA sets the reference sign to -1, which is used in some correction computations regarding limits and transforms. [Display(4, null, null)] public bool UseLinearReferenceFrameA { get; set; } Property Value bool Remarks In body-world constraint the bodyA is actually passed as bodyB. Methods Build(RigidbodyComponent, RigidbodyComponent) Create a new constraint according to the description properties between bodies A and B, or between A and World. public Constraint Build(RigidbodyComponent bodyA, RigidbodyComponent bodyB) Parameters bodyA RigidbodyComponent bodyB RigidbodyComponent Returns Constraint A new constraint constructed in the Simulation. Needs to be added with AddConstraint(Constraint) to take effect."
  },
  "api/Stride.Physics.Constraints.html": {
    "href": "api/Stride.Physics.Constraints.html",
    "title": "Namespace Stride.Physics.Constraints | Stride API",
    "summary": "Namespace Stride.Physics.Constraints Classes ConeTwistConstraintDesc Description of a ConeTwistConstraint. ConeTwistConstraintDesc.LimitDesc ConeTwist constraint properties regarding limits. GearConstraintDesc Description of a GearConstraint. HingeConstraintDesc Description of a HingeConstraint. HingeConstraintDesc.LimitDesc Hinge constraint properties regarding limits. Point2PointConstraintDesc Description of a Point2PointConstraint. SliderConstraintDesc Description of a SliderConstraint. SliderConstraintDesc.LimitDesc Slider constraint properties regarding limits. Structs HingeConstraintDesc.MotorDesc Hinge constraint properties regarding the angular motor."
  },
  "api/Stride.Physics.ContactPoint.html": {
    "href": "api/Stride.Physics.ContactPoint.html",
    "title": "Struct ContactPoint | Stride API",
    "summary": "Struct ContactPoint Namespace Stride.Physics Assembly Stride.Physics.dll public struct ContactPoint : IEquatable<ContactPoint> Implements IEquatable<ContactPoint> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields AppliedImpulse The normal impulse applied to resolve a collision between two bodies public float AppliedImpulse Field Value float AppliedImpulseLateral1 Tangential impulse to contact point of AppliedImpulse public float AppliedImpulseLateral1 Field Value float AppliedImpulseLateral2 Perpendicular impulse to both AppliedImpulse and AppliedImpulseLateral1 public float AppliedImpulseLateral2 Field Value float ColliderA public PhysicsComponent ColliderA Field Value PhysicsComponent ColliderB public PhysicsComponent ColliderB Field Value PhysicsComponent Distance public float Distance Field Value float Normal public Vector3 Normal Field Value Vector3 PositionOnA public Vector3 PositionOnA Field Value Vector3 PositionOnB public Vector3 PositionOnB Field Value Vector3 Methods Equals(ContactPoint) Indicates whether the current object is equal to another object of the same type. public bool Equals(ContactPoint other) Parameters other ContactPoint An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance."
  },
  "api/Stride.Physics.ConvexHullColliderShape.html": {
    "href": "api/Stride.Physics.ConvexHullColliderShape.html",
    "title": "Class ConvexHullColliderShape | Stride API",
    "summary": "Class ConvexHullColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class ConvexHullColliderShape : ColliderShape, IDisposable Inheritance object ColliderShape ConvexHullColliderShape Implements IDisposable Inherited Members ColliderShape.DebugScaling ColliderShape.Dispose() ColliderShape.Type ColliderShape.LocalOffset ColliderShape.LocalRotation ColliderShape.UpdateLocalTransformations() ColliderShape.PositiveCenterMatrix ColliderShape.NegativeCenterMatrix ColliderShape.cachedScaling ColliderShape.Scaling ColliderShape.Is2D ColliderShape.Description ColliderShape.CreateUpdatableDebugPrimitive(GraphicsDevice) ColliderShape.UpdateDebugPrimitive(CommandList, IDebugPrimitive) ColliderShape.Margin ColliderShape.DebugPrimitiveMatrix Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ConvexHullColliderShape(IReadOnlyList<Vector3>, IReadOnlyList<uint>, Vector3) public ConvexHullColliderShape(IReadOnlyList<Vector3> points, IReadOnlyList<uint> indices, Vector3 scaling) Parameters points IReadOnlyList<Vector3> indices IReadOnlyList<uint> scaling Vector3 Properties Indices public IReadOnlyList<uint> Indices { get; } Property Value IReadOnlyList<uint> Points public IReadOnlyList<Vector3> Points { get; } Property Value IReadOnlyList<Vector3> Methods CreateDebugPrimitive(GraphicsDevice) public override MeshDraw CreateDebugPrimitive(GraphicsDevice device) Parameters device GraphicsDevice Returns MeshDraw"
  },
  "api/Stride.Physics.ConvexHullColliderShapeDesc.html": {
    "href": "api/Stride.Physics.ConvexHullColliderShapeDesc.html",
    "title": "Class ConvexHullColliderShapeDesc | Stride API",
    "summary": "Class ConvexHullColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<ConvexHullColliderShapeDesc>))] [DataContract(\"ConvexHullColliderShapeDesc\")] [Display(500, \"Convex Hull\", null)] public class ConvexHullColliderShapeDesc : IAssetColliderShapeDesc, IColliderShapeDesc Inheritance object ConvexHullColliderShapeDesc Implements IAssetColliderShapeDesc IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Fields ConvexHulls [Display(null, null, Browsable = false)] [DataMember(10)] public List<List<List<Vector3>>> ConvexHulls Field Value List<List<List<Vector3>>> ConvexHullsIndices [Display(null, null, Browsable = false)] [DataMember(20)] public List<List<List<uint>>> ConvexHullsIndices Field Value List<List<List<uint>>> LocalOffset [DataMember(31)] public Vector3 LocalOffset Field Value Vector3 LocalRotation [DataMember(32)] public Quaternion LocalRotation Field Value Quaternion Model [DataMember(30)] public Model Model Field Value Model Scaling [DataMember(45)] public Vector3 Scaling Field Value Vector3 Properties Decomposition [DataMember(50)] public ConvexHullDecompositionParameters Decomposition { get; set; } Property Value ConvexHullDecompositionParameters Margin [DataMember(48)] public float Margin { get; set; } Property Value float Methods CreateShape(IServiceRegistry) public ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.ConvexHullDecompositionParameters.html": {
    "href": "api/Stride.Physics.ConvexHullDecompositionParameters.html",
    "title": "Class ConvexHullDecompositionParameters | Stride API",
    "summary": "Class ConvexHullDecompositionParameters Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<ConvexHullDecompositionParameters>))] [DataContract(\"DecompositionParameters\")] [Display(\"DecompositionParameters\", null)] public class ConvexHullDecompositionParameters Inheritance object ConvexHullDecompositionParameters Extension Methods UnsafeUtilities.As<T>(object?) Properties Alpha [DataMember(110)] public float Alpha { get; set; } Property Value float AngleRefine [DataMember(100)] public int AngleRefine { get; set; } Property Value int AngleSampling [DataMember(80)] public int AngleSampling { get; set; } Property Value int Depth [DataMember(60)] public int Depth { get; set; } Property Value int Enabled public bool Enabled { get; set; } Property Value bool PosRefine [DataMember(90)] public int PosRefine { get; set; } Property Value int PosSampling [DataMember(70)] public int PosSampling { get; set; } Property Value int Threshold [DataMember(120)] public float Threshold { get; set; } Property Value float Methods Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.CustomHeightScaleCalculator.html": {
    "href": "api/Stride.Physics.CustomHeightScaleCalculator.html",
    "title": "Class CustomHeightScaleCalculator | Stride API",
    "summary": "Class CustomHeightScaleCalculator Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract] [Display(\"Custom\", null)] public class CustomHeightScaleCalculator : IHeightScaleCalculator Inheritance object CustomHeightScaleCalculator Implements IHeightScaleCalculator Extension Methods UnsafeUtilities.As<T>(object?) Properties Denominator [DataMember(20)] public float Denominator { get; set; } Property Value float Numerator [DataMember(10)] public float Numerator { get; set; } Property Value float Methods Calculate(IHeightStickParameters) public float Calculate(IHeightStickParameters heightDescription) Parameters heightDescription IHeightStickParameters Returns float"
  },
  "api/Stride.Physics.CylinderColliderShape.html": {
    "href": "api/Stride.Physics.CylinderColliderShape.html",
    "title": "Class CylinderColliderShape | Stride API",
    "summary": "Class CylinderColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class CylinderColliderShape : ColliderShape, IDisposable Inheritance object ColliderShape CylinderColliderShape Implements IDisposable Inherited Members ColliderShape.DebugScaling ColliderShape.Dispose() ColliderShape.Type ColliderShape.LocalOffset ColliderShape.LocalRotation ColliderShape.UpdateLocalTransformations() ColliderShape.PositiveCenterMatrix ColliderShape.NegativeCenterMatrix ColliderShape.cachedScaling ColliderShape.Scaling ColliderShape.Is2D ColliderShape.Description ColliderShape.CreateUpdatableDebugPrimitive(GraphicsDevice) ColliderShape.UpdateDebugPrimitive(CommandList, IDebugPrimitive) ColliderShape.Margin ColliderShape.DebugPrimitiveMatrix Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors CylinderColliderShape(float, float, ShapeOrientation) Initializes a new instance of the CylinderColliderShape class. public CylinderColliderShape(float heightParam, float radiusParam, ShapeOrientation orientationParam) Parameters heightParam float radiusParam float orientationParam ShapeOrientation Fields Height public readonly float Height Field Value float Orientation public readonly ShapeOrientation Orientation Field Value ShapeOrientation Radius public readonly float Radius Field Value float Methods CreateDebugPrimitive(GraphicsDevice) public override MeshDraw CreateDebugPrimitive(GraphicsDevice device) Parameters device GraphicsDevice Returns MeshDraw"
  },
  "api/Stride.Physics.CylinderColliderShapeDesc.html": {
    "href": "api/Stride.Physics.CylinderColliderShapeDesc.html",
    "title": "Class CylinderColliderShapeDesc | Stride API",
    "summary": "Class CylinderColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<CylinderColliderShapeDesc>))] [DataContract(\"CylinderColliderShapeDesc\")] [Display(50, \"Cylinder\", null)] public class CylinderColliderShapeDesc : IInlineColliderShapeDesc, IAssetColliderShapeDesc, IColliderShapeDesc Inheritance object CylinderColliderShapeDesc Implements IInlineColliderShapeDesc IAssetColliderShapeDesc IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Fields Height [DataMember(10)] public float Height Field Value float LocalOffset [DataMember(40)] public Vector3 LocalOffset Field Value Vector3 LocalRotation [DataMember(50)] public Quaternion LocalRotation Field Value Quaternion Orientation [DataMember(30)] public ShapeOrientation Orientation Field Value ShapeOrientation Radius [DataMember(20)] public float Radius Field Value float Methods CreateShape(IServiceRegistry) public ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.DebugPrimitive.html": {
    "href": "api/Stride.Physics.DebugPrimitive.html",
    "title": "Class DebugPrimitive | Stride API",
    "summary": "Class DebugPrimitive Namespace Stride.Physics Assembly Stride.Physics.dll public class DebugPrimitive : IDebugPrimitive, IEnumerable<MeshDraw>, IEnumerable Inheritance object DebugPrimitive Implements IDebugPrimitive IEnumerable<MeshDraw> IEnumerable Extension Methods EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Fields MeshDraws public readonly List<MeshDraw> MeshDraws Field Value List<MeshDraw> Methods Add(MeshDraw) public void Add(MeshDraw meshDraw) Parameters meshDraw MeshDraw GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<MeshDraw> GetEnumerator() Returns IEnumerator<MeshDraw> An enumerator that can be used to iterate through the collection. GetMeshDraws() public IEnumerable<MeshDraw> GetMeshDraws() Returns IEnumerable<MeshDraw>"
  },
  "api/Stride.Physics.EFlags.html": {
    "href": "api/Stride.Physics.EFlags.html",
    "title": "Enum EFlags | Stride API",
    "summary": "Enum EFlags Namespace Stride.Physics Assembly Stride.Physics.dll Flags that control how ray tests are performed [Flags] public enum EFlags : uint Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields DisableHeightfieldAccelerator = 16 Don't use the heightfield raycast accelerator. See https://github.com/bulletphysics/bullet3/pull/2062 FilterBackfaces = 1 Do not return a hit when a ray traverses a back-facing triangle KeepUnflippedNormal = 2 Prevents returned face normal getting flipped when a ray hits a back-facing triangle None = 0 UseGjkConvexCastRaytest = 8 UseSubSimplexConvexCastRaytest = 4 Uses an approximate but faster ray versus convex intersection algorithm SubSimplexConvexCastRaytest is the default, even if kF_None is set."
  },
  "api/Stride.Physics.Engine.PhysicsConstraintProcessor.html": {
    "href": "api/Stride.Physics.Engine.PhysicsConstraintProcessor.html",
    "title": "Class PhysicsConstraintProcessor | Stride API",
    "summary": "Class PhysicsConstraintProcessor Namespace Stride.Physics.Engine Assembly Stride.Physics.dll public class PhysicsConstraintProcessor : EntityProcessor<PhysicsConstraintComponent> Inheritance object EntityProcessor EntityProcessor<PhysicsConstraintComponent, PhysicsConstraintComponent> EntityProcessor<PhysicsConstraintComponent> PhysicsConstraintProcessor Inherited Members EntityProcessor<PhysicsConstraintComponent>.GenerateComponentData(Entity, PhysicsConstraintComponent) EntityProcessor<PhysicsConstraintComponent>.IsAssociatedDataValid(Entity, PhysicsConstraintComponent, PhysicsConstraintComponent) EntityProcessor<PhysicsConstraintComponent, PhysicsConstraintComponent>.ComponentDatas EntityProcessor<PhysicsConstraintComponent, PhysicsConstraintComponent>.OnSystemAdd() EntityProcessor<PhysicsConstraintComponent, PhysicsConstraintComponent>.OnSystemRemove() EntityProcessor<PhysicsConstraintComponent, PhysicsConstraintComponent>.RemoveAllEntities() EntityProcessor<PhysicsConstraintComponent, PhysicsConstraintComponent>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<PhysicsConstraintComponent, PhysicsConstraintComponent>.GenerateComponentData(Entity, PhysicsConstraintComponent) EntityProcessor<PhysicsConstraintComponent, PhysicsConstraintComponent>.IsAssociatedDataValid(Entity, PhysicsConstraintComponent, PhysicsConstraintComponent) EntityProcessor<PhysicsConstraintComponent, PhysicsConstraintComponent>.OnEntityComponentAdding(Entity, PhysicsConstraintComponent, PhysicsConstraintComponent) EntityProcessor<PhysicsConstraintComponent, PhysicsConstraintComponent>.OnEntityComponentRemoved(Entity, PhysicsConstraintComponent, PhysicsConstraintComponent) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Draw(RenderContext) EntityProcessor.OnSystemAdd() EntityProcessor.OnSystemRemove() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors PhysicsConstraintProcessor() public PhysicsConstraintProcessor() Methods OnEntityComponentAdding(Entity, PhysicsConstraintComponent, PhysicsConstraintComponent) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, PhysicsConstraintComponent component, PhysicsConstraintComponent data) Parameters entity Entity The entity. component PhysicsConstraintComponent data PhysicsConstraintComponent The associated data. OnEntityComponentRemoved(Entity, PhysicsConstraintComponent, PhysicsConstraintComponent) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, PhysicsConstraintComponent component, PhysicsConstraintComponent data) Parameters entity Entity The entity. component PhysicsConstraintComponent data PhysicsConstraintComponent The associated data. Recreate(PhysicsConstraintComponent, bool) Recreate the constraint according to the description in the component. public void Recreate(PhysicsConstraintComponent component, bool skipUninitializedComponents = false) Parameters component PhysicsConstraintComponent Constraint component. skipUninitializedComponents bool If true and rigidbody internals have not been initialized no exception will be thrown. Update(GameTime) Performs work related to this processor. public override void Update(GameTime time) Parameters time GameTime"
  },
  "api/Stride.Physics.Engine.PhysicsShapesRenderingService.html": {
    "href": "api/Stride.Physics.Engine.PhysicsShapesRenderingService.html",
    "title": "Class PhysicsShapesRenderingService | Stride API",
    "summary": "Class PhysicsShapesRenderingService Namespace Stride.Physics.Engine Assembly Stride.Physics.dll public class PhysicsShapesRenderingService : GameSystem, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase GameSystem PhysicsShapesRenderingService Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Inherited Members GameSystem.Game GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.Draw(GameTime) GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) GameSystemBase.LoadContent() GameSystemBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors PhysicsShapesRenderingService(IServiceRegistry) public PhysicsShapesRenderingService(IServiceRegistry registry) Parameters registry IServiceRegistry Methods CreateDebugEntity(PhysicsComponent, RenderGroup, bool) public Entity CreateDebugEntity(PhysicsComponent component, RenderGroup renderGroup, bool alwaysAddOffset = false) Parameters component PhysicsComponent renderGroup RenderGroup alwaysAddOffset bool Returns Entity Initialize() Initializes the Game System. public override void Initialize() Remarks This method is called when the component is added to the Game. This can be used for tasks like querying for services the component needs and setting up non-graphics resources (as here the Graphics Device may have not been initialized yet). Update(GameTime) This method is called when this game component is updated. public override void Update(GameTime gameTime) Parameters gameTime GameTime The current timing."
  },
  "api/Stride.Physics.Engine.html": {
    "href": "api/Stride.Physics.Engine.html",
    "title": "Namespace Stride.Physics.Engine | Stride API",
    "summary": "Namespace Stride.Physics.Engine Classes PhysicsConstraintProcessor PhysicsShapesRenderingService"
  },
  "api/Stride.Physics.FloatHeightStickArraySource.html": {
    "href": "api/Stride.Physics.FloatHeightStickArraySource.html",
    "title": "Class FloatHeightStickArraySource | Stride API",
    "summary": "Class FloatHeightStickArraySource Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract] [Display(\"Float\", null)] public class FloatHeightStickArraySource : IHeightStickArraySource, IHeightStickParameters Inheritance object FloatHeightStickArraySource Implements IHeightStickArraySource IHeightStickParameters Extension Methods UnsafeUtilities.As<T>(object?) Properties HeightRange The range of the height. [DataMember(20)] public Vector2 HeightRange { get; set; } Property Value Vector2 Remarks X is min height and Y is max height. (height * HeightScale) should be in this range. Positive and negative heights can not be handle at the same time when the height type is Byte. HeightScale Used to calculate the height when the height type is Short or Byte. HeightScale should be 1 when the height type is Float. public float HeightScale { get; } Property Value float HeightStickSize The size of the source. [DataMember(10)] [Display(\"Size\", null)] public Int2 HeightStickSize { get; set; } Property Value Int2 Remarks X is width and Y is length. They should be greater than or equal to 2. For example, this size should be 65 * 65 when you want 64 * 64 size in a scene. HeightType The type of the height. public HeightfieldTypes HeightType { get; } Property Value HeightfieldTypes InitialHeight The value to fill the height stick array. [DataMember(30)] public float InitialHeight { get; set; } Property Value float Methods CopyTo<T>(UnmanagedArray<T>, int) Copy the source data to the height stick array. public void CopyTo<T>(UnmanagedArray<T> heightStickArray, int index) where T : struct Parameters heightStickArray UnmanagedArray<T> The destination to copy the data. index int The start index of the destination to copy the data. Type Parameters T The data type of the height IsValid() public bool IsValid() Returns bool Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.GearConstraint.html": {
    "href": "api/Stride.Physics.GearConstraint.html",
    "title": "Class GearConstraint | Stride API",
    "summary": "Class GearConstraint Namespace Stride.Physics Assembly Stride.Physics.dll public class GearConstraint : Constraint, IDisposable, IRelative Inheritance object Constraint GearConstraint Implements IDisposable IRelative Inherited Members Constraint.Dispose() Constraint.RigidBodyA Constraint.RigidBodyB Constraint.Enabled Constraint.BreakingImpulseThreshold Constraint.AppliedImpulse Constraint.Simulation Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties AxisA Gets or sets the axis a. public Vector3 AxisA { get; set; } Property Value Vector3 The axis a. AxisB Gets or sets the axis b. public Vector3 AxisB { get; set; } Property Value Vector3 The axis b. Ratio Gets or sets the ratio. public float Ratio { get; set; } Property Value float The ratio."
  },
  "api/Stride.Physics.Generic6DoFConstraint.html": {
    "href": "api/Stride.Physics.Generic6DoFConstraint.html",
    "title": "Class Generic6DoFConstraint | Stride API",
    "summary": "Class Generic6DoFConstraint Namespace Stride.Physics Assembly Stride.Physics.dll public class Generic6DoFConstraint : Constraint, IDisposable, IRelative Inheritance object Constraint Generic6DoFConstraint Implements IDisposable IRelative Derived Generic6DoFSpringConstraint Inherited Members Constraint.RigidBodyA Constraint.RigidBodyB Constraint.Enabled Constraint.BreakingImpulseThreshold Constraint.AppliedImpulse Constraint.Simulation Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors Generic6DoFConstraint() Initializes a new instance of the Generic6DoFConstraint class. public Generic6DoFConstraint() Properties AngularLowerLimit Gets or sets the angular lower limit. public Vector3 AngularLowerLimit { get; set; } Property Value Vector3 The angular lower limit. AngularUpperLimit Gets or sets the angular upper limit. public Vector3 AngularUpperLimit { get; set; } Property Value Vector3 The angular upper limit. LinearLowerLimit Gets or sets the linear lower limit. public Vector3 LinearLowerLimit { get; set; } Property Value Vector3 The linear lower limit. LinearUpperLimit Gets or sets the linear upper limit. public Vector3 LinearUpperLimit { get; set; } Property Value Vector3 The linear upper limit. RotationalLimitMotor Gets the rotational limit motor. public RotationalLimitMotor[] RotationalLimitMotor { get; } Property Value RotationalLimitMotor[] The rotational limit motor. TranslationalLimitMotor Gets the translational limit motor. public TranslationalLimitMotor TranslationalLimitMotor { get; } Property Value TranslationalLimitMotor The translational limit motor. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public override void Dispose() SetFrames(Matrix, Matrix) Sets the frames. public void SetFrames(Matrix frameA, Matrix frameB) Parameters frameA Matrix The frame a. frameB Matrix The frame b. SetLimit(int, float, float) Sets the limit. public void SetLimit(int axis, float lo, float hi) Parameters axis int The axis. lo float The lo. hi float The hi."
  },
  "api/Stride.Physics.Generic6DoFSpringConstraint.html": {
    "href": "api/Stride.Physics.Generic6DoFSpringConstraint.html",
    "title": "Class Generic6DoFSpringConstraint | Stride API",
    "summary": "Class Generic6DoFSpringConstraint Namespace Stride.Physics Assembly Stride.Physics.dll public class Generic6DoFSpringConstraint : Generic6DoFConstraint, IDisposable, IRelative Inheritance object Constraint Generic6DoFConstraint Generic6DoFSpringConstraint Implements IDisposable IRelative Inherited Members Generic6DoFConstraint.Dispose() Generic6DoFConstraint.AngularLowerLimit Generic6DoFConstraint.AngularUpperLimit Generic6DoFConstraint.LinearLowerLimit Generic6DoFConstraint.LinearUpperLimit Generic6DoFConstraint.SetFrames(Matrix, Matrix) Generic6DoFConstraint.SetLimit(int, float, float) Generic6DoFConstraint.TranslationalLimitMotor Generic6DoFConstraint.RotationalLimitMotor Constraint.RigidBodyA Constraint.RigidBodyB Constraint.Enabled Constraint.BreakingImpulseThreshold Constraint.AppliedImpulse Constraint.Simulation Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Methods EnableSpring(int, bool) Enables the spring. public void EnableSpring(int index, bool onOff) Parameters index int The index. onOff bool if set to true [on off]. SetDamping(int, float) Sets the damping. public void SetDamping(int index, float damping) Parameters index int The index. damping float The damping. SetEquilibriumPoint(int, float) Sets the equilibrium point. public void SetEquilibriumPoint(int index, float val) Parameters index int The index. val float The value. SetStiffness(int, float) Sets the stiffness. public void SetStiffness(int index, float stiffness) Parameters index int The index. stiffness float The stiffness."
  },
  "api/Stride.Physics.HeightScaleCalculator.html": {
    "href": "api/Stride.Physics.HeightScaleCalculator.html",
    "title": "Class HeightScaleCalculator | Stride API",
    "summary": "Class HeightScaleCalculator Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract] [Display(\"Auto\", null)] public class HeightScaleCalculator : IHeightScaleCalculator Inheritance object HeightScaleCalculator Implements IHeightScaleCalculator Extension Methods UnsafeUtilities.As<T>(object?) Methods Calculate(IHeightStickParameters) public float Calculate(IHeightStickParameters heightDescription) Parameters heightDescription IHeightStickParameters Returns float"
  },
  "api/Stride.Physics.HeightStickArraySourceFromHeightmap.html": {
    "href": "api/Stride.Physics.HeightStickArraySourceFromHeightmap.html",
    "title": "Class HeightStickArraySourceFromHeightmap | Stride API",
    "summary": "Class HeightStickArraySourceFromHeightmap Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract] [Display(\"Heightmap\", null)] public class HeightStickArraySourceFromHeightmap : IHeightStickArraySource, IHeightStickParameters Inheritance object HeightStickArraySourceFromHeightmap Implements IHeightStickArraySource IHeightStickParameters Extension Methods UnsafeUtilities.As<T>(object?) Properties HeightRange The range of the height. public Vector2 HeightRange { get; } Property Value Vector2 Remarks X is min height and Y is max height. (height * HeightScale) should be in this range. Positive and negative heights can not be handle at the same time when the height type is Byte. HeightScale Used to calculate the height when the height type is Short or Byte. HeightScale should be 1 when the height type is Float. public float HeightScale { get; } Property Value float HeightStickSize The size of the source. public Int2 HeightStickSize { get; } Property Value Int2 Remarks X is width and Y is length. They should be greater than or equal to 2. For example, this size should be 65 * 65 when you want 64 * 64 size in a scene. HeightType The type of the height. public HeightfieldTypes HeightType { get; } Property Value HeightfieldTypes Heightmap The heightmap to initialize the height stick array. [DataMember(10)] public Heightmap Heightmap { get; set; } Property Value Heightmap Methods CopyTo<T>(UnmanagedArray<T>, int) Copy the source data to the height stick array. public void CopyTo<T>(UnmanagedArray<T> heightStickArray, int index) where T : struct Parameters heightStickArray UnmanagedArray<T> The destination to copy the data. index int The start index of the destination to copy the data. Type Parameters T The data type of the height IsValid() public bool IsValid() Returns bool Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.HeightfieldCenteringParameters.html": {
    "href": "api/Stride.Physics.HeightfieldCenteringParameters.html",
    "title": "Struct HeightfieldCenteringParameters | Stride API",
    "summary": "Struct HeightfieldCenteringParameters Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract] public struct HeightfieldCenteringParameters Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties CenterHeight The height to be centered. [DataMember(20)] public float CenterHeight { readonly get; set; } Property Value float Enabled [DataMember(10)] public bool Enabled { readonly get; set; } Property Value bool Methods Match(HeightfieldCenteringParameters) public bool Match(HeightfieldCenteringParameters other) Parameters other HeightfieldCenteringParameters Returns bool"
  },
  "api/Stride.Physics.HeightfieldColliderShape.HeightArrayLock.LockTypes.html": {
    "href": "api/Stride.Physics.HeightfieldColliderShape.HeightArrayLock.LockTypes.html",
    "title": "Enum HeightfieldColliderShape.HeightArrayLock.LockTypes | Stride API",
    "summary": "Enum HeightfieldColliderShape.HeightArrayLock.LockTypes Namespace Stride.Physics Assembly Stride.Physics.dll public enum HeightfieldColliderShape.HeightArrayLock.LockTypes Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Read = 0 ReadWrite = 1"
  },
  "api/Stride.Physics.HeightfieldColliderShape.HeightArrayLock.html": {
    "href": "api/Stride.Physics.HeightfieldColliderShape.HeightArrayLock.html",
    "title": "Class HeightfieldColliderShape.HeightArrayLock | Stride API",
    "summary": "Class HeightfieldColliderShape.HeightArrayLock Namespace Stride.Physics Assembly Stride.Physics.dll public class HeightfieldColliderShape.HeightArrayLock : IDisposable Inheritance object HeightfieldColliderShape.HeightArrayLock Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Unlock() public void Unlock()"
  },
  "api/Stride.Physics.HeightfieldColliderShape.HeightfieldDebugPrimitive.Tile.html": {
    "href": "api/Stride.Physics.HeightfieldColliderShape.HeightfieldDebugPrimitive.Tile.html",
    "title": "Class HeightfieldColliderShape.HeightfieldDebugPrimitive.Tile | Stride API",
    "summary": "Class HeightfieldColliderShape.HeightfieldDebugPrimitive.Tile Namespace Stride.Physics Assembly Stride.Physics.dll public class HeightfieldColliderShape.HeightfieldDebugPrimitive.Tile Inheritance object HeightfieldColliderShape.HeightfieldDebugPrimitive.Tile Extension Methods UnsafeUtilities.As<T>(object?) Fields Height public int Height Field Value int MeshDraw public MeshDraw MeshDraw Field Value MeshDraw Point public Point Point Field Value Point Vertices public VertexPositionNormalColor[] Vertices Field Value VertexPositionNormalColor[] Width public int Width Field Value int"
  },
  "api/Stride.Physics.HeightfieldColliderShape.HeightfieldDebugPrimitive.html": {
    "href": "api/Stride.Physics.HeightfieldColliderShape.HeightfieldDebugPrimitive.html",
    "title": "Class HeightfieldColliderShape.HeightfieldDebugPrimitive | Stride API",
    "summary": "Class HeightfieldColliderShape.HeightfieldDebugPrimitive Namespace Stride.Physics Assembly Stride.Physics.dll public class HeightfieldColliderShape.HeightfieldDebugPrimitive : IDebugPrimitive Inheritance object HeightfieldColliderShape.HeightfieldDebugPrimitive Implements IDebugPrimitive Extension Methods UnsafeUtilities.As<T>(object?) Fields Tiles public readonly List<HeightfieldColliderShape.HeightfieldDebugPrimitive.Tile> Tiles Field Value List<HeightfieldColliderShape.HeightfieldDebugPrimitive.Tile> Methods GetMeshDraws() public IEnumerable<MeshDraw> GetMeshDraws() Returns IEnumerable<MeshDraw> New(GraphicsDevice, HeightfieldColliderShape) public static HeightfieldColliderShape.HeightfieldDebugPrimitive New(GraphicsDevice device, HeightfieldColliderShape heightfieldColliderShape) Parameters device GraphicsDevice heightfieldColliderShape HeightfieldColliderShape Returns HeightfieldColliderShape.HeightfieldDebugPrimitive Update(CommandList) public void Update(CommandList commandList) Parameters commandList CommandList"
  },
  "api/Stride.Physics.HeightfieldColliderShape.html": {
    "href": "api/Stride.Physics.HeightfieldColliderShape.html",
    "title": "Class HeightfieldColliderShape | Stride API",
    "summary": "Class HeightfieldColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class HeightfieldColliderShape : ColliderShape, IDisposable Inheritance object ColliderShape HeightfieldColliderShape Implements IDisposable Inherited Members ColliderShape.DebugScaling ColliderShape.Type ColliderShape.LocalOffset ColliderShape.LocalRotation ColliderShape.UpdateLocalTransformations() ColliderShape.PositiveCenterMatrix ColliderShape.NegativeCenterMatrix ColliderShape.cachedScaling ColliderShape.Scaling ColliderShape.Is2D ColliderShape.Description ColliderShape.CreateDebugPrimitive(GraphicsDevice) ColliderShape.Margin ColliderShape.DebugPrimitiveMatrix Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors HeightfieldColliderShape(int, int, UnmanagedArray<byte>, float, float, float, bool) public HeightfieldColliderShape(int heightStickWidth, int heightStickLength, UnmanagedArray<byte> dynamicFieldData, float heightScale, float minHeight, float maxHeight, bool flipQuadEdges) Parameters heightStickWidth int heightStickLength int dynamicFieldData UnmanagedArray<byte> heightScale float minHeight float maxHeight float flipQuadEdges bool HeightfieldColliderShape(int, int, UnmanagedArray<short>, float, float, float, bool) public HeightfieldColliderShape(int heightStickWidth, int heightStickLength, UnmanagedArray<short> dynamicFieldData, float heightScale, float minHeight, float maxHeight, bool flipQuadEdges) Parameters heightStickWidth int heightStickLength int dynamicFieldData UnmanagedArray<short> heightScale float minHeight float maxHeight float flipQuadEdges bool HeightfieldColliderShape(int, int, UnmanagedArray<float>, float, float, float, bool) public HeightfieldColliderShape(int heightStickWidth, int heightStickLength, UnmanagedArray<float> dynamicFieldData, float heightScale, float minHeight, float maxHeight, bool flipQuadEdges) Parameters heightStickWidth int heightStickLength int dynamicFieldData UnmanagedArray<float> heightScale float minHeight float maxHeight float flipQuadEdges bool Fields MinimumHeightStickLength public static readonly int MinimumHeightStickLength Field Value int MinimumHeightStickWidth public static readonly int MinimumHeightStickWidth Field Value int Properties ByteArray public UnmanagedArray<byte> ByteArray { get; } Property Value UnmanagedArray<byte> FloatArray public UnmanagedArray<float> FloatArray { get; } Property Value UnmanagedArray<float> HeightScale public float HeightScale { get; } Property Value float HeightStickLength public int HeightStickLength { get; } Property Value int HeightStickWidth public int HeightStickWidth { get; } Property Value int HeightType public HeightfieldTypes HeightType { get; } Property Value HeightfieldTypes MaxHeight public float MaxHeight { get; } Property Value float MinHeight public float MinHeight { get; } Property Value float ShortArray public UnmanagedArray<short> ShortArray { get; } Property Value UnmanagedArray<short> UseDiamondSubdivision public bool UseDiamondSubdivision { set; } Property Value bool UseZigzagSubdivision public bool UseZigzagSubdivision { set; } Property Value bool Methods CreateUpdatableDebugPrimitive(GraphicsDevice) public override IDebugPrimitive CreateUpdatableDebugPrimitive(GraphicsDevice graphicsDevice) Parameters graphicsDevice GraphicsDevice Returns IDebugPrimitive Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public override void Dispose() ~HeightfieldColliderShape() protected ~HeightfieldColliderShape() LockToReadAndWriteHeights() public HeightfieldColliderShape.HeightArrayLock LockToReadAndWriteHeights() Returns HeightfieldColliderShape.HeightArrayLock LockToReadHeights() public HeightfieldColliderShape.HeightArrayLock LockToReadHeights() Returns HeightfieldColliderShape.HeightArrayLock UpdateDebugPrimitive(CommandList, IDebugPrimitive) public override void UpdateDebugPrimitive(CommandList commandList, IDebugPrimitive debugPrimitive) Parameters commandList CommandList debugPrimitive IDebugPrimitive"
  },
  "api/Stride.Physics.HeightfieldColliderShapeDesc.html": {
    "href": "api/Stride.Physics.HeightfieldColliderShapeDesc.html",
    "title": "Class HeightfieldColliderShapeDesc | Stride API",
    "summary": "Class HeightfieldColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<HeightfieldColliderShapeDesc>))] [DataContract(\"HeightfieldColliderShapeDesc\")] [Display(300, \"Heightfield\", null)] public class HeightfieldColliderShapeDesc : IInlineColliderShapeDesc, IAssetColliderShapeDesc, IColliderShapeDesc Inheritance object HeightfieldColliderShapeDesc Implements IInlineColliderShapeDesc IAssetColliderShapeDesc IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Fields FlipQuadEdges [DataMember(70)] public bool FlipQuadEdges Field Value bool LocalOffset [DataMember(100)] public Vector3 LocalOffset Field Value Vector3 LocalRotation [DataMember(110)] public Quaternion LocalRotation Field Value Quaternion Properties Centering Add a value to local offset in order to center specific height. [DataMember(80)] public HeightfieldCenteringParameters Centering { get; set; } Property Value HeightfieldCenteringParameters Remarks NOTE: The center height is the middle point of the range, if this is disabled with asymmetrical range. HeightStickArraySource The source to initialize the height stick array. [DataMember(10)] [Display(\"Source\", null, Expand = ExpandRule.Always)] public IHeightStickArraySource HeightStickArraySource { get; set; } Property Value IHeightStickArraySource Methods CreateShape(IServiceRegistry) public ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape GetCenteringOffset() Get the centering offset that will be added to the local offset of the collider shape. public float GetCenteringOffset() Returns float The value that will be added to the local offset of the collider shape in order to center specific height. GetCenteringOffset(Vector2, float) Get the offset required in order to center specific height. public static float GetCenteringOffset(Vector2 heightRange, float centerHeight) Parameters heightRange Vector2 The range of the height. centerHeight float The height to be centered. Returns float The value in y axis required in order to center specific height. Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.HeightfieldTypes.html": {
    "href": "api/Stride.Physics.HeightfieldTypes.html",
    "title": "Enum HeightfieldTypes | Stride API",
    "summary": "Enum HeightfieldTypes Namespace Stride.Physics Assembly Stride.Physics.dll public enum HeightfieldTypes Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Byte = 1 Float = 4 Short = 2"
  },
  "api/Stride.Physics.Heightmap.html": {
    "href": "api/Stride.Physics.Heightmap.html",
    "title": "Class Heightmap | Stride API",
    "summary": "Class Heightmap Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract] [ContentSerializer(typeof(DataContentSerializer<Heightmap>))] [DataSerializerGlobal(typeof(CloneSerializer<Heightmap>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(ReferenceSerializer<Heightmap>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public class Heightmap Inheritance object Heightmap Extension Methods HeightmapExtensions.CreateTexture(Heightmap, GraphicsDevice) HeightmapExtensions.IsValid(Heightmap) UnsafeUtilities.As<T>(object?) Fields Bytes Byte height array. [DataMember(30)] [Display(null, null, Browsable = false)] public byte[] Bytes Field Value byte[] Floats Float height array. [DataMember(10)] [Display(null, null, Browsable = false)] public float[] Floats Field Value float[] HeightRange The range of the height. [DataMember(60)] public Vector2 HeightRange Field Value Vector2 Remarks X is min height and Y is max height. (height * HeightScale) should be in this range. Positive and negative heights can not be handle at the same time when the height type is Byte. HeightScale Used to calculate the height when the height type is Short or Byte. HeightScale should be 1 when the height type is Float. [DataMember(70)] public float HeightScale Field Value float HeightType The type of the height. [DataMember(40)] [Display(null, null, Browsable = false)] public HeightfieldTypes HeightType Field Value HeightfieldTypes Shorts Short height array. [DataMember(20)] [Display(null, null, Browsable = false)] public short[] Shorts Field Value short[] Size The size of the heightmap. [DataMember(50)] public Int2 Size Field Value Int2 Remarks X is width and Y is length. They should be greater than or equal to 2. For example, this size should be 65 * 65 when you want 64 * 64 size in a scene. Methods Create<T>(Int2, HeightfieldTypes, Vector2, float, T[]) public static Heightmap Create<T>(Int2 size, HeightfieldTypes heightType, Vector2 heightRange, float heightScale, T[] data) Parameters size Int2 heightType HeightfieldTypes heightRange Vector2 heightScale float data T[] Returns Heightmap Type Parameters T"
  },
  "api/Stride.Physics.HeightmapExtensions.html": {
    "href": "api/Stride.Physics.HeightmapExtensions.html",
    "title": "Class HeightmapExtensions | Stride API",
    "summary": "Class HeightmapExtensions Namespace Stride.Physics Assembly Stride.Physics.dll public static class HeightmapExtensions Inheritance object HeightmapExtensions Methods CreateTexture(Heightmap, GraphicsDevice) public static Texture CreateTexture(this Heightmap heightmap, GraphicsDevice device) Parameters heightmap Heightmap device GraphicsDevice Returns Texture IsValid(Heightmap) public static bool IsValid(this Heightmap heightmap) Parameters heightmap Heightmap Returns bool"
  },
  "api/Stride.Physics.HeightmapUtils.html": {
    "href": "api/Stride.Physics.HeightmapUtils.html",
    "title": "Class HeightmapUtils | Stride API",
    "summary": "Class HeightmapUtils Namespace Stride.Physics Assembly Stride.Physics.dll public class HeightmapUtils Inheritance object HeightmapUtils Extension Methods UnsafeUtilities.As<T>(object?) Methods CheckHeightParameters(Int2, HeightfieldTypes, Vector2, float, bool) public static bool CheckHeightParameters(Int2 size, HeightfieldTypes heightType, Vector2 heightRange, float heightScale, bool throwExceptionWhenInvalid) Parameters size Int2 heightType HeightfieldTypes heightRange Vector2 heightScale float throwExceptionWhenInvalid bool Returns bool ConvertToByteHeight(float, float, float) public static byte ConvertToByteHeight(float minValue, float maxValue, float value) Parameters minValue float maxValue float value float Returns byte ConvertToByteHeights(short[], short, short) public static byte[] ConvertToByteHeights(short[] values, short minValue = -32768, short maxValue = 32767) Parameters values short[] minValue short maxValue short Returns byte[] ConvertToByteHeights(float[], float, float) public static byte[] ConvertToByteHeights(float[] values, float minValue, float maxValue) Parameters values float[] minValue float maxValue float Returns byte[] ConvertToFloatHeight(float, float, float) public static float ConvertToFloatHeight(float minValue, float maxValue, float value) Parameters minValue float maxValue float value float Returns float ConvertToFloatHeights(byte[], byte, byte) public static float[] ConvertToFloatHeights(byte[] values, byte minValue = 0, byte maxValue = 255) Parameters values byte[] minValue byte maxValue byte Returns float[] ConvertToFloatHeights(short[], short, short) public static float[] ConvertToFloatHeights(short[] values, short minValue = -32768, short maxValue = 32767) Parameters values short[] minValue short maxValue short Returns float[] ConvertToFloatHeights(float[], float, float) public static float[] ConvertToFloatHeights(float[] values, float minValue, float maxValue) Parameters values float[] minValue float maxValue float Returns float[] ConvertToShortHeight(float, float, float) public static short ConvertToShortHeight(float minValue, float maxValue, float value) Parameters minValue float maxValue float value float Returns short ConvertToShortHeights(byte[], byte, byte) public static short[] ConvertToShortHeights(byte[] values, byte minValue = 0, byte maxValue = 255) Parameters values byte[] minValue byte maxValue byte Returns short[] ConvertToShortHeights(short[], short, short) public static short[] ConvertToShortHeights(short[] values, short minValue = -32768, short maxValue = 32767) Parameters values short[] minValue short maxValue short Returns short[] ConvertToShortHeights(float[], float, float) public static short[] ConvertToShortHeights(float[] values, float minValue, float maxValue) Parameters values float[] minValue float maxValue float Returns short[] Resize<T>(T[], Int2, Int2) public static T[] Resize<T>(T[] pixels, Int2 originalSize, Int2 newSize) Parameters pixels T[] originalSize Int2 newSize Int2 Returns T[] Type Parameters T"
  },
  "api/Stride.Physics.HingeConstraint.html": {
    "href": "api/Stride.Physics.HingeConstraint.html",
    "title": "Class HingeConstraint | Stride API",
    "summary": "Class HingeConstraint Namespace Stride.Physics Assembly Stride.Physics.dll public class HingeConstraint : Constraint, IDisposable, IRelative Inheritance object Constraint HingeConstraint Implements IDisposable IRelative Inherited Members Constraint.Dispose() Constraint.RigidBodyA Constraint.RigidBodyB Constraint.Enabled Constraint.BreakingImpulseThreshold Constraint.AppliedImpulse Constraint.Simulation Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties AngularOnly Gets or sets a value indicating whether [angular only]. public bool AngularOnly { get; set; } Property Value bool true if [angular only]; otherwise, false. HingeAngle Gets the hinge angle. public float HingeAngle { get; } Property Value float The hinge angle. LimitSign Gets the limit sign. public float LimitSign { get; } Property Value float The limit sign. LowerLimit Gets the lower limit. public float LowerLimit { get; } Property Value float The lower limit. MaxMotorImpulse Gets or sets the maximum motor impulse. public float MaxMotorImpulse { get; set; } Property Value float The maximum motor impulse. MotorTargetVelocity Gets the motor target velocity. public float MotorTargetVelocity { get; } Property Value float The motor target velocity. SolveLimit Gets the solve limit. public int SolveLimit { get; } Property Value int The solve limit. UpperLimit Gets the upper limit. public float UpperLimit { get; } Property Value float The upper limit. Methods EnableAngularMotor(bool, float, float) Enables the angular motor. public void EnableAngularMotor(bool enableMotor, float targetVelocity, float maxMotorImpulse) Parameters enableMotor bool if set to true [enable motor]. targetVelocity float The target velocity. maxMotorImpulse float The maximum motor impulse. EnableMotor(bool) Enables the motor. public void EnableMotor(bool enableMotor) Parameters enableMotor bool if set to true [enable motor]. SetAxis(Vector3) Sets the hinge axis for body A (this works mostly for body-world constraints). public void SetAxis(Vector3 axisInA) Parameters axisInA Vector3 The hinge axis. SetFrames(Matrix, Matrix) Sets the frames. public void SetFrames(Matrix frameA, Matrix frameB) Parameters frameA Matrix The frame a. frameB Matrix The frame b. SetLimit(float, float) Sets the limit. public void SetLimit(float low, float high) Parameters low float The low. high float The high. SetLimit(float, float, float) Sets the limit. public void SetLimit(float low, float high, float softness) Parameters low float The low. high float The high. softness float The softness. SetLimit(float, float, float, float) Sets the limit. public void SetLimit(float low, float high, float softness, float biasFactor) Parameters low float The low. high float The high. softness float The softness. biasFactor float The bias factor. SetLimit(float, float, float, float, float) Sets the limit. public void SetLimit(float low, float high, float softness, float biasFactor, float relaxationFactor) Parameters low float The low. high float The high. softness float The softness. biasFactor float The bias factor. relaxationFactor float The relaxation factor. SetMotorTarget(Quaternion, float) Sets the motor target. public void SetMotorTarget(Quaternion qAinB, float dt) Parameters qAinB Quaternion The q ain b. dt float The dt. SetMotorTarget(float, float) Sets the motor target. public void SetMotorTarget(float targetAngle, float dt) Parameters targetAngle float The target angle. dt float The dt."
  },
  "api/Stride.Physics.HitResult.html": {
    "href": "api/Stride.Physics.HitResult.html",
    "title": "Struct HitResult | Stride API",
    "summary": "Struct HitResult Namespace Stride.Physics Assembly Stride.Physics.dll The result of a Physics Raycast or ShapeSweep operation public struct HitResult Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Collider The Collider hit if Succeeded public PhysicsComponent Collider Field Value PhysicsComponent HitFraction public float HitFraction Field Value float Normal public Vector3 Normal Field Value Vector3 Point public Vector3 Point Field Value Vector3 Succeeded public bool Succeeded Field Value bool"
  },
  "api/Stride.Physics.IAssetColliderShapeDesc.html": {
    "href": "api/Stride.Physics.IAssetColliderShapeDesc.html",
    "title": "Interface IAssetColliderShapeDesc | Stride API",
    "summary": "Interface IAssetColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll public interface IAssetColliderShapeDesc : IColliderShapeDesc Inherited Members IColliderShapeDesc.Match(object) IColliderShapeDesc.CreateShape(IServiceRegistry) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Physics.IColliderShapeDesc.html": {
    "href": "api/Stride.Physics.IColliderShapeDesc.html",
    "title": "Interface IColliderShapeDesc | Stride API",
    "summary": "Interface IColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll public interface IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Methods CreateShape(IServiceRegistry) ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape Match(object) bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.IConstraintDesc.html": {
    "href": "api/Stride.Physics.IConstraintDesc.html",
    "title": "Interface IConstraintDesc | Stride API",
    "summary": "Interface IConstraintDesc Namespace Stride.Physics Assembly Stride.Physics.dll Description of a Constraint. public interface IConstraintDesc Extension Methods UnsafeUtilities.As<T>(object?) Properties PivotInA Position local to rigidbody A. Vector3 PivotInA { get; } Property Value Vector3 PivotInB Position local to rigidbody B. Vector3 PivotInB { get; } Property Value Vector3 Remarks Ignored when creating a body-world constraint. Type Type of the constraint description. ConstraintTypes Type { get; } Property Value ConstraintTypes Methods Build(RigidbodyComponent, RigidbodyComponent) Create a new constraint according to the description properties between bodies A and B, or between A and World. Constraint Build(RigidbodyComponent rigidbodyA, RigidbodyComponent rigidbodyB) Parameters rigidbodyA RigidbodyComponent Rigidbody A. rigidbodyB RigidbodyComponent Rigidbody B (may be null). Returns Constraint A new constraint constructed in the Simulation. Needs to be added with AddConstraint(Constraint) to take effect."
  },
  "api/Stride.Physics.IDebugPrimitive.html": {
    "href": "api/Stride.Physics.IDebugPrimitive.html",
    "title": "Interface IDebugPrimitive | Stride API",
    "summary": "Interface IDebugPrimitive Namespace Stride.Physics Assembly Stride.Physics.dll public interface IDebugPrimitive Extension Methods UnsafeUtilities.As<T>(object?) Methods GetMeshDraws() IEnumerable<MeshDraw> GetMeshDraws() Returns IEnumerable<MeshDraw>"
  },
  "api/Stride.Physics.IHeightScaleCalculator.html": {
    "href": "api/Stride.Physics.IHeightScaleCalculator.html",
    "title": "Interface IHeightScaleCalculator | Stride API",
    "summary": "Interface IHeightScaleCalculator Namespace Stride.Physics Assembly Stride.Physics.dll public interface IHeightScaleCalculator Extension Methods UnsafeUtilities.As<T>(object?) Methods Calculate(IHeightStickParameters) float Calculate(IHeightStickParameters heightDescription) Parameters heightDescription IHeightStickParameters Returns float"
  },
  "api/Stride.Physics.IHeightStickArraySource.html": {
    "href": "api/Stride.Physics.IHeightStickArraySource.html",
    "title": "Interface IHeightStickArraySource | Stride API",
    "summary": "Interface IHeightStickArraySource Namespace Stride.Physics Assembly Stride.Physics.dll public interface IHeightStickArraySource : IHeightStickParameters Inherited Members IHeightStickParameters.HeightType IHeightStickParameters.HeightRange IHeightStickParameters.HeightScale Extension Methods UnsafeUtilities.As<T>(object?) Properties HeightStickSize The size of the source. Int2 HeightStickSize { get; } Property Value Int2 Remarks X is width and Y is length. They should be greater than or equal to 2. For example, this size should be 65 * 65 when you want 64 * 64 size in a scene. Methods CopyTo<T>(UnmanagedArray<T>, int) Copy the source data to the height stick array. void CopyTo<T>(UnmanagedArray<T> heightStickArray, int index) where T : struct Parameters heightStickArray UnmanagedArray<T> The destination to copy the data. index int The start index of the destination to copy the data. Type Parameters T The data type of the height IsValid() bool IsValid() Returns bool Match(object) bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.IHeightStickParameters.html": {
    "href": "api/Stride.Physics.IHeightStickParameters.html",
    "title": "Interface IHeightStickParameters | Stride API",
    "summary": "Interface IHeightStickParameters Namespace Stride.Physics Assembly Stride.Physics.dll public interface IHeightStickParameters Extension Methods UnsafeUtilities.As<T>(object?) Properties HeightRange The range of the height. Vector2 HeightRange { get; } Property Value Vector2 Remarks X is min height and Y is max height. (height * HeightScale) should be in this range. Positive and negative heights can not be handle at the same time when the height type is Byte. HeightScale Used to calculate the height when the height type is Short or Byte. HeightScale should be 1 when the height type is Float. float HeightScale { get; } Property Value float HeightType The type of the height. HeightfieldTypes HeightType { get; } Property Value HeightfieldTypes"
  },
  "api/Stride.Physics.IInlineColliderShapeDesc.html": {
    "href": "api/Stride.Physics.IInlineColliderShapeDesc.html",
    "title": "Interface IInlineColliderShapeDesc | Stride API",
    "summary": "Interface IInlineColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll public interface IInlineColliderShapeDesc : IAssetColliderShapeDesc, IColliderShapeDesc Inherited Members IColliderShapeDesc.Match(object) IColliderShapeDesc.CreateShape(IServiceRegistry) Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Physics.IPhysicsSystem.html": {
    "href": "api/Stride.Physics.IPhysicsSystem.html",
    "title": "Interface IPhysicsSystem | Stride API",
    "summary": "Interface IPhysicsSystem Namespace Stride.Physics Assembly Stride.Physics.dll public interface IPhysicsSystem : IGameSystemBase, IComponent, IReferencable Inherited Members IGameSystemBase.Initialize() IComponent.Name IReferencable.ReferenceCount IReferencable.AddReference() IReferencable.Release() Extension Methods UnsafeUtilities.As<T>(object?) Methods Create(PhysicsProcessor, PhysicsEngineFlags) Simulation Create(PhysicsProcessor processor, PhysicsEngineFlags flags = PhysicsEngineFlags.None) Parameters processor PhysicsProcessor flags PhysicsEngineFlags Returns Simulation Release(PhysicsProcessor) void Release(PhysicsProcessor processor) Parameters processor PhysicsProcessor"
  },
  "api/Stride.Physics.IRelative.html": {
    "href": "api/Stride.Physics.IRelative.html",
    "title": "Interface IRelative | Stride API",
    "summary": "Interface IRelative Namespace Stride.Physics Assembly Stride.Physics.dll public interface IRelative Extension Methods UnsafeUtilities.As<T>(object?) Properties Simulation Simulation Simulation { get; } Property Value Simulation"
  },
  "api/Stride.Physics.PhysicsColliderShape.html": {
    "href": "api/Stride.Physics.PhysicsColliderShape.html",
    "title": "Class PhysicsColliderShape | Stride API",
    "summary": "Class PhysicsColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract] [ContentSerializer(typeof(DataContentSerializer<PhysicsColliderShape>))] [DataSerializerGlobal(typeof(CloneSerializer<PhysicsColliderShape>), null, DataSerializerGenericMode.None, false, false, Profile = \"Clone\")] [DataSerializerGlobal(typeof(ReferenceSerializer<PhysicsColliderShape>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] public class PhysicsColliderShape : IDisposable Inheritance object PhysicsColliderShape Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors PhysicsColliderShape() public PhysicsColliderShape() PhysicsColliderShape(IEnumerable<IAssetColliderShapeDesc>) public PhysicsColliderShape(IEnumerable<IAssetColliderShapeDesc> descriptions) Parameters descriptions IEnumerable<IAssetColliderShapeDesc> Properties Descriptions Used to serialize one or more collider shapes into one single shape Reading this value will automatically parse the Shape property into its description Writing this value will automatically compose, create and populate the Shape property [DataMember] public List<IAssetColliderShapeDesc> Descriptions { get; } Property Value List<IAssetColliderShapeDesc> Shape public ColliderShape Shape { get; } Property Value ColliderShape Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() New(params IAssetColliderShapeDesc[]) public static PhysicsColliderShape New(params IAssetColliderShapeDesc[] descriptions) Parameters descriptions IAssetColliderShapeDesc[] Returns PhysicsColliderShape"
  },
  "api/Stride.Physics.PhysicsConstraintComponent.html": {
    "href": "api/Stride.Physics.PhysicsConstraintComponent.html",
    "title": "Class PhysicsConstraintComponent | Stride API",
    "summary": "Class PhysicsConstraintComponent Namespace Stride.Physics Assembly Stride.Physics.dll A component descrbing a physical constraint between two rigidbodies or a rigidbody and world. [DataContract(\"PhysicsConstraintComponent\")] [Display(\"Physics Constraint\", null)] [DefaultEntityComponentProcessor(typeof(PhysicsConstraintProcessor), ExecutionMode = ExecutionMode.Runtime)] [ComponentOrder(3010)] [ComponentCategory(\"Physics\")] public class PhysicsConstraintComponent : ActivableEntityComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent PhysicsConstraintComponent Implements IIdentifiable Inherited Members ActivableEntityComponent.Enabled EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties BodyA (Required) Rigidbody A used for body-body and body-world constraints. public RigidbodyComponent BodyA { get; set; } Property Value RigidbodyComponent BodyB (Optional) Rigidbody B used for body-body constraints. public RigidbodyComponent BodyB { get; set; } Property Value RigidbodyComponent Constraint Constructed constraint object. public Constraint Constraint { get; } Property Value Constraint Description Description of the constraint to create. public IConstraintDesc Description { get; set; } Property Value IConstraintDesc DisableCollisionsBetweenBodies When true, body A and body B will not collide with each other. public bool DisableCollisionsBetweenBodies { get; set; } Property Value bool Simulation Simulation to which this constraint was added. public Simulation Simulation { get; } Property Value Simulation Methods RecreateConstraint() Removes the currently used Constraint and recreates it. public void RecreateConstraint() Remarks Needs to be called after modifying any of the properties. Events OnDetach Invoked when a constraint is broken because one of the rigidbodies involved in the constraint is removed from the scene. public event Action<PhysicsConstraintComponent> OnDetach Event Type Action<PhysicsConstraintComponent>"
  },
  "api/Stride.Physics.PhysicsDebugShapeMaterial.html": {
    "href": "api/Stride.Physics.PhysicsDebugShapeMaterial.html",
    "title": "Class PhysicsDebugShapeMaterial | Stride API",
    "summary": "Class PhysicsDebugShapeMaterial Namespace Stride.Physics Assembly Stride.Physics.dll public static class PhysicsDebugShapeMaterial Inheritance object PhysicsDebugShapeMaterial Methods CreateDefault(GraphicsDevice, Color, float) public static Material CreateDefault(GraphicsDevice device, Color color, float intensity) Parameters device GraphicsDevice color Color intensity float Returns Material CreateHeightfieldMaterial(GraphicsDevice, Color, float) public static Material CreateHeightfieldMaterial(GraphicsDevice device, Color color, float intensity) Parameters device GraphicsDevice color Color intensity float Returns Material"
  },
  "api/Stride.Physics.PhysicsEngineFlags.html": {
    "href": "api/Stride.Physics.PhysicsEngineFlags.html",
    "title": "Enum PhysicsEngineFlags | Stride API",
    "summary": "Enum PhysicsEngineFlags Namespace Stride.Physics Assembly Stride.Physics.dll [Flags] public enum PhysicsEngineFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields CollisionsOnly = 1 [DataAlias(\"ContinuosCollisionDetection\")] ContinuousCollisionDetection = 16 MultiThreaded = 4 None = 0 SoftBodySupport = 2 UseHardwareWhenPossible = 8"
  },
  "api/Stride.Physics.PhysicsProcessor.AssociatedData.html": {
    "href": "api/Stride.Physics.PhysicsProcessor.AssociatedData.html",
    "title": "Class PhysicsProcessor.AssociatedData | Stride API",
    "summary": "Class PhysicsProcessor.AssociatedData Namespace Stride.Physics Assembly Stride.Physics.dll public class PhysicsProcessor.AssociatedData Inheritance object PhysicsProcessor.AssociatedData Extension Methods UnsafeUtilities.As<T>(object?) Fields BoneMatricesUpdated public bool BoneMatricesUpdated Field Value bool ModelComponent public ModelComponent ModelComponent Field Value ModelComponent PhysicsComponent public PhysicsComponent PhysicsComponent Field Value PhysicsComponent TransformComponent public TransformComponent TransformComponent Field Value TransformComponent"
  },
  "api/Stride.Physics.PhysicsProcessor.html": {
    "href": "api/Stride.Physics.PhysicsProcessor.html",
    "title": "Class PhysicsProcessor | Stride API",
    "summary": "Class PhysicsProcessor Namespace Stride.Physics Assembly Stride.Physics.dll public class PhysicsProcessor : EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData> Inheritance object EntityProcessor EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData> PhysicsProcessor Inherited Members EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData>.ComponentDatas EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData>.OnSystemAdd() EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData>.OnSystemRemove() EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData>.RemoveAllEntities() EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData>.GenerateComponentData(Entity, PhysicsComponent) EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData>.IsAssociatedDataValid(Entity, PhysicsComponent, PhysicsProcessor.AssociatedData) EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData>.OnEntityComponentAdding(Entity, PhysicsComponent, PhysicsProcessor.AssociatedData) EntityProcessor<PhysicsComponent, PhysicsProcessor.AssociatedData>.OnEntityComponentRemoved(Entity, PhysicsComponent, PhysicsProcessor.AssociatedData) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Constructors PhysicsProcessor() public PhysicsProcessor() Properties ParentScene Gets or sets the associated parent scene to render the physics debug shapes. Assigned with default one on OnSystemAdd() public Scene ParentScene { get; set; } Property Value Scene The parent scene. Simulation public Simulation Simulation { get; } Property Value Simulation Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext GenerateComponentData(Entity, PhysicsComponent) Generates associated data to the given entity. protected override PhysicsProcessor.AssociatedData GenerateComponentData(Entity entity, PhysicsComponent component) Parameters entity Entity The entity. component PhysicsComponent Returns PhysicsProcessor.AssociatedData The associated data. IsAssociatedDataValid(Entity, PhysicsComponent, AssociatedData) Checks if the current associated data is valid, or if readding the entity is required. protected override bool IsAssociatedDataValid(Entity entity, PhysicsComponent physicsComponent, PhysicsProcessor.AssociatedData associatedData) Parameters entity Entity The entity. physicsComponent PhysicsComponent associatedData PhysicsProcessor.AssociatedData The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise. OnEntityComponentAdding(Entity, PhysicsComponent, AssociatedData) Run when a matching entity is added to this entity processor. protected override void OnEntityComponentAdding(Entity entity, PhysicsComponent component, PhysicsProcessor.AssociatedData data) Parameters entity Entity The entity. component PhysicsComponent data PhysicsProcessor.AssociatedData The associated data. OnEntityComponentRemoved(Entity, PhysicsComponent, AssociatedData) Run when a matching entity is removed from this entity processor. protected override void OnEntityComponentRemoved(Entity entity, PhysicsComponent component, PhysicsProcessor.AssociatedData data) Parameters entity Entity The entity. component PhysicsComponent data PhysicsProcessor.AssociatedData The associated data. OnSystemAdd() Run when this EntityProcessor is added to an EntityManager. protected override void OnSystemAdd() OnSystemRemove() Run when this EntityProcessor is removed from an EntityManager. protected override void OnSystemRemove() UpdateRemovals() public void UpdateRemovals()"
  },
  "api/Stride.Physics.PhysicsProfilingKeys.html": {
    "href": "api/Stride.Physics.PhysicsProfilingKeys.html",
    "title": "Class PhysicsProfilingKeys | Stride API",
    "summary": "Class PhysicsProfilingKeys Namespace Stride.Physics Assembly Stride.Physics.dll public static class PhysicsProfilingKeys Inheritance object PhysicsProfilingKeys Fields CharactersProfilingKey public static ProfilingKey CharactersProfilingKey Field Value ProfilingKey ContactsProfilingKey public static ProfilingKey ContactsProfilingKey Field Value ProfilingKey SimulationProfilingKey public static ProfilingKey SimulationProfilingKey Field Value ProfilingKey"
  },
  "api/Stride.Physics.PhysicsScriptComponentExtensions.html": {
    "href": "api/Stride.Physics.PhysicsScriptComponentExtensions.html",
    "title": "Class PhysicsScriptComponentExtensions | Stride API",
    "summary": "Class PhysicsScriptComponentExtensions Namespace Stride.Physics Assembly Stride.Physics.dll Extension methods for the ScriptComponent related to phystics public static class PhysicsScriptComponentExtensions Inheritance object PhysicsScriptComponentExtensions Methods GetSimulation(ScriptComponent) Gets the curent Simulation. public static Simulation GetSimulation(this ScriptComponent scriptComponent) Parameters scriptComponent ScriptComponent The script component to query physics from Returns Simulation The simulation object or null if there are no simulation running for the current scene."
  },
  "api/Stride.Physics.PhysicsSettings.html": {
    "href": "api/Stride.Physics.PhysicsSettings.html",
    "title": "Class PhysicsSettings | Stride API",
    "summary": "Class PhysicsSettings Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract] [Display(\"Physics\", null)] public class PhysicsSettings : Configuration Inheritance object Configuration PhysicsSettings Inherited Members Configuration.OfflineOnly Extension Methods UnsafeUtilities.As<T>(object?) Fields FixedTimeStep [DataMember(30)] public float FixedTimeStep Field Value float Flags [DataMember(10)] public PhysicsEngineFlags Flags Field Value PhysicsEngineFlags Gravity [DataMember(50)] public Vector3 Gravity Field Value Vector3 MaxSubSteps [DataMember(20, DataMemberMode.Never)] [Obsolete(\"Value is ignored, use MaxTickDuration instead\")] public int MaxSubSteps Field Value int MaxTickDuration [DataMember(40)] public float MaxTickDuration Field Value float"
  },
  "api/Stride.Physics.PhysicsSkinnedComponentBase.html": {
    "href": "api/Stride.Physics.PhysicsSkinnedComponentBase.html",
    "title": "Class PhysicsSkinnedComponentBase | Stride API",
    "summary": "Class PhysicsSkinnedComponentBase Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract(\"PhysicsSkinnedComponentBase\")] [Display(\"PhysicsSkinnedComponentBase\", null)] public abstract class PhysicsSkinnedComponentBase : PhysicsTriggerComponentBase, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent PhysicsComponent PhysicsTriggerComponentBase PhysicsSkinnedComponentBase Implements IIdentifiable Derived RigidbodyComponent Inherited Members PhysicsTriggerComponentBase.IsTrigger PhysicsTriggerComponentBase.Enabled PhysicsTriggerComponentBase.OnAttach() PhysicsComponent.logger PhysicsComponent.ColliderShapes PhysicsComponent.CollisionGroup PhysicsComponent.CanCollideWith PhysicsComponent.ProcessCollisions PhysicsComponent.CanSleep PhysicsComponent.IsActive PhysicsComponent.Activate(bool) PhysicsComponent.Restitution PhysicsComponent.Friction PhysicsComponent.RollingFriction PhysicsComponent.CcdMotionThreshold PhysicsComponent.CcdSweptSphereRadius PhysicsComponent.Collisions PhysicsComponent.NewCollision() PhysicsComponent.CollisionEnded() PhysicsComponent.Simulation PhysicsComponent.ColliderShapeChanged PhysicsComponent.colliderShape PhysicsComponent.attachInProgress PhysicsComponent.ColliderShape PhysicsComponent.CanScaleShape PhysicsComponent.PhysicsWorldTransform PhysicsComponent.Tag PhysicsComponent.BoneWorldMatrix PhysicsComponent.BoneWorldMatrixOut PhysicsComponent.BoneIndex PhysicsComponent.Data PhysicsComponent.DebugEntity PhysicsComponent.AddDebugEntity(Scene, RenderGroup, bool) PhysicsComponent.RemoveDebugEntity(Scene) PhysicsComponent.UpdatePhysicsTransformation(bool) PhysicsComponent.ComposeShape() PhysicsComponent.OnDetach() PhysicsComponent.OnUpdateDraw() PhysicsComponent.OnUpdateBones() PhysicsComponent.IgnoreCollisionWith(PhysicsComponent, CollisionState) PhysicsComponent.IsIgnoringCollisionWith(PhysicsComponent) EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties NodeName Gets or sets the link (usually a bone). [DataMember(190)] public string NodeName { get; set; } Property Value string The mesh's linked bone name Methods SetupBoneLink() protected void SetupBoneLink()"
  },
  "api/Stride.Physics.PhysicsTriggerComponentBase.html": {
    "href": "api/Stride.Physics.PhysicsTriggerComponentBase.html",
    "title": "Class PhysicsTriggerComponentBase | Stride API",
    "summary": "Class PhysicsTriggerComponentBase Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract(\"PhysicsTriggerComponentBase\")] [Display(\"PhysicsTriggerComponentBase\", null)] public abstract class PhysicsTriggerComponentBase : PhysicsComponent, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent PhysicsComponent PhysicsTriggerComponentBase Implements IIdentifiable Derived PhysicsSkinnedComponentBase StaticColliderComponent Inherited Members PhysicsComponent.logger PhysicsComponent.ColliderShapes PhysicsComponent.CollisionGroup PhysicsComponent.CanCollideWith PhysicsComponent.ProcessCollisions PhysicsComponent.CanSleep PhysicsComponent.IsActive PhysicsComponent.Activate(bool) PhysicsComponent.Restitution PhysicsComponent.Friction PhysicsComponent.RollingFriction PhysicsComponent.CcdMotionThreshold PhysicsComponent.CcdSweptSphereRadius PhysicsComponent.Collisions PhysicsComponent.NewCollision() PhysicsComponent.CollisionEnded() PhysicsComponent.Simulation PhysicsComponent.ColliderShapeChanged PhysicsComponent.colliderShape PhysicsComponent.attachInProgress PhysicsComponent.ColliderShape PhysicsComponent.CanScaleShape PhysicsComponent.PhysicsWorldTransform PhysicsComponent.Tag PhysicsComponent.BoneWorldMatrix PhysicsComponent.BoneWorldMatrixOut PhysicsComponent.BoneIndex PhysicsComponent.Data PhysicsComponent.DebugEntity PhysicsComponent.AddDebugEntity(Scene, RenderGroup, bool) PhysicsComponent.RemoveDebugEntity(Scene) PhysicsComponent.UpdatePhysicsTransformation(bool) PhysicsComponent.ComposeShape() PhysicsComponent.OnDetach() PhysicsComponent.OnUpdateDraw() PhysicsComponent.OnUpdateBones() PhysicsComponent.IgnoreCollisionWith(PhysicsComponent, CollisionState) PhysicsComponent.IsIgnoringCollisionWith(PhysicsComponent) EntityComponent.Entity EntityComponent.Id EntityComponent.EnsureEntity Extension Methods UnsafeUtilities.As<T>(object?) Properties Enabled Gets or sets if this element is enabled in the physics engine [DataMember(-10)] public override bool Enabled { get; set; } Property Value bool true, false IsTrigger [DataMember(71)] public bool IsTrigger { get; set; } Property Value bool Methods OnAttach() Called whenever an entity with this component is added to scene. protected override void OnAttach()"
  },
  "api/Stride.Physics.Point2PointConstraint.html": {
    "href": "api/Stride.Physics.Point2PointConstraint.html",
    "title": "Class Point2PointConstraint | Stride API",
    "summary": "Class Point2PointConstraint Namespace Stride.Physics Assembly Stride.Physics.dll public class Point2PointConstraint : Constraint, IDisposable, IRelative Inheritance object Constraint Point2PointConstraint Implements IDisposable IRelative Inherited Members Constraint.Dispose() Constraint.RigidBodyA Constraint.RigidBodyB Constraint.Enabled Constraint.BreakingImpulseThreshold Constraint.AppliedImpulse Constraint.Simulation Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties Damping Gets or sets the damping. public float Damping { get; set; } Property Value float The damping. ImpulseClamp Gets or sets the impulse clamp. public float ImpulseClamp { get; set; } Property Value float The impulse clamp. PivotInA Gets or sets the pivot in a. public Vector3 PivotInA { get; set; } Property Value Vector3 The pivot in a. PivotInB Gets or sets the pivot in b. public Vector3 PivotInB { get; set; } Property Value Vector3 The pivot in b. Tau Gets or sets the tau. public float Tau { get; set; } Property Value float The tau."
  },
  "api/Stride.Physics.RigidBodyTypes.html": {
    "href": "api/Stride.Physics.RigidBodyTypes.html",
    "title": "Enum RigidBodyTypes | Stride API",
    "summary": "Enum RigidBodyTypes Namespace Stride.Physics Assembly Stride.Physics.dll public enum RigidBodyTypes Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Dynamic = 1 The Physics engine is the authority for this kind of rigidbody, you should move them using forces and/or impulses, never directly editing the Transformation Kinematic = 2 You can move this kind of rigidbody around and the physics engine will interpolate and perform dynamic interactions with dynamic bodies Notice that there is no dynamic interaction with static and other kinematic bodies Static = 0 They are supposed to never move, they are not automatically updated by the engine. They can be moved tho by an explicit call to UpdateTransformation(), results are not realist for dynamic simulation so use it wisely. If you plan to move the entity it is advised to use Kinematic, which allows the normal dynamic simulation."
  },
  "api/Stride.Physics.RigidbodyComponent.html": {
    "href": "api/Stride.Physics.RigidbodyComponent.html",
    "title": "Class RigidbodyComponent | Stride API",
    "summary": "Class RigidbodyComponent Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract(\"RigidbodyComponent\")] [Display(\"Rigidbody\", null)] public sealed class RigidbodyComponent : PhysicsSkinnedComponentBase, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent PhysicsComponent PhysicsTriggerComponentBase PhysicsSkinnedComponentBase RigidbodyComponent Implements IIdentifiable Inherited Members PhysicsSkinnedComponentBase.NodeName PhysicsTriggerComponentBase.IsTrigger PhysicsTriggerComponentBase.Enabled PhysicsComponent.ColliderShapes PhysicsComponent.CollisionGroup PhysicsComponent.CanCollideWith PhysicsComponent.ProcessCollisions PhysicsComponent.CanSleep PhysicsComponent.IsActive PhysicsComponent.Activate(bool) PhysicsComponent.Restitution PhysicsComponent.Friction PhysicsComponent.RollingFriction PhysicsComponent.CcdMotionThreshold PhysicsComponent.CcdSweptSphereRadius PhysicsComponent.Collisions PhysicsComponent.NewCollision() PhysicsComponent.CollisionEnded() PhysicsComponent.Simulation PhysicsComponent.ColliderShapeChanged PhysicsComponent.CanScaleShape PhysicsComponent.PhysicsWorldTransform PhysicsComponent.Tag PhysicsComponent.BoneWorldMatrix PhysicsComponent.BoneWorldMatrixOut PhysicsComponent.BoneIndex PhysicsComponent.DebugEntity PhysicsComponent.AddDebugEntity(Scene, RenderGroup, bool) PhysicsComponent.RemoveDebugEntity(Scene) PhysicsComponent.UpdatePhysicsTransformation(bool) PhysicsComponent.ComposeShape() PhysicsComponent.IgnoreCollisionWith(PhysicsComponent, CollisionState) PhysicsComponent.IsIgnoringCollisionWith(PhysicsComponent) EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Constructors RigidbodyComponent() public RigidbodyComponent() Properties AngularDamping Gets or sets the angular damping of this rigidbody [DataMember(90)] public float AngularDamping { get; set; } Property Value float true, false AngularFactor Gets or sets the angular factor. public Vector3 AngularFactor { get; set; } Property Value Vector3 The angular factor. AngularVelocity Gets or sets the angular velocity. public Vector3 AngularVelocity { get; set; } Property Value Vector3 The angular velocity. ColliderShape Gets the collider shape. public override ColliderShape ColliderShape { get; set; } Property Value ColliderShape The collider shape Gravity Gets or sets the gravity acceleration applied to this RigidBody [DataMember(100)] public Vector3 Gravity { get; set; } Property Value Vector3 A vector representing moment and direction IsKinematic Gets or sets the kinematic property [DataMember(75)] public bool IsKinematic { get; set; } Property Value bool true, false LinearDamping Gets or sets the linear damping of this rigidbody [DataMember(85)] public float LinearDamping { get; set; } Property Value float true, false LinearFactor Gets or sets the linear factor. public Vector3 LinearFactor { get; set; } Property Value Vector3 The linear factor. LinearVelocity Gets or sets the linear velocity. public Vector3 LinearVelocity { get; set; } Property Value Vector3 The linear velocity. LinkedConstraints Gets the linked constraints. public List<Constraint> LinkedConstraints { get; } Property Value List<Constraint> The linked constraints. Mass Gets or sets the mass of this Rigidbody [DataMember(80)] [DataMemberRange(0, 6)] public float Mass { get; set; } Property Value float true, false OverrideGravity Gets or sets if this Rigidbody overrides world gravity [DataMember(95)] public bool OverrideGravity { get; set; } Property Value bool true, false RigidBodyType Gets or sets the type. public RigidBodyTypes RigidBodyType { get; set; } Property Value RigidBodyTypes The type. TotalForce Gets the total force. public Vector3 TotalForce { get; } Property Value Vector3 The total force. TotalTorque Gets the total torque. public Vector3 TotalTorque { get; } Property Value Vector3 The total torque. Methods ApplyForce(Vector3) Applies the force. public void ApplyForce(Vector3 force) Parameters force Vector3 The force. ApplyForce(Vector3, Vector3) Applies the force. public void ApplyForce(Vector3 force, Vector3 localOffset) Parameters force Vector3 The force. localOffset Vector3 The local offset. ApplyImpulse(Vector3) Applies the impulse. public void ApplyImpulse(Vector3 impulse) Parameters impulse Vector3 The impulse. ApplyImpulse(Vector3, Vector3) Applies the impulse. public void ApplyImpulse(Vector3 impulse, Vector3 localOffset) Parameters impulse Vector3 The impulse. localOffset Vector3 The local offset. ApplyTorque(Vector3) Applies the torque. public void ApplyTorque(Vector3 torque) Parameters torque Vector3 The torque. ApplyTorqueImpulse(Vector3) Applies the torque impulse. public void ApplyTorqueImpulse(Vector3 torque) Parameters torque Vector3 The torque. ClearForces() Clears all forces being applied to this rigidbody public void ClearForces() OnAttach() Called whenever an entity with this component is added to scene. protected override void OnAttach() OnDetach() protected override void OnDetach() OnUpdateDraw() protected override void OnUpdateDraw()"
  },
  "api/Stride.Physics.RotationalLimitMotor.html": {
    "href": "api/Stride.Physics.RotationalLimitMotor.html",
    "title": "Class RotationalLimitMotor | Stride API",
    "summary": "Class RotationalLimitMotor Namespace Stride.Physics Assembly Stride.Physics.dll public class RotationalLimitMotor Inheritance object RotationalLimitMotor Extension Methods UnsafeUtilities.As<T>(object?) Constructors RotationalLimitMotor(RotationalLimitMotor) Initializes a new instance of the RotationalLimitMotor class. public RotationalLimitMotor(RotationalLimitMotor motor) Parameters motor RotationalLimitMotor The motor. Properties AccumulatedImpulse Gets or sets the accumulated impulse. public float AccumulatedImpulse { get; set; } Property Value float The accumulated impulse. Bounce Gets or sets the bounce. public float Bounce { get; set; } Property Value float The bounce. CurrentLimit Gets or sets the current limit. public int CurrentLimit { get; set; } Property Value int The current limit. CurrentLimitError Gets or sets the current limit error. public float CurrentLimitError { get; set; } Property Value float The current limit error. CurrentPosition Gets or sets the current position. public float CurrentPosition { get; set; } Property Value float The current position. Damping Gets or sets the damping. public float Damping { get; set; } Property Value float The damping. EnableMotor Gets or sets a value indicating whether to enable the motor. public bool EnableMotor { get; set; } Property Value bool true if the motor is enabled; otherwise, false. HiLimit Gets or sets the hi limit. public float HiLimit { get; set; } Property Value float The hi limit. IsLimited Gets a value indicating whether this instance is limited. public bool IsLimited { get; } Property Value bool true if this instance is limited; otherwise, false. LimitSoftness Gets or sets the limit softness. public float LimitSoftness { get; set; } Property Value float The limit softness. LoLimit Gets or sets the lo limit. public float LoLimit { get; set; } Property Value float The lo limit. MaxLimitForce Gets or sets the maximum limit force. public float MaxLimitForce { get; set; } Property Value float The maximum limit force. MaxMotorForce Gets or sets the maximum motor force. public float MaxMotorForce { get; set; } Property Value float The maximum motor force. NormalCfm Gets or sets the normal CFM. public float NormalCfm { get; set; } Property Value float The normal CFM. StopCfm Gets or sets the stop CFM. public float StopCfm { get; set; } Property Value float The stop CFM. StopErp Gets or sets the stop erp. public float StopErp { get; set; } Property Value float The stop erp. TargetVelocity Gets or sets the target velocity. public float TargetVelocity { get; set; } Property Value float The target velocity. Methods Dispose() Releases unmanaged and - optionally - managed resources. public void Dispose()"
  },
  "api/Stride.Physics.ShapeOrientation.html": {
    "href": "api/Stride.Physics.ShapeOrientation.html",
    "title": "Enum ShapeOrientation | Stride API",
    "summary": "Enum ShapeOrientation Namespace Stride.Physics Assembly Stride.Physics.dll Defines the different possible orientations of a shape. public enum ShapeOrientation Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields UpX = 0 The shape is aligned with the Ox axis. UpY = 1 The shape is aligned with the Oy axis. UpZ = 2 The shape is aligned with the Oz axis."
  },
  "api/Stride.Physics.ShortHeightStickArraySource.html": {
    "href": "api/Stride.Physics.ShortHeightStickArraySource.html",
    "title": "Class ShortHeightStickArraySource | Stride API",
    "summary": "Class ShortHeightStickArraySource Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract] [Display(\"Short\", null)] public class ShortHeightStickArraySource : IHeightStickArraySource, IHeightStickParameters Inheritance object ShortHeightStickArraySource Implements IHeightStickArraySource IHeightStickParameters Extension Methods UnsafeUtilities.As<T>(object?) Properties HeightRange The range of the height. [DataMember(20)] public Vector2 HeightRange { get; set; } Property Value Vector2 Remarks X is min height and Y is max height. (height * HeightScale) should be in this range. Positive and negative heights can not be handle at the same time when the height type is Byte. HeightScale Used to calculate the height when the height type is Short or Byte. HeightScale should be 1 when the height type is Float. public float HeightScale { get; } Property Value float HeightScaleCalculator Select how to calculate HeightScale. [DataMember(30)] [Display(\"HeightScale\", null, Expand = ExpandRule.Always)] public IHeightScaleCalculator HeightScaleCalculator { get; set; } Property Value IHeightScaleCalculator HeightStickSize The size of the source. [DataMember(10)] [Display(\"Size\", null)] public Int2 HeightStickSize { get; set; } Property Value Int2 Remarks X is width and Y is length. They should be greater than or equal to 2. For example, this size should be 65 * 65 when you want 64 * 64 size in a scene. HeightType The type of the height. public HeightfieldTypes HeightType { get; } Property Value HeightfieldTypes InitialShort The value to fill the height stick array. [DataMember(40)] [DataMemberRange(-32767, 32767, 1, 10, 0)] public short InitialShort { get; set; } Property Value short Methods CopyTo<T>(UnmanagedArray<T>, int) Copy the source data to the height stick array. public void CopyTo<T>(UnmanagedArray<T> heightStickArray, int index) where T : struct Parameters heightStickArray UnmanagedArray<T> The destination to copy the data. index int The start index of the destination to copy the data. Type Parameters T The data type of the height IsValid() public bool IsValid() Returns bool Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.Simulation.OnSimulationCreationDelegate.html": {
    "href": "api/Stride.Physics.Simulation.OnSimulationCreationDelegate.html",
    "title": "Delegate Simulation.OnSimulationCreationDelegate | Stride API",
    "summary": "Delegate Simulation.OnSimulationCreationDelegate Namespace Stride.Physics Assembly Stride.Physics.dll public delegate PhysicsEngineFlags Simulation.OnSimulationCreationDelegate() Returns PhysicsEngineFlags Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Physics.Simulation.SimulationArgs.html": {
    "href": "api/Stride.Physics.Simulation.SimulationArgs.html",
    "title": "Class Simulation.SimulationArgs | Stride API",
    "summary": "Class Simulation.SimulationArgs Namespace Stride.Physics Assembly Stride.Physics.dll public class Simulation.SimulationArgs : EventArgs Inheritance object EventArgs Simulation.SimulationArgs Inherited Members EventArgs.Empty Extension Methods UnsafeUtilities.As<T>(object?) Fields DeltaTime public float DeltaTime Field Value float"
  },
  "api/Stride.Physics.Simulation.SimulationTickEvent.html": {
    "href": "api/Stride.Physics.Simulation.SimulationTickEvent.html",
    "title": "Delegate Simulation.SimulationTickEvent | Stride API",
    "summary": "Delegate Simulation.SimulationTickEvent Namespace Stride.Physics Assembly Stride.Physics.dll public delegate void Simulation.SimulationTickEvent(Simulation sender, float tick) Parameters sender Simulation tick float Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Physics.Simulation.html": {
    "href": "api/Stride.Physics.Simulation.html",
    "title": "Class Simulation | Stride API",
    "summary": "Class Simulation Namespace Stride.Physics Assembly Stride.Physics.dll public class Simulation : IDisposable Inheritance object Simulation Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields DisableSimulation Totally disable the simulation if set to true public static bool DisableSimulation Field Value bool OnSimulationCreation Temporary solution to inject engine flags public static Simulation.OnSimulationCreationDelegate OnSimulationCreation Field Value Simulation.OnSimulationCreationDelegate Properties ColliderShapesRenderGroup public RenderGroup ColliderShapesRenderGroup { get; set; } Property Value RenderGroup ColliderShapesRendering Enables or disables the rendering of collider shapes public bool ColliderShapesRendering { set; } Property Value bool ContinuousCollisionDetection public bool ContinuousCollisionDetection { get; set; } Property Value bool CurrentCollisions Every pair of components currently colliding with each other public ICollection<Collision> CurrentCollisions { get; } Property Value ICollection<Collision> FixedTimeStep By decreasing the size of fixedTimeStep, you are increasing the “resolution” of the simulation. Default is 1.0f / 60.0f or 60fps public float FixedTimeStep { get; set; } Property Value float Gravity Gets or sets the gravity. public Vector3 Gravity { get; set; } Property Value Vector3 The gravity. Exceptions Exception Cannot perform this action when the physics engine is set to CollisionsOnly IncludeStaticAgainstStaticCollisions Should static - static collisions of StaticColliderComponent yield PhysicsComponent.NewCollision() and added to PhysicsComponent.Collisions ? public bool IncludeStaticAgainstStaticCollisions { get; set; } Property Value bool Remarks Regardless of the state of this value you can still retrieve static-static collisions through CurrentCollisions. MaxSubSteps The maximum number of steps that the Simulation is allowed to take each tick. If the engine is running slow (large deltaTime), then you must increase the number of maxSubSteps to compensate for this, otherwise your simulation is “losing” time. It's important that frame DeltaTime is always less than MaxSubSteps*FixedTimeStep, otherwise you are losing time. [Obsolete(\"Value is ignored, use MaxTickDuration instead\")] public int MaxSubSteps { get; set; } Property Value int MaxTickDuration public float MaxTickDuration { get; set; } Property Value float SpeculativeContactRestitution public bool SpeculativeContactRestitution { get; set; } Property Value bool Methods AddConstraint(Constraint) Adds the constraint to the engine processing pipeline. public void AddConstraint(Constraint constraint) Parameters constraint Constraint The constraint. Exceptions Exception Cannot perform this action when the physics engine is set to CollisionsOnly AddConstraint(Constraint, bool) Adds the constraint to the engine processing pipeline. public void AddConstraint(Constraint constraint, bool disableCollisionsBetweenLinkedBodies) Parameters constraint Constraint The constraint. disableCollisionsBetweenLinkedBodies bool if set to true [disable collisions between linked bodies]. Exceptions Exception Cannot perform this action when the physics engine is set to CollisionsOnly ClearForces() public void ClearForces() CreateConstraint(ConstraintTypes, RigidbodyComponent, Matrix, bool) Creates the constraint. public static Constraint CreateConstraint(ConstraintTypes type, RigidbodyComponent rigidBodyA, Matrix frameA, bool useReferenceFrameA = false) Parameters type ConstraintTypes The type. rigidBodyA RigidbodyComponent The rigid body a. frameA Matrix The frame a. useReferenceFrameA bool if set to true [use reference frame a]. Returns Constraint Exceptions Exception Cannot perform this action when the physics engine is set to CollisionsOnly or Both RigidBodies must be valid or A Gear constraint always needs two rigidbodies to be created. CreateConstraint(ConstraintTypes, RigidbodyComponent, RigidbodyComponent, Matrix, Matrix, bool) Creates the constraint. public static Constraint CreateConstraint(ConstraintTypes type, RigidbodyComponent rigidBodyA, RigidbodyComponent rigidBodyB, Matrix frameA, Matrix frameB, bool useReferenceFrameA = false) Parameters type ConstraintTypes The type. rigidBodyA RigidbodyComponent The rigid body a. rigidBodyB RigidbodyComponent The rigid body b. frameA Matrix The frame a. frameB Matrix The frame b. useReferenceFrameA bool if set to true [use reference frame a]. Returns Constraint Exceptions Exception Cannot perform this action when the physics engine is set to CollisionsOnly or Both RigidBodies must be valid CreateHingeConstraint(RigidbodyComponent, Vector3, Vector3, RigidbodyComponent, Vector3, Vector3, bool) Creates a hinge constraint using a specialized constructor. public static HingeConstraint CreateHingeConstraint(RigidbodyComponent rigidBodyA, Vector3 pivotInA, Vector3 axisInA, RigidbodyComponent rigidBodyB, Vector3 pivotInB, Vector3 axisInB, bool useReferenceFrameA = false) Parameters rigidBodyA RigidbodyComponent The rigid body a. pivotInA Vector3 Pivot point in body a. axisInA Vector3 Axis in body a. rigidBodyB RigidbodyComponent The rigid body b. pivotInB Vector3 Pivot point in body b. axisInB Vector3 Axis in body b. useReferenceFrameA bool if set to true [use reference frame a]. Returns HingeConstraint Exceptions Exception Cannot perform this action when the physics engine is set to CollisionsOnly or Both RigidBodies must be valid CreateHingeConstraint(RigidbodyComponent, Vector3, Vector3, bool) Creates a hinge constraint using a specialized constructor. public static HingeConstraint CreateHingeConstraint(RigidbodyComponent rigidBodyA, Vector3 pivotInA, Vector3 axisInA, bool useReferenceFrameA = false) Parameters rigidBodyA RigidbodyComponent The rigid body a. pivotInA Vector3 Pivot point in body a. axisInA Vector3 Axis in body a. useReferenceFrameA bool if set to true [use reference frame a]. Returns HingeConstraint Exceptions Exception Cannot perform this action when the physics engine is set to CollisionsOnly or RigidBody must be valid Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() OnSimulationBegin(SimulationArgs) protected virtual void OnSimulationBegin(Simulation.SimulationArgs e) Parameters e Simulation.SimulationArgs OnSimulationEnd(SimulationArgs) protected virtual void OnSimulationEnd(Simulation.SimulationArgs e) Parameters e Simulation.SimulationArgs Raycast(Vector3, Vector3, CollisionFilterGroups, CollisionFilterGroupFlags, bool, EFlags) Raycasts and returns the closest hit public HitResult Raycast(Vector3 from, Vector3 to, CollisionFilterGroups filterGroup = CollisionFilterGroups.DefaultFilter, CollisionFilterGroupFlags filterFlags = (CollisionFilterGroupFlags)-1, bool hitTriggers = false, EFlags eFlags = EFlags.None) Parameters from Vector3 The starting point of this raycast to Vector3 The end point of this raycast filterGroup CollisionFilterGroups The collision group of this raycast filterFlags CollisionFilterGroupFlags The collision group that this raycast can collide with hitTriggers bool Whether this test should collide with PhysicsTriggerComponentBase eFlags EFlags Flags that control how this ray test is performed Returns HitResult The result of this test Raycast(Vector3, Vector3, out HitResult, CollisionFilterGroups, CollisionFilterGroupFlags, bool, EFlags) Raycasts, returns true when it hit something public bool Raycast(Vector3 from, Vector3 to, out HitResult result, CollisionFilterGroups filterGroup = CollisionFilterGroups.DefaultFilter, CollisionFilterGroupFlags filterFlags = (CollisionFilterGroupFlags)-1, bool hitTriggers = false, EFlags eFlags = EFlags.None) Parameters from Vector3 The starting point of this raycast to Vector3 The end point of this raycast result HitResult Information about this test filterGroup CollisionFilterGroups The collision group of this raycast filterFlags CollisionFilterGroupFlags The collision group that this raycast can collide with hitTriggers bool Whether this test should collide with PhysicsTriggerComponentBase eFlags EFlags Flags that control how this ray test is performed Returns bool True if the test collided with an object in the simulation RaycastPenetrating(Vector3, Vector3, ICollection<HitResult>, CollisionFilterGroups, CollisionFilterGroupFlags, bool, EFlags) Raycasts penetrating any shape the ray encounters. Filtering by CollisionGroup public void RaycastPenetrating(Vector3 from, Vector3 to, ICollection<HitResult> resultsOutput, CollisionFilterGroups filterGroup = CollisionFilterGroups.DefaultFilter, CollisionFilterGroupFlags filterFlags = (CollisionFilterGroupFlags)-1, bool hitTriggers = false, EFlags eFlags = EFlags.None) Parameters from Vector3 The starting point of this raycast to Vector3 The end point of this raycast resultsOutput ICollection<HitResult> The collection to add intersections to filterGroup CollisionFilterGroups The collision group of this raycast filterFlags CollisionFilterGroupFlags The collision group that this raycast can collide with hitTriggers bool Whether this test should collide with PhysicsTriggerComponentBase eFlags EFlags Flags that control how this ray test is performed RemoveConstraint(Constraint) Removes the constraint from the engine processing pipeline. public void RemoveConstraint(Constraint constraint) Parameters constraint Constraint The constraint. Exceptions Exception Cannot perform this action when the physics engine is set to CollisionsOnly ShapeSweep(ColliderShape, Matrix, Matrix, CollisionFilterGroups, CollisionFilterGroupFlags, bool) Performs a sweep test using a collider shape and returns the closest hit public HitResult ShapeSweep(ColliderShape shape, Matrix from, Matrix to, CollisionFilterGroups filterGroup = CollisionFilterGroups.DefaultFilter, CollisionFilterGroupFlags filterFlags = (CollisionFilterGroupFlags)-1, bool hitTriggers = false) Parameters shape ColliderShape The shape used when testing collisions with colliders in the simulation from Matrix The starting point of this sweep to Matrix The end point of this sweep filterGroup CollisionFilterGroups The collision group of this shape sweep filterFlags CollisionFilterGroupFlags The collision group that this shape sweep can collide with hitTriggers bool Whether this test should collide with PhysicsTriggerComponentBase Returns HitResult The result of this test Exceptions ArgumentException This kind of shape cannot be used for a ShapeSweep. ShapeSweepPenetrating(ColliderShape, Matrix, Matrix, ICollection<HitResult>, CollisionFilterGroups, CollisionFilterGroupFlags, bool) Performs a sweep test using a collider shape and never stops until \"to\" public void ShapeSweepPenetrating(ColliderShape shape, Matrix from, Matrix to, ICollection<HitResult> resultsOutput, CollisionFilterGroups filterGroup = CollisionFilterGroups.DefaultFilter, CollisionFilterGroupFlags filterFlags = (CollisionFilterGroupFlags)-1, bool hitTriggers = false) Parameters shape ColliderShape The shape against which colliders in the simulation will be tested from Matrix The starting point of this sweep to Matrix The end point of this sweep resultsOutput ICollection<HitResult> The collection to add hit results to filterGroup CollisionFilterGroups The collision group of this shape sweep filterFlags CollisionFilterGroupFlags The collision group that this shape sweep can collide with hitTriggers bool Whether this test should collide with PhysicsTriggerComponentBase Exceptions ArgumentException This kind of shape cannot be used for a ShapeSweep. Events PostTick Called right after processing a tick of the physics simulation, this may never occur before many updates, or occur multiple times between updates depending on this Simulation properties public event Simulation.SimulationTickEvent PostTick Event Type Simulation.SimulationTickEvent PreTick Called right before processing a tick of the physics simulation, this may never occur before many updates, or occur multiple times between updates depending on this Simulation properties public event Simulation.SimulationTickEvent PreTick Event Type Simulation.SimulationTickEvent SimulationBegin Called before the physics simulation. This event might not be fired by the main thread. [Obsolete(\"The simulation is not guaranteed to tick following this call, use PreTick instead. This is the same thing as Update\")] public event EventHandler<Simulation.SimulationArgs> SimulationBegin Event Type EventHandler<Simulation.SimulationArgs> SimulationEnd Called after the physics simulation. This event might not be fired by the main thread. [Obsolete(\"The simulation is not guaranteed to have ticked before this call, use PostTick instead. This is the same thing as Update\")] public event EventHandler<Simulation.SimulationArgs> SimulationEnd Event Type EventHandler<Simulation.SimulationArgs>"
  },
  "api/Stride.Physics.SliderConstraint.html": {
    "href": "api/Stride.Physics.SliderConstraint.html",
    "title": "Class SliderConstraint | Stride API",
    "summary": "Class SliderConstraint Namespace Stride.Physics Assembly Stride.Physics.dll public class SliderConstraint : Constraint, IDisposable, IRelative Inheritance object Constraint SliderConstraint Implements IDisposable IRelative Inherited Members Constraint.Dispose() Constraint.RigidBodyA Constraint.RigidBodyB Constraint.Enabled Constraint.BreakingImpulseThreshold Constraint.AppliedImpulse Constraint.Simulation Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties AngularDepth Gets the angular depth. public float AngularDepth { get; } Property Value float The angular depth. AngularPosition Gets the angular position. public float AngularPosition { get; } Property Value float The angular position. DampingDirAngular Gets or sets the damping dir angular. public float DampingDirAngular { get; set; } Property Value float The damping dir angular. DampingDirLinear Gets or sets the damping dir linear. public float DampingDirLinear { get; set; } Property Value float The damping dir linear. DampingLimAngular Gets or sets the damping lim angular. public float DampingLimAngular { get; set; } Property Value float The damping lim angular. DampingLimLinear Gets or sets the damping lim linear. public float DampingLimLinear { get; set; } Property Value float The damping lim linear. DampingOrthoAngular Gets or sets the damping ortho angular. public float DampingOrthoAngular { get; set; } Property Value float The damping ortho angular. DampingOrthoLinear Gets or sets the damping ortho linear. public float DampingOrthoLinear { get; set; } Property Value float The damping ortho linear. LinearDepth Gets the linear depth. public float LinearDepth { get; } Property Value float The linear depth. LinearPosition Gets the linear position. public float LinearPosition { get; } Property Value float The linear position. LowerAngularLimit Gets or sets the lower angular limit. public float LowerAngularLimit { get; set; } Property Value float The lower angular limit. LowerLinearLimit Gets or sets the lower linear limit. public float LowerLinearLimit { get; set; } Property Value float The lower linear limit. MaxAngMotorForce Gets or sets the maximum ang motor force. public float MaxAngMotorForce { get; set; } Property Value float The maximum ang motor force. MaxLinearMotorForce Gets or sets the maximum linear motor force. public float MaxLinearMotorForce { get; set; } Property Value float The maximum linear motor force. PoweredAngularMotor Gets or sets a value indicating whether [powered angular motor]. public bool PoweredAngularMotor { get; set; } Property Value bool true if [powered angular motor]; otherwise, false. PoweredLinearMotor Gets or sets a value indicating whether [powered linear motor]. public bool PoweredLinearMotor { get; set; } Property Value bool true if [powered linear motor]; otherwise, false. RestitutionDirAngular Gets or sets the restitution dir angular. public float RestitutionDirAngular { get; set; } Property Value float The restitution dir angular. RestitutionDirLinear Gets or sets the restitution dir linear. public float RestitutionDirLinear { get; set; } Property Value float The restitution dir linear. RestitutionLimAngular Gets or sets the restitution lim angular. public float RestitutionLimAngular { get; set; } Property Value float The restitution lim angular. RestitutionLimLinear Gets or sets the restitution lim linear. public float RestitutionLimLinear { get; set; } Property Value float The restitution lim linear. RestitutionOrthoAngular Gets or sets the restitution ortho angular. public float RestitutionOrthoAngular { get; set; } Property Value float The restitution ortho angular. RestitutionOrthoLinear Gets or sets the restitution ortho linear. public float RestitutionOrthoLinear { get; set; } Property Value float The restitution ortho linear. SoftnessDirAngular Gets or sets the softness dir angular. public float SoftnessDirAngular { get; set; } Property Value float The softness dir angular. SoftnessDirLinear Gets or sets the softness dir linear. public float SoftnessDirLinear { get; set; } Property Value float The softness dir linear. SoftnessLimAngular Gets or sets the softness lim angular. public float SoftnessLimAngular { get; set; } Property Value float The softness lim angular. SoftnessLimLinear Gets or sets the softness lim linear. public float SoftnessLimLinear { get; set; } Property Value float The softness lim linear. SoftnessOrthoAngular Gets or sets the softness ortho angular. public float SoftnessOrthoAngular { get; set; } Property Value float The softness ortho angular. SoftnessOrthoLinear Gets or sets the softness ortho linear. public float SoftnessOrthoLinear { get; set; } Property Value float The softness ortho linear. SolveAngularLimit Gets a value indicating whether [solve angular limit]. public bool SolveAngularLimit { get; } Property Value bool true if [solve angular limit]; otherwise, false. SolveLinearLimit Gets a value indicating whether [solve linear limit]. public bool SolveLinearLimit { get; } Property Value bool true if [solve linear limit]; otherwise, false. TargetAngularMotorVelocity Gets or sets the target angular motor velocity. public float TargetAngularMotorVelocity { get; set; } Property Value float The target angular motor velocity. TargetLinearMotorVelocity Gets or sets the target linear motor velocity. public float TargetLinearMotorVelocity { get; set; } Property Value float The target linear motor velocity. UpperAngularLimit Gets or sets the upper angular limit. public float UpperAngularLimit { get; set; } Property Value float The upper angular limit. UpperLinearLimit Gets or sets the upper linear limit. public float UpperLinearLimit { get; set; } Property Value float The upper linear limit. Methods SetFrames(Matrix, Matrix) Sets the frames. public void SetFrames(Matrix frameA, Matrix frameB) Parameters frameA Matrix The frame a. frameB Matrix The frame b."
  },
  "api/Stride.Physics.SphereColliderShape.html": {
    "href": "api/Stride.Physics.SphereColliderShape.html",
    "title": "Class SphereColliderShape | Stride API",
    "summary": "Class SphereColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class SphereColliderShape : ColliderShape, IDisposable Inheritance object ColliderShape SphereColliderShape Implements IDisposable Inherited Members ColliderShape.DebugScaling ColliderShape.Dispose() ColliderShape.Type ColliderShape.LocalOffset ColliderShape.LocalRotation ColliderShape.UpdateLocalTransformations() ColliderShape.PositiveCenterMatrix ColliderShape.NegativeCenterMatrix ColliderShape.cachedScaling ColliderShape.Scaling ColliderShape.Is2D ColliderShape.Description ColliderShape.CreateUpdatableDebugPrimitive(GraphicsDevice) ColliderShape.UpdateDebugPrimitive(CommandList, IDebugPrimitive) ColliderShape.Margin ColliderShape.DebugPrimitiveMatrix Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors SphereColliderShape(bool, float) Initializes a new instance of the SphereColliderShape class. public SphereColliderShape(bool is2D, float radiusParam) Parameters is2D bool if set to true [is2 d]. radiusParam float Fields Radius public readonly float Radius Field Value float Methods CreateDebugPrimitive(GraphicsDevice) public override MeshDraw CreateDebugPrimitive(GraphicsDevice device) Parameters device GraphicsDevice Returns MeshDraw"
  },
  "api/Stride.Physics.SphereColliderShapeDesc.html": {
    "href": "api/Stride.Physics.SphereColliderShapeDesc.html",
    "title": "Class SphereColliderShapeDesc | Stride API",
    "summary": "Class SphereColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<SphereColliderShapeDesc>))] [DataContract(\"SphereColliderShapeDesc\")] [Display(50, \"Sphere\", null)] public class SphereColliderShapeDesc : IInlineColliderShapeDesc, IAssetColliderShapeDesc, IColliderShapeDesc Inheritance object SphereColliderShapeDesc Implements IInlineColliderShapeDesc IAssetColliderShapeDesc IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Fields Is2D [DataMember(10)] public bool Is2D Field Value bool LocalOffset [DataMember(30)] public Vector3 LocalOffset Field Value Vector3 Radius [DataMember(20)] public float Radius Field Value float Methods CreateShape(IServiceRegistry) public ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.StaticColliderComponent.html": {
    "href": "api/Stride.Physics.StaticColliderComponent.html",
    "title": "Class StaticColliderComponent | Stride API",
    "summary": "Class StaticColliderComponent Namespace Stride.Physics Assembly Stride.Physics.dll [DataContract(\"StaticColliderComponent\")] [Display(\"Static collider\", null)] public sealed class StaticColliderComponent : PhysicsTriggerComponentBase, IIdentifiable Inheritance object EntityComponent ActivableEntityComponent PhysicsComponent PhysicsTriggerComponentBase StaticColliderComponent Implements IIdentifiable Inherited Members PhysicsTriggerComponentBase.IsTrigger PhysicsTriggerComponentBase.Enabled PhysicsComponent.ColliderShapes PhysicsComponent.CollisionGroup PhysicsComponent.CanCollideWith PhysicsComponent.ProcessCollisions PhysicsComponent.CanSleep PhysicsComponent.IsActive PhysicsComponent.Activate(bool) PhysicsComponent.Restitution PhysicsComponent.Friction PhysicsComponent.RollingFriction PhysicsComponent.CcdMotionThreshold PhysicsComponent.CcdSweptSphereRadius PhysicsComponent.Collisions PhysicsComponent.NewCollision() PhysicsComponent.CollisionEnded() PhysicsComponent.Simulation PhysicsComponent.ColliderShapeChanged PhysicsComponent.ColliderShape PhysicsComponent.CanScaleShape PhysicsComponent.PhysicsWorldTransform PhysicsComponent.Tag PhysicsComponent.BoneWorldMatrix PhysicsComponent.BoneWorldMatrixOut PhysicsComponent.BoneIndex PhysicsComponent.DebugEntity PhysicsComponent.AddDebugEntity(Scene, RenderGroup, bool) PhysicsComponent.RemoveDebugEntity(Scene) PhysicsComponent.UpdatePhysicsTransformation(bool) PhysicsComponent.ComposeShape() PhysicsComponent.IgnoreCollisionWith(PhysicsComponent, CollisionState) PhysicsComponent.IsIgnoringCollisionWith(PhysicsComponent) EntityComponent.Entity EntityComponent.Id Extension Methods UnsafeUtilities.As<T>(object?) Properties AlwaysUpdateNaviMeshCache [DataMember(100)] public bool AlwaysUpdateNaviMeshCache { get; set; } Property Value bool Methods OnAttach() Called whenever an entity with this component is added to scene. protected override void OnAttach() OnDetach() protected override void OnDetach()"
  },
  "api/Stride.Physics.StaticMeshColliderShape.html": {
    "href": "api/Stride.Physics.StaticMeshColliderShape.html",
    "title": "Class StaticMeshColliderShape | Stride API",
    "summary": "Class StaticMeshColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class StaticMeshColliderShape : ColliderShape, IDisposable Inheritance object ColliderShape StaticMeshColliderShape Implements IDisposable Inherited Members ColliderShape.DebugScaling ColliderShape.Type ColliderShape.LocalOffset ColliderShape.LocalRotation ColliderShape.UpdateLocalTransformations() ColliderShape.PositiveCenterMatrix ColliderShape.NegativeCenterMatrix ColliderShape.cachedScaling ColliderShape.Scaling ColliderShape.Is2D ColliderShape.Description ColliderShape.CreateUpdatableDebugPrimitive(GraphicsDevice) ColliderShape.UpdateDebugPrimitive(CommandList, IDebugPrimitive) ColliderShape.Margin ColliderShape.DebugPrimitiveMatrix Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors StaticMeshColliderShape(Model, IServiceRegistry) Create a static collider from an asset model, any changes the model receives won't be reflected on the collider public StaticMeshColliderShape(Model model, IServiceRegistry services) Parameters model Model services IServiceRegistry StaticMeshColliderShape(ICollection<Vector3>, ICollection<int>) Create a static collider from the data provided, data will only be read, changes to it won't be reflected on the collider. public StaticMeshColliderShape(ICollection<Vector3> vertices, ICollection<int> indices) Parameters vertices ICollection<Vector3> indices ICollection<int> Fields Model Can be null when this was created without Model public readonly Model Model Field Value Model Methods CreateDebugPrimitive(GraphicsDevice) public override MeshDraw CreateDebugPrimitive(GraphicsDevice device) Parameters device GraphicsDevice Returns MeshDraw Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public override void Dispose() GetMeshDataCopy(out Vector3[], out int[]) public void GetMeshDataCopy(out Vector3[] verts, out int[] indices) Parameters verts Vector3[] indices int[]"
  },
  "api/Stride.Physics.StaticMeshColliderShapeDesc.html": {
    "href": "api/Stride.Physics.StaticMeshColliderShapeDesc.html",
    "title": "Class StaticMeshColliderShapeDesc | Stride API",
    "summary": "Class StaticMeshColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<StaticMeshColliderShapeDesc>))] [DataContract(\"StaticMeshColliderShapeDesc\")] [Display(600, \"Static Mesh\", null)] public class StaticMeshColliderShapeDesc : IInlineColliderShapeDesc, IAssetColliderShapeDesc, IColliderShapeDesc Inheritance object StaticMeshColliderShapeDesc Implements IInlineColliderShapeDesc IAssetColliderShapeDesc IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Fields Model [DataMember(30)] public Model Model Field Value Model Methods CreateShape(IServiceRegistry) public ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.StaticPlaneColliderShape.html": {
    "href": "api/Stride.Physics.StaticPlaneColliderShape.html",
    "title": "Class StaticPlaneColliderShape | Stride API",
    "summary": "Class StaticPlaneColliderShape Namespace Stride.Physics Assembly Stride.Physics.dll public class StaticPlaneColliderShape : ColliderShape, IDisposable Inheritance object ColliderShape StaticPlaneColliderShape Implements IDisposable Inherited Members ColliderShape.DebugScaling ColliderShape.Dispose() ColliderShape.Type ColliderShape.LocalOffset ColliderShape.LocalRotation ColliderShape.UpdateLocalTransformations() ColliderShape.PositiveCenterMatrix ColliderShape.NegativeCenterMatrix ColliderShape.cachedScaling ColliderShape.Scaling ColliderShape.Is2D ColliderShape.Description ColliderShape.CreateUpdatableDebugPrimitive(GraphicsDevice) ColliderShape.UpdateDebugPrimitive(CommandList, IDebugPrimitive) ColliderShape.Margin ColliderShape.DebugPrimitiveMatrix Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors StaticPlaneColliderShape(Vector3, float) Initializes a new instance of the StaticPlaneColliderShape class. A static plane that is solid to infinity on one side. Several of these can be used to confine a convex space in a manner that completely prevents tunneling to the outside. The plane itself is specified with a normal and distance as is standard in mathematics. public StaticPlaneColliderShape(Vector3 normalParam, float offsetParam) Parameters normalParam Vector3 offsetParam float Fields Normal public readonly Vector3 Normal Field Value Vector3 Offset public readonly float Offset Field Value float Methods CreateDebugPrimitive(GraphicsDevice) public override MeshDraw CreateDebugPrimitive(GraphicsDevice device) Parameters device GraphicsDevice Returns MeshDraw"
  },
  "api/Stride.Physics.StaticPlaneColliderShapeDesc.html": {
    "href": "api/Stride.Physics.StaticPlaneColliderShapeDesc.html",
    "title": "Class StaticPlaneColliderShapeDesc | Stride API",
    "summary": "Class StaticPlaneColliderShapeDesc Namespace Stride.Physics Assembly Stride.Physics.dll [ContentSerializer(typeof(DataContentSerializer<StaticPlaneColliderShapeDesc>))] [DataContract(\"StaticPlaneColliderShapeDesc\")] [Display(50, \"Infinite Plane\", null)] public class StaticPlaneColliderShapeDesc : IInlineColliderShapeDesc, IAssetColliderShapeDesc, IColliderShapeDesc Inheritance object StaticPlaneColliderShapeDesc Implements IInlineColliderShapeDesc IAssetColliderShapeDesc IColliderShapeDesc Extension Methods UnsafeUtilities.As<T>(object?) Fields Normal [DataMember(10)] public Vector3 Normal Field Value Vector3 Offset [DataMember(20)] public float Offset Field Value float Methods CreateShape(IServiceRegistry) public ColliderShape CreateShape(IServiceRegistry services) Parameters services IServiceRegistry Returns ColliderShape Match(object) public bool Match(object obj) Parameters obj object Returns bool"
  },
  "api/Stride.Physics.TranslationalLimitMotor.html": {
    "href": "api/Stride.Physics.TranslationalLimitMotor.html",
    "title": "Class TranslationalLimitMotor | Stride API",
    "summary": "Class TranslationalLimitMotor Namespace Stride.Physics Assembly Stride.Physics.dll public class TranslationalLimitMotor Inheritance object TranslationalLimitMotor Extension Methods UnsafeUtilities.As<T>(object?) Constructors TranslationalLimitMotor(TranslationalLimitMotor) Initializes a new instance of the TranslationalLimitMotor class. public TranslationalLimitMotor(TranslationalLimitMotor motor) Parameters motor TranslationalLimitMotor The motor. Properties AccumulatedImpulse Gets or sets the accumulated impulse. public Vector3 AccumulatedImpulse { get; set; } Property Value Vector3 The accumulated impulse. CurrentLimitError Gets or sets the current limit error. public Vector3 CurrentLimitError { get; set; } Property Value Vector3 The current limit error. CurrentLinearDiff Gets or sets the current linear difference. public Vector3 CurrentLinearDiff { get; set; } Property Value Vector3 The current linear difference. Damping Gets or sets the damping. public float Damping { get; set; } Property Value float The damping. LimitSoftness Gets or sets the limit softness. public float LimitSoftness { get; set; } Property Value float The limit softness. LowerLimit Gets or sets the lower limit. public Vector3 LowerLimit { get; set; } Property Value Vector3 The lower limit. MaxMotorForce Gets or sets the maximum motor force. public Vector3 MaxMotorForce { get; set; } Property Value Vector3 The maximum motor force. NormalCFM Gets or sets the normal CFM. public Vector3 NormalCFM { get; set; } Property Value Vector3 The normal CFM. Restitution Gets or sets the restitution. public float Restitution { get; set; } Property Value float The restitution. StopCFM Gets or sets the stop CFM. public Vector3 StopCFM { get; set; } Property Value Vector3 The stop CFM. StopERP Gets or sets the stop erp. public Vector3 StopERP { get; set; } Property Value Vector3 The stop erp. TargetVelocity Gets or sets the target velocity. public Vector3 TargetVelocity { get; set; } Property Value Vector3 The target velocity. UpperLimit Gets or sets the upper limit. public Vector3 UpperLimit { get; set; } Property Value Vector3 The upper limit. Methods Dispose() Releases unmanaged and - optionally - managed resources. public void Dispose()"
  },
  "api/Stride.Physics.UnmanagedArrayExtensions.html": {
    "href": "api/Stride.Physics.UnmanagedArrayExtensions.html",
    "title": "Class UnmanagedArrayExtensions | Stride API",
    "summary": "Class UnmanagedArrayExtensions Namespace Stride.Physics Assembly Stride.Physics.dll public static class UnmanagedArrayExtensions Inheritance object UnmanagedArrayExtensions Methods Fill<T>(UnmanagedArray<T>, T, int, int) Fill the array with specific value. public static void Fill<T>(this UnmanagedArray<T> unmanagedArray, T value, int index, int fillLength) where T : struct Parameters unmanagedArray UnmanagedArray<T> The destination to fill. value T The value used to fill. index int The start index of the destination to fill. fillLength int The filling length. Type Parameters T The type param of UnmanagedArray"
  },
  "api/Stride.Physics.html": {
    "href": "api/Stride.Physics.html",
    "title": "Namespace Stride.Physics | Stride API",
    "summary": "Namespace Stride.Physics Classes BoxColliderShape BoxColliderShapeDesc Bullet2PhysicsSystem ByteHeightStickArraySource CapsuleColliderShape CapsuleColliderShapeDesc CharacterComponent ColliderShape ColliderShapeAssetDesc CompoundColliderShape ConeColliderShape ConeColliderShapeDesc ConeTwistConstraint Constraint ConvexHullColliderShape ConvexHullColliderShapeDesc ConvexHullDecompositionParameters CustomHeightScaleCalculator CylinderColliderShape CylinderColliderShapeDesc DebugPrimitive FloatHeightStickArraySource GearConstraint Generic6DoFConstraint Generic6DoFSpringConstraint HeightScaleCalculator HeightStickArraySourceFromHeightmap HeightfieldColliderShape HeightfieldColliderShape.HeightArrayLock HeightfieldColliderShape.HeightfieldDebugPrimitive HeightfieldColliderShape.HeightfieldDebugPrimitive.Tile HeightfieldColliderShapeDesc Heightmap HeightmapExtensions HeightmapUtils HingeConstraint PhysicsColliderShape PhysicsConstraintComponent A component descrbing a physical constraint between two rigidbodies or a rigidbody and world. PhysicsDebugShapeMaterial PhysicsProcessor PhysicsProcessor.AssociatedData PhysicsProfilingKeys PhysicsScriptComponentExtensions Extension methods for the ScriptComponent related to phystics PhysicsSettings PhysicsSkinnedComponentBase PhysicsTriggerComponentBase Point2PointConstraint RigidbodyComponent RotationalLimitMotor ShortHeightStickArraySource Simulation Simulation.SimulationArgs SliderConstraint SphereColliderShape SphereColliderShapeDesc StaticColliderComponent StaticMeshColliderShape StaticMeshColliderShapeDesc StaticPlaneColliderShape StaticPlaneColliderShapeDesc TranslationalLimitMotor UnmanagedArrayExtensions Structs Collision A pair of component colliding with each other. Pair of [b,a] is considered equal to [a,b]. ContactPoint HeightfieldCenteringParameters HitResult The result of a Physics Raycast or ShapeSweep operation Interfaces IAssetColliderShapeDesc IColliderShapeDesc IConstraintDesc Description of a Constraint. IDebugPrimitive IHeightScaleCalculator IHeightStickArraySource IHeightStickParameters IInlineColliderShapeDesc IPhysicsSystem IRelative Enums ColliderShapeTypes CollisionFilterGroupFlags CollisionFilterGroups ConstraintTypes EFlags Flags that control how ray tests are performed HeightfieldColliderShape.HeightArrayLock.LockTypes HeightfieldTypes PhysicsEngineFlags RigidBodyTypes ShapeOrientation Defines the different possible orientations of a shape. Delegates Simulation.OnSimulationCreationDelegate Simulation.SimulationTickEvent"
  },
  "api/Stride.Profiling.DebugTextSystem.html": {
    "href": "api/Stride.Profiling.DebugTextSystem.html",
    "title": "Class DebugTextSystem | Stride API",
    "summary": "Class DebugTextSystem Namespace Stride.Profiling Assembly Stride.Engine.dll public class DebugTextSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase DebugTextSystem Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Inherited Members GameSystemBase.Game GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.Initialize() GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) GameSystemBase.LoadContent() GameSystemBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DebugTextSystem(IServiceRegistry) public DebugTextSystem(IServiceRegistry registry) Parameters registry IServiceRegistry Properties DefaultOnScreenTime Sets or gets the time that messages will stay on screen by default. public TimeSpan DefaultOnScreenTime { get; set; } Property Value TimeSpan TailSize Sets or gets the size of the messages queue, older messages will be discarded if the size is greater. public int TailSize { get; set; } Property Value int TextColor Sets or gets the color to use when drawing the profiling system fonts. public Color4 TextColor { get; set; } Property Value Color4 Methods Draw(GameTime) Draws the Game Component. public override void Draw(GameTime gameTime) Parameters gameTime GameTime The current timing information. Print(string, Int2, Color4?, TimeSpan?) Print a custom overlay message public void Print(string message, Int2 position, Color4? color = null, TimeSpan? timeOnScreen = null) Parameters message string position Int2 color Color4? timeOnScreen TimeSpan? Update(GameTime) This method is called when this game component is updated. public override void Update(GameTime gameTime) Parameters gameTime GameTime The current timing."
  },
  "api/Stride.Profiling.GameProfilingResults.html": {
    "href": "api/Stride.Profiling.GameProfilingResults.html",
    "title": "Enum GameProfilingResults | Stride API",
    "summary": "Enum GameProfilingResults Namespace Stride.Profiling Assembly Stride.Engine.dll public enum GameProfilingResults Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"CPU profiling events\", null)] CpuEvents = 1 [Display(\"FPS\", null)] Fps = 0 [Display(\"GPU profiling events\", null)] GpuEvents = 2"
  },
  "api/Stride.Profiling.GameProfilingSorting.html": {
    "href": "api/Stride.Profiling.GameProfilingSorting.html",
    "title": "Enum GameProfilingSorting | Stride API",
    "summary": "Enum GameProfilingSorting Namespace Stride.Profiling Assembly Stride.Engine.dll public enum GameProfilingSorting Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"Average time\", null)] ByAverageTime = 0 [Display(\"Key\", null)] ByName = 2 [Display(\"Total time\", null)] ByTime = 1"
  },
  "api/Stride.Profiling.GameProfilingSystem.html": {
    "href": "api/Stride.Profiling.GameProfilingSystem.html",
    "title": "Class GameProfilingSystem | Stride API",
    "summary": "Class GameProfilingSystem Namespace Stride.Profiling Assembly Stride.Engine.dll public class GameProfilingSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase GameProfilingSystem Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Inherited Members GameSystemBase.Game GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.Initialize() GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Update(GameTime) GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) GameSystemBase.LoadContent() GameSystemBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors GameProfilingSystem(IServiceRegistry) Initializes a new instance of the GameProfilingSystem class. public GameProfilingSystem(IServiceRegistry registry) Parameters registry IServiceRegistry The service registry. Properties CurrentResultPage Sets or gets the profiling result page to display. public uint CurrentResultPage { get; set; } Property Value uint FilteringMode Sets or gets which data should be displayed on screen. public GameProfilingResults FilteringMode { get; set; } Property Value GameProfilingResults RefreshTime Sets or gets the refreshing time of the profiling information in milliseconds. public double RefreshTime { get; set; } Property Value double RenderTarget The render target where the profiling results should be rendered into. If null, the BackBuffer is used. public Texture RenderTarget { get; set; } Property Value Texture SortingMode Sets or gets the way the printed information will be sorted. public GameProfilingSorting SortingMode { get; set; } Property Value GameProfilingSorting TextColor Sets or gets the color to use when drawing the profiling system fonts. public Color4 TextColor { get; set; } Property Value Color4 Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. DisableProfiling() Disables the profiling system drawing. public void DisableProfiling() Draw(GameTime) Draws the Game Component. public override void Draw(GameTime gameTime) Parameters gameTime GameTime The current timing information. EnableProfiling(bool, params ProfilingKey[]) Enables the profiling system drawing. public void EnableProfiling(bool excludeKeys = false, params ProfilingKey[] keys) Parameters excludeKeys bool If true the keys specified after are excluded from rendering, if false they will be exclusively included. keys ProfilingKey[] The keys to exclude or include."
  },
  "api/Stride.Profiling.GcProfiling.html": {
    "href": "api/Stride.Profiling.GcProfiling.html",
    "title": "Class GcProfiling | Stride API",
    "summary": "Class GcProfiling Namespace Stride.Profiling Assembly Stride.Engine.dll public class GcProfiling : IDisposable Inheritance object GcProfiling Implements IDisposable Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors GcProfiling() public GcProfiling() Fields GcCollectionCountKey public static ProfilingKey GcCollectionCountKey Field Value ProfilingKey GcMemoryKey public static ProfilingKey GcMemoryKey Field Value ProfilingKey Methods Disable() public void Disable() Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Enable() public void Enable() Tick() public void Tick()"
  },
  "api/Stride.Profiling.html": {
    "href": "api/Stride.Profiling.html",
    "title": "Namespace Stride.Profiling | Stride API",
    "summary": "Namespace Stride.Profiling Classes DebugTextSystem GameProfilingSystem GcProfiling Enums GameProfilingResults GameProfilingSorting"
  },
  "api/Stride.Rendering.ActiveRenderStage.html": {
    "href": "api/Stride.Rendering.ActiveRenderStage.html",
    "title": "Struct ActiveRenderStage | Stride API",
    "summary": "Struct ActiveRenderStage Namespace Stride.Rendering Assembly Stride.Rendering.dll public struct ActiveRenderStage Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors ActiveRenderStage(string) public ActiveRenderStage(string effectName) Parameters effectName string Fields EffectSelector public EffectSelector EffectSelector Field Value EffectSelector Properties Active public bool Active { get; } Property Value bool"
  },
  "api/Stride.Rendering.AssemblyEffectKeysAttribute.html": {
    "href": "api/Stride.Rendering.AssemblyEffectKeysAttribute.html",
    "title": "Class AssemblyEffectKeysAttribute | Stride API",
    "summary": "Class AssemblyEffectKeysAttribute Namespace Stride.Rendering Assembly Stride.dll Assembly attribute used to mark assembly that has been preprocessed using the ParameterKeyProcessor. Assemblies without this attribute will have all of their type members tagged with EffectKeysAttribute scanned for ParameterKey. [AttributeUsage(AttributeTargets.Assembly)] public class AssemblyEffectKeysAttribute : Attribute Inheritance object Attribute AssemblyEffectKeysAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Rendering.BackToFrontSortMode.html": {
    "href": "api/Stride.Rendering.BackToFrontSortMode.html",
    "title": "Class BackToFrontSortMode | Stride API",
    "summary": "Class BackToFrontSortMode Namespace Stride.Rendering Assembly Stride.Rendering.dll Sort elements according to the pattern: [RenderFeature Sort Key 8 bits] [Distance back to front 32 bits] [RenderObject states 24 bits] [DataContract(\"BackToFrontSortMode\")] public class BackToFrontSortMode : SortModeDistance Inheritance object SortMode SortModeDistance BackToFrontSortMode Inherited Members SortModeDistance.distancePosition SortModeDistance.distancePrecision SortModeDistance.statePosition SortModeDistance.statePrecision SortModeDistance.ComputeDistance(float) SortModeDistance.CreateSortKey(float) SortModeDistance.GenerateSortKey(RenderView, RenderViewStage, SortKey*) Extension Methods UnsafeUtilities.As<T>(object?) Constructors BackToFrontSortMode() public BackToFrontSortMode()"
  },
  "api/Stride.Rendering.Background.BackgroundRenderFeature.html": {
    "href": "api/Stride.Rendering.Background.BackgroundRenderFeature.html",
    "title": "Class BackgroundRenderFeature | Stride API",
    "summary": "Class BackgroundRenderFeature Namespace Stride.Rendering.Background Assembly Stride.Rendering.dll public class BackgroundRenderFeature : RootRenderFeature, IComponent, IReferencable, ICollectorHolder, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RenderFeature RootRenderFeature BackgroundRenderFeature Implements IComponent IReferencable ICollectorHolder IGraphicsRendererCore IDisposable Inherited Members RootRenderFeature.RenderData RootRenderFeature.Index RootRenderFeature.SortKey RootRenderFeature.RenderObjects RootRenderFeature.ObjectNodeReferences RootRenderFeature.RenderNodes RootRenderFeature.RenderStageSelectors RootRenderFeature.Unload() RootRenderFeature.GetRenderNode(RenderNodeReference) RootRenderFeature.GetViewObjectNode(ViewObjectNodeReference) RootRenderFeature.GetObjectNode(ObjectNodeReference) RootRenderFeature.CreateViewObjectNode(RenderView, RenderObject) RootRenderFeature.OnAddRenderObject(RenderObject) RootRenderFeature.OnRemoveRenderObject(RenderObject) RootRenderFeature.Reset() RootRenderFeature.PrepareDataArrays() RootRenderFeature.ComputeDataArrayExpectedSize(DataType) RootRenderFeature.BindPerViewShaderResource(string, RenderView, GraphicsResource) RenderFeature.Context RenderFeature.RenderSystem RenderFeature.Initialized RenderFeature.Enabled RenderFeature.Initialize(RenderContext) RenderFeature.Destroy() RenderFeature.Collect() RenderFeature.Extract() RenderFeature.PrepareEffectPermutations(RenderDrawContext) RenderFeature.Draw(RenderDrawContext, RenderView, RenderViewStage) RenderFeature.Flush(RenderDrawContext) RenderFeature.OnRenderSystemChanged() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors BackgroundRenderFeature() public BackgroundRenderFeature() Properties SupportedRenderObjectType Gets the type of render object supported by this RootRenderFeature. public override Type SupportedRenderObjectType { get; } Property Value Type Methods Draw(RenderDrawContext, RenderView, RenderViewStage, int, int) Performs GPU updates and/or draw. public override void Draw(RenderDrawContext context, RenderView renderView, RenderViewStage renderViewStage, int startIndex, int endIndex) Parameters context RenderDrawContext renderView RenderView renderViewStage RenderViewStage startIndex int endIndex int InitializeCore() Initializes this instance. Query for specific cbuffer (either new one, like PerMaterial, or parts of an existing one, like PerObject=>Skinning) protected override void InitializeCore() Prepare(RenderDrawContext) Performs most of the work (computation and resource preparation). Later game simulation might be running during that step. public override void Prepare(RenderDrawContext context) Parameters context RenderDrawContext"
  },
  "api/Stride.Rendering.Background.BackgroundRenderProcessor.html": {
    "href": "api/Stride.Rendering.Background.BackgroundRenderProcessor.html",
    "title": "Class BackgroundRenderProcessor | Stride API",
    "summary": "Class BackgroundRenderProcessor Namespace Stride.Rendering.Background Assembly Stride.Engine.dll A default entity processor for BackgroundComponent. public class BackgroundRenderProcessor : EntityProcessor<BackgroundComponent, RenderBackground>, IEntityComponentRenderProcessor Inheritance object EntityProcessor EntityProcessor<BackgroundComponent, RenderBackground> BackgroundRenderProcessor Implements IEntityComponentRenderProcessor Inherited Members EntityProcessor<BackgroundComponent, RenderBackground>.ComponentDatas EntityProcessor<BackgroundComponent, RenderBackground>.OnSystemAdd() EntityProcessor<BackgroundComponent, RenderBackground>.OnSystemRemove() EntityProcessor<BackgroundComponent, RenderBackground>.RemoveAllEntities() EntityProcessor<BackgroundComponent, RenderBackground>.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor<BackgroundComponent, RenderBackground>.GenerateComponentData(Entity, BackgroundComponent) EntityProcessor<BackgroundComponent, RenderBackground>.IsAssociatedDataValid(Entity, BackgroundComponent, RenderBackground) EntityProcessor<BackgroundComponent, RenderBackground>.OnEntityComponentAdding(Entity, BackgroundComponent, RenderBackground) EntityProcessor<BackgroundComponent, RenderBackground>.OnEntityComponentRemoved(Entity, BackgroundComponent, RenderBackground) EntityProcessor.Tags EntityProcessor.UpdateProfilingState EntityProcessor.DrawProfilingState EntityProcessor.Enabled EntityProcessor.MainComponentType EntityProcessor.RequiredTypes EntityProcessor.HasRequiredComponents EntityProcessor.Order EntityProcessor.EntityManager EntityProcessor.Services EntityProcessor.Update(GameTime) EntityProcessor.OnSystemAdd() EntityProcessor.RemoveAllEntities() EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool) EntityProcessor.InternalAddEntity(Entity) EntityProcessor.InternalRemoveEntity(Entity, bool) Extension Methods UnsafeUtilities.As<T>(object?) Properties ActiveBackground Gets the active background. public RenderBackground ActiveBackground { get; } Property Value RenderBackground The active background. VisibilityGroup public VisibilityGroup VisibilityGroup { get; set; } Property Value VisibilityGroup Methods Draw(RenderContext) Performs work related to this processor. public override void Draw(RenderContext context) Parameters context RenderContext GenerateComponentData(Entity, BackgroundComponent) Generates associated data to the given entity. protected override RenderBackground GenerateComponentData(Entity entity, BackgroundComponent component) Parameters entity Entity The entity. component BackgroundComponent Returns RenderBackground The associated data. IsAssociatedDataValid(Entity, BackgroundComponent, RenderBackground) Checks if the current associated data is valid, or if readding the entity is required. protected override bool IsAssociatedDataValid(Entity entity, BackgroundComponent component, RenderBackground associatedData) Parameters entity Entity The entity. component BackgroundComponent associatedData RenderBackground The associated data. Returns bool True if the change in associated data requires the entity to be readded, false otherwise. OnSystemRemove() Run when this EntityProcessor is removed from an EntityManager. protected override void OnSystemRemove()"
  },
  "api/Stride.Rendering.Background.RenderBackground.html": {
    "href": "api/Stride.Rendering.Background.RenderBackground.html",
    "title": "Class RenderBackground | Stride API",
    "summary": "Class RenderBackground Namespace Stride.Rendering.Background Assembly Stride.Rendering.dll public class RenderBackground : RenderObject Inheritance object RenderObject RenderBackground Inherited Members RenderObject.Enabled RenderObject.RenderGroup RenderObject.BoundingBox RenderObject.RenderFeature RenderObject.ObjectNode RenderObject.StaticObjectNode RenderObject.VisibilityObjectNode RenderObject.ActiveRenderStages RenderObject.StateSortKey RenderObject.Index RenderObject.Source Extension Methods UnsafeUtilities.As<T>(object?) Fields Intensity public float Intensity Field Value float Is2D public bool Is2D Field Value bool Rotation public Quaternion Rotation Field Value Quaternion Texture public Texture Texture Field Value Texture"
  },
  "api/Stride.Rendering.Background.html": {
    "href": "api/Stride.Rendering.Background.html",
    "title": "Namespace Stride.Rendering.Background | Stride API",
    "summary": "Namespace Stride.Rendering.Background Classes BackgroundRenderFeature BackgroundRenderProcessor A default entity processor for BackgroundComponent. RenderBackground"
  },
  "api/Stride.Rendering.BackgroundCubemapShaderKeys.html": {
    "href": "api/Stride.Rendering.BackgroundCubemapShaderKeys.html",
    "title": "Class BackgroundCubemapShaderKeys | Stride API",
    "summary": "Class BackgroundCubemapShaderKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll public static class BackgroundCubemapShaderKeys Inheritance object BackgroundCubemapShaderKeys Fields Cubemap public static readonly ObjectParameterKey<Texture> Cubemap Field Value ObjectParameterKey<Texture>"
  },
  "api/Stride.Rendering.BackgroundShaderKeys.html": {
    "href": "api/Stride.Rendering.BackgroundShaderKeys.html",
    "title": "Class BackgroundShaderKeys | Stride API",
    "summary": "Class BackgroundShaderKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll public static class BackgroundShaderKeys Inheritance object BackgroundShaderKeys Fields Intensity public static readonly ValueParameterKey<float> Intensity Field Value ValueParameterKey<float>"
  },
  "api/Stride.Rendering.BackgroundVelocityKeys.html": {
    "href": "api/Stride.Rendering.BackgroundVelocityKeys.html",
    "title": "Class BackgroundVelocityKeys | Stride API",
    "summary": "Class BackgroundVelocityKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll public static class BackgroundVelocityKeys Inheritance object BackgroundVelocityKeys Fields DeltaMatrix public static readonly ValueParameterKey<Matrix> DeltaMatrix Field Value ValueParameterKey<Matrix>"
  },
  "api/Stride.Rendering.CameraComponentRendererExtensions.html": {
    "href": "api/Stride.Rendering.CameraComponentRendererExtensions.html",
    "title": "Class CameraComponentRendererExtensions | Stride API",
    "summary": "Class CameraComponentRendererExtensions Namespace Stride.Rendering Assembly Stride.Engine.dll public static class CameraComponentRendererExtensions Inheritance object CameraComponentRendererExtensions Fields Current Property key to access the current collection of CameraComponent from Tags. public static readonly PropertyKey<CameraComponent> Current Field Value PropertyKey<CameraComponent> Methods GetCurrentCamera(RenderContext) public static CameraComponent GetCurrentCamera(this RenderContext context) Parameters context RenderContext Returns CameraComponent"
  },
  "api/Stride.Rendering.CameraCubeKeys.html": {
    "href": "api/Stride.Rendering.CameraCubeKeys.html",
    "title": "Class CameraCubeKeys | Stride API",
    "summary": "Class CameraCubeKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll public static class CameraCubeKeys Inheritance object CameraCubeKeys Fields CameraViewProjectionMatrices public static readonly ValueParameterKey<Matrix> CameraViewProjectionMatrices Field Value ValueParameterKey<Matrix> CameraWorldPosition public static readonly ValueParameterKey<Vector3> CameraWorldPosition Field Value ValueParameterKey<Vector3>"
  },
  "api/Stride.Rendering.CameraCullingMode.html": {
    "href": "api/Stride.Rendering.CameraCullingMode.html",
    "title": "Enum CameraCullingMode | Stride API",
    "summary": "Enum CameraCullingMode Namespace Stride.Rendering Assembly Stride.Rendering.dll Culling mode of a RenderView. public enum CameraCullingMode Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Frustum = 1 Meshes outside of the camera's view frustum will be culled. None = 0 No culling is applied to meshes."
  },
  "api/Stride.Rendering.CameraKeys.html": {
    "href": "api/Stride.Rendering.CameraKeys.html",
    "title": "Class CameraKeys | Stride API",
    "summary": "Class CameraKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll Keys used by transformations. public static class CameraKeys Inheritance object CameraKeys Fields AspectRatio public static readonly ValueParameterKey<float> AspectRatio Field Value ValueParameterKey<float> FarClipPlane public static readonly ValueParameterKey<float> FarClipPlane Field Value ValueParameterKey<float> FocusDistance Camera focus distance public static readonly ValueParameterKey<float> FocusDistance Field Value ValueParameterKey<float> NearClipPlane public static readonly ValueParameterKey<float> NearClipPlane Field Value ValueParameterKey<float> ViewSize public static readonly ValueParameterKey<Vector2> ViewSize Field Value ValueParameterKey<Vector2> ZProjection public static readonly ValueParameterKey<Vector2> ZProjection Field Value ValueParameterKey<Vector2> Methods ZProjectionACalculate(float, float) public static Vector2 ZProjectionACalculate(float nearClipPlane, float farClipPlane) Parameters nearClipPlane float farClipPlane float Returns Vector2"
  },
  "api/Stride.Rendering.ClearRendererFlags.html": {
    "href": "api/Stride.Rendering.ClearRendererFlags.html",
    "title": "Enum ClearRendererFlags | Stride API",
    "summary": "Enum ClearRendererFlags Namespace Stride.Rendering Assembly Stride.Rendering.dll Flags used to clear a render frame. [DataContract(\"ClearRenderFrameFlags\")] public enum ClearRendererFlags Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields [Display(\"Color and Depth\", null)] [DataAlias(\"Color\")] ColorAndDepth = 0 Clears both the Color and DepthStencil buffer. [Display(\"Color Only\", null)] ColorOnly = 1 Clears only the Color buffer. [Display(\"Depth Only\", null)] DepthOnly = 2 Clears only the depth."
  },
  "api/Stride.Rendering.Colors.ColorRgbProvider.html": {
    "href": "api/Stride.Rendering.Colors.ColorRgbProvider.html",
    "title": "Class ColorRgbProvider | Stride API",
    "summary": "Class ColorRgbProvider Namespace Stride.Rendering.Colors Assembly Stride.Rendering.dll A light color described by a rgb color [DataContract(\"ColorRgbProvider\")] [DataAlias(\"LightColorRgb\")] [Display(\"RGB\", null)] public class ColorRgbProvider : IColorProvider Inheritance object ColorRgbProvider Implements IColorProvider Extension Methods UnsafeUtilities.As<T>(object?) Constructors ColorRgbProvider() Initializes a new instance of the ColorRgbProvider class. public ColorRgbProvider() ColorRgbProvider(Color) Initializes a new instance of the ColorRgbProvider class. public ColorRgbProvider(Color color) Parameters color Color The color. ColorRgbProvider(Color3) Initializes a new instance of the ColorRgbProvider class. public ColorRgbProvider(Color3 color) Parameters color Color3 The color. Properties Value Gets or sets the light color in rgb. [DataMember(10)] [DataAlias(\"Color\")] public Color3 Value { get; set; } Property Value Color3 The color. Methods ComputeColor() Computes the color of the light (sRgb space). public Color3 ComputeColor() Returns Color3 Color3."
  },
  "api/Stride.Rendering.Colors.IColorProvider.html": {
    "href": "api/Stride.Rendering.Colors.IColorProvider.html",
    "title": "Interface IColorProvider | Stride API",
    "summary": "Interface IColorProvider Namespace Stride.Rendering.Colors Assembly Stride.Rendering.dll Defines the interface for describing the color of a light. public interface IColorProvider Extension Methods UnsafeUtilities.As<T>(object?) Methods ComputeColor() Computes the color of the light (sRgb space). Color3 ComputeColor() Returns Color3 Color3."
  },
  "api/Stride.Rendering.Colors.html": {
    "href": "api/Stride.Rendering.Colors.html",
    "title": "Namespace Stride.Rendering.Colors | Stride API",
    "summary": "Namespace Stride.Rendering.Colors Classes ColorRgbProvider A light color described by a rgb color Interfaces IColorProvider Defines the interface for describing the color of a light."
  },
  "api/Stride.Rendering.Compositing.ClearRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.ClearRenderer.html",
    "title": "Class ClearRenderer | Stride API",
    "summary": "Class ClearRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll A renderer to clear a render frame. [Display(\"Clear\", null)] public class ClearRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase ClearRenderer Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) SceneRendererBase.CollectCore(RenderContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ClearRenderer() Initializes a new instance of the ClearRenderer class. public ClearRenderer() Properties ClearFlags Gets or sets the clear flags. [DataMember(10)] [Display(\"Clear Flags\", null)] public ClearRendererFlags ClearFlags { get; set; } Property Value ClearRendererFlags The clear flags. Color Gets or sets the clear color. [DataMember(20)] [Display(\"Color\", null)] public Color4 Color { get; set; } Property Value Color4 The clear color. Depth Gets or sets the depth value used to clear the depth stencil buffer. [DataMember(30)] [Display(\"Depth Value\", null)] public float Depth { get; set; } Property Value float The depth value used to clear the depth stencil buffer. Stencil Gets or sets the stencil value used to clear the depth stencil buffer. [DataMember(40)] [Display(\"Stencil Value\", null)] public byte Stencil { get; set; } Property Value byte The stencil value used to clear the depth stencil buffer. Methods DrawCore(RenderContext, RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderContext context, RenderDrawContext drawContext) Parameters context RenderContext drawContext RenderDrawContext"
  },
  "api/Stride.Rendering.Compositing.ColorTargetSemantic.html": {
    "href": "api/Stride.Rendering.Compositing.ColorTargetSemantic.html",
    "title": "Class ColorTargetSemantic | Stride API",
    "summary": "Class ColorTargetSemantic Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public class ColorTargetSemantic : IRenderTargetSemantic Inheritance object ColorTargetSemantic Implements IRenderTargetSemantic Extension Methods UnsafeUtilities.As<T>(object?) Properties ShaderClass The shader class deriving from ComputeColor that is used as a composition to output to the render target public ShaderSource ShaderClass { get; } Property Value ShaderSource"
  },
  "api/Stride.Rendering.Compositing.CompositingProfilingKeys.html": {
    "href": "api/Stride.Rendering.Compositing.CompositingProfilingKeys.html",
    "title": "Class CompositingProfilingKeys | Stride API",
    "summary": "Class CompositingProfilingKeys Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public class CompositingProfilingKeys Inheritance object CompositingProfilingKeys Extension Methods UnsafeUtilities.As<T>(object?) Fields Compositing public static readonly ProfilingKey Compositing Field Value ProfilingKey GBuffer public static readonly ProfilingKey GBuffer Field Value ProfilingKey LightShafts public static readonly ProfilingKey LightShafts Field Value ProfilingKey MsaaResolve public static readonly ProfilingKey MsaaResolve Field Value ProfilingKey Opaque public static readonly ProfilingKey Opaque Field Value ProfilingKey Transparent public static readonly ProfilingKey Transparent Field Value ProfilingKey"
  },
  "api/Stride.Rendering.Compositing.DebugRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.DebugRenderer.html",
    "title": "Class DebugRenderer | Stride API",
    "summary": "Class DebugRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll [Display(\"Debug renderer\", null)] public class DebugRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererCore, IDisposable, ISharedRenderer, IIdentifiable, IGraphicsRendererBase Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase DebugRenderer Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererCore IDisposable ISharedRenderer IIdentifiable IGraphicsRendererBase Inherited Members SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties DebugRenderStages public List<RenderStage> DebugRenderStages { get; } Property Value List<RenderStage> Methods CollectCore(RenderContext) Main collect method. protected override void CollectCore(RenderContext context) Parameters context RenderContext DrawCore(RenderContext, RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderContext context, RenderDrawContext drawContext) Parameters context RenderContext drawContext RenderDrawContext"
  },
  "api/Stride.Rendering.Compositing.DelegateSceneRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.DelegateSceneRenderer.html",
    "title": "Class DelegateSceneRenderer | Stride API",
    "summary": "Class DelegateSceneRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll A renderer which can provide Draw(RenderDrawContext) implementation with a delegate. public class DelegateSceneRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase DelegateSceneRenderer Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) SceneRendererBase.CollectCore(RenderContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DelegateSceneRenderer(Action<RenderDrawContext>) public DelegateSceneRenderer(Action<RenderDrawContext> drawAction) Parameters drawAction Action<RenderDrawContext> Methods DrawCore(RenderContext, RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderContext context, RenderDrawContext drawContext) Parameters context RenderContext drawContext RenderDrawContext"
  },
  "api/Stride.Rendering.Compositing.EditorTopLevelCompositor.html": {
    "href": "api/Stride.Rendering.Compositing.EditorTopLevelCompositor.html",
    "title": "Class EditorTopLevelCompositor | Stride API",
    "summary": "Class EditorTopLevelCompositor Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll Used by editor as top level compositor. public class EditorTopLevelCompositor : SceneExternalCameraRenderer, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererCore, IDisposable, ISharedRenderer, IIdentifiable, IGraphicsRendererBase Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase SceneCameraRenderer SceneExternalCameraRenderer EditorTopLevelCompositor Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererCore IDisposable ISharedRenderer IIdentifiable IGraphicsRendererBase Inherited Members SceneExternalCameraRenderer.ExternalCamera SceneExternalCameraRenderer.ResolveCamera(RenderContext) SceneCameraRenderer.RenderView SceneCameraRenderer.Camera SceneCameraRenderer.Child SceneCameraRenderer.RenderMask SceneCameraRenderer.Logger SceneCameraRenderer.CollectCore(RenderContext) SceneCameraRenderer.DrawCore(RenderContext, RenderDrawContext) SceneCameraRenderer.UpdateCameraToRenderView(RenderContext, RenderView, CameraComponent) SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties EnablePreviewGame When true, PreviewGame will be used as compositor. public bool EnablePreviewGame { get; set; } Property Value bool PostGizmoCompositors public List<ISceneRenderer> PostGizmoCompositors { get; } Property Value List<ISceneRenderer> PreGizmoCompositors public List<ISceneRenderer> PreGizmoCompositors { get; } Property Value List<ISceneRenderer> PreviewGame Compositor for previewing game, used when EnablePreviewGame is true. public ISceneRenderer PreviewGame { get; set; } Property Value ISceneRenderer Methods CollectInner(RenderContext) protected override void CollectInner(RenderContext context) Parameters context RenderContext DrawInner(RenderDrawContext) protected override void DrawInner(RenderDrawContext context) Parameters context RenderDrawContext"
  },
  "api/Stride.Rendering.Compositing.EnvironmentLightRoughnessTargetSemantic.html": {
    "href": "api/Stride.Rendering.Compositing.EnvironmentLightRoughnessTargetSemantic.html",
    "title": "Class EnvironmentLightRoughnessTargetSemantic | Stride API",
    "summary": "Class EnvironmentLightRoughnessTargetSemantic Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public class EnvironmentLightRoughnessTargetSemantic : IRenderTargetSemantic Inheritance object EnvironmentLightRoughnessTargetSemantic Implements IRenderTargetSemantic Extension Methods UnsafeUtilities.As<T>(object?) Properties ShaderClass The shader class deriving from ComputeColor that is used as a composition to output to the render target public ShaderSource ShaderClass { get; } Property Value ShaderSource"
  },
  "api/Stride.Rendering.Compositing.ForceAspectRatioSceneRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.ForceAspectRatioSceneRenderer.html",
    "title": "Class ForceAspectRatioSceneRenderer | Stride API",
    "summary": "Class ForceAspectRatioSceneRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public class ForceAspectRatioSceneRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase ForceAspectRatioSceneRenderer Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields DefaultAspectRatio public const float DefaultAspectRatio = 1.7777778 Field Value float Properties Child public ISceneRenderer Child { get; set; } Property Value ISceneRenderer FixedAspectRatio Gets or sets the aspect ratio. public float FixedAspectRatio { get; set; } Property Value float The aspect ratio. ForceAspectRatio Gets or sets a value wether to edit the Viewport to force the aspect ratio and add letterboxes or pillarboxes where needed public bool ForceAspectRatio { get; set; } Property Value bool Methods CollectCore(RenderContext) Main collect method. protected override void CollectCore(RenderContext context) Parameters context RenderContext DrawCore(RenderContext, RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderContext context, RenderDrawContext drawContext) Parameters context RenderContext drawContext RenderDrawContext"
  },
  "api/Stride.Rendering.Compositing.ForwardRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.ForwardRenderer.html",
    "title": "Class ForwardRenderer | Stride API",
    "summary": "Class ForwardRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll Renders your game. It should use current RenderView and GetCurrentCamera(RenderContext). [Display(\"Forward renderer\", null)] public class ForwardRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererCore, IDisposable, ISharedRenderer, IIdentifiable, IGraphicsRendererBase Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase ForwardRenderer Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererCore IDisposable ISharedRenderer IIdentifiable IGraphicsRendererBase Inherited Members SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Fields DepthBufferFormat public const PixelFormat DepthBufferFormat = D24_UNorm_S8_UInt Field Value PixelFormat viewDepthStencil protected Texture viewDepthStencil Field Value Texture viewOutputTarget protected Texture viewOutputTarget Field Value Texture Properties BindDepthAsResourceDuringTransparentRendering If true, depth buffer generated during OpaqueRenderStage will be available as a shader resource named DepthBase.DepthStencil during TransparentRenderStage. public bool BindDepthAsResourceDuringTransparentRendering { get; set; } Property Value bool Remarks This is needed by some effects such as particles soft edges. On recent platforms that can bind depth buffer as read-only (HasDepthAsReadOnlyRT), depth buffer will be used as is. Otherwise, a copy will be generated. BindOpaqueAsResourceDuringTransparentRendering If true, render target generated during OpaqueRenderStage will be available as a shader resource named OpaqueBase.OpaqueRenderTarget during TransparentRenderStage. public bool BindOpaqueAsResourceDuringTransparentRendering { get; set; } Property Value bool Clear public ClearRenderer Clear { get; set; } Property Value ClearRenderer GBufferRenderStage The G-Buffer render stage to render depth buffer and possibly some other extra info to buffers (i.e. normals) public RenderStage GBufferRenderStage { get; set; } Property Value RenderStage LightProbes Enable Light Probe. public bool LightProbes { get; set; } Property Value bool LightShafts Light shafts effect public LightShafts LightShafts { get; set; } Property Value LightShafts MSAALevel The level of multi-sampling public MultisampleCount MSAALevel { get; set; } Property Value MultisampleCount MSAAResolver MSAA Resolver is used to resolve multi-sampled render targets into normal render targets public MSAAResolver MSAAResolver { get; } Property Value MSAAResolver OpaqueRenderStage The main render stage for opaque geometry. public RenderStage OpaqueRenderStage { get; set; } Property Value RenderStage PostEffects The post effects renderer. public IPostProcessingEffects PostEffects { get; set; } Property Value IPostProcessingEffects ShadowMapRenderStages The shadow map render stages for shadow casters. No shadow rendering will happen if null. public List<RenderStage> ShadowMapRenderStages { get; } Property Value List<RenderStage> SubsurfaceScatteringBlurEffect Separable subsurface scattering effect public SubsurfaceScatteringBlur SubsurfaceScatteringBlurEffect { get; set; } Property Value SubsurfaceScatteringBlur TransparentRenderStage The transparent render stage for transparent geometry. public RenderStage TransparentRenderStage { get; set; } Property Value RenderStage VRSettings Virtual Reality related settings public VRRendererSettings VRSettings { get; set; } Property Value VRRendererSettings ViewCount protected int ViewCount { get; } Property Value int ViewIndex protected int ViewIndex { get; } Property Value int Methods CollectCore(RenderContext) Main collect method. protected override void CollectCore(RenderContext context) Parameters context RenderContext CollectStages(RenderContext) protected virtual void CollectStages(RenderContext context) Parameters context RenderContext CollectView(RenderContext) protected virtual void CollectView(RenderContext context) Parameters context RenderContext ComputeNonMSAADepthFormat(PixelFormat) protected static PixelFormat ComputeNonMSAADepthFormat(PixelFormat format) Parameters format PixelFormat Returns PixelFormat Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. DrawCore(RenderContext, RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderContext context, RenderDrawContext drawContext) Parameters context RenderContext drawContext RenderDrawContext DrawView(RenderContext, RenderDrawContext, int, int) protected virtual void DrawView(RenderContext context, RenderDrawContext drawContext, int eyeIndex, int eyeCount) Parameters context RenderContext drawContext RenderDrawContext eyeIndex int eyeCount int InitializeCore() protected override void InitializeCore() PrepareRenderTargets(RenderDrawContext, Size2) Prepares targets per frame, caching and handling MSAA etc. protected virtual void PrepareRenderTargets(RenderDrawContext drawContext, Size2 renderTargetsSize) Parameters drawContext RenderDrawContext The current draw context renderTargetsSize Size2 The render target size ValidateOpaqueStageOutput(RenderOutputValidator, RenderContext) protected virtual void ValidateOpaqueStageOutput(RenderOutputValidator renderOutputValidator, RenderContext renderContext) Parameters renderOutputValidator RenderOutputValidator renderContext RenderContext"
  },
  "api/Stride.Rendering.Compositing.GraphicsCompositor.html": {
    "href": "api/Stride.Rendering.Compositing.GraphicsCompositor.html",
    "title": "Class GraphicsCompositor | Stride API",
    "summary": "Class GraphicsCompositor Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll The GraphicsCompositor class organizes how scenes are rendered in the Stride engine, providing extensive customization of the rendering pipeline. [DataSerializerGlobal(typeof(ReferenceSerializer<GraphicsCompositor>), null, DataSerializerGenericMode.None, false, false, Profile = \"Content\")] [ContentSerializer(typeof(DataContentSerializerWithReuse<GraphicsCompositor>))] [DataContract] [DataSerializerGlobal(null, typeof(FastTrackingCollection<RenderStage>), DataSerializerGenericMode.None, false, false)] [DataSerializerGlobal(null, typeof(FastTrackingCollection<RootRenderFeature>), DataSerializerGenericMode.None, false, false)] public class GraphicsCompositor : RendererBase, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase RendererBase GraphicsCompositor Implements IComponent IReferencable ICollectorHolder IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members RendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks This class handles the initialization and destruction of the render system, manages the cameras used in the composition, and controls the render stages and features. It provides entry points for the game compositor, a single view compositor, and a compositor used by the scene editor. Key features of the GraphicsCompositor include: Using one or multiple cameras Filtering entities Rendering to one or more render textures with different viewports Setting HDR or LDR rendering Applying post effects to a render target Clearing a render target or only the depth buffer Editable in the Game Studio and at runtime from scripts For more information, see the Graphics Compositor documentation. Fields Current A property key to get the current GraphicsCompositor from the Tags. public static readonly PropertyKey<GraphicsCompositor> Current Field Value PropertyKey<GraphicsCompositor> Properties Cameras Gets the cameras used by this composition. [DataMember(10)] public SceneCameraSlotCollection Cameras { get; } Property Value SceneCameraSlotCollection The cameras. Editor The entry point for a compositor used by the scene editor. public ISceneRenderer Editor { get; set; } Property Value ISceneRenderer Game The entry point for the game compositor. public ISceneRenderer Game { get; set; } Property Value ISceneRenderer RenderFeatures The list of render features. [DataMember(30)] public IList<RootRenderFeature> RenderFeatures { get; } Property Value IList<RootRenderFeature> RenderStages The list of render stages. [DataMember(20)] public IList<RenderStage> RenderStages { get; } Property Value IList<RenderStage> RenderSystem Gets the render system used with this graphics compositor. public RenderSystem RenderSystem { get; } Property Value RenderSystem SingleView The entry point for a compositor that can render a single view. public ISceneRenderer SingleView { get; set; } Property Value ISceneRenderer Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. DrawCore(RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderDrawContext context) Parameters context RenderDrawContext The context. InitializeCore() protected override void InitializeCore()"
  },
  "api/Stride.Rendering.Compositing.GraphicsCompositorHelper.html": {
    "href": "api/Stride.Rendering.Compositing.GraphicsCompositorHelper.html",
    "title": "Class GraphicsCompositorHelper | Stride API",
    "summary": "Class GraphicsCompositorHelper Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll Helper functions for creating GraphicsCompositor. public static class GraphicsCompositorHelper Inheritance object GraphicsCompositorHelper Methods CreateDefault(bool, string, CameraComponent, Color4?, GraphicsProfile, RenderGroupMask) Creates a typical graphics compositor programatically. It can render meshes, sprites and backgrounds. public static GraphicsCompositor CreateDefault(bool enablePostEffects, string modelEffectName = \"StrideForwardShadingEffect\", CameraComponent camera = null, Color4? clearColor = null, GraphicsProfile graphicsProfile = GraphicsProfile.Level_10_0, RenderGroupMask groupMask = RenderGroupMask.All) Parameters enablePostEffects bool modelEffectName string camera CameraComponent clearColor Color4? graphicsProfile GraphicsProfile groupMask RenderGroupMask Returns GraphicsCompositor"
  },
  "api/Stride.Rendering.Compositing.IRenderTargetSemantic.html": {
    "href": "api/Stride.Rendering.Compositing.IRenderTargetSemantic.html",
    "title": "Interface IRenderTargetSemantic | Stride API",
    "summary": "Interface IRenderTargetSemantic Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll The usage of a render target public interface IRenderTargetSemantic Extension Methods UnsafeUtilities.As<T>(object?) Properties ShaderClass The shader class deriving from ComputeColor that is used as a composition to output to the render target ShaderSource ShaderClass { get; } Property Value ShaderSource"
  },
  "api/Stride.Rendering.Compositing.ISceneGraphicsCompositor.html": {
    "href": "api/Stride.Rendering.Compositing.ISceneGraphicsCompositor.html",
    "title": "Interface ISceneGraphicsCompositor | Stride API",
    "summary": "Interface ISceneGraphicsCompositor Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll Defines the common interface for a graphics composer responsible to compose the scene to a final render target. public interface ISceneGraphicsCompositor : IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inherited Members IGraphicsRendererBase.Draw(RenderDrawContext) IGraphicsRendererCore.Enabled IGraphicsRendererCore.Initialized IGraphicsRendererCore.Initialize(RenderContext) IDisposable.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Rendering.Compositing.ISceneRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.ISceneRenderer.html",
    "title": "Interface ISceneRenderer | Stride API",
    "summary": "Interface ISceneRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public interface ISceneRenderer : IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inherited Members IRenderCollector.Collect(RenderContext) IGraphicsRendererBase.Draw(RenderDrawContext) IGraphicsRendererCore.Enabled IGraphicsRendererCore.Initialized IGraphicsRendererCore.Initialize(RenderContext) IDisposable.Dispose() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Rendering.Compositing.ISharedRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.ISharedRenderer.html",
    "title": "Interface ISharedRenderer | Stride API",
    "summary": "Interface ISharedRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public interface ISharedRenderer : IIdentifiable, IGraphicsRendererBase Inherited Members IIdentifiable.Id IGraphicsRendererBase.Draw(RenderDrawContext) Extension Methods UnsafeUtilities.As<T>(object?) Properties Name string Name { get; } Property Value string"
  },
  "api/Stride.Rendering.Compositing.MSAAResolver.FilterTypes.html": {
    "href": "api/Stride.Rendering.Compositing.MSAAResolver.FilterTypes.html",
    "title": "Enum MSAAResolver.FilterTypes | Stride API",
    "summary": "Enum MSAAResolver.FilterTypes Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll MSAA resolve shader modes. public enum MSAAResolver.FilterTypes Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields BSpline = 6 B-Spline filter. BlackmanHarris = 4 Blackman Harris filter. Box = 1 Box filter. CatmullRom = 7 Catmull Rom filter. Default = 0 Default filter Gaussian = 3 Gaussian filter. Mitchell = 8 Mitchell filter. Sinc = 9 Sinus function filter. SmoothStep = 5 Smoothstep function filter. Triangle = 2 Triangle filter."
  },
  "api/Stride.Rendering.Compositing.MSAAResolver.html": {
    "href": "api/Stride.Rendering.Compositing.MSAAResolver.html",
    "title": "Class MSAAResolver | Stride API",
    "summary": "Class MSAAResolver Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll A renderer to resolve MSAA textures. [DataContract] [Display(\"MSAA Resolver\", null)] public class MSAAResolver : ImageEffect, IComponent, IReferencable, ICollectorHolder, IImageEffect, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase RendererBase DrawEffect ImageEffect MSAAResolver Implements IComponent IReferencable ICollectorHolder IImageEffect IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members ImageEffect.EnableSetRenderTargets ImageEffect.SetInput(int, Texture) ImageEffect.Reset() ImageEffect.SetOutput(Texture) ImageEffect.SetOutput(params Texture[]) ImageEffect.SetDepthOutput(Texture, Texture) ImageEffect.SetDepthOutput(Texture, params Texture[]) ImageEffect.SetViewport(Viewport?) ImageEffect.SetViewports(ReadOnlySpan<Viewport>) ImageEffect.SetScissorRectangle(Rectangle?) ImageEffect.SetScissorRectangles(ReadOnlySpan<Rectangle>) ImageEffect.PreDrawCore(RenderDrawContext) ImageEffect.SetRenderTargets(RenderDrawContext) ImageEffect.PostDrawCore(RenderDrawContext) ImageEffect.DisposeCreatedRenderTargetViews(RenderDrawContext) ImageEffect.InputCount ImageEffect.GetInput(int) ImageEffect.GetSafeInput(int) ImageEffect.DepthStencil ImageEffect.HasDepthStencilOutput ImageEffect.OutputCount ImageEffect.GetOutput(int) ImageEffect.GetSafeOutput(int) ImageEffect.NewScopedRenderTarget2D(TextureDescription) ImageEffect.NewScopedRenderTarget2D(int, int, PixelFormat, TextureFlags, int) ImageEffect.NewScopedRenderTarget2D(int, int, PixelFormat, MipMapCount, TextureFlags, int) DrawEffect.SamplingPattern DrawEffect.Parameters DrawEffect.Scaler DrawEffect.SetDefaultParameters() DrawEffect.Draw(RenderDrawContext, string) DrawEffect.Draw(RenderDrawContext, string, params object[]) DrawEffect.ToString() RendererBase.Draw(RenderDrawContext) RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.Unload() RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) ImageEffectExtensions.SetInput(IImageEffect, Texture) ImageEffectExtensions.SetInput(IImageEffect, Texture, Texture) ImageEffectExtensions.SetInput(IImageEffect, Texture, Texture, Texture) UnsafeUtilities.As<T>(object?) Constructors MSAAResolver() Initializes a new instance of the MSAAResolver class. public MSAAResolver() MSAAResolver(string, string) Initializes a new instance of the MSAAResolver class. public MSAAResolver(string msaaResolverShaderName, string msaaDepthResolverShaderName) Parameters msaaResolverShaderName string Name of the MSAA resolve pass shader. msaaDepthResolverShaderName string Name of the MSAA depth resolve pass shader. Properties Enabled Gets or sets a value indicating whether this RendererCoreBase is enabled. public override bool Enabled { get; set; } Property Value bool true if enabled; otherwise, false. FilterRadius MSAA resolve filter radius value. [DataMember(20)] [DataMemberRange(0.5, 3, 0.01, 0.1, 3)] public float FilterRadius { get; set; } Property Value float FilterType MSAA resolve filter type. [DataMember(10)] public MSAAResolver.FilterTypes FilterType { get; set; } Property Value MSAAResolver.FilterTypes Methods DrawCore(RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderDrawContext drawContext) Parameters drawContext RenderDrawContext InitializeCore() protected override void InitializeCore() Resolve(RenderDrawContext, Texture, Texture) Resolves the specified input multisampled texture. public void Resolve(RenderDrawContext drawContext, Texture input, Texture output) Parameters drawContext RenderDrawContext The draw context. input Texture The input. output Texture The output."
  },
  "api/Stride.Rendering.Compositing.MSAAResolverParams.html": {
    "href": "api/Stride.Rendering.Compositing.MSAAResolverParams.html",
    "title": "Class MSAAResolverParams | Stride API",
    "summary": "Class MSAAResolverParams Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll [DataContract] public class MSAAResolverParams : ShaderMixinParameters, IDictionary<ParameterKey, object>, ICollection<KeyValuePair<ParameterKey, object>>, IEnumerable<KeyValuePair<ParameterKey, object>>, IEnumerable Inheritance object ParameterCollection ShaderMixinParameters MSAAResolverParams Implements IDictionary<ParameterKey, object> ICollection<KeyValuePair<ParameterKey, object>> IEnumerable<KeyValuePair<ParameterKey, object>> IEnumerable Inherited Members ShaderMixinParameters.EffectParameters ShaderMixinParameters.Add(ParameterKey, object) ShaderMixinParameters.Contains(KeyValuePair<ParameterKey, object>) ShaderMixinParameters.CopyTo(KeyValuePair<ParameterKey, object>[], int) ShaderMixinParameters.Count ShaderMixinParameters.GetEnumerator() ShaderMixinParameters.IsReadOnly ShaderMixinParameters.this[ParameterKey] ShaderMixinParameters.Keys ShaderMixinParameters.Values ShaderMixinParameters.TryGetValue(ParameterKey, out object) ShaderMixinParameters.Add(KeyValuePair<ParameterKey, object>) ShaderMixinParameters.Remove(KeyValuePair<ParameterKey, object>) ParameterCollection.DataValues ParameterCollection.ObjectValues ParameterCollection.PermutationCounter ParameterCollection.LayoutCounter ParameterCollection.ParameterKeyInfos ParameterCollection.Layout ParameterCollection.HasLayout ParameterCollection.ToString() ParameterCollection.GetAccessor<T>(ObjectParameterKey<T>, bool) ParameterCollection.GetAccessor<T>(PermutationParameterKey<T>, bool) ParameterCollection.GetAccessor<T>(ValueParameterKey<T>, int) ParameterCollection.Set<T>(ObjectParameterKey<T>, T) ParameterCollection.Get<T>(ObjectParameterKey<T>, bool) ParameterCollection.Set<T>(PermutationParameterKey<T>, T) ParameterCollection.Get<T>(PermutationParameterKey<T>, bool) ParameterCollection.Set<T>(ValueParameterKey<T>, T) ParameterCollection.Set<T>(ValueParameterKey<T>, ref T) ParameterCollection.Set<T>(ValueParameterKey<T>, T[]) ParameterCollection.Set<T>(ValueParameterKey<T>, int, ref T) ParameterCollection.Get<T>(ValueParameterKey<T>) ParameterCollection.GetValues<T>(ValueParameterKey<T>) ParameterCollection.CopyTo<T>(ValueParameterKey<T>, ParameterCollection, ValueParameterKey<T>) ParameterCollection.Set<T>(ValueParameter<T>, T) ParameterCollection.Set<T>(ValueParameter<T>, ref T) ParameterCollection.Set<T>(ValueParameter<T>, int, ref T) ParameterCollection.Set<T>(PermutationParameter<T>, T) ParameterCollection.Set<T>(ObjectParameterAccessor<T>, T) ParameterCollection.Get<T>(ValueParameter<T>) ParameterCollection.Get<T>(PermutationParameter<T>) ParameterCollection.Get<T>(ObjectParameterAccessor<T>) ParameterCollection.SetObject(ParameterKey, object) ParameterCollection.GetObject(ParameterKey) ParameterCollection.Remove(ParameterKey) ParameterCollection.Clear() ParameterCollection.ContainsKey(ParameterKey) ParameterCollection.UpdateLayout(ParameterCollectionLayout) ParameterCollection.GetObjectParameterHelper(ParameterKey, bool) Extension Methods ParameterCollectionExtensions.ToStringPermutationsDetailed(ParameterCollection) ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Fields MSAASamples public static readonly PermutationParameterKey<int> MSAASamples Field Value PermutationParameterKey<int> ResolveFilterDiameter public static readonly PermutationParameterKey<float> ResolveFilterDiameter Field Value PermutationParameterKey<float> ResolveFilterType public static readonly PermutationParameterKey<int> ResolveFilterType Field Value PermutationParameterKey<int>"
  },
  "api/Stride.Rendering.Compositing.MaterialIndexTargetSemantic.html": {
    "href": "api/Stride.Rendering.Compositing.MaterialIndexTargetSemantic.html",
    "title": "Class MaterialIndexTargetSemantic | Stride API",
    "summary": "Class MaterialIndexTargetSemantic Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public class MaterialIndexTargetSemantic : IRenderTargetSemantic Inheritance object MaterialIndexTargetSemantic Implements IRenderTargetSemantic Extension Methods UnsafeUtilities.As<T>(object?) Properties ShaderClass The shader class deriving from ComputeColor that is used as a composition to output to the render target public ShaderSource ShaderClass { get; } Property Value ShaderSource"
  },
  "api/Stride.Rendering.Compositing.NormalTargetSemantic.html": {
    "href": "api/Stride.Rendering.Compositing.NormalTargetSemantic.html",
    "title": "Class NormalTargetSemantic | Stride API",
    "summary": "Class NormalTargetSemantic Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public class NormalTargetSemantic : IRenderTargetSemantic Inheritance object NormalTargetSemantic Implements IRenderTargetSemantic Extension Methods UnsafeUtilities.As<T>(object?) Properties ShaderClass The shader class deriving from ComputeColor that is used as a composition to output to the render target public ShaderSource ShaderClass { get; } Property Value ShaderSource"
  },
  "api/Stride.Rendering.Compositing.OctahedronNormalSpecularColorTargetSemantic.html": {
    "href": "api/Stride.Rendering.Compositing.OctahedronNormalSpecularColorTargetSemantic.html",
    "title": "Class OctahedronNormalSpecularColorTargetSemantic | Stride API",
    "summary": "Class OctahedronNormalSpecularColorTargetSemantic Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public class OctahedronNormalSpecularColorTargetSemantic : IRenderTargetSemantic Inheritance object OctahedronNormalSpecularColorTargetSemantic Implements IRenderTargetSemantic Extension Methods UnsafeUtilities.As<T>(object?) Properties ShaderClass The shader class deriving from ComputeColor that is used as a composition to output to the render target public ShaderSource ShaderClass { get; } Property Value ShaderSource"
  },
  "api/Stride.Rendering.Compositing.RenderOutputValidator.html": {
    "href": "api/Stride.Rendering.Compositing.RenderOutputValidator.html",
    "title": "Class RenderOutputValidator | Stride API",
    "summary": "Class RenderOutputValidator Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll Represents how we setup the graphics pipeline output targets. public sealed class RenderOutputValidator Inheritance object RenderOutputValidator Extension Methods UnsafeUtilities.As<T>(object?) Properties RenderTargets public IReadOnlyList<RenderTargetDescription> RenderTargets { get; } Property Value IReadOnlyList<RenderTargetDescription> ShaderSource public ShaderMixinSource ShaderSource { get; } Property Value ShaderMixinSource Methods Add<T>(PixelFormat, bool) public void Add<T>(PixelFormat format, bool isShaderResource = true) where T : IRenderTargetSemantic, new() Parameters format PixelFormat isShaderResource bool Type Parameters T BeginCustomValidation(PixelFormat, MultisampleCount) public void BeginCustomValidation(PixelFormat depthStencilFormat, MultisampleCount multisampleCount = MultisampleCount.None) Parameters depthStencilFormat PixelFormat multisampleCount MultisampleCount EndCustomValidation() public void EndCustomValidation() Find(Type) public int Find(Type semanticType) Parameters semanticType Type Returns int Find<T>() public int Find<T>() where T : IRenderTargetSemantic Returns int Type Parameters T Validate(ref RenderOutputDescription) public void Validate(ref RenderOutputDescription renderOutput) Parameters renderOutput RenderOutputDescription"
  },
  "api/Stride.Rendering.Compositing.RenderTargetDescription.html": {
    "href": "api/Stride.Rendering.Compositing.RenderTargetDescription.html",
    "title": "Struct RenderTargetDescription | Stride API",
    "summary": "Struct RenderTargetDescription Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public struct RenderTargetDescription : IEquatable<RenderTargetDescription> Implements IEquatable<RenderTargetDescription> Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Format public PixelFormat Format Field Value PixelFormat Semantic public IRenderTargetSemantic Semantic Field Value IRenderTargetSemantic Methods Equals(RenderTargetDescription) Indicates whether the current object is equal to another object of the same type. public bool Equals(RenderTargetDescription other) Parameters other RenderTargetDescription An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(RenderTargetDescription, RenderTargetDescription) public static bool operator ==(RenderTargetDescription left, RenderTargetDescription right) Parameters left RenderTargetDescription right RenderTargetDescription Returns bool operator !=(RenderTargetDescription, RenderTargetDescription) public static bool operator !=(RenderTargetDescription left, RenderTargetDescription right) Parameters left RenderTargetDescription right RenderTargetDescription Returns bool"
  },
  "api/Stride.Rendering.Compositing.RenderTextureSceneRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.RenderTextureSceneRenderer.html",
    "title": "Class RenderTextureSceneRenderer | Stride API",
    "summary": "Class RenderTextureSceneRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public class RenderTextureSceneRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase RenderTextureSceneRenderer Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties Child public ISceneRenderer Child { get; set; } Property Value ISceneRenderer RenderTexture public Texture RenderTexture { get; set; } Property Value Texture Methods CollectCore(RenderContext) Main collect method. protected override void CollectCore(RenderContext context) Parameters context RenderContext DrawCore(RenderContext, RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderContext context, RenderDrawContext drawContext) Parameters context RenderContext drawContext RenderDrawContext"
  },
  "api/Stride.Rendering.Compositing.SceneCameraRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.SceneCameraRenderer.html",
    "title": "Class SceneCameraRenderer | Stride API",
    "summary": "Class SceneCameraRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll Defines and sets a RenderView and set it up using Camera or current context camera. [Display(\"Camera Renderer\", null)] public class SceneCameraRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase SceneCameraRenderer Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Derived SceneExternalCameraRenderer Inherited Members SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Remarks Since it sets a view, it is usually not shareable for multiple rendering. Fields Logger public Logger Logger Field Value Logger Properties Camera Gets or sets the camera. public SceneCameraSlot Camera { get; set; } Property Value SceneCameraSlot The camera. Child public ISceneRenderer Child { get; set; } Property Value ISceneRenderer RenderMask public RenderGroupMask RenderMask { get; set; } Property Value RenderGroupMask RenderView public RenderView RenderView { get; } Property Value RenderView Methods CollectCore(RenderContext) Main collect method. protected override void CollectCore(RenderContext context) Parameters context RenderContext CollectInner(RenderContext) protected virtual void CollectInner(RenderContext renderContext) Parameters renderContext RenderContext DrawCore(RenderContext, RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderContext context, RenderDrawContext drawContext) Parameters context RenderContext drawContext RenderDrawContext DrawInner(RenderDrawContext) protected virtual void DrawInner(RenderDrawContext renderContext) Parameters renderContext RenderDrawContext ResolveCamera(RenderContext) Resolves camera to the one contained in slot Camera. protected virtual CameraComponent ResolveCamera(RenderContext renderContext) Parameters renderContext RenderContext Returns CameraComponent UpdateCameraToRenderView(RenderContext, RenderView, CameraComponent) public static void UpdateCameraToRenderView(RenderContext context, RenderView renderView, CameraComponent camera) Parameters context RenderContext renderView RenderView camera CameraComponent"
  },
  "api/Stride.Rendering.Compositing.SceneCameraSlot.html": {
    "href": "api/Stride.Rendering.Compositing.SceneCameraSlot.html",
    "title": "Class SceneCameraSlot | Stride API",
    "summary": "Class SceneCameraSlot Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll A camera slot used by contained in a SceneCameraSlotCollection and referenceable by a SceneCameraSlotId [DataContract(\"SceneCameraSlot\")] public sealed class SceneCameraSlot : IIdentifiable Inheritance object SceneCameraSlot Implements IIdentifiable Extension Methods UnsafeUtilities.As<T>(object?) Constructors SceneCameraSlot() Initializes a new instance of the SceneCameraSlot class. public SceneCameraSlot() Properties Camera public CameraComponent Camera { get; } Property Value CameraComponent Id Gets the id of this instance [DataMember(5)] public Guid Id { get; set; } Property Value Guid Name Gets or sets the name. [DataMember(10)] public string Name { get; set; } Property Value string The name. Methods ToSlotId() Generates a SceneCameraSlotId corresponding to this slot. public SceneCameraSlotId ToSlotId() Returns SceneCameraSlotId A new instance of SceneCameraSlotId. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object."
  },
  "api/Stride.Rendering.Compositing.SceneCameraSlotCollection.html": {
    "href": "api/Stride.Rendering.Compositing.SceneCameraSlotCollection.html",
    "title": "Class SceneCameraSlotCollection | Stride API",
    "summary": "Class SceneCameraSlotCollection Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll A collection of CameraComponent. [DataContract(\"SceneCameraSlotCollection\")] public sealed class SceneCameraSlotCollection : FastTrackingCollection<SceneCameraSlot>, IList<SceneCameraSlot>, ICollection<SceneCameraSlot>, IReadOnlyList<SceneCameraSlot>, IReadOnlyCollection<SceneCameraSlot>, IEnumerable<SceneCameraSlot>, IEnumerable Inheritance object FastCollection<SceneCameraSlot> FastTrackingCollection<SceneCameraSlot> SceneCameraSlotCollection Implements IList<SceneCameraSlot> ICollection<SceneCameraSlot> IReadOnlyList<SceneCameraSlot> IReadOnlyCollection<SceneCameraSlot> IEnumerable<SceneCameraSlot> IEnumerable Inherited Members FastTrackingCollection<SceneCameraSlot>.CollectionChanged FastCollection<SceneCameraSlot>.Capacity FastCollection<SceneCameraSlot>.Count FastCollection<SceneCameraSlot>.this[int] FastCollection<SceneCameraSlot>.Add(SceneCameraSlot) FastCollection<SceneCameraSlot>.Clear() FastCollection<SceneCameraSlot>.Contains(SceneCameraSlot) FastCollection<SceneCameraSlot>.CopyTo(SceneCameraSlot[], int) FastCollection<SceneCameraSlot>.IndexOf(SceneCameraSlot) FastCollection<SceneCameraSlot>.Insert(int, SceneCameraSlot) FastCollection<SceneCameraSlot>.Remove(SceneCameraSlot) FastCollection<SceneCameraSlot>.RemoveAt(int) FastCollection<SceneCameraSlot>.AddRange<TE>(TE) FastCollection<SceneCameraSlot>.GetEnumerator() FastCollection<SceneCameraSlot>.Sort() FastCollection<SceneCameraSlot>.Sort(IComparer<SceneCameraSlot>) FastCollection<SceneCameraSlot>.Sort(int, int, IComparer<SceneCameraSlot>) FastCollection<SceneCameraSlot>.IsReadOnly FastCollection<SceneCameraSlot>.EnsureCapacity(int) Extension Methods ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Fields Current Property key to access the current collection of CameraComponent from Tags. public static readonly PropertyKey<SceneCameraSlotCollection> Current Field Value PropertyKey<SceneCameraSlotCollection>"
  },
  "api/Stride.Rendering.Compositing.SceneCameraSlotId.SceneCameraSlotIdDataSerializer.html": {
    "href": "api/Stride.Rendering.Compositing.SceneCameraSlotId.SceneCameraSlotIdDataSerializer.html",
    "title": "Class SceneCameraSlotId.SceneCameraSlotIdDataSerializer | Stride API",
    "summary": "Class SceneCameraSlotId.SceneCameraSlotIdDataSerializer Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll public sealed class SceneCameraSlotId.SceneCameraSlotIdDataSerializer : DataSerializer<SceneCameraSlotId> Inheritance object DataSerializer DataSerializer<SceneCameraSlotId> SceneCameraSlotId.SceneCameraSlotIdDataSerializer Inherited Members DataSerializer<SceneCameraSlotId>.SerializationType DataSerializer<SceneCameraSlotId>.IsBlittable DataSerializer<SceneCameraSlotId>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<SceneCameraSlotId>.Serialize(SceneCameraSlotId, SerializationStream) DataSerializer<SceneCameraSlotId>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer<SceneCameraSlotId>.PreSerialize(ref SceneCameraSlotId, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId DataSerializer.Initialize(SerializerSelector) Extension Methods UnsafeUtilities.As<T>(object?) Methods Serialize(ref SceneCameraSlotId, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref SceneCameraSlotId assetReference, ArchiveMode mode, SerializationStream stream) Parameters assetReference SceneCameraSlotId mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Rendering.Compositing.SceneCameraSlotId.html": {
    "href": "api/Stride.Rendering.Compositing.SceneCameraSlotId.html",
    "title": "Struct SceneCameraSlotId | Stride API",
    "summary": "Struct SceneCameraSlotId Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll Identifies a camera slotIndex in a scene composition. [DataContract(\"SceneCameraSlotId\")] [DataStyle(DataStyle.Compact)] [DataSerializer(typeof(SceneCameraSlotId.SceneCameraSlotIdDataSerializer))] public struct SceneCameraSlotId : IEquatable<SceneCameraSlotId> Implements IEquatable<SceneCameraSlotId> Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors SceneCameraSlotId(Guid) Initializes a new instance of the SceneCameraSlotId class. public SceneCameraSlotId(Guid id) Parameters id Guid The identifier. Fields Id The Guid matching a SceneCameraSlot. public readonly Guid Id Field Value Guid Properties IsEmpty Gets whether this SceneCameraSlotId is empty. public bool IsEmpty { get; } Property Value bool Methods Equals(SceneCameraSlotId) Indicates whether the current object is equal to another object of the same type. public bool Equals(SceneCameraSlotId other) Parameters other SceneCameraSlotId An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name. Operators operator ==(SceneCameraSlotId, SceneCameraSlotId) public static bool operator ==(SceneCameraSlotId left, SceneCameraSlotId right) Parameters left SceneCameraSlotId right SceneCameraSlotId Returns bool operator !=(SceneCameraSlotId, SceneCameraSlotId) public static bool operator !=(SceneCameraSlotId left, SceneCameraSlotId right) Parameters left SceneCameraSlotId right SceneCameraSlotId Returns bool"
  },
  "api/Stride.Rendering.Compositing.SceneExternalCameraRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.SceneExternalCameraRenderer.html",
    "title": "Class SceneExternalCameraRenderer | Stride API",
    "summary": "Class SceneExternalCameraRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll A camera renderer that can use an external camera not in the scene. public class SceneExternalCameraRenderer : SceneCameraRenderer, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase SceneCameraRenderer SceneExternalCameraRenderer Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Derived EditorTopLevelCompositor Inherited Members SceneCameraRenderer.RenderView SceneCameraRenderer.Camera SceneCameraRenderer.Child SceneCameraRenderer.RenderMask SceneCameraRenderer.Logger SceneCameraRenderer.CollectCore(RenderContext) SceneCameraRenderer.DrawCore(RenderContext, RenderDrawContext) SceneCameraRenderer.CollectInner(RenderContext) SceneCameraRenderer.DrawInner(RenderDrawContext) SceneCameraRenderer.UpdateCameraToRenderView(RenderContext, RenderView, CameraComponent) SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties ExternalCamera public CameraComponent ExternalCamera { get; set; } Property Value CameraComponent Methods ResolveCamera(RenderContext) Resolves camera to ExternalCamera rather than the default behavior. protected override CameraComponent ResolveCamera(RenderContext renderContext) Parameters renderContext RenderContext Returns CameraComponent"
  },
  "api/Stride.Rendering.Compositing.SceneRendererBase.html": {
    "href": "api/Stride.Rendering.Compositing.SceneRendererBase.html",
    "title": "Class SceneRendererBase | Stride API",
    "summary": "Class SceneRendererBase Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll Describes the code part of a GraphicsCompositor. [DataContract(Inherited = true)] public abstract class SceneRendererBase : RendererCoreBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Derived ClearRenderer DebugRenderer DelegateSceneRenderer ForceAspectRatioSceneRenderer ForwardRenderer RenderTextureSceneRenderer SceneCameraRenderer SceneRendererCollection SingleStageRenderer Inherited Members RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors SceneRendererBase() protected SceneRendererBase() Properties Id [DataMember(-100)] [Display(null, null, Browsable = false)] public Guid Id { get; set; } Property Value Guid Methods Collect(RenderContext) Executed before extract. Should create views, update RenderStages, etc... public void Collect(RenderContext context) Parameters context RenderContext CollectCore(RenderContext) Main collect method. protected virtual void CollectCore(RenderContext context) Parameters context RenderContext Draw(RenderDrawContext) Draws this renderer with the specified context. See remarks. public void Draw(RenderDrawContext context) Parameters context RenderDrawContext The context. Remarks The method Initialize(RenderContext) should be called automatically by the implementation if it was not done before the first draw. DrawCore(RenderContext, RenderDrawContext) Main drawing method for this renderer that must be implemented. protected abstract void DrawCore(RenderContext context, RenderDrawContext drawContext) Parameters context RenderContext drawContext RenderDrawContext"
  },
  "api/Stride.Rendering.Compositing.SceneRendererCollection.html": {
    "href": "api/Stride.Rendering.Compositing.SceneRendererCollection.html",
    "title": "Class SceneRendererCollection | Stride API",
    "summary": "Class SceneRendererCollection Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll A collection of ISceneRenderer. public class SceneRendererCollection : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable, IEnumerable<ISceneRenderer>, IEnumerable Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase SceneRendererCollection Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable IEnumerable<ISceneRenderer> IEnumerable Inherited Members SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Properties Children [Display(null, null, Expand = ExpandRule.Always)] public List<ISceneRenderer> Children { get; } Property Value List<ISceneRenderer> Methods Add(ISceneRenderer) public void Add(ISceneRenderer child) Parameters child ISceneRenderer CollectCore(RenderContext) Main collect method. protected override void CollectCore(RenderContext context) Parameters context RenderContext DrawCore(RenderContext, RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderContext context, RenderDrawContext drawContext) Parameters context RenderContext drawContext RenderDrawContext GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator<ISceneRenderer> GetEnumerator() Returns IEnumerator<ISceneRenderer> An enumerator that can be used to iterate through the collection."
  },
  "api/Stride.Rendering.Compositing.SingleStageRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.SingleStageRenderer.html",
    "title": "Class SingleStageRenderer | Stride API",
    "summary": "Class SingleStageRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll Renders a single stage with the current RenderView. public class SingleStageRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase SceneRendererBase SingleStageRenderer Implements IComponent IReferencable ICollectorHolder ISceneRenderer IRenderCollector IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members SceneRendererBase.Id SceneRendererBase.Collect(RenderContext) SceneRendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Properties RenderStage public RenderStage RenderStage { get; set; } Property Value RenderStage Methods CollectCore(RenderContext) Main collect method. protected override void CollectCore(RenderContext context) Parameters context RenderContext DrawCore(RenderContext, RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderContext context, RenderDrawContext drawContext) Parameters context RenderContext drawContext RenderDrawContext"
  },
  "api/Stride.Rendering.Compositing.SpecularColorRoughnessTargetSemantic.html": {
    "href": "api/Stride.Rendering.Compositing.SpecularColorRoughnessTargetSemantic.html",
    "title": "Class SpecularColorRoughnessTargetSemantic | Stride API",
    "summary": "Class SpecularColorRoughnessTargetSemantic Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public class SpecularColorRoughnessTargetSemantic : IRenderTargetSemantic Inheritance object SpecularColorRoughnessTargetSemantic Implements IRenderTargetSemantic Extension Methods UnsafeUtilities.As<T>(object?) Properties ShaderClass The shader class deriving from ComputeColor that is used as a composition to output to the render target public ShaderSource ShaderClass { get; } Property Value ShaderSource"
  },
  "api/Stride.Rendering.Compositing.VRDeviceDescription.html": {
    "href": "api/Stride.Rendering.Compositing.VRDeviceDescription.html",
    "title": "Class VRDeviceDescription | Stride API",
    "summary": "Class VRDeviceDescription Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll [DataContract] public class VRDeviceDescription Inheritance object VRDeviceDescription Extension Methods UnsafeUtilities.As<T>(object?) Properties Api [DataMember(10)] public VRApi Api { get; set; } Property Value VRApi ResolutionScale Scales the render resolution, note that this compounds with the user-specified resolution multiplier [DataMember(20)] public float ResolutionScale { get; set; } Property Value float"
  },
  "api/Stride.Rendering.Compositing.VROverlayRenderer.html": {
    "href": "api/Stride.Rendering.Compositing.VROverlayRenderer.html",
    "title": "Class VROverlayRenderer | Stride API",
    "summary": "Class VROverlayRenderer Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll [DataContract] public class VROverlayRenderer Inheritance object VROverlayRenderer Extension Methods UnsafeUtilities.As<T>(object?) Fields FollowsHeadRotation [DataMember(50)] public bool FollowsHeadRotation Field Value bool LocalPosition [DataMember(20)] public Vector3 LocalPosition Field Value Vector3 LocalRotation [DataMember(30)] public Quaternion LocalRotation Field Value Quaternion Overlay public VROverlay Overlay Field Value VROverlay SurfaceSize [DataMember(40)] public Vector2 SurfaceSize Field Value Vector2 Texture [DataMember(10)] public Texture Texture Field Value Texture"
  },
  "api/Stride.Rendering.Compositing.VRRendererSettings.html": {
    "href": "api/Stride.Rendering.Compositing.VRRendererSettings.html",
    "title": "Class VRRendererSettings | Stride API",
    "summary": "Class VRRendererSettings Namespace Stride.Rendering.Compositing Assembly Stride.Engine.dll [DataContract] public class VRRendererSettings Inheritance object VRRendererSettings Extension Methods UnsafeUtilities.As<T>(object?) Fields CopyMirror Specifies if VR rendering should be copied to the current render target. [DataMember(25)] public bool CopyMirror Field Value bool MirrorScaler public ImageScaler MirrorScaler Field Value ImageScaler RenderViews public RenderView[] RenderViews Field Value RenderView[] VRDevice public VRDevice VRDevice Field Value VRDevice Properties Enabled [DataMember(10)] public bool Enabled { get; set; } Property Value bool IgnoreCameraRotation [DataMember(20)] public bool IgnoreCameraRotation { get; set; } Property Value bool IgnoreDevicePosition [DataMember(27)] public bool IgnoreDevicePosition { get; set; } Property Value bool IgnoreDeviceRotation [DataMember(25)] public bool IgnoreDeviceRotation { get; set; } Property Value bool Overlays [DataMember(40)] public List<VROverlayRenderer> Overlays { get; } Property Value List<VROverlayRenderer> RequestPassthrough [DataMember(50)] public bool RequestPassthrough { get; set; } Property Value bool RequiredApis [DataMember(30)] public List<VRDeviceDescription> RequiredApis { get; } Property Value List<VRDeviceDescription>"
  },
  "api/Stride.Rendering.Compositing.VelocityTargetSemantic.html": {
    "href": "api/Stride.Rendering.Compositing.VelocityTargetSemantic.html",
    "title": "Class VelocityTargetSemantic | Stride API",
    "summary": "Class VelocityTargetSemantic Namespace Stride.Rendering.Compositing Assembly Stride.Rendering.dll public class VelocityTargetSemantic : IRenderTargetSemantic Inheritance object VelocityTargetSemantic Implements IRenderTargetSemantic Extension Methods UnsafeUtilities.As<T>(object?) Properties ShaderClass The shader class deriving from ComputeColor that is used as a composition to output to the render target public ShaderSource ShaderClass { get; } Property Value ShaderSource"
  },
  "api/Stride.Rendering.Compositing.html": {
    "href": "api/Stride.Rendering.Compositing.html",
    "title": "Namespace Stride.Rendering.Compositing | Stride API",
    "summary": "Namespace Stride.Rendering.Compositing Classes ClearRenderer A renderer to clear a render frame. ColorTargetSemantic CompositingProfilingKeys DebugRenderer DelegateSceneRenderer A renderer which can provide Draw(RenderDrawContext) implementation with a delegate. EditorTopLevelCompositor Used by editor as top level compositor. EnvironmentLightRoughnessTargetSemantic ForceAspectRatioSceneRenderer ForwardRenderer Renders your game. It should use current RenderView and GetCurrentCamera(RenderContext). GraphicsCompositor The GraphicsCompositor class organizes how scenes are rendered in the Stride engine, providing extensive customization of the rendering pipeline. GraphicsCompositorHelper Helper functions for creating GraphicsCompositor. MSAAResolver A renderer to resolve MSAA textures. MSAAResolverParams MaterialIndexTargetSemantic NormalTargetSemantic OctahedronNormalSpecularColorTargetSemantic RenderOutputValidator Represents how we setup the graphics pipeline output targets. RenderTextureSceneRenderer SceneCameraRenderer Defines and sets a RenderView and set it up using Camera or current context camera. SceneCameraSlot A camera slot used by contained in a SceneCameraSlotCollection and referenceable by a SceneCameraSlotId SceneCameraSlotCollection A collection of CameraComponent. SceneCameraSlotId.SceneCameraSlotIdDataSerializer SceneExternalCameraRenderer A camera renderer that can use an external camera not in the scene. SceneRendererBase Describes the code part of a GraphicsCompositor. SceneRendererCollection A collection of ISceneRenderer. SingleStageRenderer Renders a single stage with the current RenderView. SpecularColorRoughnessTargetSemantic VRDeviceDescription VROverlayRenderer VRRendererSettings VelocityTargetSemantic Structs RenderTargetDescription SceneCameraSlotId Identifies a camera slotIndex in a scene composition. Interfaces IRenderTargetSemantic The usage of a render target ISceneGraphicsCompositor Defines the common interface for a graphics composer responsible to compose the scene to a final render target. ISceneRenderer ISharedRenderer Enums MSAAResolver.FilterTypes MSAA resolve shader modes."
  },
  "api/Stride.Rendering.ComputeColorParameterKeys.html": {
    "href": "api/Stride.Rendering.ComputeColorParameterKeys.html",
    "title": "Class ComputeColorParameterKeys | Stride API",
    "summary": "Class ComputeColorParameterKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll public static class ComputeColorParameterKeys Inheritance object ComputeColorParameterKeys Fields ColorParameter public static readonly ValueParameterKey<Color4> ColorParameter Field Value ValueParameterKey<Color4>"
  },
  "api/Stride.Rendering.ComputeColorTextureDynamicScaledOffsetKeys.html": {
    "href": "api/Stride.Rendering.ComputeColorTextureDynamicScaledOffsetKeys.html",
    "title": "Class ComputeColorTextureDynamicScaledOffsetKeys | Stride API",
    "summary": "Class ComputeColorTextureDynamicScaledOffsetKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll public static class ComputeColorTextureDynamicScaledOffsetKeys Inheritance object ComputeColorTextureDynamicScaledOffsetKeys Fields Offset public static readonly ValueParameterKey<Vector2> Offset Field Value ValueParameterKey<Vector2> Scale public static readonly ValueParameterKey<Vector2> Scale Field Value ValueParameterKey<Vector2>"
  },
  "api/Stride.Rendering.ComputeEffect.ComputeEffectShader.html": {
    "href": "api/Stride.Rendering.ComputeEffect.ComputeEffectShader.html",
    "title": "Class ComputeEffectShader | Stride API",
    "summary": "Class ComputeEffectShader Namespace Stride.Rendering.ComputeEffect Assembly Stride.Rendering.dll A compute effect based directly on a single compute shader. public class ComputeEffectShader : DrawEffect, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase RendererBase DrawEffect ComputeEffectShader Implements IComponent IReferencable ICollectorHolder IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members DrawEffect.SamplingPattern DrawEffect.Parameters DrawEffect.Scaler DrawEffect.Reset() DrawEffect.Draw(RenderDrawContext, string) DrawEffect.Draw(RenderDrawContext, string, params object[]) DrawEffect.ToString() RendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors ComputeEffectShader(RenderContext) public ComputeEffectShader(RenderContext context) Parameters context RenderContext Properties EffectInstance The current effect instance. public DynamicEffectInstance EffectInstance { get; } Property Value DynamicEffectInstance ShaderSourceName Gets or sets the name of the input compute shader file (.sdsl) public string ShaderSourceName { get; set; } Property Value string ThreadGroupCounts Gets or sets the number of group counts the shader should be dispatched to. public Int3 ThreadGroupCounts { get; set; } Property Value Int3 ThreadNumbers Gets or sets the number of threads desired by thread group. public Int3 ThreadNumbers { get; set; } Property Value Int3 Methods DrawCore(RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderDrawContext context) Parameters context RenderDrawContext The context. PreDrawCore(RenderDrawContext) protected override void PreDrawCore(RenderDrawContext context) Parameters context RenderDrawContext SetDefaultParameters() Sets the default parameters (called at constructor time and if Reset() is called) protected override void SetDefaultParameters() UpdateParameters() Updates the effect Parameters from properties defined in this instance. See remarks. protected virtual void UpdateParameters()"
  },
  "api/Stride.Rendering.ComputeEffect.ComputeEffectShaderKeys.html": {
    "href": "api/Stride.Rendering.ComputeEffect.ComputeEffectShaderKeys.html",
    "title": "Class ComputeEffectShaderKeys | Stride API",
    "summary": "Class ComputeEffectShaderKeys Namespace Stride.Rendering.ComputeEffect Assembly Stride.Rendering.dll public class ComputeEffectShaderKeys Inheritance object ComputeEffectShaderKeys Extension Methods UnsafeUtilities.As<T>(object?) Fields ComputeShaderName public static readonly PermutationParameterKey<string> ComputeShaderName Field Value PermutationParameterKey<string> ThreadNumbers public static readonly PermutationParameterKey<Int3> ThreadNumbers Field Value PermutationParameterKey<Int3>"
  },
  "api/Stride.Rendering.ComputeEffect.ComputeShaderBaseKeys.html": {
    "href": "api/Stride.Rendering.ComputeEffect.ComputeShaderBaseKeys.html",
    "title": "Class ComputeShaderBaseKeys | Stride API",
    "summary": "Class ComputeShaderBaseKeys Namespace Stride.Rendering.ComputeEffect Assembly Stride.Rendering.dll public class ComputeShaderBaseKeys Inheritance object ComputeShaderBaseKeys Extension Methods UnsafeUtilities.As<T>(object?) Fields ThreadGroupCountGlobal public static readonly ValueParameterKey<Int3> ThreadGroupCountGlobal Field Value ValueParameterKey<Int3>"
  },
  "api/Stride.Rendering.ComputeEffect.GGXPrefiltering.RadiancePrefilteringGGX.html": {
    "href": "api/Stride.Rendering.ComputeEffect.GGXPrefiltering.RadiancePrefilteringGGX.html",
    "title": "Class RadiancePrefilteringGGX | Stride API",
    "summary": "Class RadiancePrefilteringGGX Namespace Stride.Rendering.ComputeEffect.GGXPrefiltering Assembly Stride.Rendering.dll A class for radiance pre-filtering using the GGX distribution function. public class RadiancePrefilteringGGX : DrawEffect, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase RendererBase DrawEffect RadiancePrefilteringGGX Implements IComponent IReferencable ICollectorHolder IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members DrawEffect.SamplingPattern DrawEffect.Parameters DrawEffect.Scaler DrawEffect.Reset() DrawEffect.SetDefaultParameters() DrawEffect.Draw(RenderDrawContext, string) DrawEffect.Draw(RenderDrawContext, string, params object[]) DrawEffect.ToString() RendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors RadiancePrefilteringGGX(RenderContext) Create a new instance of the class. public RadiancePrefilteringGGX(RenderContext context) Parameters context RenderContext the context Properties DoNotFilterHighestLevel Gets or sets the boolean indicating if the highest level of mipmaps should be let as-is or pre-filtered. public bool DoNotFilterHighestLevel { get; set; } Property Value bool MipmapGenerationCount Gets or sets the number of pre-filtered mipmap to generate. public int MipmapGenerationCount { get; set; } Property Value int PrefilteredRadiance Gets or sets the texture to use to store the result of the pre-filtering. public Texture PrefilteredRadiance { get; set; } Property Value Texture RadianceMap Gets or sets the input radiance map to pre-filter. public Texture RadianceMap { get; set; } Property Value Texture SamplingsCount Gets or sets the number of sampling used during the importance sampling public int SamplingsCount { get; set; } Property Value int Remarks Should be a power of 2 and maximum value is 1024 Methods DrawCore(RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderDrawContext context) Parameters context RenderDrawContext The context."
  },
  "api/Stride.Rendering.ComputeEffect.GGXPrefiltering.RadiancePrefilteringGGXNoCompute.html": {
    "href": "api/Stride.Rendering.ComputeEffect.GGXPrefiltering.RadiancePrefilteringGGXNoCompute.html",
    "title": "Class RadiancePrefilteringGGXNoCompute | Stride API",
    "summary": "Class RadiancePrefilteringGGXNoCompute Namespace Stride.Rendering.ComputeEffect.GGXPrefiltering Assembly Stride.Rendering.dll A class for radiance pre-filtering using the GGX distribution function. public class RadiancePrefilteringGGXNoCompute : DrawEffect, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase RendererBase DrawEffect RadiancePrefilteringGGXNoCompute Implements IComponent IReferencable ICollectorHolder IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members DrawEffect.SamplingPattern DrawEffect.Parameters DrawEffect.Scaler DrawEffect.Reset() DrawEffect.SetDefaultParameters() DrawEffect.Draw(RenderDrawContext, string) DrawEffect.Draw(RenderDrawContext, string, params object[]) DrawEffect.ToString() RendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors RadiancePrefilteringGGXNoCompute(RenderContext) Create a new instance of the class. public RadiancePrefilteringGGXNoCompute(RenderContext context) Parameters context RenderContext the context Properties DoNotFilterHighestLevel Gets or sets the boolean indicating if the highest level of mipmaps should be let as-is or pre-filtered. public bool DoNotFilterHighestLevel { get; set; } Property Value bool MipmapGenerationCount Gets or sets the number of pre-filtered mipmap to generate. public int MipmapGenerationCount { get; set; } Property Value int PrefilteredRadiance Gets or sets the texture to use to store the result of the pre-filtering. public Texture PrefilteredRadiance { get; set; } Property Value Texture RadianceMap Gets or sets the input radiance map to pre-filter. public Texture RadianceMap { get; set; } Property Value Texture SamplingsCount Gets or sets the number of sampling used during the importance sampling public int SamplingsCount { get; set; } Property Value int Remarks Should be a power of 2 and maximum value is 1024 Methods DrawCore(RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderDrawContext context) Parameters context RenderDrawContext The context."
  },
  "api/Stride.Rendering.ComputeEffect.GGXPrefiltering.html": {
    "href": "api/Stride.Rendering.ComputeEffect.GGXPrefiltering.html",
    "title": "Namespace Stride.Rendering.ComputeEffect.GGXPrefiltering | Stride API",
    "summary": "Namespace Stride.Rendering.ComputeEffect.GGXPrefiltering Classes RadiancePrefilteringGGX A class for radiance pre-filtering using the GGX distribution function. RadiancePrefilteringGGXNoCompute A class for radiance pre-filtering using the GGX distribution function."
  },
  "api/Stride.Rendering.ComputeEffect.LambertianPrefiltering.LambertianPrefilteringSH.html": {
    "href": "api/Stride.Rendering.ComputeEffect.LambertianPrefiltering.LambertianPrefilteringSH.html",
    "title": "Class LambertianPrefilteringSH | Stride API",
    "summary": "Class LambertianPrefilteringSH Namespace Stride.Rendering.ComputeEffect.LambertianPrefiltering Assembly Stride.Rendering.dll Performs Lambertian pre-filtering in the form of Spherical Harmonics. public class LambertianPrefilteringSH : DrawEffect, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase RendererBase DrawEffect LambertianPrefilteringSH Implements IComponent IReferencable ICollectorHolder IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members DrawEffect.SamplingPattern DrawEffect.Parameters DrawEffect.Scaler DrawEffect.Reset() DrawEffect.SetDefaultParameters() DrawEffect.Draw(RenderDrawContext, string) DrawEffect.Draw(RenderDrawContext, string, params object[]) DrawEffect.ToString() RendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors LambertianPrefilteringSH(RenderContext) public LambertianPrefilteringSH(RenderContext context) Parameters context RenderContext Properties HarmonicOrder Gets or sets the level of precision desired when calculating the spherical harmonics. public int HarmonicOrder { get; set; } Property Value int PrefilteredLambertianSH Gets the computed spherical harmonics corresponding to the pre-filtered lambertian. public SphericalHarmonics PrefilteredLambertianSH { get; } Property Value SphericalHarmonics RadianceMap Gets or sets the input radiance map to pre-filter. public Texture RadianceMap { get; set; } Property Value Texture Methods DrawCore(RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderDrawContext context) Parameters context RenderDrawContext The context."
  },
  "api/Stride.Rendering.ComputeEffect.LambertianPrefiltering.LambertianPrefilteringSHNoCompute.html": {
    "href": "api/Stride.Rendering.ComputeEffect.LambertianPrefiltering.LambertianPrefilteringSHNoCompute.html",
    "title": "Class LambertianPrefilteringSHNoCompute | Stride API",
    "summary": "Class LambertianPrefilteringSHNoCompute Namespace Stride.Rendering.ComputeEffect.LambertianPrefiltering Assembly Stride.Rendering.dll Performs Lambertian pre-filtering in the form of Spherical Harmonics. public class LambertianPrefilteringSHNoCompute : ImageEffect, IComponent, IReferencable, ICollectorHolder, IImageEffect, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase RendererBase DrawEffect ImageEffect LambertianPrefilteringSHNoCompute Implements IComponent IReferencable ICollectorHolder IImageEffect IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Inherited Members ImageEffect.EnableSetRenderTargets ImageEffect.SetInput(int, Texture) ImageEffect.Reset() ImageEffect.SetOutput(Texture) ImageEffect.SetOutput(params Texture[]) ImageEffect.SetDepthOutput(Texture, Texture) ImageEffect.SetDepthOutput(Texture, params Texture[]) ImageEffect.SetViewport(Viewport?) ImageEffect.SetViewports(ReadOnlySpan<Viewport>) ImageEffect.SetScissorRectangle(Rectangle?) ImageEffect.SetScissorRectangles(ReadOnlySpan<Rectangle>) ImageEffect.PreDrawCore(RenderDrawContext) ImageEffect.SetRenderTargets(RenderDrawContext) ImageEffect.PostDrawCore(RenderDrawContext) ImageEffect.DisposeCreatedRenderTargetViews(RenderDrawContext) ImageEffect.InputCount ImageEffect.GetInput(int) ImageEffect.GetSafeInput(int) ImageEffect.DepthStencil ImageEffect.HasDepthStencilOutput ImageEffect.OutputCount ImageEffect.GetOutput(int) ImageEffect.GetSafeOutput(int) ImageEffect.NewScopedRenderTarget2D(TextureDescription) ImageEffect.NewScopedRenderTarget2D(int, int, PixelFormat, TextureFlags, int) ImageEffect.NewScopedRenderTarget2D(int, int, PixelFormat, MipMapCount, TextureFlags, int) DrawEffect.SamplingPattern DrawEffect.Parameters DrawEffect.Scaler DrawEffect.SetDefaultParameters() DrawEffect.Draw(RenderDrawContext, string) DrawEffect.Draw(RenderDrawContext, string, params object[]) DrawEffect.ToString() RendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) ImageEffectExtensions.SetInput(IImageEffect, Texture) ImageEffectExtensions.SetInput(IImageEffect, Texture, Texture) ImageEffectExtensions.SetInput(IImageEffect, Texture, Texture, Texture) UnsafeUtilities.As<T>(object?) Constructors LambertianPrefilteringSHNoCompute(RenderContext) public LambertianPrefilteringSHNoCompute(RenderContext context) Parameters context RenderContext Properties HarmonicOrder Gets or sets the level of precision desired when calculating the spherical harmonics. public int HarmonicOrder { get; set; } Property Value int PrefilteredLambertianSH Gets the computed spherical harmonics corresponding to the pre-filtered lambertian. public SphericalHarmonics PrefilteredLambertianSH { get; } Property Value SphericalHarmonics RadianceMap Gets or sets the input radiance map to pre-filter. public Texture RadianceMap { get; set; } Property Value Texture Methods DrawCore(RenderDrawContext) Main drawing method for this renderer that must be implemented. protected override void DrawCore(RenderDrawContext context) Parameters context RenderDrawContext The context."
  },
  "api/Stride.Rendering.ComputeEffect.LambertianPrefiltering.html": {
    "href": "api/Stride.Rendering.ComputeEffect.LambertianPrefiltering.html",
    "title": "Namespace Stride.Rendering.ComputeEffect.LambertianPrefiltering | Stride API",
    "summary": "Namespace Stride.Rendering.ComputeEffect.LambertianPrefiltering Classes LambertianPrefilteringSH Performs Lambertian pre-filtering in the form of Spherical Harmonics. LambertianPrefilteringSHNoCompute Performs Lambertian pre-filtering in the form of Spherical Harmonics."
  },
  "api/Stride.Rendering.ComputeEffect.html": {
    "href": "api/Stride.Rendering.ComputeEffect.html",
    "title": "Namespace Stride.Rendering.ComputeEffect | Stride API",
    "summary": "Namespace Stride.Rendering.ComputeEffect Classes ComputeEffectShader A compute effect based directly on a single compute shader. ComputeEffectShaderKeys ComputeShaderBaseKeys"
  },
  "api/Stride.Rendering.ConstantBufferOffsetReference.html": {
    "href": "api/Stride.Rendering.ConstantBufferOffsetReference.html",
    "title": "Struct ConstantBufferOffsetReference | Stride API",
    "summary": "Struct ConstantBufferOffsetReference Namespace Stride.Rendering Assembly Stride.Rendering.dll Handle used to query what's the actual offset of a given variable in a constant buffer, through GetConstantBufferOffset(ConstantBufferOffsetReference). public struct ConstantBufferOffsetReference Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Invalid public static readonly ConstantBufferOffsetReference Invalid Field Value ConstantBufferOffsetReference"
  },
  "api/Stride.Rendering.Data.ParameterCollectionHashSerializer.html": {
    "href": "api/Stride.Rendering.Data.ParameterCollectionHashSerializer.html",
    "title": "Class ParameterCollectionHashSerializer | Stride API",
    "summary": "Class ParameterCollectionHashSerializer Namespace Stride.Rendering.Data Assembly Stride.dll public class ParameterCollectionHashSerializer : ClassDataSerializer<ParameterCollection> Inheritance object DataSerializer DataSerializer<ParameterCollection> ClassDataSerializer<ParameterCollection> ParameterCollectionHashSerializer Inherited Members ClassDataSerializer<ParameterCollection>.PreSerialize(ref ParameterCollection, ArchiveMode, SerializationStream) DataSerializer<ParameterCollection>.SerializationType DataSerializer<ParameterCollection>.IsBlittable DataSerializer<ParameterCollection>.Serialize(ref object, ArchiveMode, SerializationStream) DataSerializer<ParameterCollection>.Serialize(ParameterCollection, SerializationStream) DataSerializer<ParameterCollection>.PreSerialize(ref object, ArchiveMode, SerializationStream) DataSerializer.BinaryFormatVersion DataSerializer.SerializationTypeId Extension Methods UnsafeUtilities.As<T>(object?) Methods Initialize(SerializerSelector) Initializes the specified serializer. public override void Initialize(SerializerSelector serializerSelector) Parameters serializerSelector SerializerSelector The serializer. Remarks This method should be thread-safe and OK to call multiple times. Serialize(ref ParameterCollection, ArchiveMode, SerializationStream) Serializes or deserializes the given object obj. public override void Serialize(ref ParameterCollection parameterCollection, ArchiveMode mode, SerializationStream stream) Parameters parameterCollection ParameterCollection mode ArchiveMode The serialization mode. stream SerializationStream The stream to serialize or deserialize to."
  },
  "api/Stride.Rendering.Data.html": {
    "href": "api/Stride.Rendering.Data.html",
    "title": "Namespace Stride.Rendering.Data | Stride API",
    "summary": "Namespace Stride.Rendering.Data Classes ParameterCollectionHashSerializer"
  },
  "api/Stride.Rendering.DataType.html": {
    "href": "api/Stride.Rendering.DataType.html",
    "title": "Enum DataType | Stride API",
    "summary": "Enum DataType Namespace Stride.Rendering Assembly Stride.Rendering.dll public enum DataType Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields EffectObject = 3 Object = 1 Render = 2 StaticObject = 5 View = 4 ViewObject = 0"
  },
  "api/Stride.Rendering.DefaultEffectMixinProvider.html": {
    "href": "api/Stride.Rendering.DefaultEffectMixinProvider.html",
    "title": "Class DefaultEffectMixinProvider | Stride API",
    "summary": "Class DefaultEffectMixinProvider Namespace Stride.Rendering Assembly Stride.Rendering.dll [DataContract(\"DefaultEffectMixinProvider\")] public class DefaultEffectMixinProvider : IEffectMixinProvider Inheritance object DefaultEffectMixinProvider Implements IEffectMixinProvider Extension Methods UnsafeUtilities.As<T>(object?) Constructors DefaultEffectMixinProvider(string) public DefaultEffectMixinProvider(string name) Parameters name string Methods GenerateShaderSource() Generates the shader source used for rendering. public ShaderSource GenerateShaderSource() Returns ShaderSource ShaderSource."
  },
  "api/Stride.Rendering.DepthBaseKeys.html": {
    "href": "api/Stride.Rendering.DepthBaseKeys.html",
    "title": "Class DepthBaseKeys | Stride API",
    "summary": "Class DepthBaseKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll public static class DepthBaseKeys Inheritance object DepthBaseKeys Fields DepthStencil public static readonly ObjectParameterKey<Texture> DepthStencil Field Value ObjectParameterKey<Texture>"
  },
  "api/Stride.Rendering.DitherKeys.html": {
    "href": "api/Stride.Rendering.DitherKeys.html",
    "title": "Class DitherKeys | Stride API",
    "summary": "Class DitherKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll public static class DitherKeys Inheritance object DitherKeys Fields Time public static readonly ValueParameterKey<float> Time Field Value ValueParameterKey<float>"
  },
  "api/Stride.Rendering.DrawEffect.html": {
    "href": "api/Stride.Rendering.DrawEffect.html",
    "title": "Class DrawEffect | Stride API",
    "summary": "Class DrawEffect Namespace Stride.Rendering Assembly Stride.Rendering.dll The base class in charge of applying and drawing an effect. [DataContract] public abstract class DrawEffect : RendererBase, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable Inheritance object DisposeBase ComponentBase RendererCoreBase RendererBase DrawEffect Implements IComponent IReferencable ICollectorHolder IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable Derived ComputeEffectShader RadiancePrefilteringGGX RadiancePrefilteringGGXNoCompute LambertianPrefilteringSH ImageEffect Inherited Members RendererBase.DrawCore(RenderDrawContext) RendererBase.Draw(RenderDrawContext) RendererCoreBase.Enabled RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.Unload() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DrawEffect() Initializes a new instance of the DrawEffect class with the given RenderContext. protected DrawEffect() DrawEffect(RenderContext, string) Initializes a new instance of the DrawEffect class. protected DrawEffect(RenderContext context, string name = null) Parameters context RenderContext The context. name string The name. DrawEffect(string) Initializes a new instance of the DrawEffect class. protected DrawEffect(string name) Parameters name string Properties Parameters Gets the parameters. public ParameterCollection Parameters { get; protected set; } Property Value ParameterCollection The parameters. SamplingPattern public SamplingPattern SamplingPattern { get; set; } Property Value SamplingPattern Scaler Gets a shared ImageScaler. protected ImageScaler Scaler { get; } Property Value ImageScaler Methods Draw(RenderDrawContext, string) Draws a full screen quad using iterating on each pass of this effect. public void Draw(RenderDrawContext context, string name) Parameters context RenderDrawContext name string Draw(RenderDrawContext, string, params object[]) Draws a full screen quad using iterating on each pass of this effect. public void Draw(RenderDrawContext context, string nameFormat, params object[] args) Parameters context RenderDrawContext nameFormat string args object[] Reset() Resets the state of this effect. public virtual void Reset() SetDefaultParameters() Sets the default parameters (called at constructor time and if Reset() is called) protected virtual void SetDefaultParameters() ToString() Returns a string that represents this instance. public override string ToString() Returns string A string that represents this instance."
  },
  "api/Stride.Rendering.DynamicEffectInstance.html": {
    "href": "api/Stride.Rendering.DynamicEffectInstance.html",
    "title": "Class DynamicEffectInstance | Stride API",
    "summary": "Class DynamicEffectInstance Namespace Stride.Rendering Assembly Stride.Rendering.dll Represents an instance of an Effect that can be dynamically compiled in different permutations according to the permutation parameters set in its Parameters. public class DynamicEffectInstance : EffectInstance, IDisposable, IReferencable Inheritance object DisposeBase EffectInstance DynamicEffectInstance Implements IDisposable IReferencable Inherited Members EffectInstance.Effect EffectInstance.permutationCounter EffectInstance.DescriptorReflection EffectInstance.RootSignature EffectInstance.Parameters EffectInstance.Destroy() EffectInstance.UpdateEffect(GraphicsDevice) EffectInstance.Apply(GraphicsContext) DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors DynamicEffectInstance(string, ParameterCollection?) Initializes a new instance of the DynamicEffectInstance class with the specified effect name and parameters. public DynamicEffectInstance(string effectName, ParameterCollection? parameters = null) Parameters effectName string The name of the Effect. parameters ParameterCollection Properties EffectCompilerParameters Gets the parameters used when compiling the Effect used by this instance. public ref EffectCompilerParameters EffectCompilerParameters { get; } Property Value EffectCompilerParameters EffectName Gets or sets the name of the Effect to be used by this instance. public string EffectName { get; set; } Property Value string Methods ChooseEffect() Selects and compiles the appropriate Effect based on the current parameters. protected override void ChooseEffect() Remarks This method updates the Effect by recompiling and reloading it with the current set of permutation parameters. Initialize(IServiceRegistry) Initializes the Effect instance. public void Initialize(IServiceRegistry services) Parameters services IServiceRegistry The service registry used to obtain necessary services for initialization. Remarks This method retrieves the EffectSystem service from the provided service registry. Exceptions ArgumentNullException services is null. ServiceNotFoundException The required service EffectSystem was not found."
  },
  "api/Stride.Rendering.EffectDescriptorSetReference.html": {
    "href": "api/Stride.Rendering.EffectDescriptorSetReference.html",
    "title": "Struct EffectDescriptorSetReference | Stride API",
    "summary": "Struct EffectDescriptorSetReference Namespace Stride.Rendering Assembly Stride.Rendering.dll Handle used to query what's the actual offset of a given variable in a constant buffer, through GetConstantBufferOffset(ConstantBufferOffsetReference). public struct EffectDescriptorSetReference Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Index public readonly int Index Field Value int"
  },
  "api/Stride.Rendering.EffectInstance.html": {
    "href": "api/Stride.Rendering.EffectInstance.html",
    "title": "Class EffectInstance | Stride API",
    "summary": "Class EffectInstance Namespace Stride.Rendering Assembly Stride.Graphics.dll Represents an instance of an Effect, including its values and Graphics Resources to bind (such as Textures, Buffers, or SamplerStates). public class EffectInstance : DisposeBase, IDisposable, IReferencable Inheritance object DisposeBase EffectInstance Implements IDisposable IReferencable Derived DynamicEffectInstance Inherited Members DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors EffectInstance(Effect, ParameterCollection?) Represents an instance of an Effect, including its values and Graphics Resources to bind (such as Textures, Buffers, or SamplerStates). public EffectInstance(Effect effect, ParameterCollection? parameters = null) Parameters effect Effect The Effect that will be used by the Effect instance. parameters ParameterCollection An optional collection of parameters that can be used to customize the Effect instance. Specify null to use the default parameters. Fields permutationCounter protected int permutationCounter Field Value int Properties DescriptorReflection Gets a reflection object that describes the Descriptor Sets and their layouts for the Effect used by this instance. This includes the bindings for Graphics Resources such as Textures, Buffers, and SamplerStates. public EffectDescriptorSetReflection DescriptorReflection { get; } Property Value EffectDescriptorSetReflection Effect Gets the Effect currently used by this instance. public Effect Effect { get; protected set; } Property Value Effect Parameters Gets the collection of parameters used by this Effect instance. public ParameterCollection Parameters { get; } Property Value ParameterCollection RootSignature Gets the Root Signature associated with the current graphics pipeline. public RootSignature RootSignature { get; } Property Value RootSignature Remarks A Root Signature is used to specify how Graphics Resources, such as Textures and Buffers, are bound to the graphics pipeline (i.e. how DescriptorSet will be bound together). Methods Apply(GraphicsContext) Applies the current parameters set for this Effect instance to the provided graphics context, updating bound Graphics Resources, uploading Constant Buffers, etc. public void Apply(GraphicsContext graphicsContext) Parameters graphicsContext GraphicsContext The graphics context to which the Effect parameters will be applied. This context must be valid and initialized before calling this method. Exceptions ArgumentNullException graphicsContext is null. ChooseEffect() Selects and compiles the appropriate Effect based on the current parameters. protected virtual void ChooseEffect() Remarks When overridden in a derived class, this method should implement the logic to select and compile the Effect based on the current set of parameters, for example, by using the permutation parameters set in Parameters to compile a specific version of the Effect. Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. UpdateEffect(GraphicsDevice) Updates the Effect associated with this instance. public bool UpdateEffect(GraphicsDevice graphicsDevice) Parameters graphicsDevice GraphicsDevice The Graphics Device to which the Effect is applied. Returns bool true if the Effect was updated; otherwise, false. Remarks This method checks if the Effect needs to be updated based on changes in the permutation parameters or the source of the Effect. If an update is necessary, it reinitializes the Effect, updates the reflection information, and prepares the necessary Graphics Resources and data."
  },
  "api/Stride.Rendering.EffectObjectNode.html": {
    "href": "api/Stride.Rendering.EffectObjectNode.html",
    "title": "Struct EffectObjectNode | Stride API",
    "summary": "Struct EffectObjectNode Namespace Stride.Rendering Assembly Stride.Rendering.dll Represents a RenderObject drawn with a specific RenderEffect, with attached properties. public struct EffectObjectNode Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors EffectObjectNode(RenderEffect, ObjectNodeReference) public EffectObjectNode(RenderEffect renderEffect, ObjectNodeReference objectNode) Parameters renderEffect RenderEffect objectNode ObjectNodeReference Fields ObjectConstantBufferOffset The \"PerObject\" constant buffer offset in our global cbuffer. public int ObjectConstantBufferOffset Field Value int ObjectDescriptorSet The \"PerObject\" descriptor set. public DescriptorSet ObjectDescriptorSet Field Value DescriptorSet ObjectNode The object node reference. public ObjectNodeReference ObjectNode Field Value ObjectNodeReference RenderEffect The effect used. public RenderEffect RenderEffect Field Value RenderEffect"
  },
  "api/Stride.Rendering.EffectObjectNodeReference.html": {
    "href": "api/Stride.Rendering.EffectObjectNodeReference.html",
    "title": "Struct EffectObjectNodeReference | Stride API",
    "summary": "Struct EffectObjectNodeReference Namespace Stride.Rendering Assembly Stride.Rendering.dll public struct EffectObjectNodeReference Inherited Members ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors EffectObjectNodeReference(int) public EffectObjectNodeReference(int index) Parameters index int Fields Index public readonly int Index Field Value int Invalid Invalid slot. public static readonly EffectObjectNodeReference Invalid Field Value EffectObjectNodeReference Methods Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object other) Parameters other object Returns bool true if obj and this instance are the same type and represent the same value; otherwise, false. GetHashCode() Returns the hash code for this instance. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator +(EffectObjectNodeReference, int) public static EffectObjectNodeReference operator +(EffectObjectNodeReference value, int offset) Parameters value EffectObjectNodeReference offset int Returns EffectObjectNodeReference operator ==(EffectObjectNodeReference, EffectObjectNodeReference) public static bool operator ==(EffectObjectNodeReference a, EffectObjectNodeReference b) Parameters a EffectObjectNodeReference b EffectObjectNodeReference Returns bool operator !=(EffectObjectNodeReference, EffectObjectNodeReference) public static bool operator !=(EffectObjectNodeReference a, EffectObjectNodeReference b) Parameters a EffectObjectNodeReference b EffectObjectNodeReference Returns bool operator *(EffectObjectNodeReference, int) public static EffectObjectNodeReference operator *(EffectObjectNodeReference value, int multiplyFactor) Parameters value EffectObjectNodeReference multiplyFactor int Returns EffectObjectNodeReference"
  },
  "api/Stride.Rendering.EffectObjectPropertyData-1.html": {
    "href": "api/Stride.Rendering.EffectObjectPropertyData-1.html",
    "title": "Struct EffectObjectPropertyData<T> | Stride API",
    "summary": "Struct EffectObjectPropertyData<T> Namespace Stride.Rendering Assembly Stride.Rendering.dll public struct EffectObjectPropertyData<T> Type Parameters T Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties this[EffectObjectNodeReference] public ref T this[EffectObjectNodeReference index] { get; } Parameters index EffectObjectNodeReference Property Value T"
  },
  "api/Stride.Rendering.EffectObjectPropertyDefinition-1.html": {
    "href": "api/Stride.Rendering.EffectObjectPropertyDefinition-1.html",
    "title": "Class EffectObjectPropertyDefinition<T> | Stride API",
    "summary": "Class EffectObjectPropertyDefinition<T> Namespace Stride.Rendering Assembly Stride.Rendering.dll public class EffectObjectPropertyDefinition<T> Type Parameters T Inheritance object EffectObjectPropertyDefinition<T> Extension Methods UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Rendering.EffectObjectPropertyKey-1.html": {
    "href": "api/Stride.Rendering.EffectObjectPropertyKey-1.html",
    "title": "Struct EffectObjectPropertyKey<T> | Stride API",
    "summary": "Struct EffectObjectPropertyKey<T> Namespace Stride.Rendering Assembly Stride.Rendering.dll public struct EffectObjectPropertyKey<T> Type Parameters T Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?)"
  },
  "api/Stride.Rendering.EffectParameterUpdater.html": {
    "href": "api/Stride.Rendering.EffectParameterUpdater.html",
    "title": "Struct EffectParameterUpdater | Stride API",
    "summary": "Struct EffectParameterUpdater Namespace Stride.Rendering Assembly Stride.Graphics.dll Helper class to update several ResourceGroup from a ParameterCollection. public struct EffectParameterUpdater Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Constructors EffectParameterUpdater(EffectParameterUpdaterLayout, ParameterCollection) public EffectParameterUpdater(EffectParameterUpdaterLayout updaterLayout, ParameterCollection parameters) Parameters updaterLayout EffectParameterUpdaterLayout parameters ParameterCollection Properties ResourceGroups public ResourceGroup[] ResourceGroups { get; } Property Value ResourceGroup[] Methods Update(GraphicsDevice, ResourceGroupAllocator, ParameterCollection) public void Update(GraphicsDevice graphicsDevice, ResourceGroupAllocator resourceGroupAllocator, ParameterCollection parameters) Parameters graphicsDevice GraphicsDevice resourceGroupAllocator ResourceGroupAllocator parameters ParameterCollection"
  },
  "api/Stride.Rendering.EffectParameterUpdaterLayout.html": {
    "href": "api/Stride.Rendering.EffectParameterUpdaterLayout.html",
    "title": "Class EffectParameterUpdaterLayout | Stride API",
    "summary": "Class EffectParameterUpdaterLayout Namespace Stride.Rendering Assembly Stride.Graphics.dll Defines the layout used by EffectParameterUpdater to update several ResourceGroups from a ParameterCollection. public class EffectParameterUpdaterLayout Inheritance object EffectParameterUpdaterLayout Extension Methods UnsafeUtilities.As<T>(object?) Constructors EffectParameterUpdaterLayout(GraphicsDevice, EffectBytecode, DescriptorSetLayoutBuilder[]) Initializes a new instance of the EffectParameterUpdaterLayout class. public EffectParameterUpdaterLayout(GraphicsDevice graphicsDevice, EffectBytecode effectBytecode, DescriptorSetLayoutBuilder[] layouts) Parameters graphicsDevice GraphicsDevice The Graphics Device used to create resource group layouts. Cannot be null. effectBytecode EffectBytecode layouts DescriptorSetLayoutBuilder[] An array of DescriptorSetLayoutBuilder instances that define the layouts for resource groups. Each layout is processed to extract resources and Constant Buffers. Cannot be null or contain null elements. Remarks This constructor processes the provided Descriptor Set layouts to create resource group layouts and associates them with the Effect's parameters. It identifies Constant Buffers within the layouts and processes them to ensure they are compatible with the Effect's bytecode."
  },
  "api/Stride.Rendering.EffectPermutationSlot.html": {
    "href": "api/Stride.Rendering.EffectPermutationSlot.html",
    "title": "Struct EffectPermutationSlot | Stride API",
    "summary": "Struct EffectPermutationSlot Namespace Stride.Rendering Assembly Stride.Rendering.dll Defines an effect permutation slot for a RootRenderFeature. public struct EffectPermutationSlot Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.AsPointer<T>(ref T) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsReadOnlySpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom) UnsafeUtilities.AsSpan<TFrom, TTo>(scoped ref TFrom, int) UnsafeUtilities.As<TFrom, TTo>(ref TFrom) UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Fields Index public readonly int Index Field Value int Invalid Invalid slot. public static readonly EffectPermutationSlot Invalid Field Value EffectPermutationSlot"
  },
  "api/Stride.Rendering.EffectSelector.html": {
    "href": "api/Stride.Rendering.EffectSelector.html",
    "title": "Class EffectSelector | Stride API",
    "summary": "Class EffectSelector Namespace Stride.Rendering Assembly Stride.Rendering.dll public class EffectSelector Inheritance object EffectSelector Extension Methods UnsafeUtilities.As<T>(object?) Constructors EffectSelector(string) public EffectSelector(string effectName) Parameters effectName string Properties EffectName public string EffectName { get; } Property Value string"
  },
  "api/Stride.Rendering.EffectSystem.html": {
    "href": "api/Stride.Rendering.EffectSystem.html",
    "title": "Class EffectSystem | Stride API",
    "summary": "Class EffectSystem Namespace Stride.Rendering Assembly Stride.Rendering.dll The effect system. public class EffectSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase EffectSystem Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Inherited Members GameSystemBase.Game GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.Draw(GameTime) GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) GameSystemBase.LoadContent() GameSystemBase.UnloadContent() ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) EffectSystemExtensions.LoadEffect(EffectSystem, string) UnsafeUtilities.As<T>(object?) Constructors EffectSystem(IServiceRegistry) Initializes a new instance of the EffectSystem class. public EffectSystem(IServiceRegistry services) Parameters services IServiceRegistry The services. Properties Compiler public IEffectCompiler Compiler { get; set; } Property Value IEffectCompiler FileProvider Gets or sets the database file provider, to use for loading effects and shader sources. public IVirtualFileProvider FileProvider { get; } Property Value IVirtualFileProvider The database file provider. Methods Destroy() Disposes the object's resources. protected override void Destroy() Remarks Override in a derived class to implement disposal logic specific to it. This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released. GetShaderFromParameters(string, CompilerParameters) Get the shader from the database based on the parameters used for its compilation. protected CompilerResults GetShaderFromParameters(string effectName, CompilerParameters parameters) Parameters effectName string Name of the effect. parameters CompilerParameters The parameters. Returns CompilerResults The EffectBytecode if found. Initialize() Initializes the Game System. public override void Initialize() Remarks This method is called when the component is added to the Game. This can be used for tasks like querying for services the component needs and setting up non-graphics resources (as here the Graphics Device may have not been initialized yet). IsValid(Effect) public bool IsValid(Effect effect) Parameters effect Effect Returns bool LoadEffect(string, CompilerParameters) Loads the effect. public TaskOrResult<Effect> LoadEffect(string effectName, CompilerParameters compilerParameters) Parameters effectName string Name of the effect. compilerParameters CompilerParameters The compiler parameters. Returns TaskOrResult<Effect> A new instance of an effect. Exceptions InvalidOperationException Could not compile shader. Need fallback. SetCompilationMode(CompilationMode) public void SetCompilationMode(CompilationMode compilationMode) Parameters compilationMode CompilationMode Update(GameTime) This method is called when this game component is updated. public override void Update(GameTime gameTime) Parameters gameTime GameTime The current timing."
  },
  "api/Stride.Rendering.EffectSystemExtensions.html": {
    "href": "api/Stride.Rendering.EffectSystemExtensions.html",
    "title": "Class EffectSystemExtensions | Stride API",
    "summary": "Class EffectSystemExtensions Namespace Stride.Rendering Assembly Stride.Rendering.dll Extensions for EffectSystem public static class EffectSystemExtensions Inheritance object EffectSystemExtensions Methods LoadEffect(EffectSystem, string) Creates an effect. public static TaskOrResult<Effect> LoadEffect(this EffectSystem effectSystem, string effectName) Parameters effectSystem EffectSystem The effect system. effectName string Name of the effect. Returns TaskOrResult<Effect> A new instance of an effect."
  },
  "api/Stride.Rendering.EffectValidator.html": {
    "href": "api/Stride.Rendering.EffectValidator.html",
    "title": "Struct EffectValidator | Stride API",
    "summary": "Struct EffectValidator Namespace Stride.Rendering Assembly Stride.Rendering.dll How to use: BeginEffectValidation(); ValidateParameter(key1, value1); ValidateParameter(key2, value2); ... EndEffectValidation(); //returns true if same as last time, false if something changed You can use EffectValues to actually compile the effect. public struct EffectValidator Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() Extension Methods UnsafeUtilities.BitCast<TFrom, TTo>(TFrom) UnsafeUtilities.As<T>(object?) Properties ShouldSkip Sets this property to true to skip this effect. public bool ShouldSkip { readonly get; set; } Property Value bool Methods BeginEffectValidation() public void BeginEffectValidation() EndEffectValidation() public bool EndEffectValidation() Returns bool Initialize() public void Initialize() ValidateParameter<T>(PermutationParameterKey<T>, T) public void ValidateParameter<T>(PermutationParameterKey<T> key, T value) Parameters key PermutationParameterKey<T> value T Type Parameters T"
  },
  "api/Stride.Rendering.Fonts.GameFontSystem.html": {
    "href": "api/Stride.Rendering.Fonts.GameFontSystem.html",
    "title": "Class GameFontSystem | Stride API",
    "summary": "Class GameFontSystem Namespace Stride.Rendering.Fonts Assembly Stride.Rendering.dll The game system in charge of calling FontSystem. public class GameFontSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable Inheritance object DisposeBase ComponentBase GameSystemBase GameFontSystem Implements IDisposable ICollectorHolder IGameSystemBase IComponent IReferencable IUpdateable IDrawable IContentable Inherited Members GameSystemBase.Game GameSystemBase.Services GameSystemBase.Content GameSystemBase.GraphicsDevice GameSystemBase.DrawOrderChanged GameSystemBase.VisibleChanged GameSystemBase.BeginDraw() GameSystemBase.EndDraw() GameSystemBase.Visible GameSystemBase.DrawOrder GameSystemBase.Initialize() GameSystemBase.InitializeGraphicsDeviceService() GameSystemBase.EnabledChanged GameSystemBase.UpdateOrderChanged GameSystemBase.Update(GameTime) GameSystemBase.Enabled GameSystemBase.UpdateOrder GameSystemBase.OnDrawOrderChanged(object, EventArgs) GameSystemBase.OnUpdateOrderChanged(object, EventArgs) ComponentBase.Tags ComponentBase.Name ComponentBase.Destroy() ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) UnsafeUtilities.As<T>(object?) Constructors GameFontSystem(IServiceRegistry) public GameFontSystem(IServiceRegistry registry) Parameters registry IServiceRegistry Properties FontSystem public FontSystem FontSystem { get; } Property Value FontSystem Methods Draw(GameTime) Draws the Game Component. public override void Draw(GameTime gameTime) Parameters gameTime GameTime The current timing information. LoadContent() protected override void LoadContent() UnloadContent() protected override void UnloadContent()"
  },
  "api/Stride.Rendering.Fonts.html": {
    "href": "api/Stride.Rendering.Fonts.html",
    "title": "Namespace Stride.Rendering.Fonts | Stride API",
    "summary": "Namespace Stride.Rendering.Fonts Classes GameFontSystem The game system in charge of calling FontSystem."
  },
  "api/Stride.Rendering.FrameResourceGroupLayout.html": {
    "href": "api/Stride.Rendering.FrameResourceGroupLayout.html",
    "title": "Class FrameResourceGroupLayout | Stride API",
    "summary": "Class FrameResourceGroupLayout Namespace Stride.Rendering Assembly Stride.Rendering.dll Implementation of RenderSystemResourceGroupLayout specifically for PerFrame cbuffer of RenderSystem. public class FrameResourceGroupLayout : RenderSystemResourceGroupLayout Inheritance object ResourceGroupLayout RenderSystemResourceGroupLayout FrameResourceGroupLayout Inherited Members RenderSystemResourceGroupLayout.State RenderSystemResourceGroupLayout.GetConstantBufferOffset(ConstantBufferOffsetReference) RenderSystemResourceGroupLayout.GetLogicalGroup(LogicalGroupReference) ResourceGroupLayout.DescriptorSetLayoutBuilder ResourceGroupLayout.DescriptorSetLayout ResourceGroupLayout.ConstantBufferSize ResourceGroupLayout.ConstantBufferReflection ResourceGroupLayout.Hash ResourceGroupLayout.ConstantBufferHash ResourceGroupLayout.New(GraphicsDevice, ResourceGroupDescription) ResourceGroupLayout.New<TLayout>(GraphicsDevice, ResourceGroupDescription) Extension Methods UnsafeUtilities.As<T>(object?) Fields Entry public ResourceGroupEntry Entry Field Value ResourceGroupEntry"
  },
  "api/Stride.Rendering.FrontToBackSortMode.html": {
    "href": "api/Stride.Rendering.FrontToBackSortMode.html",
    "title": "Class FrontToBackSortMode | Stride API",
    "summary": "Class FrontToBackSortMode Namespace Stride.Rendering Assembly Stride.Rendering.dll Sort elements according to the pattern: [RenderFeature Sort Key 8 bits] [Distance front to back 16 bits] [RenderObject states 32 bits] [DataContract(\"FrontToBackSortMode\")] public class FrontToBackSortMode : SortModeDistance Inheritance object SortMode SortModeDistance FrontToBackSortMode Inherited Members SortModeDistance.distancePosition SortModeDistance.distancePrecision SortModeDistance.statePosition SortModeDistance.statePrecision SortModeDistance.ComputeDistance(float) SortModeDistance.CreateSortKey(float) SortModeDistance.GenerateSortKey(RenderView, RenderViewStage, SortKey*) Extension Methods UnsafeUtilities.As<T>(object?) Constructors FrontToBackSortMode() public FrontToBackSortMode()"
  },
  "api/Stride.Rendering.GlobalKeys.html": {
    "href": "api/Stride.Rendering.GlobalKeys.html",
    "title": "Class GlobalKeys | Stride API",
    "summary": "Class GlobalKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll public static class GlobalKeys Inheritance object GlobalKeys Fields Time public static readonly ValueParameterKey<float> Time Field Value ValueParameterKey<float> TimeStep public static readonly ValueParameterKey<float> TimeStep Field Value ValueParameterKey<float>"
  },
  "api/Stride.Rendering.GlobalVRKeys.html": {
    "href": "api/Stride.Rendering.GlobalVRKeys.html",
    "title": "Class GlobalVRKeys | Stride API",
    "summary": "Class GlobalVRKeys Namespace Stride.Rendering Assembly Stride.Rendering.dll public static class GlobalVRKeys Inheritance object GlobalVRKeys Fields EyeCount public static readonly ValueParameterKey<int> EyeCount Field Value ValueParameterKey<int> EyeIndex public static readonly ValueParameterKey<int> EyeIndex Field Value ValueParameterKey<int>"
  },
  "api/Stride.Rendering.GraphicsRendererCollection-1.html": {
    "href": "api/Stride.Rendering.GraphicsRendererCollection-1.html",
    "title": "Class GraphicsRendererCollection<T> | Stride API",
    "summary": "Class GraphicsRendererCollection<T> Namespace Stride.Rendering Assembly Stride.Rendering.dll A collection of IGraphicsRenderer that is itself a IGraphicsRenderer handling automatically Initialize(RenderContext) and Unload(). [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] public abstract class GraphicsRendererCollection<T> : GraphicsRendererCollectionBase<T>, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable, IList<T>, ICollection<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable where T : class, IGraphicsRenderer Type Parameters T Type of the IGraphicsRenderer Inheritance object DisposeBase ComponentBase RendererCoreBase GraphicsRendererCollectionBase<T> GraphicsRendererCollection<T> Implements IComponent IReferencable ICollectorHolder IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable IList<T> ICollection<T> IReadOnlyList<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable Inherited Members GraphicsRendererCollectionBase<T>.Enabled GraphicsRendererCollectionBase<T>.GetEnumerator() GraphicsRendererCollectionBase<T>.Add(T) GraphicsRendererCollectionBase<T>.Clear() GraphicsRendererCollectionBase<T>.Contains(T) GraphicsRendererCollectionBase<T>.CopyTo(T[], int) GraphicsRendererCollectionBase<T>.Remove(T) GraphicsRendererCollectionBase<T>.Count GraphicsRendererCollectionBase<T>.IsReadOnly GraphicsRendererCollectionBase<T>.IndexOf(T) GraphicsRendererCollectionBase<T>.Insert(int, T) GraphicsRendererCollectionBase<T>.RemoveAt(int) GraphicsRendererCollectionBase<T>.this[int] GraphicsRendererCollectionBase<T>.Unload() GraphicsRendererCollectionBase<T>.Draw(RenderDrawContext) GraphicsRendererCollectionBase<T>.DrawCore(RenderDrawContext) GraphicsRendererCollectionBase<T>.InitializeRenderers(RenderContext) RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) EnumerableExtensions.IsNullOrEmpty(IEnumerable) UnsafeUtilities.As<T>(object?) Methods DrawRenderer(RenderDrawContext, T) protected override void DrawRenderer(RenderDrawContext context, T renderer) Parameters context RenderDrawContext renderer T"
  },
  "api/Stride.Rendering.GraphicsRendererCollectionBase-1.html": {
    "href": "api/Stride.Rendering.GraphicsRendererCollectionBase-1.html",
    "title": "Class GraphicsRendererCollectionBase<T> | Stride API",
    "summary": "Class GraphicsRendererCollectionBase<T> Namespace Stride.Rendering Assembly Stride.Rendering.dll A collection of IGraphicsRenderer that is itself a IGraphicsRenderer handling automatically Initialize(RenderContext) and Unload(). [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] public abstract class GraphicsRendererCollectionBase<T> : RendererCoreBase, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable, IList<T>, ICollection<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable where T : class, IGraphicsRendererCore Type Parameters T Type of the IGraphicsRenderer Inheritance object DisposeBase ComponentBase RendererCoreBase GraphicsRendererCollectionBase<T> Implements IComponent IReferencable ICollectorHolder IGraphicsRenderer IGraphicsRendererBase IGraphicsRendererCore IDisposable IList<T> ICollection<T> IReadOnlyList<T> IReadOnlyCollection<T> IEnumerable<T> IEnumerable Derived GraphicsRendererCollection<T> Inherited Members RendererCoreBase.Profiling RendererCoreBase.GPUProfilingKey RendererCoreBase.CPUProfilingKey RendererCoreBase.Context RendererCoreBase.Services RendererCoreBase.Content RendererCoreBase.GraphicsDevice RendererCoreBase.EffectSystem RendererCoreBase.Initialized RendererCoreBase.Initialize(RenderContext) RendererCoreBase.InitializeCore() RendererCoreBase.PreDrawCore(RenderDrawContext) RendererCoreBase.PostDrawCore(RenderDrawContext) RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat) RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage) RendererCoreBase.PushScopedResource<T>(T) RendererCoreBase.CheckIsInDrawCore() RendererCoreBase.Destroy() RendererCoreBase.ToLoadAndUnload<T>(T) RendererCoreBase.PreDrawCoreInternal(RenderDrawContext) RendererCoreBase.EnsureContext(RenderContext) RendererCoreBase.PostDrawCoreInternal(RenderDrawContext) ComponentBase.Tags ComponentBase.Name ComponentBase.OnNameChanged() ComponentBase.ToString() DisposeBase.IsDisposed DisposeBase.Dispose() DisposeBase.OnAddReference() DisposeBase.OnReleaseReference() Extension Methods ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder) ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder) ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>?) EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>) EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>) EnumerableExtensions.NotNull<T>(IEnumerable<T?>) EnumerableExtensions.ToHashCode<T>(IEnumerable<T>) CollectionExtensions.GetItemOrNull<T>(IList<T>, int) CollectionExtensions.SwapRemoveAt<T>(IList<T>, int) CollectionExtensions.SwapRemove<T>(IList<T>, T) CollectionExtensions.IndexOf<T>(IReadOnlyList<T>, T) EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>) En