From 525c2acfe274d2519aef6f4221f5a29b46c3f07a Mon Sep 17 00:00:00 2001 From: Anders Leino Date: Thu, 27 Feb 2025 08:42:26 +0200 Subject: Improve entry point lookup function documentation (#6451) * Document that findEntryPointByName is not applicable if there is no [shader(...)] attribute * Update the user guide to mention findAndCheckEntryPoint for entry points without [shader(...)] attributes * format code --------- Co-authored-by: slangbot <186143334+slangbot@users.noreply.github.com> Co-authored-by: Yong He --- include/slang.h | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'include/slang.h') diff --git a/include/slang.h b/include/slang.h index 54647b830..66fd317c6 100644 --- a/include/slang.h +++ b/include/slang.h @@ -4361,6 +4361,10 @@ struct IModule : public IComponentType { SLANG_COM_INTERFACE(0xc720e64, 0x8722, 0x4d31, {0x89, 0x90, 0x63, 0x8a, 0x98, 0xb1, 0xc2, 0x79}) + /// Find and an entry point by name. + /// Note that this does not work in case the function is not explicitly designated as an entry + /// point, e.g. using a `[shader("...")]` attribute. In such cases, consider using + /// `IModule::findAndCheckEntryPoint` instead. virtual SLANG_NO_THROW SlangResult SLANG_MCALL findEntryPointByName(char const* name, IEntryPoint** outEntryPoint) = 0; -- cgit v1.2.3