1
0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-23 00:38:47 +00:00

[X10D.Unity] Add various yield instructions

This commit is contained in:
Oliver Booth 2022-07-14 12:00:55 +01:00
parent 02765b8b19
commit dcbe591d66
No known key found for this signature in database
GPG Key ID: 32A00B35503AF634
14 changed files with 729 additions and 0 deletions

View File

@ -75,6 +75,13 @@
- X10D.Unity: Added `Vector3Int.WithZ()` - X10D.Unity: Added `Vector3Int.WithZ()`
- X10D.Unity: Added `Vector4.Deconstruct()` - X10D.Unity: Added `Vector4.Deconstruct()`
- X10D.Unity: Added `Vector4.Round([float])` - X10D.Unity: Added `Vector4.Round([float])`
- X10D.Unity: Added `WaitForFrames` yield instruction
- X10D.Unity: Added `WaitForKeyDown` yield instruction
- X10D.Unity: Added `WaitForKeyUp` yield instruction
- X10D.Unity: Added `WaitForSecondsNoAlloc` yield instruction
- X10D.Unity: Added `WaitForSecondsRealtimeNoAlloc` yield instruction
- X10D.Unity: Added `WaitForTimeSpanNoAlloc` yield instruction
- X10D.Unity: Added `WaitForTimeSpanRealtimeNoAlloc` yield instruction
### Changed ### Changed
- X10D.Unity: Obsolesced `Singleton<T>` - X10D.Unity: Obsolesced `Singleton<T>`

View File

@ -0,0 +1,347 @@
%YAML 1.1
%TAG !u! tag:unity3d.com,2011:
--- !u!29 &1
OcclusionCullingSettings:
m_ObjectHideFlags: 0
serializedVersion: 2
m_OcclusionBakeSettings:
smallestOccluder: 5
smallestHole: 0.25
backfaceThreshold: 100
m_SceneGUID: 00000000000000000000000000000000
m_OcclusionCullingData: {fileID: 0}
--- !u!104 &2
RenderSettings:
m_ObjectHideFlags: 0
serializedVersion: 9
m_Fog: 0
m_FogColor: {r: 0.5, g: 0.5, b: 0.5, a: 1}
m_FogMode: 3
m_FogDensity: 0.01
m_LinearFogStart: 0
m_LinearFogEnd: 300
m_AmbientSkyColor: {r: 0.212, g: 0.227, b: 0.259, a: 1}
m_AmbientEquatorColor: {r: 0.114, g: 0.125, b: 0.133, a: 1}
m_AmbientGroundColor: {r: 0.047, g: 0.043, b: 0.035, a: 1}
m_AmbientIntensity: 1
m_AmbientMode: 0
m_SubtractiveShadowColor: {r: 0.42, g: 0.478, b: 0.627, a: 1}
m_SkyboxMaterial: {fileID: 10304, guid: 0000000000000000f000000000000000, type: 0}
m_HaloStrength: 0.5
m_FlareStrength: 1
m_FlareFadeSpeed: 3
m_HaloTexture: {fileID: 0}
m_SpotCookie: {fileID: 10001, guid: 0000000000000000e000000000000000, type: 0}
m_DefaultReflectionMode: 0
m_DefaultReflectionResolution: 128
m_ReflectionBounces: 1
m_ReflectionIntensity: 1
m_CustomReflection: {fileID: 0}
m_Sun: {fileID: 0}
m_IndirectSpecularColor: {r: 0.44657898, g: 0.4964133, b: 0.5748178, a: 1}
m_UseRadianceAmbientProbe: 0
--- !u!157 &3
LightmapSettings:
m_ObjectHideFlags: 0
serializedVersion: 12
m_GIWorkflowMode: 1
m_GISettings:
serializedVersion: 2
m_BounceScale: 1
m_IndirectOutputScale: 1
m_AlbedoBoost: 1
m_EnvironmentLightingMode: 0
m_EnableBakedLightmaps: 1
m_EnableRealtimeLightmaps: 0
m_LightmapEditorSettings:
serializedVersion: 12
m_Resolution: 2
m_BakeResolution: 40
m_AtlasSize: 1024
m_AO: 0
m_AOMaxDistance: 1
m_CompAOExponent: 1
m_CompAOExponentDirect: 0
m_ExtractAmbientOcclusion: 0
m_Padding: 2
m_LightmapParameters: {fileID: 0}
m_LightmapsBakeMode: 1
m_TextureCompression: 1
m_FinalGather: 0
m_FinalGatherFiltering: 1
m_FinalGatherRayCount: 256
m_ReflectionCompression: 2
m_MixedBakeMode: 2
m_BakeBackend: 1
m_PVRSampling: 1
m_PVRDirectSampleCount: 32
m_PVRSampleCount: 512
m_PVRBounces: 2
m_PVREnvironmentSampleCount: 256
m_PVREnvironmentReferencePointCount: 2048
m_PVRFilteringMode: 1
m_PVRDenoiserTypeDirect: 1
m_PVRDenoiserTypeIndirect: 1
m_PVRDenoiserTypeAO: 1
m_PVRFilterTypeDirect: 0
m_PVRFilterTypeIndirect: 0
m_PVRFilterTypeAO: 0
m_PVREnvironmentMIS: 1
m_PVRCulling: 1
m_PVRFilteringGaussRadiusDirect: 1
m_PVRFilteringGaussRadiusIndirect: 5
m_PVRFilteringGaussRadiusAO: 2
m_PVRFilteringAtrousPositionSigmaDirect: 0.5
m_PVRFilteringAtrousPositionSigmaIndirect: 2
m_PVRFilteringAtrousPositionSigmaAO: 1
m_ExportTrainingData: 0
m_TrainingDataDestination: TrainingData
m_LightProbeSampleCountMultiplier: 4
m_LightingDataAsset: {fileID: 0}
m_LightingSettings: {fileID: 0}
--- !u!196 &4
NavMeshSettings:
serializedVersion: 2
m_ObjectHideFlags: 0
m_BuildSettings:
serializedVersion: 2
agentTypeID: 0
agentRadius: 0.5
agentHeight: 2
agentSlope: 45
agentClimb: 0.4
ledgeDropHeight: 0
maxJumpAcrossDistance: 0
minRegionArea: 2
manualCellSize: 0
cellSize: 0.16666667
manualTileSize: 0
tileSize: 256
accuratePlacement: 0
maxJobWorkers: 0
preserveTilesOutsideBounds: 0
debug:
m_Flags: 0
m_NavMeshData: {fileID: 0}
--- !u!1 &736700400
GameObject:
m_ObjectHideFlags: 0
m_CorrespondingSourceObject: {fileID: 0}
m_PrefabInstance: {fileID: 0}
m_PrefabAsset: {fileID: 0}
serializedVersion: 6
m_Component:
- component: {fileID: 736700402}
- component: {fileID: 736700401}
m_Layer: 0
m_Name: GameObject
m_TagString: Untagged
m_Icon: {fileID: 0}
m_NavMeshLayer: 0
m_StaticEditorFlags: 0
m_IsActive: 1
--- !u!114 &736700401
MonoBehaviour:
m_ObjectHideFlags: 0
m_CorrespondingSourceObject: {fileID: 0}
m_PrefabInstance: {fileID: 0}
m_PrefabAsset: {fileID: 0}
m_GameObject: {fileID: 736700400}
m_Enabled: 1
m_EditorHideFlags: 0
m_Script: {fileID: 11500000, guid: 67d53e2f993d4a5ba0eb34431d1846cd, type: 3}
m_Name:
m_EditorClassIdentifier:
--- !u!4 &736700402
Transform:
m_ObjectHideFlags: 0
m_CorrespondingSourceObject: {fileID: 0}
m_PrefabInstance: {fileID: 0}
m_PrefabAsset: {fileID: 0}
m_GameObject: {fileID: 736700400}
m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
m_LocalPosition: {x: 0, y: 0, z: 0}
m_LocalScale: {x: 1, y: 1, z: 1}
m_ConstrainProportionsScale: 0
m_Children: []
m_Father: {fileID: 0}
m_RootOrder: 2
m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
--- !u!1 &1077233431
GameObject:
m_ObjectHideFlags: 0
m_CorrespondingSourceObject: {fileID: 0}
m_PrefabInstance: {fileID: 0}
m_PrefabAsset: {fileID: 0}
serializedVersion: 6
m_Component:
- component: {fileID: 1077233433}
- component: {fileID: 1077233432}
m_Layer: 0
m_Name: Directional Light
m_TagString: Untagged
m_Icon: {fileID: 0}
m_NavMeshLayer: 0
m_StaticEditorFlags: 0
m_IsActive: 1
--- !u!108 &1077233432
Light:
m_ObjectHideFlags: 0
m_CorrespondingSourceObject: {fileID: 0}
m_PrefabInstance: {fileID: 0}
m_PrefabAsset: {fileID: 0}
m_GameObject: {fileID: 1077233431}
m_Enabled: 1
serializedVersion: 10
m_Type: 1
m_Shape: 0
m_Color: {r: 1, g: 0.95686275, b: 0.8392157, a: 1}
m_Intensity: 1
m_Range: 10
m_SpotAngle: 30
m_InnerSpotAngle: 21.80208
m_CookieSize: 10
m_Shadows:
m_Type: 2
m_Resolution: -1
m_CustomResolution: -1
m_Strength: 1
m_Bias: 0.05
m_NormalBias: 0.4
m_NearPlane: 0.2
m_CullingMatrixOverride:
e00: 1
e01: 0
e02: 0
e03: 0
e10: 0
e11: 1
e12: 0
e13: 0
e20: 0
e21: 0
e22: 1
e23: 0
e30: 0
e31: 0
e32: 0
e33: 1
m_UseCullingMatrixOverride: 0
m_Cookie: {fileID: 0}
m_DrawHalo: 0
m_Flare: {fileID: 0}
m_RenderMode: 0
m_CullingMask:
serializedVersion: 2
m_Bits: 4294967295
m_RenderingLayerMask: 1
m_Lightmapping: 4
m_LightShadowCasterMode: 0
m_AreaSize: {x: 1, y: 1}
m_BounceIntensity: 1
m_ColorTemperature: 6570
m_UseColorTemperature: 0
m_BoundingSphereOverride: {x: 0, y: 0, z: 0, w: 0}
m_UseBoundingSphereOverride: 0
m_UseViewFrustumForShadowCasterCull: 1
m_ShadowRadius: 0
m_ShadowAngle: 0
--- !u!4 &1077233433
Transform:
m_ObjectHideFlags: 0
m_CorrespondingSourceObject: {fileID: 0}
m_PrefabInstance: {fileID: 0}
m_PrefabAsset: {fileID: 0}
m_GameObject: {fileID: 1077233431}
m_LocalRotation: {x: 0.40821788, y: -0.23456968, z: 0.10938163, w: 0.8754261}
m_LocalPosition: {x: 0, y: 3, z: 0}
m_LocalScale: {x: 1, y: 1, z: 1}
m_ConstrainProportionsScale: 0
m_Children: []
m_Father: {fileID: 0}
m_RootOrder: 1
m_LocalEulerAnglesHint: {x: 50, y: -30, z: 0}
--- !u!1 &1698122894
GameObject:
m_ObjectHideFlags: 0
m_CorrespondingSourceObject: {fileID: 0}
m_PrefabInstance: {fileID: 0}
m_PrefabAsset: {fileID: 0}
serializedVersion: 6
m_Component:
- component: {fileID: 1698122897}
- component: {fileID: 1698122896}
- component: {fileID: 1698122895}
m_Layer: 0
m_Name: Main Camera
m_TagString: MainCamera
m_Icon: {fileID: 0}
m_NavMeshLayer: 0
m_StaticEditorFlags: 0
m_IsActive: 1
--- !u!81 &1698122895
AudioListener:
m_ObjectHideFlags: 0
m_CorrespondingSourceObject: {fileID: 0}
m_PrefabInstance: {fileID: 0}
m_PrefabAsset: {fileID: 0}
m_GameObject: {fileID: 1698122894}
m_Enabled: 1
--- !u!20 &1698122896
Camera:
m_ObjectHideFlags: 0
m_CorrespondingSourceObject: {fileID: 0}
m_PrefabInstance: {fileID: 0}
m_PrefabAsset: {fileID: 0}
m_GameObject: {fileID: 1698122894}
m_Enabled: 1
serializedVersion: 2
m_ClearFlags: 1
m_BackGroundColor: {r: 0.19215687, g: 0.3019608, b: 0.4745098, a: 0}
m_projectionMatrixMode: 1
m_GateFitMode: 2
m_FOVAxisMode: 0
m_SensorSize: {x: 36, y: 24}
m_LensShift: {x: 0, y: 0}
m_FocalLength: 50
m_NormalizedViewPortRect:
serializedVersion: 2
x: 0
y: 0
width: 1
height: 1
near clip plane: 0.3
far clip plane: 1000
field of view: 60
orthographic: 0
orthographic size: 5
m_Depth: -1
m_CullingMask:
serializedVersion: 2
m_Bits: 4294967295
m_RenderingPath: -1
m_TargetTexture: {fileID: 0}
m_TargetDisplay: 0
m_TargetEye: 3
m_HDR: 1
m_AllowMSAA: 1
m_AllowDynamicResolution: 0
m_ForceIntoRT: 0
m_OcclusionCulling: 1
m_StereoConvergence: 10
m_StereoSeparation: 0.022
--- !u!4 &1698122897
Transform:
m_ObjectHideFlags: 0
m_CorrespondingSourceObject: {fileID: 0}
m_PrefabInstance: {fileID: 0}
m_PrefabAsset: {fileID: 0}
m_GameObject: {fileID: 1698122894}
m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
m_LocalPosition: {x: 0, y: 1, z: -10}
m_LocalScale: {x: 1, y: 1, z: 1}
m_ConstrainProportionsScale: 0
m_Children: []
m_Father: {fileID: 0}
m_RootOrder: 0
m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}

View File

@ -0,0 +1,7 @@
fileFormatVersion: 2
guid: b95b5f3924bd65b4bb0b7703abdd4fe5
DefaultImporter:
externalObjects: {}
userData:
assetBundleName:
assetBundleVariant:

View File

@ -0,0 +1,36 @@
using System.Collections;
using UnityEngine;
namespace X10D.Unity.Tests
{
public class YieldInstructionIntegrationTests : MonoBehaviour
{
private void Start()
{
StartCoroutine(CO_WaitForAnyKeyDown());
StartCoroutine(CO_WaitForSpaceKeyDown());
StartCoroutine(CO_WaitForSpaceKeyUp());
}
private IEnumerator CO_WaitForAnyKeyDown()
{
Debug.Log("Waiting for any key to be pressed...");
yield return new WaitForKeyDown();
Debug.Log("Key was pressed!");
}
private IEnumerator CO_WaitForSpaceKeyDown()
{
Debug.Log("Waiting for Space key to be pressed...");
yield return new WaitForKeyDown(KeyCode.Space);
Debug.Log("Space key was pressed!");
}
private IEnumerator CO_WaitForSpaceKeyUp()
{
Debug.Log("Waiting for Space key to be released...");
yield return new WaitForKeyUp(KeyCode.Space);
Debug.Log("Space key was released!");
}
}
}

View File

@ -0,0 +1,3 @@
fileFormatVersion: 2
guid: 67d53e2f993d4a5ba0eb34431d1846cd
timeCreated: 1657791682

View File

@ -0,0 +1,52 @@
using System;
using System.Collections;
using NUnit.Framework;
using UnityEngine;
using UnityEngine.TestTools;
using UTime = UnityEngine.Time;
namespace X10D.Unity.Tests
{
public class YieldInstructionTests : MonoBehaviour
{
[UnityTest]
public IEnumerator WaitForFrames_ShouldYieldCorrectNumberOfFrames()
{
int frameCount = UTime.frameCount;
yield return new WaitForFrames(10);
Assert.AreEqual(frameCount + 10, UTime.frameCount);
}
[UnityTest]
public IEnumerator WaitForSecondsNoAlloc_ShouldYieldForCorrectTime()
{
var time = (int)UTime.time;
yield return new WaitForSecondsNoAlloc(2);
Assert.AreEqual(time + 2, (int)UTime.time);
}
[UnityTest]
public IEnumerator WaitForSecondsRealtimeNoAlloc_ShouldYieldForCorrectTime()
{
var time = (int)UTime.time;
yield return new WaitForSecondsRealtimeNoAlloc(2);
Assert.AreEqual(time + 2, (int)UTime.time);
}
[UnityTest]
public IEnumerator WaitForTimeSpan_ShouldYieldForCorrectTime()
{
var time = (int)UTime.time;
yield return new WaitForTimeSpan(TimeSpan.FromSeconds(2));
Assert.AreEqual(time + 2, (int)UTime.time);
}
[UnityTest]
public IEnumerator WaitForTimeSpanRealtime_ShouldYieldForCorrectTime()
{
var time = (int)UTime.time;
yield return new WaitForTimeSpanRealtime(TimeSpan.FromSeconds(2));
Assert.AreEqual(time + 2, (int)UTime.time);
}
}
}

View File

@ -0,0 +1,3 @@
fileFormatVersion: 2
guid: d7d35eefdf5b43278a6f6aa268a71091
timeCreated: 1657795834

View File

@ -0,0 +1,40 @@
using System.Collections;
namespace X10D.Unity;
/// <summary>
/// Represents a yield instruction that waits for a specific number of frames.
/// </summary>
public struct WaitForFrames : IEnumerator
{
private readonly int _frameCount;
private int _frameIndex;
/// <summary>
/// Initializes a new instance of the <see cref="WaitForFrames" /> struct.
/// </summary>
/// <param name="frameCount">The frame count.</param>
public WaitForFrames(int frameCount)
{
_frameCount = frameCount;
_frameIndex = 0;
}
/// <inheritdoc />
public object Current
{
get => _frameCount;
}
/// <inheritdoc />
public bool MoveNext()
{
return ++_frameIndex <= _frameCount;
}
/// <inheritdoc />
public void Reset()
{
_frameIndex = 0;
}
}

View File

@ -0,0 +1,38 @@
using System.Collections;
using UnityEngine;
namespace X10D.Unity;
/// <summary>
/// Represents a yield instruction that waits for a key to be pressed.
/// </summary>
public readonly struct WaitForKeyDown : IEnumerator
{
private readonly KeyCode _keyCode;
/// <summary>
/// Initializes a new instance of the <see cref="WaitForKeyDown" /> struct.
/// </summary>
/// <param name="keyCode">The key to wait for.</param>
public WaitForKeyDown(KeyCode keyCode)
{
_keyCode = keyCode;
}
/// <inheritdoc />
public object Current
{
get => _keyCode == KeyCode.None ? Input.anyKeyDown : Input.GetKeyDown(_keyCode);
}
/// <inheritdoc />
public bool MoveNext()
{
return !(_keyCode == KeyCode.None ? Input.anyKeyDown : Input.GetKeyDown(_keyCode));
}
/// <inheritdoc />
public void Reset()
{
}
}

View File

@ -0,0 +1,38 @@
using System.Collections;
using UnityEngine;
namespace X10D.Unity;
/// <summary>
/// Represents a yield instruction that waits for a key to be released.
/// </summary>
public readonly struct WaitForKeyUp : IEnumerator
{
private readonly KeyCode _keyCode;
/// <summary>
/// Initializes a new instance of the <see cref="WaitForKeyUp" /> struct.
/// </summary>
/// <param name="keyCode">The key to wait for.</param>
public WaitForKeyUp(KeyCode keyCode)
{
_keyCode = keyCode;
}
/// <inheritdoc />
public object Current
{
get => _keyCode == KeyCode.None || Input.GetKeyUp(_keyCode);
}
/// <inheritdoc />
public bool MoveNext()
{
return !(_keyCode == KeyCode.None || Input.GetKeyUp(_keyCode));
}
/// <inheritdoc />
public void Reset()
{
}
}

View File

@ -0,0 +1,41 @@
using System.Collections;
namespace X10D.Unity;
/// <summary>
/// Represents a yield instruction which waits for a specified amount of seconds.
/// </summary>
/// <remarks>This struct exists as an allocation-free alternative to <see cref="UnityEngine.WaitForSeconds" />.</remarks>
public struct WaitForSecondsNoAlloc : IEnumerator
{
private readonly float _duration;
private float _delta;
/// <summary>
/// Initializes a new instance of the <see cref="WaitForTimeSpan" /> struct.
/// </summary>
/// <param name="duration">The duration of the pause, in seconds.</param>
public WaitForSecondsNoAlloc(float duration)
{
_duration = duration;
_delta = 0f;
}
/// <inheritdoc />
public object Current
{
get => _delta;
}
/// <inheritdoc />
public bool MoveNext()
{
_delta += UnityEngine.Time.deltaTime;
return _delta < _duration;
}
/// <inheritdoc />
public void Reset()
{
}
}

View File

@ -0,0 +1,38 @@
using System.Collections;
namespace X10D.Unity;
/// <summary>
/// Represents a yield instruction which waits for a given amount of time, as provided by a <see cref="TimeSpan" />.
/// </summary>
/// <remarks>This struct exists as an allocation-free alternative to <see cref="UnityEngine.WaitForSecondsRealtime" />.</remarks>
public readonly struct WaitForSecondsRealtimeNoAlloc : IEnumerator
{
private readonly DateTime _expectedEnd;
/// <summary>
/// Initializes a new instance of the <see cref="WaitForTimeSpan" /> struct.
/// </summary>
/// <param name="duration">The duration of the pause, in seconds.</param>
public WaitForSecondsRealtimeNoAlloc(float duration)
{
_expectedEnd = DateTime.Now + TimeSpan.FromSeconds(duration);
}
/// <inheritdoc />
public object Current
{
get => DateTime.Now;
}
/// <inheritdoc />
public bool MoveNext()
{
return DateTime.Now < _expectedEnd;
}
/// <inheritdoc />
public void Reset()
{
}
}

View File

@ -0,0 +1,42 @@
using System.Collections;
namespace X10D.Unity;
/// <summary>
/// Represents a yield instruction which waits for a given amount of time, as provided by a <see cref="TimeSpan" />.
/// </summary>
public struct WaitForTimeSpan : IEnumerator
{
private readonly TimeSpan _duration;
private readonly DateTime _start;
private DateTime _current;
/// <summary>
/// Initializes a new instance of the <see cref="WaitForTimeSpan" /> struct.
/// </summary>
/// <param name="duration">The duration of the pause.</param>
public WaitForTimeSpan(TimeSpan duration)
{
_duration = duration;
_start = DateTime.Now;
_current = _start;
}
/// <inheritdoc />
public object Current
{
get => _current;
}
/// <inheritdoc />
public bool MoveNext()
{
_current += TimeSpan.FromSeconds(UnityEngine.Time.deltaTime);
return _current < _start + _duration;
}
/// <inheritdoc />
public void Reset()
{
}
}

View File

@ -0,0 +1,37 @@
using System.Collections;
namespace X10D.Unity;
/// <summary>
/// Represents a yield instruction which waits for a given amount of time, as provided by a <see cref="TimeSpan" />.
/// </summary>
public readonly struct WaitForTimeSpanRealtime : IEnumerator
{
private readonly DateTime _expectedEnd;
/// <summary>
/// Initializes a new instance of the <see cref="WaitForTimeSpanRealtime" /> struct.
/// </summary>
/// <param name="duration">The duration of the pause.</param>
public WaitForTimeSpanRealtime(TimeSpan duration)
{
_expectedEnd = DateTime.Now + duration;
}
/// <inheritdoc />
public object Current
{
get => DateTime.Now;
}
/// <inheritdoc />
public bool MoveNext()
{
return DateTime.Now < _expectedEnd;
}
/// <inheritdoc />
public void Reset()
{
}
}