eve::platform_event::IPlatformEventSink类 参考

EVENGINE_API_FOUNDATION public API. 更多...

#include <PlatformEventSink.h>

Public 类型
enum	Priority { kObserver = 0 , kSurface = 10 , kInput = 20 }
	Priority public API. 更多...

Public 成员函数
virtual	~IPlatformEventSink ()=default
virtual bool	shouldConsumePlatformEvent (const void *nativeEvent)
virtual Message *	translatePlatformEvent (const void *nativeEvent)
virtual void	onPumpFinished ()

静态 Public 属性
static constexpr const char *	capabilityName = "eve.event.IPlatformEventSink"

详细描述

EVENGINE_API_FOUNDATION public API.

在文件 PlatformEventSink.h 第 31 行定义.

成员枚举类型说明

Priority

enum eve::platform_event::IPlatformEventSink::Priority

Priority public API.

Dispatch order; lower runs first.

枚举值
kObserver
kSurface
kInput

在文件 PlatformEventSink.h 第 35 行定义.

构造及析构函数说明

~IPlatformEventSink()

virtual eve::platform_event::IPlatformEventSink::~IPlatformEventSink ( )

virtualdefault

成员函数说明

onPumpFinished()

virtual void eve::platform_event::IPlatformEventSink::onPumpFinished ( )

inlinevirtual

Called once per pump() after the platform queue drains.

在文件 PlatformEventSink.h 第 62 行定义.

被这些函数引用 eve::platform_event::sdl::Event::pump().

shouldConsumePlatformEvent()

virtual bool eve::platform_event::IPlatformEventSink::shouldConsumePlatformEvent ( const void *  nativeEvent )

inlinevirtual

Inspect an event before translation. Return true to consume it, so no later sink sees it and no Message is queued. @ownership nativeEvent is borrowed from the platform pump; the sink never owns it. @lifetime nativeEvent is valid only for this synchronous call.

在文件 PlatformEventSink.h 第 50 行定义.

translatePlatformEvent()

virtual Message * eve::platform_event::IPlatformEventSink::translatePlatformEvent ( const void *  nativeEvent )

inlinevirtual

Translate an event into a queued Message, updating any module state it implies. Return nullptr to leave the event to the next sink. Ownership of a returned Message passes to the caller. @ownership nativeEvent is an immediate borrow; a returned Message transfers ownership. @lifetime nativeEvent is valid only for this call; the returned Message remains valid until deleted.

在文件 PlatformEventSink.h 第 59 行定义.

类成员变量说明

capabilityName

constexpr const char* eve::platform_event::IPlatformEventSink::capabilityName = "eve.event.IPlatformEventSink"

staticconstexpr

在文件 PlatformEventSink.h 第 41 行定义.

---

该类的文档由以下文件生成:

• src/modules/platform_event/PlatformEventSink.h