code: static void SetOpacityMaskClipValue ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, float Value, bool NonDefaultOnly )


module: GLTFExporter

code: static void SetParameterValue ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, const FHashedMaterialParameterInfo & ParameterInfo, float Value, bool NonDefaultOnly )


code: static void SetParameterValue ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, const FHashedMaterialParameterInfo & ParameterInfo, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & Value, bool NonDefaultOnly )


code: static void SetParameterValue ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, const FHashedMaterialParameterInfo & ParameterInfo, [UTexture](API\Runtime\Engine\Engine\UTexture) * Value, bool NonDefaultOnly )


code: static void SetProxyMaterial ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * OriginalMaterial, [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * ProxyMaterial )


code: static void SetTwoSided ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, bool Value, bool NonDefaultOnly )


className: FGLTFProxyMaterialUtilities

code: class FGLTFProxyMaterialUtilities


className: ArImage

module: GoogleARCoreBase

code: typedef struct ArImage_ ArImage


className: ArSession

code: typedef struct ArSession_ ArSession


className: EGoogleARCoreAugmentedFaceMode

description: Describes the possible modes for Augmented Face detection.

code: enum EGoogleARCoreAugmentedFaceMode { Disabled = 0, PoseAndMesh = 2, }


className: EGoogleARCoreAugmentedFaceRegion

description: Describes the face regions for which the pose can be queried. Left and right are defined relative to the actor (the person that the mesh belongs to).

code: enum EGoogleARCoreAugmentedFaceRegion { NoseTip = 0, ForeheadLeft = 1, ForeheadRight = 2, }


className: EGoogleARCoreAvailability

code: enum EGoogleARCoreAvailability { UnknownError = 0, UnknownChecking = 1, UnknownTimedOut = 2, UnsupportedDeviceNotCapable = 100, SupportedNotInstalled = 201, SupportedApkTooOld = 202, SupportedInstalled = 203, }


className: EGoogleARCoreCameraDepthSensorUsage

description: Describes the usage of the depth sensor of the ARCore camera.

code: enum EGoogleARCoreCameraDepthSensorUsage { DepthSensor_Any = 0, DepthSensor_RequireAndUse = 1 << 0, DepthSensor_DoNotUse = 1 << 1, }


className: EGoogleARCoreCameraFacing

description: Describes the orientation of the selected camera relative to the device display.

code: enum EGoogleARCoreCameraFacing { None = 0, Back = 1, Front = 2, }


className: EGoogleARCoreCameraFPS

description: Describes the target FPS of the ARCore camera.

code: enum EGoogleARCoreCameraFPS { FPS_Any = 0, FPS_30 = 1 << 0, FPS_60 = 1 << 1, }


description: 2d coordinate systems referenced by ARCore.

code: enum EGoogleARCoreCoordinates2DType { Texture = 0, Image = 1, Viewport = 2, }


className: EGoogleARCoreFunctionStatus

description: Describes the status of most ARCore functions.

code: enum EGoogleARCoreFunctionStatus { Success, Fatal, SessionPaused, NotTracking, ResourceExhausted, NotAvailable, InvalidType, IllegalState, Unknown, }


className: EGoogleARCoreInstallStatus

code: enum EGoogleARCoreInstallStatus { Installed = 0, Requrested = 1, }


className: EGoogleARCoreLineTraceChannel

description: Describes which channel ARLineTrace will be performed on.

code: enum EGoogleARCoreLineTraceChannel { None = 0, FeaturePoint = 1, InfinitePlane = 2, PlaneUsingExtent = 4, PlaneUsingBoundaryPolygon = 8, FeaturePointWithSurfaceNormal = 16, AugmentedImage = 32, }


className: EGoogleARCoreTrackingFailureReason

description: Describes the possible tracking failure reasons in ARCore.

code: enum EGoogleARCoreTrackingFailureReason { None = 0, BadState = 1, InsufficientLight = 2, ExcessiveMotion = 3, InsufficientFeatures = 4, }


className: EGoogleARCoreTrackingState

description: Describes the tracking state of the current ARCore session.

code: enum EGoogleARCoreTrackingState { Tracking = 0, NotTracking = 1, StoppedTracking = 2, }


description: Deprecated. Please use the cross-platformUARCandidateImageinstead.

ImageAsset

type: TObjectPtr<UTe...

description: Texture to use for this image. Valid formats are RGBA8 and BGRA8.

Name

type: FName

description: Name of the image.

Width

type: float

description: Width of the image in meters.


code: bool IsCompatibleWith ( const [FGoogleARCoreCameraConfig](API\Plugins\GoogleARCoreBase\FGoogleARCoreCameraConfig) & OtherConfig ) const


code: void SetMaxFPS ( int32 MaxFPS )


className: FGoogleARCoreCameraConfig

description: Camera configuration from ARCore.

CameraFacing

type: EGoogleARCoreCa...

CameraID

type: FString

description: The id of the camera will be used in this CameraConfig.

CameraImageResolution

type: FIntPoint

description: CPU-accessible camera image resolution.

CameraTextureResolution

description: Texture resolution for the camera image accessible to the graphics API and shaders.

DepthSensorUsage

description: The desired depth sensor usage of the camera.

TargetFPS

description: The target FPS of the camera.


description: Below are for internal use only

code: FGoogleARCoreCameraConfig()


className: OnCameraConfig

description: A delegate can be bound through C++. It will be called before ARSession started and returns a list of supported ARCore camera configurations. Bind this delegate if you want to choose a specific camera config in your app. Call UGoogleARCoreSessionFunctionLibrary::ConfigARCoreCamera after the delegate is triggered.


className: FGoogleARCoreDelegates

description: Delegate to call on camera configuration.

code: class FGoogleARCoreDelegates


className: FGoogleARCoreLightEstimate

description: A struct describes the ARCore light estimation.

code: struct FGoogleARCoreLightEstimate

bIsValid

type: bool

description: Whether this light estimation is valid.

PixelIntensity

description: The average pixel intensity of the passthrough camera image.

RGBScaleFactor

type: FVector

description: The RGB scale to match the color of the light in the real environment.


description:
Singleton-like access to this module's interface. Provided for convenience only. Beware of calling this method during the shutdown phase because your module might already have been unloaded.
Returns singleton instance, loading the module on demand if needed.

code: static [IGoogleARCoreBaseModule](API\Plugins\GoogleARCoreBase\IGoogleARCoreBaseModule) & Get()


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use.

code: static bool IsAvailable()


className: operator&

code: constexpr [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) operator& ( [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) Lhs, [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) Rhs )


className: operator&=

code: [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) & operator&= ( [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) & Lhs, [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) Rhs )


className: operator~

code: constexpr [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) operator~ ( [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) E )


className: operator^

code: constexpr [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) operator^ ( [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) Lhs, [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) Rhs )


className: operator^=

code: [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) & operator^= ( [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) & Lhs, [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) Rhs )


className: operator!

code: constexpr bool operator! ( [EGoogleARCoreLineTraceChannel](API\Plugins\GoogleARCoreBase\EGoogleARCoreLineTraceChannel) E )


className: IGoogleARCoreBaseModule

description: The public interface to this module.

code: class IGoogleARCoreBaseModule : public [IHeadMountedDisplayModule](API\Runtime\HeadMountedDisplay\IHeadMountedDisplayModule)


description: Draws the face mesh wireframe using debug lines.

code: virtual void DebugDraw ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutlineColor, float OutlineThickness, float PersistForSeconds ) const


description: Returns the latest known local-to-tracking transform of the given face region.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="GoogleARCore|AugmentedImage") FTransform GetLocalToTrackingTransformOfRegion ( [EGoogleARCoreAugmentedFaceRegion](API\Plugins\GoogleARCoreBase\EGoogleARCoreAugmentedFaceRegion) Region )


description: Returns the latest known local-to-world transform of the given face region.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="GoogleARCore|AugmentedImage") FTransform GetLocalToWorldTransformOfRegion ( [EGoogleARCoreAugmentedFaceRegion](API\Plugins\GoogleARCoreBase\EGoogleARCoreAugmentedFaceRegion) Region )


className: UGoogleARCoreAugmentedFace

description: AnUObjectrepresenting a face detected by ARCore.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UGoogleARCoreAugmentedFace : public [UARFaceGeometry](API\Runtime\AugmentedReality\UARFaceGeometry)


description: Draw a box around the image, for debugging purposes.


description: This is called by FGoogleARCoreAugmentedImageResource::UpdateGeometryData() to adjust the tracked position of the object.

code: void UpdateTrackedGeometry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InLocalToTrackingTransform, const FTransform & InAlignmentTransform, FVector2D InEstimatedSize, [UARCandidateImage](API\Runtime\AugmentedReality\UARCandidateImage) * InDetectedImage, int32 InImageIndex, const [FString](API\Runtime\Core\Containers\FString) & ImageName )


className: UGoogleARCoreAugmentedImage

description: An object representing an augmented image currently in the scene.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UGoogleARCoreAugmentedImage : public [UARTrackedImage](API\Runtime\AugmentedReality\UARTrackedImage)


description: Overridden serialization function.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


className: UGoogleARCoreAugmentedImageDatabase

description: Deprecated. Please use the ARCandidateImage list inUARSessionConfiginstead.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UGoogleARCoreAugmentedImageDatabase : public [UDataAsset](API\Runtime\Engine\Engine\UDataAsset)

Entries

type: TArray<FGoogle...

description: The individual instances ofFGoogleARCoreAugmentedImageDatabaseEntryobjects.

SerializedDatabase

type: TArray< uint8 >

description: The serialized database, in the ARCore augmented image database serialization format.


description:
Get the number of data planes in the image.
The plane count.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="GoogleARCore|CameraImage", Meta=(Keywords="googlear arcore cameraimage")) int32 GetPlaneCount() const


description:
Get the height of the image in pixels.
The height.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="GoogleARCore|CameraImage", Meta=(Keywords="googlear arcore cameraimage")) int32 GetHeight() const


description: Get the raw image data of a given plane.

code: const uint8 * GetPlaneData ( int32 Plane, int32 & PixelStride, int32 & RowStride, int32 & DataLength ) const


description:
Get the width of the image in pixels.
The width.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="GoogleARCore|CameraImage", Meta=(Keywords="googlear arcore cameraimage")) int32 GetWidth() const


description: Explicitly release the ARCore resources owned by this object.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="GoogleARCore|CameraImage", Meta=(Keywords="googlear arcore cameraimage")) void Release()


code: ~UGoogleARCoreCameraImage()


className: UGoogleARCoreCameraImage

description: An object that represents an acquired CPU-accessible camera image.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, BlueprintType) class UGoogleARCoreCameraImage : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Get the focal length in pixels.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="GoogleARCore|CameraIntrinsics") void GetFocalLength ( float & OutFX, float & OutFY )


description: Get the principal point in pixels.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="GoogleARCore|CameraIntrinsics") void GetPrincipalPoint ( float & OutCX, float & OutCY )


description: Get the image's width and height in pixels.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="GoogleARCore|CameraIntrinsics") void GetImageDimensions ( int32 & OutWidth, int32 & OutHeight )


code: void SetCameraIntrinsics ( const [FARCameraIntrinsics](API\Runtime\AugmentedReality\FARCameraIntrinsics) & InCameraIntrinsics )


className: UGoogleARCoreCameraIntrinsics

description: An object wrapping the ArCameraIntrinsics data from the ARCore SDK.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UGoogleARCoreCameraIntrinsics : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: UGoogleARCoreEventManager()


className: UGoogleARCoreEditorSettings

description: Helper class used to expose FGoogleARCoreSessionConfig setting in the Editor plugin settings.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine, defaultconfig) class UGoogleARCoreEditorSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bARCoreRequiredApp

description: Check this option if you app require ARCore to run on Android.


code: ~UGoogleARCoreEventManager()


className: UGoogleARCoreEventManager

description: Manager for ARCore delegates.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Category="AR AugmentedReality") class UGoogleARCoreEventManager : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

OnConfigCamera

type: FGoogleARCoreOn...

description: A dynamic delegate can be assigned through blueprint.


className: UGoogleARCoreFrameFunctionLibrary

description: A function library that provides static/Blueprint functions associated with most recent GoogleARCore tracking frame.


description: Returns the point position in Unreal world space and it's confidence value from 0 ~ 1.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="GoogleARCore|PointCloud") void GetPoint ( int Index, FVector & OutWorldPosition, float & OutConfidence )


description: Each point has a unique identifier (within a session) that is persistent across frames. That is, if a point from point cloud 1 has the same id as the point from point cloud 2, then it represents the same point in space.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="GoogleARCore|PointCloud") int GetPointId ( int Index )


description: Returns the point position in Unreal AR Tracking space.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="GoogleARCore|PointCloud") void GetPointInTrackingSpace ( int Index, FVector & OutTrackingSpaceLocation, float & OutConfidence )


description: Returns the number of point inside this point cloud.


description: Returns the timestamp in nanosecond when this point cloud was observed.

code: int64 GetUpdateTimestamp()


description: Checks if this point cloud has been updated in this frame.


description: Release PointCloud's resources back to ArCore. Data will not be available after releasePointCloud is called.


description: Destructor

code: ~UGoogleARCorePointCloud()


className: UGoogleARCorePointCloud

description: AUObjectthat contains a set of observed 3D points and confidence values.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UGoogleARCorePointCloud : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description:
Create a new ARCore session configuration.
The new configuration object.

code: static [UGoogleARCoreSessionConfig](API\Plugins\GoogleARCoreBase\UGoogleARCoreSessionConfig) * CreateARCoreSessionConfig ( bool bHorizontalPlaneDetection, bool bVerticalPlaneDetection, EARLightEstimationMode InLightEstimationMode, EARFrameSyncMode InFrameSyncMode, bool bInEnableAutoFocus, bool bInEnableAutomaticCameraOverlay, bool bInEnableAutomaticCameraTracking )


description: Get the augmented image database being used.


description: Set the augmented image database to use.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="google arcore augmentedimages") void SetAugmentedImageDatabase ( [UGoogleARCoreAugmentedImageDatabase](API\Plugins\GoogleARCoreBase\UGoogleARCoreAugmentedImageDatab-) * NewImageDatabase )


className: UGoogleARCoreSessionConfig

description: AUDataAssetthat can be used to configure ARCore specific settings on top ofUARSessionConfig.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Category="AR AugmentedReality") class UGoogleARCoreSessionConfig : public [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig)

AugmentedFaceMode

type: EGoogleARCoreAu...

description: Configure which Augmented Face mode will be used in the AR session.

AugmentedImageDatabase

type: TObjectPtr<UGo...

description: AUGoogleARCoreAugmentedImageDatabaseasset to use use for image tracking.

CameraFacing

description: Configure which camera will be used to in the AR session.


description:
On ARCore platform, you can leave the PhysicalWidth and PhysicalHeight to 0 if you don't know the physical size of the image or the physical size is dynamic. And this function takes time to perform non-trivial image processing (20ms - 30ms), and should be run on a background thread.
A `UARCandidateImage_ Object pointer if the underlying ARPlatform added the candidate image at runtime successfully. Return nullptr otherwise.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR AugmentedReality|Session", Meta=(Keywords="ar augmentedreality augmented reality candidate image")) static [UARCandidateImage](API\Runtime\AugmentedReality\UARCandidateImage) * AddRuntimeCandidateImageFromRawbytes ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & ImageGrayscalePixels, int ImageWidth, int ImageHeight, [FString](API\Runtime\Core\Containers\FString) FriendlyName, float PhysicalWidth, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * CandidateTexture )


className: UGoogleARCoreSessionFunctionLibrary

description: A function library that provides static/Blueprint functions associated with GoogleARCore session.


description: Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

module: GoogleARCoreRendering

code: virtual void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


description: Overload this method to report a name for your referencer

code: virtual [FString](API\Runtime\Core\Containers\FString) GetReferencerName() const


code: void InitializeRenderer_RenderThread ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily )


code: void RenderVideoOverlay_RenderThread ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [FSceneView](API\Runtime\Engine\FSceneView) & InView )


code: void UpdateCameraTextures ( [UTexture](API\Runtime\Engine\Engine\UTexture) * NewCameraTexture, [UTexture](API\Runtime\Engine\Engine\UTexture) * DepthTexture, bool bEnableOcclusion )


className: FGoogleARCorePassthroughCameraRenderer

code: class FGoogleARCorePassthroughCameraRenderer : public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject)


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: IModuleInterfaceimplementation.

code: virtual void StartupModule()


className: FGoogleARCoreRenderingModule

code: class FGoogleARCoreRenderingModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: A helper class that is used to load the GoogleARCorePassthroughCameraMaterial from its default object.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UGoogleARCoreCameraOverlayMaterialLoader : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

DebugOverlayMaterial

type: TObjectPtr<UMa...

description: A pointer to the camera overlay material that will be used to render the passthrough camera texture as background.

DepthColorationMaterial

description: Material used for rendering the coloration of the depth map.


className: ArFuture

module: GoogleARCoreServices

code: typedef struct ArFuture_ ArFuture


className: ArHostCloudAnchorFuture

code: typedef struct ArHostCloudAnchorFuture_ ArHostCloudAnchorFuture


className: EARPinCloudMode

description: This is an enum that can be set in aFGoogleARCoreServicesConfigto enable/disable cloud ARPin. When EARPinCloudMode is Enabled, ARCoreServices will provides functionalities of hosting and resolving cloud ARPins, with the overhead of maintaining the rolling buffer of feature/IMU measurements, and the requirements of INTERNET permissions.

code: enum EARPinCloudMode { Disabled = 0, Enabled = 1, }


className: ArResolveCloudAnchorFuture

code: typedef struct ArResolveCloudAnchorFuture_ ArResolveCloudAnchorFuture


className: EARPinCloudTaskResult

description: A enum describes the CloudARPin task result.

code: enum EARPinCloudTaskResult { Success, Failed, Started, CloudARPinNotEnabled, NotTracking, SessionPaused, InvalidPin, ResourceExhausted, }


className: ECloudAnchorFutureType

code: enum ECloudAnchorFutureType { Unknown, Host, Resolve, }


className: ECloudARPinCloudState

description: A enum describes the cloud state of a CloudARPin.

code: enum ECloudARPinCloudState { NotHosted, InProgress, Cancelled, Success, ErrorInternalError, ErrorNotAuthorized, ErrorLocalizationFailure, ErrorServiceUnavailable, ErrorResourceExhausted, ErrorHostingDatasetProcessingFailed, ErrorResolvingCloudIDNotFound, ErrorSDKVersionTooOld, ErrorSDKVersionTooNew, }


className: FGoogleARCoreServicesConfig

description: A struct describes the configuration in GoogleARCore Services

ARPinCloudMode

type: EARPinCloudMode

description: Whether enabling ARPin hosting/resolving in GoogleARCoreServices.


code: [ArFuture](API\Plugins\GoogleARCoreServices\ArFuture) *const AsFuture() const


code: [ArHostCloudAnchorFuture](API\Plugins\GoogleARCoreServices\ArHostCloudAnchorFuture) *const AsHostFuture() const


code: [ArResolveCloudAnchorFuture](API\Plugins\GoogleARCoreServices\ArResolveCloudAnchorFuture) *const AsResolveFuture() const


code: FGoogleARFutureHolder ( [ECloudAnchorFutureType](API\Plugins\GoogleARCoreServices\ECloudAnchorFutureType) InFutureType )


code: ~FGoogleARFutureHolder()


className: FGoogleARFutureHolder

code: struct FGoogleARFutureHolder

Future

type: ArFuture*

HostFuture

type: ArHostCloudAnch...

ResolveFuture

type: ArResolveCloudA...


code: FLogCategoryLogGoogleARCoreServices()


className: FLogCategoryLogGoogleARCoreServices

code: struct FLogCategoryLogGoogleARCoreServices : public [FLogCategory< ELogVerbosity::Log, ELogVerbosity::All >](API\Runtime\Core\Logging\FLogCategory)


className: GoogleARFutureHolderPtr

description: An raii holder for ArFutures of the types we use, to ensure they are released.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct [FGoogleARFutureHolder](API\Plugins\GoogleARCoreServices\FGoogleARFutureHolder) > GoogleARFutureHolderPtr


className: LogGoogleARCoreServices


description: Gets the current cloud state of this CloudARPin. Note that the cloud state will only be updated once per frame.


description:
Gets the CloudID of this CloudARPin.
Return a non-emptyFStringif the CloudARPin is ready. otherwise, return an emptyFString.


code: bool IsPending() const


code: void ReleaseFuture()


code: void SetCloudID ( [FString](API\Runtime\Core\Containers\FString) NewCloudID )


code: void SetFuture ( [GoogleARFutureHolderPtr](API\Plugins\GoogleARCoreServices\GoogleARFutureHolderPtr) FutureHolder )


code: void UpdateCloudState ( [ECloudARPinCloudState](API\Plugins\GoogleARCoreServices\ECloudARPinCloudState) NewCloudState )


className: UCloudARPin

description: A CloudARPin will be created when you host an existing ARPin, or resolved a previous hosted CloudARPin. It is a subclass ofUARPinso all functions onUARPinworks on CloudARPin, besides that you can query its CloudState and CloudID

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Experimental, Category="GoogleARCoreServices|CloudARPin") class UCloudARPin : public [UARPin](API\Runtime\AugmentedReality\UARPin)


description:
Configure the current Unreal AR session with the desired GoogleARCoreServices configuration. If there is an running AR session, the configuration will take effect immediately. Otherwise, it will take effect when the next AR session is running.
True if GoogleARCoreServices is configured successfully. False if the configuration failed to apply.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="GoogleARCoreServices|Configuration", Meta=(Keywords="googlear ar service config")) static bool ConfigGoogleARCoreServices ( [FGoogleARCoreServicesConfig](API\Plugins\GoogleARCoreServices\FGoogleARCoreServicesConfig) ServiceConfig )


description: Creating and hosting a CloudARPin and return it immediately. Note that this function only start the hosting process. Call GetARPinCloudState to check if the hosting is finished or failed with error.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="GoogleARCoreServices|CloudARPin", Meta=(LifetimeInDays=1, Keywords="googlear ar service remove ")) static [UCloudARPin](API\Plugins\GoogleARCoreServices\UCloudARPin) * CreateAndHostCloudARPin ( [UARPin](API\Runtime\AugmentedReality\UARPin) * ARPinToHost, int32 LifetimeInDays, [EARPinCloudTaskResult](API\Plugins\GoogleARCoreServices\EARPinCloudTaskResult) & OutTaskResult )


description: Note that aUCloudARPinwill be always created when this function is called, even in the case that the CloudId is failed to host. You can check the CloudState of returningUCloudARPinto see why the hosting failed.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="GoogleARCoreServices|CloudARPin", Meta=(Latent, LatentInfo="LatentInfo", LifetimeInDays=1, WorldContext="WorldContextObject", Keywords="googlear ar service host cloud")) static void CreateAndHostCloudARPinLatentAction ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [UARPin](API\Runtime\AugmentedReality\UARPin) * ARPinToHost, int32 LifetimeInDays, [EARPinCloudTaskResult](API\Plugins\GoogleARCoreServices\EARPinCloudTaskResult) & OutHostingResult, [UCloudARPin](API\Plugins\GoogleARCoreServices\UCloudARPin) *& OutCloudARPin )


description: Note that aUCloudARPinwill be always created when this function is called, even in the case that the CloudId is failed to resolve. You can check the CloudState of returningUCloudARPinto see why the resolving failed.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="GoogleARCoreServices|CloudARPin", Meta=(Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", Keywords="googlear ar service resolve cloud")) static void CreateAndResolveCloudARPinLatentAction ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [FString](API\Runtime\Core\Containers\FString) CloudId, [EARPinCloudTaskResult](API\Plugins\GoogleARCoreServices\EARPinCloudTaskResult) & OutAcquiringResult, [UCloudARPin](API\Plugins\GoogleARCoreServices\UCloudARPin) *& OutCloudARPin )


description: Creating and Resolving a CloudARPin and return it immediately. Note that this function only start the acquiring process. Call GetARPinCloudState to check if the acquiring is finished or failed with error.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="GoogleARCoreServices|CloudARPin", Meta=(Keywords="googlear ar service remove ")) static [UCloudARPin](API\Plugins\GoogleARCoreServices\UCloudARPin) * CreateAndResolveCloudARPin ( [FString](API\Runtime\Core\Containers\FString) CloudId, [EARPinCloudTaskResult](API\Plugins\GoogleARCoreServices\EARPinCloudTaskResult) & OutTaskResult )


description: Get a list of all CloudARPin in the current ARSession.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [UCloudARPin](API\Plugins\GoogleARCoreServices\UCloudARPin) * > GetAllCloudARPin()


description: Remove the given CloudARPin from the current ARSession.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="GoogleARCoreServices|CloudARPin", Meta=(Keywords="googlear ar service remove ")) static void RemoveCloudARPin ( [UCloudARPin](API\Plugins\GoogleARCoreServices\UCloudARPin) * PinToRemove )


className: UGoogleARCoreServicesFunctionLibrary

description: A function library that provides static/Blueprint functions for Google ARCore Services.


className: EGooglePADCellularDataConfirmStatus

description: The status associated with a request to display a cellular data confirmation dialog.

module: GooglePAD

code: enum EGooglePADCellularDataConfirmStatus { AssetPack_CONFIRM_UNKNOWN = 0, AssetPack_CONFIRM_PENDING, AssetPack_CONFIRM_USER_APPROVED, AssetPack_CONFIRM_USER_CANCELED, }


className: EGooglePADDownloadStatus

description: The status associated with Asset Pack download operations.

code: enum EGooglePADDownloadStatus { AssetPack_UNKNOWN = 0, AssetPack_DOWNLOAD_PENDING, AssetPack_DOWNLOADING, AssetPack_TRANSFERRING, AssetPack_DOWNLOAD_COMPLETED, AssetPack_DOWNLOAD_FAILED, AssetPack_DOWNLOAD_CANCELED, AssetPack_WAITING_FOR_WIFI, AssetPack_NOT_INSTALLED, AssetPack_INFO_PENDING, AssetPack_INFO_FAILED, AssetPack_REMOVAL_PENDING, AssetPack_REMOVAL_FAILED, }


className: EGooglePADErrorCode

description: An error code associated with Asset Pack operations.

code: enum EGooglePADErrorCode { AssetPack_NO_ERROR = 0, AssetPack_APP_UNAVAILABLE, AssetPack_UNAVAILABLE, AssetPack_INVALID_REQUEST, AssetPack_DOWNLOAD_NOT_FOUND, AssetPack_API_NOT_AVAILABLE, AssetPack_NETWORK_ERROR, AssetPack_ACCESS_DENIED, AssetPack_INSUFFICIENT_STORAGE, AssetPack_PLAY_STORE_NOT_FOUND, AssetPack_NETWORK_UNRESTRICTED, AssetPack_INTERNAL_ERROR, AssetPack_INITIALIZATION_NEEDED, AssetPack_INITIALIZATION_FAILED, }


className: EGooglePADStorageMethod

description: The method used to store an Asset Pack on the device.

code: enum EGooglePADStorageMethod { AssetPack_STORAGE_FILES = 0, AssetPack_STORAGE_APK, AssetPack_STORAGE_UNKNOWN, AssetPack_STORAGE_NOT_INSTALLED, }


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: FGooglePADModule

code: class FGooglePADModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Cancel download of a set of asset packs

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Cancel Download"), Category="GooglePAD") static [EGooglePADErrorCode](API\Plugins\GooglePAD\EGooglePADErrorCode) CancelDownload ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > AssetPacks )


className: DownloadStateMap

description: Handles for DownloadState

code: static [TMap](API\Runtime\Core\Containers\TMap)< int32, void * > DownloadStateMap;


className: DownloadStateMapIndex

code: static int32 DownloadStateMapIndex = 0;


description: Get location handle of requested asset pack (release when done)

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Get AssetPack Location"), Category="GooglePAD") static [EGooglePADErrorCode](API\Plugins\GooglePAD\EGooglePADErrorCode) GetAssetPackLocation ( const [FString](API\Runtime\Core\Containers\FString) & Name, int32 & Location )


description: Get asset path from from location

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Get Assets Path"), Category="GooglePAD") static [FString](API\Runtime\Core\Containers\FString) GetAssetsPath ( const int32 Location )


description: Get the number of bytes downloaded from a download state

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Get Bytes Downloaded"), Category="GooglePAD") static int32 GetBytesDownloaded ( const int32 State )


description: Get download state handle of an asset pack (release when done)

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Get Download State"), Category="GooglePAD") static [EGooglePADErrorCode](API\Plugins\GooglePAD\EGooglePADErrorCode) GetDownloadState ( const [FString](API\Runtime\Core\Containers\FString) & Name, int32 & State )


description: Get download status from a download state

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Get Download Status"), Category="GooglePAD") static [EGooglePADDownloadStatus](API\Plugins\GooglePAD\EGooglePADDownloadStatus) GetDownloadStatus ( const int32 State )


description: Get status of cellular confirmation dialog

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Get Cellular Data Confirmation Status"), Category="GooglePAD") static [EGooglePADErrorCode](API\Plugins\GooglePAD\EGooglePADErrorCode) GetShowCellularDataConfirmationStatus ( [EGooglePADCellularDataConfirmStatus](API\Plugins\GooglePAD\EGooglePADCellularDataConfirmSta-) & Status )


description: Get the total number of bytes to download from a download state

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Get Total Bytes To Download"), Category="GooglePAD") static int32 GetTotalBytesToDownload ( const int32 State )


description: Initialize java objects and cache them for further usage. called when the module is loaded

code: static void Initialize()


className: LocationMap

description: Handles for AssetPackLocation

code: static [TMap](API\Runtime\Core\Containers\TMap)< int32, void * > LocationMap;


className: LocationMapIndex

code: static int32 LocationMapIndex = 0;


className: PauseHandle

description: Foreground/background delegate for pause.


description: Release location resources

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Release AssetPack Location"), Category="GooglePAD") static void ReleaseAssetPackLocation ( const int32 Location )


description: Release download state resources

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Release Download State"), Category="GooglePAD") static void ReleaseDownloadState ( const int32 State )


description: Request download of a set of asset packs

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Request Download"), Category="GooglePAD") static [EGooglePADErrorCode](API\Plugins\GooglePAD\EGooglePADErrorCode) RequestDownload ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > AssetPacks )


description: Request information about a set of asset packs

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Request Info"), Category="GooglePAD") static [EGooglePADErrorCode](API\Plugins\GooglePAD\EGooglePADErrorCode) RequestInfo ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > AssetPacks )


description: Request removal of an asset pack

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Request Removal"), Category="GooglePAD") static [EGooglePADErrorCode](API\Plugins\GooglePAD\EGooglePADErrorCode) RequestRemoval ( const [FString](API\Runtime\Core\Containers\FString) & Name )


className: ResumeHandle

description: Foreground/background delegate for resume.


description: Get storage method from location

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Get Storage Method"), Category="GooglePAD") static [EGooglePADStorageMethod](API\Plugins\GooglePAD\EGooglePADStorageMethod) GetStorageMethod ( const int32 Location )


description: Releases resources. called when the module is shut down

code: static void Shutdown()


description: Show confirmation dialog requesting data download over cellular network

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Show Cellular Data Confirmation"), Category="GooglePAD") static [EGooglePADErrorCode](API\Plugins\GooglePAD\EGooglePADErrorCode) ShowCellularDataConfirmation()


className: UGooglePADFunctionLibrary

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UGooglePADFunctionLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


module: GooglePADEditor

code: virtual void ShutdownModule()


code: virtual void StartupModule()


className: FGooglePADEditorModule

code: class FGooglePADEditorModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


code: UGooglePADRuntimeSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UGooglePADRuntimeSettings

description: Implements the settings for the GooglePAD plugin.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine, defaultconfig) class UGooglePADRuntimeSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bEnablePlugin

description: Enable GooglePAD plugin.

bOnlyDistribution

description: Only for distribution builds.

bOnlyShipping

description: Only for shipping builds.


module: GPULightmass

code: AGPULightmassSettingsActor ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AGPULightmassSettingsActor

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(NotPlaceable) class AGPULightmassSettingsActor : public [AInfo](API\Runtime\Engine\GameFramework\AInfo)

Settings

type: TObjectPtr<UGP...


className: EGPULightmassDenoiser

code: enum EGPULightmassDenoiser { IntelOIDN, SimpleFireflyRemover, }


className: EGPULightmassDenoisingOptions

code: enum EGPULightmassDenoisingOptions { None, OnCompletion, DuringInteractivePreview, }


className: EGPULightmassMode

code: enum EGPULightmassMode { FullBake, BakeWhatYouSee, }


code: FGPULightmass * CreateGPULightmassForWorld ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, class [UGPULightmassSettings](API\Plugins\GPULightmass\UGPULightmassSettings) * Settings )


code: virtual [IStaticLightingSystem](API\Runtime\Engine\Rendering\IStaticLightingSystem) * GetStaticLightingSystemForWorld ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld )


code: void RemoveGPULightmassFromWorld ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld )


description: IModuleInterfaceimplementation


className: FGPULightmassModule

code: class FGPULightmassModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [IStaticLightingSystemImpl](API\Runtime\Engine\Rendering\IStaticLightingSystemImpl)

OnStaticLightingSystemsChanged

type: FSimpleMulticas...

StaticLightingSystems

type: TMap<UWorld&#...

description: Due to limitations in ourTMapimplementation I cannot useTUniquePtrhere But the GPULightmassModule is the only owner of all static lighting systems, and all worlds weak refer to the systems


description:
Called by the editor to query whether a property of this object is allowed to be modified. The property editor uses this to disable controls for properties that should not be changed. When overriding this function you should always call the parent implementation first.
true if the property can be modified in the editor, otherwise false

code: virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


className: UGPULightmassSettings

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UGPULightmassSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bCompressLightmaps

description: Whether to compress lightmap textures.

bShowProgressBars

description: If true, draw a green progress bar within each tile as it renders.

bUseFirstBounceRayGuiding

description: If Irradiance Caching is enabled, First Bounce Ray Guiding will search the hemisphere over each first bounce sample to find the brightest directions to weigh the rest of the samples towards.

bUseIrradianceCacheBackfaceDetection

description: Further prevent leaks caused by irradiance cache cells being placed inside geometry, at the cost of more fireflies and slower sampling speed. Recommended to be used with higher irradiance cache quality (>=256)

bUseIrradianceCaching

description: Irradiance Caching should be enabled with interior scenes to achieve more physically correct GI intensities, albeit with some biasing.

bVisualizeIrradianceCache

description: If true, visualize the Irradiance Cache cells.

Denoiser

type: EGPULightmassDe...

DenoisingOptions

description: If enabled, denoise the results on the CPU after rendering.

FirstBounceRayGuidingTrialSamples

description: Number of samples used for First Bounce Ray Guiding, which are thrown away before sampling for lighting.

GISamples

description: Total number of ray paths executed per texel across all bounces.

IrradianceCacheCornerRejection

type: float

description: Reject IC entries around corners to help reduce leaking and artifacts.

IrradianceCacheQuality

description: Number of samples per Irradiance Cache cell.

IrradianceCacheSpacing

description: Size of each Irradiance Cache cell. Smaller sizes will be slower but more accurate.

LightmapTilePoolSize

description: GPU Lightmass manages a pool for calculations of visible tiles.

Mode

type: EGPULightmassMo...

description: Full Bake mode renders the full lightmap resolution for every object in the scene.

StationaryLightShadowSamples

description: Number of samples for stationary shadows, which are calculated and stored separately from GI.

TilePassesInFullSpeedMode

description: Baking speed multiplier when Realtime is disabled in the viewer.

TilePassesInSlowMode

description: Baking speed multiplier when Realtime is enabled in the viewer.

VolumetricLightmapDetailCellSize

description: Size of an Volumetric Lightmap voxel at the highest density (used around geometry), in world space units.


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=GPULightmass) void Launch()


description: Accessor for the delegate called when the light build finishes successfully or is cancelled


description: Called once all UWorldSubsystems have been initialized

code: virtual void PostInitialize()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=GPULightmass) void Save()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=GPULightmass) void SetRealtime ( bool bInRealtime )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=GPULightmass) void Stop()


className: UGPULightmassSubsystem

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UGPULightmassSubsystem : public [UWorldSubsystem](API\Runtime\Engine\Subsystems\UWorldSubsystem)


module: GPUTextureTransfer

code: static [FGPUTextureTransferModule](API\Plugins\GPUTextureTransfer\FGPUTextureTransferModule) & Get()


code: static bool IsAvailable()


code: static constexpr uint8 RHI_MAX = static_cast<uint8>(UE::GPUTextureTransfer::ERHI::RHI_MAX);


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: FGPUTextureTransferModule

code: class FGPUTextureTransferModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: FInitializeDMAArgs

code: struct FInitializeDMAArgs

RHI

type: ERHI

description: Which RHI is being used.

RHICommandQueue

type: void *

description: The RHI device's command queue.

RHIDevice

description: The RHI device to use for gpu texture transfers.

RHIDeviceUUID

description: Unique device identifier (Vulkan only)

VulkanInstance

description: Vulkan instance (Vulkan only)


className: FLoggingCallbackPtr

code: typedef void(*)(const TCHAR *Format,...) FLoggingCallbackPtr


className: FRegisterDMABufferArgs

code: struct FRegisterDMABufferArgs

PixelFormat

type: EPixelFormat


className: FRegisterDMATextureArgs

code: struct FRegisterDMATextureArgs

RHITexture

type: FRHITexture...

SharedHandle

description: Only for VK.

Stride

description: Stride in bytes.


code: bool BeginSync ( void * InBuffer, [ETransferDirection](API\Plugins\GPUTextureTransfer\UE__GPUTextureTransfer__ETransfe-) TransferDirection )


code: void EndSync ( void * InBuffer )


description: Get the recommended alignment for the cpu buffer.

code: uint32 GetBufferAlignment() const


description: Get the recommended stride for textures that will be copied.

code: uint32 GetTextureStride() const


code: bool Initialize ( const [FInitializeDMAArgs](API\Plugins\GPUTextureTransfer\FInitializeDMAArgs) & Args )


description: Calling this will prevent the DVP library from using the RHI texture passed as argument until Unlock is called.

code: void LockTexture ( [FRHITexture](API\Runtime\RHI\FRHITexture) * RHITexture )


code: void RegisterBuffer ( const [FRegisterDMABufferArgs](API\Plugins\GPUTextureTransfer\FRegisterDMABufferArgs) & Args )


code: void RegisterTexture ( const [FRegisterDMATextureArgs](API\Plugins\GPUTextureTransfer\FRegisterDMATextureArgs) & Args )


description: EndSync(Buffer);

code: bool TransferTexture ( void * InBuffer, [FRHITexture](API\Runtime\RHI\FRHITexture) * RHITexture, [ETransferDirection](API\Plugins\GPUTextureTransfer\UE__GPUTextureTransfer__ETransfe-) TransferDirection )


description: Calling this will allow the DVP library to access the RHI texture passed as argument.

code: void UnlockTexture ( [FRHITexture](API\Runtime\RHI\FRHITexture) * RHITexture )


code: void UnregisterBuffer ( void * InBuffer )


code: void UnregisterTexture ( [FRHITexture](API\Runtime\RHI\FRHITexture) * RHITexture )


code: virtual ~ITextureTransfer()


className: ITextureTransfer

code: class ITextureTransfer


code: namespace UE { namespace GPUTextureTransfer { enum ERHI { Invalid, D3D11, D3D12, Vulkan, RHI_MAX, } } }


code: namespace UE { namespace GPUTextureTransfer { enum EPixelFormat { PF_8Bit, PF_10Bit, } } }


code: namespace UE { namespace GPUTextureTransfer { enum ETransferDirection { GPU_TO_CPU, CPU_TO_GPU, } } }


module: HairCardGeneratorFramework

code: namespace HairCardGenerator_Utils { void HairCardGenerator_Utils::RegisterModularHairCardGenerator ( [IHairCardGenerator](API\Plugins\HairCardGeneratorFramework\IHairCardGenerator) * Generator ) }


code: namespace HairCardGenerator_Utils { void HairCardGenerator_Utils::UnregisterModularHairCardGenerator ( [IHairCardGenerator](API\Plugins\HairCardGeneratorFramework\IHairCardGenerator) * Generator ) }


code: bool GenerateHairCardsForLOD ( [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * Groom, [FHairGroupsCardsSourceDescription](API\Plugins\HairStrandsCore\FHairGroupsCardsSourceDescriptio-) & CardsDesc )


code: bool IsCompatibleSettings ( [UHairCardGenerationSettings](API\Plugins\HairStrandsCore\UHairCardGenerationSettings) * OldSettings )


className: ModularFeatureName

code: static const [FName](API\Runtime\Core\UObject\FName) ModularFeatureName;


className: IHairCardGenerator

code: class IHairCardGenerator : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


className: EEditGroomCardsToolActions

module: HairModelingToolset

code: enum EEditGroomCardsToolActions { NoAction, Delete, SelectionClear, SelectionFill, SelectionAddNext, SelectionAddPrevious, SelectionAddToEnd, SelectionAddToStart, }


className: EGroomToMeshUVMode

code: enum EGroomToMeshUVMode { PlanarSplitting = 1, MinimalConformal = 2, PlanarSplitConformal = 3, }


description: Makes the change to the object

code: virtual void Apply ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: Reverts change to the object

code: virtual void Revert ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: Describes this change (for debugging)

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString() const


code: FBeginGroomCardsEditChange ( int32 GroupID )


className: FBeginGroomCardsEditChange

code: class FBeginGroomCardsEditChange : public [FToolCommandChange](API\Runtime\InteractiveToolsFramework\FToolCommandChange)


className: FEditGroomCardsTopologyPostEditChange

code: class FEditGroomCardsTopologyPostEditChange : public [FToolCommandChange](API\Runtime\InteractiveToolsFramework\FToolCommandChange)


className: FEditGroomCardsTopologyPreEditChange

code: class FEditGroomCardsTopologyPreEditChange : public [FToolCommandChange](API\Runtime\InteractiveToolsFramework\FToolCommandChange)


className: FEndGroomCardsEditChange

code: class FEndGroomCardsEditChange : public [FToolCommandChange](API\Runtime\InteractiveToolsFramework\FToolCommandChange)

CardEdit

type: TPimplPtr< FGro...


description: IDynamicMeshOperatorFactory API.


className: FGenerateLODOperatorFactory

code: class FGenerateLODOperatorFactory : public [UE::Geometry::IDynamicMeshOperatorFactory](API\Plugins\ModelingOperators\IDynamicMeshOperatorFactory)

LODSettings

type: FLODLevelGenera...

ParentTool

type: TWeakObjectPtr<...

UseTransform

type: FTransform


description: Initialize commands

code: virtual void RegisterCommands()


code: FHairModelingToolCommands()


className: FHairModelingToolCommands

description: TInteractiveToolCommandsimplementation for this module that provides standard Editor hotkey support

code: class FHairModelingToolCommands : public [TCommands< FHairModelingToolCommands >](API\Runtime\Slate\Framework\Commands\TCommands)

BeginGenerateLODMeshesTool

type: TSharedPtr<FUI...


description: Query the Extension for extended information. This function is optional, the results will be ignored unless it is overridden and returns true.

code: virtual bool GetExtensionExtendedInfo ( [FModelingModeExtensionExtendedInfo](API\Plugins\ModelingToolsEditorMode\FModelingModeExtensionExtendedIn-) & InfoOut )


description: IModelingModeToolExtensionimplementation


description: If creating multiple copies of the ToolBuilder for a particular Tool would be problematic, it is the responsiblity of theIModelingModeToolExtensionimplementation to cache these internally, otherwise they will be garbage collected when the caller releases them.

code: virtual void GetExtensionTools ( const [FExtensionToolQueryInfo](API\Plugins\ModelingToolsEditorMode\FExtensionToolQueryInfo) & QueryInfo, [TArray](API\Runtime\Core\Containers\TArray)< [FExtensionToolDescription](API\Plugins\ModelingToolsEditorMode\FExtensionToolDescription) > & ToolsOut )


description:
If the same Section is used in multiple Extensions, some buttons may not be shown
A text string that defines the name of the Toolbar Section this Extension's tools will be included in.


code: virtual void ShutdownModule()


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


className: FHairModelingToolsetModule

code: class FHairModelingToolsetModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [IModelingModeToolExtension](API\Plugins\ModelingToolsEditorMode\IModelingModeToolExtension)


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) > Get()


code: static void Initialize()


code: static void Shutdown()


className: StyleSet

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) > StyleSet = nullptr;


className: FHairModelingToolsStyle

code: class FHairModelingToolsStyle


code: bool operator!= ( const [FLODLevelGenerateSettings](API\Plugins\HairModelingToolset\FLODLevelGenerateSettings) & Other )


code: void Initialize ( [UGroomCardsEditorTool](API\Plugins\HairModelingToolset\UGroomCardsEditorTool) * ParentToolIn )


code: void PostAction ( [EEditGroomCardsToolActions](API\Plugins\HairModelingToolset\EEditGroomCardsToolActions) Action )


className: FLODLevelGenerateSettings

bReproject

type: bool

description: Target vertex/triangle count

Result

type: FString

SimplifierType

type: ESimplifyType

description: Simplification Scheme

TargetCount

description: Target vertex/triangle count

TargetMode

type: ESimplifyTarget...

description: Simplification Target Type

TargetPercentage

description: Target percentage


className: UEditGroomCardsToolActionPropertySet


description: Delete the current selected cards

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(CallInEditor, Category=FaceEdits, Meta=(DisplayName="Delete", DisplayPriority=10)) void Delete()


className: UEditGroomCardsToolActions


description: true if this Tool is currently in a state where it can be Accepted. This may be false if for example there was an error in the Tool.

code: virtual bool CanAccept() const


description: true if this Tool support being Accepted, ie calling Shutdown(EToolShutdownType::Accept)

code: virtual bool HasAccept() const


description: true if this Tool support being Cancelled, ie calling Shutdown(EToolShutdownType::Cancel)

code: virtual bool HasCancel() const


code: virtual void OnShutdown ( EToolShutdownType ShutdownType )


description: Allow the Tool to do any necessary processing on Tick

code: virtual void OnTick ( float DeltaTime )


description: Allow the Tool to do any custom drawing (ie via PDI/RHI)

code: virtual void Render ( [IToolsContextRenderAPI](API\Runtime\InteractiveToolsFramework\IToolsContextRenderAPI) * RenderAPI )


description: Called by ToolManager to initialize the ToolafterToolBuilder::BuildTool() has been called

code: virtual void Setup()


className: UGenerateLODMeshesTool

description: Simple Mesh Simplifying Tool


description: new Tool instance. Override this in subclasses to build a different Tool class type

code: virtual [USingleSelectionMeshEditingTool](API\Plugins\ModelingComponents\BaseTools\USingleSelectionMeshEditingTool) * CreateNewTool ( const [FToolBuilderState](API\Runtime\InteractiveToolsFramework\FToolBuilderState) & SceneState ) const


className: UGenerateLODMeshesToolBuilder


code: UGenerateLODMeshesToolProperties()


className: UGenerateLODMeshesToolProperties

description: Standard properties of the Simplify operation

bDiscardAttributes

description: Discard UVs and existing normals, allowing the simplifier to ignore any UV and normal seams.

bReproject

description: Enable projection back to input mesh

bShowGroupColors

description: Display colors corresponding to the mesh's polygon groups

bShowWireframe

description: If true, display wireframe

LODLevels

type: TArray<FLODLev...

NameIndexBase

type: int

description: Output LOD Assets will be numbered starting at this number

SimplifierType

description: Simplification Scheme

TargetCount

description: Target triangle/vertex count

TargetEdgeLength

description: Target edge length

TargetMode

description: Simplification Target Type

description: Target percentage of original triangle count


code: void AfterTopologyEdit()


code: void ApplyDeleteAction()


code: void ApplyGroomCardEdit ( const FGroomCardEdit & Edit, bool bIsRevert )


code: void BeginCardEdit ( int32 CardGroupID )


code: void BeginMoveChange()


code: bool CheckInOperation ( int32 Timestamp ) const


description: IClickDragBehaviorTargetAPI.

code: virtual [FInputRayHit](API\Runtime\InteractiveToolsFramework\FInputRayHit) CanBeginClickDragSequence ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & PressPos )


code: void CompleteMeshEditChange ( const [FText](API\Runtime\Core\Internationalization\FText) & TransactionLabel, [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FToolCommandChange](API\Runtime\InteractiveToolsFramework\FToolCommandChange) > EditChange, const [FGroupTopologySelection](API\Plugins\DynamicMesh\FGroupTopologySelection) & OutputSelection )


description: UMeshSurfacePointToolAPI.

code: virtual bool HitTest ( const FRay & Ray, [FHitResult](API\Runtime\Engine\Engine\FHitResult) & OutHit )


code: void InitializeMesh()


description: IClickBehaviorTargetAPI.

code: virtual [FInputRayHit](API\Runtime\InteractiveToolsFramework\FInputRayHit) IsHitByClick ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


description: This function is called when the user begins a click-drag-release interaction

code: virtual void OnBeginDrag ( const FRay & Ray )


description: Notify Target that click ocurred

code: virtual void OnClicked ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


description: This function is called when the user releases the button driving a click-drag-release interaction

code: virtual void OnEndDrag ( const FRay & Ray )


description: Terminate active hover sequence

code: virtual void OnEndHover()


code: void OnPreviewMeshChanged()


code: void OnSelectionModifiedEvent()


code: virtual void OnTick ( float DeltaTime )


description: This function is called each frame that the user is in a click-drag-release interaction

code: virtual void OnUpdateDrag ( const FRay & Ray )


code: void RecomputeTopology()


description: Update active hover sequence with new input position

code: virtual bool OnUpdateHover ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & DevicePos )


code: virtual void Render ( [IToolsContextRenderAPI](API\Runtime\InteractiveToolsFramework\IToolsContextRenderAPI) * RenderAPI )


description: Actions API

code: void RequestAction ( [EEditGroomCardsToolActions](API\Plugins\HairModelingToolset\EEditGroomCardsToolActions) ActionType )


code: void RestoreCardEdit ( const FGroomCardEdit * RestoreEdit )


description: Register InputBehaviors, etc

code: virtual void Setup()


code: virtual void SetWorld ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World )


description: Called by ToolManager to shut down the Tool

code: virtual void Shutdown ( EToolShutdownType ShutdownType )


code: void UpdateOnCurveEdit()


code: UGroomCardsEditorTool()


className: UGroomCardsEditorTool

ActiveVertexChange

type: FMeshVertexChan...

CardMeshSelectionMechanic

type: TObjectPtr<UPo...

ControlPointsMechanic

type: TObjectPtr<USp...

CurveSourceAdapter

type: TSharedPtr<FSp...

EditableCardSet

type: TPimplPtr< FEdi...

EditActions

type: TObjectPtr<UEd...

InfoProperties

type: TObjectPtr<UGr...

MeshMaterial

type: TObjectPtr<UMa...

OnPreviewMeshChangedHandle

type: FDelegateHandle

PendingAction

type: EEditGroomCards...

PreviewGeom

type: TObjectPtr<UPr...

SelectActions

type: TObjectPtr<USe...

TargetGroom

type: TLazyObjectPtr<...

TargetWorld

type: UWorld*

Topology

type: TUniquePtr<FGr...


code: virtual [UMeshSurfacePointTool](API\Runtime\InteractiveToolsFramework\BaseTools\UMeshSurfacePointTool) * CreateNewTool ( const [FToolBuilderState](API\Runtime\InteractiveToolsFramework\FToolBuilderState) & SceneState ) const


className: UGroomCardsEditorToolBuilder


className: UGroomCardsInfoToolProperties


description: true if this Tool is currently in a state where it can be Accepted. This may be false if for example there was an error in the Tool.

code: virtual bool CanAccept() const


className: FClipMeshSettings

code: struct FClipMeshSettings

ClipSource

type: AActor*

InputMesh

type: TSharedPtr<FDy...


code: bool operator&61;&61; &40; const FClipMeshSettings & Other &41; const


code: bool operator&61;&61; &40; const FMorphologySettings & Other &41; const


className: FMorphologySettings

code: struct FMorphologySettings

CloseDist

type: float


code: bool operator&61;&61; &40; const FPostprocessSettings & Other &41; const


className: FPostprocessSettings

code: struct FPostprocessSettings

UVGenMode

type: EGroomToMeshUVM...


code: bool operator&61;&61; &40; const FSimplifySettings & Other &41; const


className: FSimplifySettings

code: struct FSimplifySettings


code: bool operator&61;&61; &40; const FSmoothingSettings & Other &41; const


className: FSmoothingSettings

code: struct FSmoothingSettings


code: bool operator&61;&61; &40; const FVoxelizeSettings & Other &41; const


className: FVoxelizeSettings

code: struct FVoxelizeSettings


description: true if this Tool support being Accepted, ie calling Shutdown(EToolShutdownType::Accept)

code: virtual bool HasAccept() const


description: true if this Tool support being Cancelled, ie calling Shutdown(EToolShutdownType::Cancel)

code: virtual bool HasCancel() const


description: Allow the Tool to do any necessary processing on Tick

code: virtual void OnTick ( float DeltaTime )


code: void RecalculateMesh()


description: Allow the Tool to do any custom drawing (ie via PDI/RHI)

code: virtual void Render ( [IToolsContextRenderAPI](API\Runtime\InteractiveToolsFramework\IToolsContextRenderAPI) * RenderAPI )


code: virtual void SetSelection ( [AGroomActor](API\Plugins\HairStrandsCore\AGroomActor) * Groom )


description: Called by ToolManager to initialize the ToolafterToolBuilder::BuildTool() has been called

code: virtual void Setup()


code: virtual void SetWorld ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World )


code: virtual void Shutdown ( EToolShutdownType ShutdownType )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > UpdateClipMesh ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > InputMesh )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > UpdateMorphology ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > InputMesh )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > UpdatePostprocessing ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > InputMesh )


code: void UpdatePreview ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > ResultMesh )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > UpdateSimplification ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > InputMesh )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > UpdateSmoothing ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > InputMesh )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > UpdateUVs ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > InputMesh, [EGroomToMeshUVMode](API\Plugins\HairModelingToolset\EGroomToMeshUVMode) UVMode )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > UpdateUVs_ExpMapPlaneSplits ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > InputMesh, bool bRecalcAsConformal )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > UpdateUVs_MinimalConformal ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3), ESPMode::ThreadSafe > InputMesh )


className: UGroomToMeshTool

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UGroomToMeshTool : public [UInteractiveTool](API\Runtime\InteractiveToolsFramework\UInteractiveTool)

bResultValid

type: bool

CachedClipMeshSettings

type: FClipMeshSettin...

CachedMorphologySettings

type: FMorphologySett...

CachedPostprocessSettings

type: FPostprocessSet...

CachedSimplifySettings

type: FSimplifySettin...

CachedSmoothSettings

type: FSmoothingSetti...

CachedVoxelizeSettings

type: FVoxelizeSettin...


description:
Create a new instance of this builder's Tool
a new instance of the Tool, or nullptr on error/failure

code: virtual [UInteractiveTool](API\Runtime\InteractiveToolsFramework\UInteractiveTool) * BuildTool ( const [FToolBuilderState](API\Runtime\InteractiveToolsFramework\FToolBuilderState) & SceneState ) const


description:
Check if, given the current scene state, a new instance of this builder's Tool can be created
true if a new Tool instance can be created

code: virtual bool CanBuildTool ( const [FToolBuilderState](API\Runtime\InteractiveToolsFramework\FToolBuilderState) & SceneState ) const


className: UGroomToMeshToolBuilder


className: UGroomToMeshToolProperties

ClipMeshActor

description: Todo: this probably also needs to support skeletal mesh

VertexCount

type: int

description: Target triangle count

VoxelCount

description: The size of the geometry bounding box major axis measured in voxels


description: Add the next vertex along the card curve to the selection

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(CallInEditor, Category=Selection, Meta=(DisplayPriority=3)) void AddNext()


description: Add the previous vertex along the card curve to the selection

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(CallInEditor, Category=Selection, Meta=(DisplayPriority=4)) void AddPrevious()


description: Clear the current selection

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(CallInEditor, Category=Selection, Meta=(DisplayPriority=1)) void Clear()


description: Select unselected points along curve between selected points

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(CallInEditor, Category=Selection, Meta=(DisplayPriority=1)) void Fill()


description: Select all vertices to the start of the card

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(CallInEditor, Category=Selection, Meta=(DisplayPriority=6)) void ToStart()


description: Select all vertices to the end of the card

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(CallInEditor, Category=Selection, Meta=(DisplayPriority=5)) void ToEnd()


className: USelectGroomCardsToolActions


className: AddComputeMipsPass

module: HairStrandsCore

code: void AddComputeMipsPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, FRDGTextureRef & OutTexture )


className: AddHairCardsRBFInterpolationPass

code: void AddHairCardsRBFInterpolationPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, const int32 MeshLODIndex, [FHairCardsRestResource](API\Plugins\HairStrandsCore\FHairCardsRestResource) * RestResources, [FHairCardsDeformedResource](API\Plugins\HairStrandsCore\FHairCardsDeformedResource) * DeformedResources, [FHairStrandsRestRootResource](API\Plugins\HairStrandsCore\FHairStrandsRestRootResource) * RestRootResources, [FHairStrandsDeformedRootResource](API\Plugins\HairStrandsCore\FHairStrandsDeformedRootResource) * DeformedRootResources )


className: AddHairStrandInitMeshSamplesPass

description: Init the samples information to be used for interpolation

code: void AddHairStrandInitMeshSamplesPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, const int32 LODIndex, const [HairStrandsTriangleType](API\Plugins\HairStrandsCore\HairStrandsTriangleType) Type, const [FHairStrandsProjectionMeshData::LOD](API\Plugins\HairStrandsCore\FHairStrandsProjectionMeshData\LOD) & MeshData, [FHairStrandsRestRootResource](API\Plugins\HairStrandsCore\FHairStrandsRestRootResource) * RestResources, [FHairStrandsDeformedRootResource](API\Plugins\HairStrandsCore\FHairStrandsDeformedRootResource) * DeformedResources )


className: AddHairMeshesRBFInterpolationPass

code: void AddHairMeshesRBFInterpolationPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, const int32 MeshLODIndex, [FHairMeshesRestResource](API\Plugins\HairStrandsCore\FHairMeshesRestResource) * RestResources, [FHairMeshesDeformedResource](API\Plugins\HairStrandsCore\FHairMeshesDeformedResource) * DeformedResources, [FHairStrandsRestRootResource](API\Plugins\HairStrandsCore\FHairStrandsRestRootResource) * RestRootResources, [FHairStrandsDeformedRootResource](API\Plugins\HairStrandsCore\FHairStrandsDeformedRootResource) * DeformedRootResources )


className: AddHairStrandUpdateMeshSamplesPass

description: Update the samples information to be used for interpolation

code: void AddHairStrandUpdateMeshSamplesPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, const int32 LODIndex, const [FHairStrandsProjectionMeshData::LOD](API\Plugins\HairStrandsCore\FHairStrandsProjectionMeshData\LOD) & ProjectionMeshData, [FHairStrandsRestRootResource](API\Plugins\HairStrandsCore\FHairStrandsRestRootResource) * RestResources, [FHairStrandsDeformedRootResource](API\Plugins\HairStrandsCore\FHairStrandsDeformedRootResource) * DeformedResources )


className: AddHairStrandUpdateMeshTrianglesPass

description: Update the triangles information on which hair stands have been projected

code: void AddHairStrandUpdateMeshTrianglesPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, const int32 LODIndex, const [HairStrandsTriangleType](API\Plugins\HairStrandsCore\HairStrandsTriangleType) Type, const [FHairStrandsProjectionMeshData::LOD](API\Plugins\HairStrandsCore\FHairStrandsProjectionMeshData\LOD) & MeshData, [FHairStrandsRestRootResource](API\Plugins\HairStrandsCore\FHairStrandsRestRootResource) * RestResources, [FHairStrandsDeformedRootResource](API\Plugins\HairStrandsCore\FHairStrandsDeformedRootResource) * DeformedResources )


className: AddHairStrandUpdatePositionOffsetPass

code: void AddHairStrandUpdatePositionOffsetPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, const int32 LODIndex, [FHairStrandsDeformedRootResource](API\Plugins\HairStrandsCore\FHairStrandsDeformedRootResource) * DeformedRootResources, [FHairStrandsDeformedResource](API\Plugins\HairStrandsCore\FHairStrandsDeformedResource) * DeformedResources )


className: AddSkinUpdatePass

code: void AddSkinUpdatePass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, uint32 SectionIndex, uint32 BonesOffset, class [FSkeletalMeshLODRenderData](API\Runtime\Engine\Rendering\FSkeletalMeshLODRenderData) & RenderData, [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * BoneMatrices, [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * PrevBoneMatrices, FRDGBufferRef OutDeformedosition, FRDGBufferRef OutPreviousDeformedosition )


description: Returns GroomComponent subobject

code: [UGroomComponent](API\Plugins\HairStrandsCore\UGroomComponent) * GetGroomComponent() const


description:
Used by the "Sync to Content Browser" right-click menu option in the editor.
Whether the object references content (all overrides of this function should return true)

code: virtual bool GetReferencedContentObjects ( [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & Objects ) const


code: AGroomActor ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AGroomActor

description: An actor that renders a simulated hair

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Input, Replication, Mobility), ShowCategories=("Input|MouseInput", "Input|TouchInput")) class AGroomActor : public [AActor](API\Runtime\Engine\GameFramework\AActor)

GroomComponent

type: TObjectPtr< cla...

description: Strand hair component that performs simulation and rendering

SpriteComponent

type: TObjectPtr<UBi...

description: Billboard used to see the scene in the editor


className: ComputeHairStrandsInterpolation

code: void ComputeHairStrandsInterpolation ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, const uint32 ViewUniqueID, const uint32 ViewRayTracingMask, const EGroomViewMode ViewMode, const FVector & TranslatedWorldOffset, const [FShaderPrintData](API\Runtime\Renderer\FShaderPrintData) * ShaderPrintData, [FHairGroupInstance](API\Plugins\HairStrandsCore\FHairGroupInstance) * Instance, int32 LODIndex, FHairStrandClusterData * ClusterData )


className: ComputeInterpolationWeights

code: void ComputeInterpolationWeights ( [UGroomBindingAsset](API\Plugins\HairStrandsCore\UGroomBindingAsset) * BindingAsset, [FSkeletalMeshRenderData](API\Runtime\Engine\Rendering\FSkeletalMeshRenderData) * TargetRenderData, [TArray](API\Runtime\Core\Containers\TArray)< [FRWBuffer](API\Runtime\RHI\FRWBuffer) > & TransferedPositions )


className: ConvertFromGroomAsset

description: Convert a groom asset into an editable groom asset.

code: void ConvertFromGroomAsset ( [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * In, [FEditableGroom](API\Plugins\HairStrandsCore\FEditableGroom) * Out )


className: ConvertToGroomAsset

description: Convert an editable groom asset into a groom asset The 'operations' flag indicates what type of modifications have been done onto the editable groom. This helps to drive the update mechanism.

code: void ConvertToGroomAsset ( [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * Out, const [FEditableGroom](API\Plugins\HairStrandsCore\FEditableGroom) * In, uint32 Operations )


className: CreateHairStrandsDebugDatas

description: Debug data (used for debug visalization but also for texture generation)

code: void CreateHairStrandsDebugDatas ( const [FHairStrandsDatas](API\Plugins\HairStrandsCore\FHairStrandsDatas) & InData, [FHairStrandsDebugDatas](API\Plugins\HairStrandsCore\FHairStrandsDebugDatas) & Out )


className: CreateHairStrandsDebugResources

code: void CreateHairStrandsDebugResources ( class [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, const [FHairStrandsDebugDatas](API\Plugins\HairStrandsCore\FHairStrandsDebugDatas) * In, [FHairStrandsDebugDatas::FResources](API\Plugins\HairStrandsCore\FHairStrandsDebugDatas\FResources) * Out )


className: EFollicleMaskChannel

description: List of channel

code: enum EFollicleMaskChannel { R = 0, G = 1, B = 2, A = 3, }


className: EGroomBasisType

code: enum EGroomBasisType { NoBasis, BezierBasis, BsplineBasis, CatmullromBasis, HermiteBasis, PowerBasis, }


className: EGroomBindingMeshType

description: Enum that describes the type of mesh to bind to

code: enum EGroomBindingMeshType { SkeletalMesh, GeometryCache, }


className: EGroomBindingType

code: enum EGroomBindingType { NoneBinding, Rigid, Skinning, }


className: EGroomCacheAttributes

description: Attributes in groom that can be animated

code: enum EGroomCacheAttributes { None = 0, Position = 1, Width = 1 << 1, Color = 1 << 2, PositionWidth = (Position | Width), PositionColor = (Position | Color), WidthColor = (Position | Color), PositionWidthColor = (Position | Width | Color), }


className: EGroomCacheType

description: Types of GroomCache Strands: animated render strands (including animatable hair attributes) Guides: animated guides that require in-engine simulation (position only)

code: enum EGroomCacheType { None, Strands, Guides, }


className: EGroomCacheImportType

code: enum EGroomCacheImportType { None = 0x00, Strands = 0x01, Guides = 0x02, All = Strands | Guides, }


className: EEditableGroomOperations

code: enum EEditableGroomOperations { ControlPoints_Added = 0x1, ControlPoints_Modified = 0x2, ControlPoints_Deleted = 0x4, Strands_Added = 0x8, Strands_Modified = 0x10, Strands_Deleted = 0x20, Group_Added = 0x40, Group_Deleted = 0x80, }


className: EGroomCurveType

code: enum EGroomCurveType { Cubic, Linear, VariableOrder, }


className: EGroomGeometryType

code: enum EGroomGeometryType { Strands, Cards, Meshes, }


className: EGroomGuideType

code: enum EGroomGuideType { Imported, Generated, Rigged, }


className: EGroomInterpolationQuality

code: enum EGroomInterpolationQuality { Low, Medium, High, Unknown, }


className: EGroomInterpolationType

description: List of interpolation type

code: enum EGroomInterpolationType { None = 0, RigidTransform = 0x02, OffsetTransform = 0x04, SmoothTransform = 0x08, }


className: EGroomInterpolationWeight

code: enum EGroomInterpolationWeight { Parametric, Root, Index, Unknown, }


className: EGroomLODType

code: enum EGroomLODType { Manual, Auto, }


className: EGroomNiagaraSolvers

description: List of niagara solvers

code: enum EGroomNiagaraSolvers { None = 0, CosseratRods = 0x02, AngularSprings = 0x04, CustomSolver = 0x08, }


className: EGroomOverrideType

code: enum EGroomOverrideType { Auto, Enable, Disable, }


className: EGroomStrandsSize

description: Size of each strands

code: enum EGroomStrandsSize { None = 0, Size2 = 0x02, Size4 = 0x04, Size8 = 0x08, Size16 = 0x10, Size32 = 0x20, }


className: EHairAtlasTextureType

code: enum EHairAtlasTextureType { Depth, Tangent, Attribute, Coverage, AuxilaryData, Material, }


className: EHairAttribute

code: enum EHairAttribute { RootUV, ClumpID, StrandID, PrecomputedGuideWeights, Color, Roughness, AO, Count, }


className: EHairAttributeFlags

code: enum EHairAttributeFlags { HasRootUDIM, HasMultipleClumpIDs, }


className: EHairCardsClusterType

code: enum EHairCardsClusterType { Low, High, }


className: EHairCardsGenerationType

code: enum EHairCardsGenerationType { CardsCount, UseGuides, }


className: EHairCardsSourceType

code: enum EHairCardsSourceType { Procedural, Imported, }


className: EHairGroupInfoFlags

code: enum EHairGroupInfoFlags { HasTrimmedPoint = 1, HasTrimmedCurve = 2, }


className: EHairInterpolationQuality

code: enum EHairInterpolationQuality { Low, Medium, High, Unknown, }


className: EHairInterpolationWeight

code: enum EHairInterpolationWeight { Parametric, Root, Index, Distance, Unknown, }


className: EHairLODSelectionType

code: enum EHairLODSelectionType { Immediate, Predicted, Forced, }


className: EHairResourceLoadingType

code: enum EHairResourceLoadingType { Async, Sync, }


code: void AddAvailableCurve ( uint32 In )


className: EStatus

code: enum EStatus { None = 0, Loading = 1, Valid = 2, }


code: bool HasStatus ( [EStatus](API\Plugins\HairStrandsCore\EHairResourceStatus\EStatus) In ) const


className: EHairStrandsAllocationType

code: enum EHairStrandsAllocationType { Immediate, Deferred, }


className: EHairResourceStatus

code: struct EHairResourceStatus

Status

type: EStatus


className: EHairStrandsResourcesType

code: enum EHairStrandsResourcesType { Guides, Strands, Cards, }


className: EStrandsTexturesMeshType

description: Size of each strands

code: enum EStrandsTexturesMeshType { Static = 0, Skeletal = 1, }


className: EHairViewRayTracingMask

code: enum EHairViewRayTracingMask { RayTracing = 0x1, PathTracing = 0x2, }


className: EStrandsTexturesTraceType

description: Size of each strands

code: enum EStrandsTexturesTraceType { TraceInside = 0, TraceOuside = 1, TraceBidirectional = 2, }


className: ExtractMeshData

code: [FHairStrandsProjectionMeshData](API\Plugins\HairStrandsCore\FHairStrandsProjectionMeshData) ExtractMeshData ( [FSkeletalMeshRenderData](API\Runtime\Engine\Rendering\FSkeletalMeshRenderData) * RenderData )


className: FEditableGroom

code: struct FEditableGroom

Groups

type: TArray<FEditab...


className: FEditableGroomGroup

description: Group & Groom.

code: struct FEditableGroomGroup

GroupName

type: FName


className: FEditableHairGuide

code: struct FEditableHairGuide


className: FEditableHairGuideControlPoint

description: Guides.

code: struct FEditableHairGuideControlPoint


className: FEditableHairStrandControlPoint

description: Strands.

code: struct FEditableHairStrandControlPoint

BaseColor

type: FLinearColor


className: FEditableHairStrand

code: struct FEditableHairStrand

GuideIDs

description: Pre-computed Simulation.


className: EChannel

code: enum EChannel { R = 0, G = 1, B = 2, A = 3, }


className: FFollicleInfo

code: struct FFollicleInfo

Channel

type: EChannel

GroomAsset

type: UGroomAsset...


className: FFollicleMaskOptions

Channel

type: EFollicleMaskCh...

description: Texture channel in which the groom's roots mask will be writtent to.

Groom

type: TObjectPtr<UGr...

description: Groom asset


className: FGroomAnimationInfo

description: Relevant information about a groom animation

Attributes

type: EGroomCacheAttr...

Duration

type: float


code: void Accumulate ( const [FGroomAssetMemoryStats](API\Plugins\HairStrandsCore\FGroomAssetMemoryStats) & In )


className: FStrandsDetails

code: struct FStrandsDetails


code: static [FGroomAssetMemoryStats](API\Plugins\HairStrandsCore\FGroomAssetMemoryStats) Get ( const [FHairGroupPlatformData](API\Plugins\HairStrandsCore\FHairGroupPlatformData) & In )


code: uint32 GetTotalCPUSize() const


code: uint32 GetTotalGPUSize() const


className: FGroomAssetMemoryStats

code: struct FGroomAssetMemoryStats

CPU

type: FStats

Curves

type: FStrandsDetails


code: void Accumulate ( const [FGroomBindingAssetMemoryStats](API\Plugins\HairStrandsCore\FGroomBindingAssetMemoryStats) & In )


code: static [FGroomBindingAssetMemoryStats](API\Plugins\HairStrandsCore\FGroomBindingAssetMemoryStats) Get ( const [UGroomBindingAsset::FHairGroupPlatformData](API\Plugins\HairStrandsCore\UGroomBindingAsset\FHairGroupPlatformData) & InCPU, const [UGroomBindingAsset::FHairGroupResource](API\Plugins\HairStrandsCore\UGroomBindingAsset\FHairGroupResource) & InGPU )


className: FGroomBindingAssetMemoryStats

code: struct FGroomBindingAssetMemoryStats


description: Build binding asset data.

code: static bool BuildBinding ( class [UGroomBindingAsset](API\Plugins\HairStrandsCore\UGroomBindingAsset) * BindingAsset, bool bInitResource )


description: Build binding asset data.

code: static bool BuildBinding ( class [UGroomBindingAsset](API\Plugins\HairStrandsCore\UGroomBindingAsset) * BindingAsset, uint32 InGroupIndex )


description: Extract root data from bulk data.

code: static void GetRootData ( [FHairStrandsRootData](API\Plugins\HairStrandsCore\FHairStrandsRootData) & Out, const [FHairStrandsRootBulkData](API\Plugins\HairStrandsCore\FHairStrandsRootBulkData) & In )


className: FGroomBindingBuilder

code: struct FGroomBindingBuilder


description: Build bulk data for Strands / Guides

code: static void BuildBulkData ( const [FHairGroupInfo](API\Plugins\HairStrandsCore\FHairGroupInfo) & InInfo, const [FHairStrandsDatas](API\Plugins\HairStrandsCore\FHairStrandsDatas) & InData, [FHairStrandsBulkData](API\Plugins\HairStrandsCore\FHairStrandsBulkData) & OutBulkData )


description: Build cluster data

code: static void BuildClusterBulkData ( const [FHairStrandsDatas](API\Plugins\HairStrandsCore\FHairStrandsDatas) & InRenData, const float InGroomAssetRadius, const [FHairGroupsLOD](API\Plugins\HairStrandsCore\FHairGroupsLOD) & InSettings, [FHairStrandsClusterBulkData](API\Plugins\HairStrandsCore\FHairStrandsClusterBulkData) & OutClusterData )


description: 2.b BuildFHairStrandsDatasfor Strands or Guides. This version:

code: static void BuildData ( [FHairStrandsDatas](API\Plugins\HairStrandsCore\FHairStrandsDatas) & OutStrands )


description: 2.a BuildFHairStrandsDatasfor Strands & Guides, based on HairDescriptionGroups and DecimationSettings

code: static void BuildData ( const [FHairDescriptionGroup](API\Plugins\HairStrandsCore\FHairDescriptionGroup) & InHairDescriptionGroup, const [FHairGroupsInterpolation](API\Plugins\HairStrandsCore\FHairGroupsInterpolation) & InSettings, [FHairGroupInfo](API\Plugins\HairStrandsCore\FHairGroupInfo) & OutGroupInfo, [FHairStrandsDatas](API\Plugins\HairStrandsCore\FHairStrandsDatas) & OutStrands, [FHairStrandsDatas](API\Plugins\HairStrandsCore\FHairStrandsDatas) & OutGuides, bool bAllowCurveReordering )


description: Build hair group based on the hair description

code: static bool BuildHairDescriptionGroups ( const [FHairDescription](API\Plugins\HairStrandsCore\FHairDescription) & HairDescription, [FHairDescriptionGroups](API\Plugins\HairStrandsCore\FHairDescriptionGroups) & Out )


description: Build interplation bulk data

code: static void BuildInterplationBulkData ( const [FHairStrandsDatas](API\Plugins\HairStrandsCore\FHairStrandsDatas) & InSimData, const [FHairStrandsInterpolationDatas](API\Plugins\HairStrandsCore\FHairStrandsInterpolationDatas) & InInterpolationData, [FHairStrandsInterpolationBulkData](API\Plugins\HairStrandsCore\FHairStrandsInterpolationBulkDat-) & OutInterpolationData )


description: Build interplation data based on the hairStrands data

code: static void BuildInterplationData ( const [FHairGroupInfo](API\Plugins\HairStrandsCore\FHairGroupInfo) & InInfo, const [FHairStrandsDatas](API\Plugins\HairStrandsCore\FHairStrandsDatas) & InRenData, const [FHairStrandsDatas](API\Plugins\HairStrandsCore\FHairStrandsDatas) & InSimData, const [FHairInterpolationSettings](API\Plugins\HairStrandsCore\FHairInterpolationSettings) & InInterpolationSettings, [FHairStrandsInterpolationDatas](API\Plugins\HairStrandsCore\FHairStrandsInterpolationDatas) & OutInterpolationData )


className: FGroomBuilder

description: HairDescription -> HairDescriptionGroups -> HairStrandsData -> HairStrandsBulkData* -> HairStrandsInterpolationData ->HairStrandsInterpolationBulkData* -> HairStrandsClusterData*

code: struct FGroomBuilder


description: Optional: Voxelize hair group index.

code: static void VoxelizeGroupIndex ( const [FHairDescriptionGroups](API\Plugins\HairStrandsCore\FHairDescriptionGroups) & In, [FHairStrandsVoxelData](API\Plugins\HairStrandsCore\FHairStrandsVoxelData) & Out )


className: FGroomBuildSettings

bOverrideGuides

type: bool

description: Flag to override the imported guides with generated guides.

bRandomizeGuide

description: Randomize which guides affect a given hair strand.

bUseUniqueGuide

description: Force a hair strand to be affected by a unique guide.

HairToGuideDensity

description: Density factor for converting hair into guide curve if no guides are provided.

InterpolationDistance

type: EGroomInterpola...

description: Interpolation distance metric.

InterpolationQuality

description: Interpolation data quality.


code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: FGroomCacheAnimationData()


code: FGroomCacheAnimationData ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FHairDescriptionGroup](API\Plugins\HairStrandsCore\FHairDescriptionGroup) > && HairGroupData, int32 Version, [EGroomCacheType](API\Plugins\HairStrandsCore\EGroomCacheType) Type, [EGroomCacheAttributes](API\Plugins\HairStrandsCore\EGroomCacheAttributes) Attributes )


className: FGroomCacheAnimationData

description: Groom animation data for a frame

code: struct FGroomCacheAnimationData

GroupsData

type: TArray<FGroomC...


code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Owner, int32 ChunkIndex )


className: FGroomCacheChunk

description: The smallest unit of streamed GroomCache data The BulkData member is loaded on-demand so that loading the GroomCache itself is relatively lightweight

code: struct FGroomCacheChunk

BulkData

type: FByteBulkData

description: Bulk data if stored in the package.

DataSize

description: Size of the chunk of data in bytes

FrameIndex

description: Frame index of the frame stored in this block


code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, int32 Version, [EGroomCacheAttributes](API\Plugins\HairStrandsCore\EGroomCacheAttributes) InAttributes )


code: FGroomCacheGroupData ( struct [FHairStrandsDatas](API\Plugins\HairStrandsCore\FHairStrandsDatas) && GroupData )


className: FGroomCacheGroupData

description: Animatable group data that maps toFHairStrandsDatas

code: struct FGroomCacheGroupData

BoundingBox

type: FBox

StrandData

type: FGroomCacheStra...

VertexData

type: FGroomCacheVert...


className: FGroomCacheImportSettings

bImportGroomAsset

description: Import or re-import the groom asset from this file

bImportGroomCache

description: Import the animated groom that was detected in this file

bOverrideConversionSettings

description: Set to true to override the groom conversion settings.

bSkipEmptyFrames

description: Skip empty (pre-roll) frames and start importing at the frame which actually contains data

ConversionSettings

type: FGroomConversio...

description: Conversion settings to apply to the groom cache import when override is enabled

FrameEnd

description: Ending index to stop sampling the animation at

FrameStart

description: Starting index to start sampling the animation from

GroomAsset

type: FSoftObjectPath

description: The groom asset the groom cache will be built from (must be compatible)

ImportType

type: EGroomCacheImpo...

description: Groom Cache types to import


className: FGroomCacheInfo

description: Information about the GroomCache itself

AnimationInfo

type: FGroomAnimation...

Type

type: EGroomCacheType


description: The serialization version of the GroomCache data

code: static int32 GetCurrentVersion()


code: void AddGroomSample ( [TArray](API\Runtime\Core\Containers\TArray)< [FHairDescriptionGroup](API\Plugins\HairStrandsCore\FHairDescriptionGroup) > && GroomData )


code: void TransferChunks ( [UGroomCache](API\Plugins\HairStrandsCore\UGroomCache) * GroomCache )


code: FGroomCacheProcessor ( [EGroomCacheType](API\Plugins\HairStrandsCore\EGroomCacheType) InType, [EGroomCacheAttributes](API\Plugins\HairStrandsCore\EGroomCacheAttributes) InAttributes )


className: FGroomCacheProcessor

description: Proxy that processes the HairGroupData into GroomCacheChunks that contain the groom animation data

code: class FGroomCacheProcessor


code: FGroomCacheStrandData ( struct [FHairStrandsCurves](API\Plugins\HairStrandsCore\FHairStrandsCurves) && CurvesData, float InMaxLength, float InMaxRadius )


className: FGroomCacheStrandData

description: Animatable strand data that maps toFHairStrandsCurves

code: struct FGroomCacheStrandData

CurvesLength

type: TArray< float >


code: FGroomCacheVertexData ( struct [FHairStrandsPoints](API\Plugins\HairStrandsCore\FHairStrandsPoints) && PointsData )


className: FGroomCacheVertexData

description: Animatable vertex data that maps toFHairStrandsPoints

code: struct FGroomCacheVertexData

PointsBaseColor

type: TArray<FLinear...

PointsPosition

type: TArray< FVector...

PositionBuffer

type: TRefCountPtr<F...

description: GPU resources. Lazily allocated.


code: void Accumulate ( const [FGroomComponentMemoryStats](API\Plugins\HairStrandsCore\FGroomComponentMemoryStats) & In )


code: static [FGroomComponentMemoryStats](API\Plugins\HairStrandsCore\FGroomComponentMemoryStats) Get ( const [FHairGroupInstance](API\Plugins\HairStrandsCore\FHairGroupInstance) * In )


code: uint32 GetTotalSize() const


className: FGroomComponentMemoryStats

code: struct FGroomComponentMemoryStats


code: FGroomComponentRecreateRenderStateContext ( [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * GroomAsset )


description: Used to recreate render context for all GroomComponents that use a given GroomAsset


code: FGroomConversionSettings()


className: FGroomConversionSettings

Rotation

type: FVector

description: Rotation in Euler angles in degrees to fix up or front axes

Scale

description: Scale value to convert file unit into centimeters


description: Create skeletal mesh bones+physics asset from groom asset guides.

code: static [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * CreateSkeletalMesh ( [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * GroomAsset )


className: FGroomDeformerBuilder

code: struct FGroomDeformerBuilder


className: FGroomHairGroupPreview

GroupName

type: FName

InterpolationSettings

type: FHairGroupsInte...


className: Invalid

code: static const [FGroomID](API\Plugins\HairStrandsCore\FGroomID) Invalid;


code: FGroomID ( const [FElementID](API\Runtime\MeshDescription\FElementID) InitElementID )


code: FGroomID ( const int32 InitIDValue )


className: FGroomID

code: struct FGroomID : public [FElementID](API\Runtime\MeshDescription\FElementID)


code: static uint32 GetEntryCount ( uint32 InSampleCount )


description: Return a new GroomAsset with the RBF deformation from the BindingAsset baked into it.

code: void GetRBFDeformedGroomAsset ( const [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * InGroomAsset, const [UGroomBindingAsset](API\Plugins\HairStrandsCore\UGroomBindingAsset) * BindingAsset, [FTextureSource](API\Runtime\Engine\Engine\FTextureSource) * MaskTextureSource, const float MaskScale, [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * OutGroomAsset )


code: static uint32 GetWeightCount ( uint32 InSampleCount )


className: FGroomRBFDeformer

code: struct FGroomRBFDeformer


code: static void AllocateFollicleTextureResources ( [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * OuTexture, const FIntPoint & Resolution, uint32 MipCount )


code: static void BuildFollicleTexture ( const [TArray](API\Runtime\Core\Containers\TArray)< [FFollicleInfo](API\Plugins\HairStrandsCore\FFollicleInfo) > & InInfos, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * OutFollicleTexture, bool bUseGPU )


code: static void BuildStrandsTextures ( const [FStrandsTexturesInfo](API\Plugins\HairStrandsCore\FStrandsTexturesInfo) & InInfo, const [FStrandsTexturesOutput](API\Plugins\HairStrandsCore\FStrandsTexturesOutput) & Output )


description: Follicle texture.

code: static [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * CreateGroomFollicleMaskTexture ( const [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * GroomAsset, uint32 Resolution )